Как правильно провести десериализацию xml файла с вложенными объектами при помощи Symfony Serializer?

Question

[Алексей Скляров]

Есть CommerceML файл, который приходит от 1С, в нем указываются товарные группы в виде:

Товарные группы из import.xml

<Группы>
			<Группа>
				<Ид>58a742d8-dcc4-11ec-9656-fa163ec2d0ed</Ид>
				<Наименование>Ковры</Наименование>
				<Группы>
					<Группа>
						<Ид>5df7cfa0-dcc4-11ec-9656-fa163ec2d0ed</Ид>
						<Наименование>Merinos</Наименование>
						<Группы>
							<Группа>
								<Ид>6a0d73a8-dcc4-11ec-9656-fa163ec2d0ed</Ид>
								<Наименование>Buhara</Наименование>
								<Группы>
									<Группа>
										<Ид>6a0d73a8-dcc4-11ec-9656-fa163ec2d0ez</Ид>
										<Наименование>Fourth Level Children</Наименование>
									</Группа>
									<Группа>
										<Ид>648a64cc-dcc4-11ec-9656-fa163ec2d0ex</Ид>
										<Наименование>Fourth Level Children</Наименование>
									</Группа>
								</Группы>
							</Группа>
							<Группа>
								<Ид>648a64cc-dcc4-11ec-9656-fa163ec2d0ed</Ид>
								<Наименование>Crystal</Наименование>
							</Группа>
						</Группы>
					</Группа>
					<Группа>
						<Ид>5df7cfa0-dcc4-11ec-9656-fa163ec2d0zd</Ид>
						<Наименование>Другое</Наименование>
					</Группа>
				</Группы>
			</Группа>
		</Группы>

Данная структура представляет из себя иерархию, и я хочу получить подобную структуру в виде DTO.

Для этого я создал сам GroupDto

GroupDto.php

<?php
namespace App\Services\CommerceML\Dto;

use Spatie\DataTransferObject\DataTransferObject;
use Symfony\Component\Serializer\Annotation\SerializedName;

class ≠ extends DataTransferObject
{
    /**
     * @SerializedName("Ид")
     */
    public string $id = '';

    /**
     * @SerializedName("Наименование")
     */
    public string $name = '';

    /**
     * @SerializedName("Группы")
     */   
    public array $childrens = [];
}

Важный момент public array $childrens = []; в DTO должен представлять из себя массив таких же DTO как и родитель, то есть класс GroupDto.

Собственно, сам сериализатор настроен так:

$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$extractor = new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()]);
$metadataAwareNameConverter = new MetadataAwareNameConverter($classMetadataFactory);
$encoders = [new XmlEncoder()];
 $normalizers = [new ArrayDenormalizer(), new ObjectNormalizer($classMetadataFactory, $metadataAwareNameConverter, null ,$extractor)];
        
$serializer = new Serializer($normalizers, $encoders);

И вызов сериализатора:

$xml = simplexml_load_file(storage_path('1cExchange/1/import.xml'));
foreach ($xml->Классификатор->Группы as $group) {
      dd($serializer->deserialize($group->Группа->asXML(), GroupDto::class, 'xml', ['flatten_nested_attributes' => true]));
}

Но в таком случае получаю такой вывод:

Вывод

^ App\Services\CommerceML\Dto\GroupDto {#628 ▼
  #exceptKeys: []
  #onlyKeys: []
  +id: "58a742d8-dcc4-11ec-9656-fa163ec2d0ed"
  +name: "Ковры"
  +childrens: array:1 [▼
    "Группа" => array:2 [▼
      0 => array:3 [▼
        "Ид" => "5df7cfa0-dcc4-11ec-9656-fa163ec2d0ed"
        "Наименование" => "Merinos"
        "Группы" => array:1 [▶]
      ]
      1 => array:2 [▼
        "Ид" => "5df7cfa0-dcc4-11ec-9656-fa163ec2d0zd"
        "Наименование" => "Pepsi"
      ]
    ]
  ]
}

Хотелось бы, чтобы массив children был содержал в себе таки же GroupDto сформированные, а не чистые массивы, можно ли это как-то сделать вообще?

Comments

[BoShurik]

А если так:

/**
 * @SerializedName("Группы")
 * @var GroupDto[]
 */   
public array $childrens = [];

[Алексей Скляров]

BoShurik, в таком случае дочерние не прокидываются вообще

^ App\Services\CommerceML\Dto\GroupDto {#628 ▼
  #exceptKeys: []
  #onlyKeys: []
  +id: "58a742d8-dcc4-11ec-9656-fa163ec2d0ed"
  +name: "Ковры"
  +childrens: array:1 [▼
    0 => App\Services\CommerceML\Dto\GroupDto {#663 ▼
      #exceptKeys: []
      #onlyKeys: []
      +id: ""
      +name: ""
      +childrens: []
    }
  ]
}

Может ошибка в том, что я передаю не весь XML, который в начале вопроса прикрепил, а прохожу циклом все категории первого уровня, и их уже передаю в десериализатор, но думаю это никак не влияет

[BoShurik]

Алексей Скляров, попробуйте еще в контекст передать flatten_nested_attributes

Ну и да, я бы попытался весь документ через объекты описать, а не только его часть

[Алексей Скляров]

BoShurik, контекст в примере и так указан, к сожалению не работает. Часть я пытаюсь обработать просто для того, чтобы понять почему на преобразовании товарных групп происходит ошибка. Я правильно понимаю, что никаких дополнительных методов в GroupDto писать не нужно, типа: addChildren(), removeChildren() [подсмотрел тут]?

[BoShurik]

Алексей Скляров, речь о передаче контекста внутрь $childrens (с помощью аннотаций), в вашем случае он передается только на родительский элемент
Никаких дополнительный методов не нужно, все так

[Алексей Скляров]

BoShurik, не подскажите как это делается? В документации читал - ничего не нашел, может имеется ввиду что надо свой еще кастомный denormalizer написать?

[BoShurik]

Алексей Скляров, https://symfony.com/blog/new-in-symfony-5-3-inline...

[Алексей Скляров]

BoShurik, попробовал так сделать, эффекта никакого, но я заметил один момент, который возможно и не позволяет мне "чисто" решить мою задачу. Если я уберу аннотацию @var GroupDto[] перед public array $childrens = [];, то в это поле попадет чистый массив без преобразований, но вот его вид скорее всего и является причиной, почему у меня мой код отрабатывает не так, как я ожидаю:

0 => App\Services\CommerceML\Dto\GroupDto {#841 ▼
      #exceptKeys: []
      #onlyKeys: []
      +id: "58a742d8-dcc4-11ec-9656-fa163ec2d0ed"
      +name: "Ковры"
      +childrens: array:1 [▼
        "Группа" => array:2 [▼
          0 => array:3 [▶]
          1 => array:2 [▶]
        ]
      ]
    }

Как вы можете увидеть, в childrens передается массив с одной парой значений "Группа" => Array(). Не знаю почему SimpleXml парсит CommerceMl именно так, но видимо в $childrens поле мне нужно передавать не условный $array, а $array['Группы'].

Но как это правильно сделать? Если я в DTO добавлю метод

public function setChildrens(array $childrens): void
{
   $this->childrens = $childrens;
}

то в данный метод попадет не чистый массив, а уже преобразованнный (массив из кривых DTO), то есть мне нужно как-то запустить сеттер раньше преобразования. Вроде как это можно сделать через методы addXXX, removeXXX?

[BoShurik]

Алексей Скляров, можно написать свой Normalizer в котором обрабатывать эту ситуацию

[Алексей Скляров]

BoShurik, напишите в данную информацию в ответ, я отмечу решением и прикреплю в комментарий к ответу свое готовое решение по этому вопросу.

Answer 1

[BoShurik]

В общем случае надо добавить аннотацию @var GroupDto[] чтоб сериалайзер понимал, что там типизированный массив.
Плюс придется написать свой Normalizer, т.к. при нормализации родительской группы вы ручками "игнорируете" ноду "Группа"

Comments

[Алексей Скляров]

Собственно мое решение задачи. Сперва пишем денормализатор

GroupDenormalizer.php

<?php

namespace App\Services\CommerceML\Serializer\Normalizer;

use App\Services\CommerceML\Dto\GroupDto;
use Symfony\Component\Serializer\Normalizer\{DenormalizerAwareInterface, DenormalizerAwareTrait, DenormalizerInterface};

class GroupDenormalizer implements DenormalizerInterface, DenormalizerAwareInterface
{
    use DenormalizerAwareTrait;

    public function denormalize($data, string $type, string $format = null, array $context = [])
    {
        // По какой-то причине если дочерняя группа одна - она не оборачивается в массив
        if(array_key_exists('Группы', $data)) {
            $data['Группы']['Группа'] = (array_key_exists('Ид',$data['Группы']['Группа'])) 
                        ? [$data['Группы']['Группа']] 
                        : $data['Группы']['Группа'];
        }


        $childrens = array_key_exists('Группы', $data) ? array_map(fn($children) => $this->denormalizer->denormalize($children, GroupDto::class), $data['Группы']['Группа']) : null;

        return new GroupDto(
            id: $data['Ид'] ?? null,
            name: $data['Наименование'] ?? null,
            childrens: $childrens,
        );

        return $data;
    }

    public function supportsDenormalization($data, string $type, string $format = null)
    {
        return $type === GroupDto::class;
    }
}

Затем подключаем его в сериализатор, у меня получилось так:

Serializer

$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
        $extractor = new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()]);
        $metadataAwareNameConverter = new MetadataAwareNameConverter($classMetadataFactory);
        $encoders = [new XmlEncoder()];
        $normalizers = [
            new GroupDenormalizer(),
            new ArrayDenormalizer(),
            new ObjectNormalizer($classMetadataFactory, $metadataAwareNameConverter, null ,$extractor)
        ];
        
        $this->serializer = new Serializer($normalizers, $encoders);

Кусок кода, который отвечает за сам запуск deserializer:

foreach ($xmlGroups->Группа as $group) {
            $groups->push(
                $this->serializer->deserialize($group->asXML(), GroupDto::class, 'xml', ['flatten_nested_attributes' => true])
            );
        }

тут $xmlGroups->Группа это нода, получаемая из парсинга с помощью SimpleXml.