Как правильно фильтровать и мапить данные при реализации API на Symfony?

Question

[siller444]

Доброго времени суток!
Возник вопрос, а точнее пару вопросов:
- как правильно валидировать (фильтровать) данные из реквеста без компонента Form
- как мапить данные на сущности без использования JMSSerializerBundle

Немного погуглив, часто натыкался на то что Component Form это не лучьший вариант для использования в API, но никто почему-то не предложил альтернативных решений.

Буду благодарен за любые идеи, ссылки. Спасибо!

Answer 1

[BoShurik]

1. symfony/validator

$violations = $this->get('validator')->validate($dto);

2. symfony/serializer

$dto = $this->get('serializer')->deserialize(
    $request->getContent(),
    DTO::class
);

Все это можно красиво обернуть в Action Argument Resolving, т.о. код будет выглядеть что-то вроде

public function editAction(DTO $dto)
{

}

где в $dto уже будет валидный объект

Comments

[siller444]

Спасибо большое за ответ, сейчас попробую, выглядит действительно просто и изящно)))

где в $dto уже будет валидный объект

Тоесть как я понимаю в Action ДТОшка придет уже провалидированной?
Если да, то кто вернет список ошибок?

[BoShurik]

siller444, у меня что-то вроде этого

class OrderModelResolver implements ArgumentValueResolverInterface
{
    /**
     * @var SerializerInterface
     */
    private $serializer;
    
    /**
     * @var ValidatorInterface
     */
    private $validator;

    public function __construct(SerializerInterface $serializer, ValidatorInterface $validator)
    {
        $this->serializer = $serializer;
        $this->validator = $validator;
    }

    /**
     * @inheritDoc
     */
    public function resolve(Request $request, ArgumentMetadata $argument)
    {
        $model = $this->>serializer->deserialize($request->getContent(), OrderModel::class)

        $violations = $this->validator->validate($model);
        if ($violations->count() > 0) {
            throw new ValidationException($violations);
        }

        yield $model;
    }

    /**
     * @inheritDoc
     */
    public function supports(Request $request, ArgumentMetadata $argument)
    {
        return $argument->getType() == OrderModel::class;
    }
}

class ValidationExceptionListener implements EventSubscriberInterface
{
    /**
     * @inheritDoc
     */
    public static function getSubscribedEvents()
    {
        return [
            KernelEvents::EXCEPTION => 'onException',
        ];
    }

    public function onException(GetResponseForExceptionEvent $event)
    {
        $exception = $event->getException();
        if (!$exception instanceof ValidationException) {
            return;
        }

        $errors = [];
        /** @var ConstraintViolationInterface $violation */
        foreach ($exception->getViolations() as $violation) {
            $errors[$violation->getPropertyPath()] = $violation->getMessage();
        }

        $response = new JsonResponse([
            'errors' => $errors,
        ], 400);

        $event->setResponse($response);
        $event->stopPropagation();
    }
}

[siller444]

BoShurik, это гениально))) Спасибо, вре работает! Гибко и четко, реально СПАСИБО!)))

[galliard]

BoShurik, уверен, что валидацию стоит делать в резольвере, а не, например, в контроллере?

[BoShurik]

galliard, а в чем проблема? У тебя по факту будет в каждом контроллере один и тот же вызов валидатора. Правила валидации все равно описаны через аннотации:

use Symfony\Component\Validator\Constraints as Assert;

class DTO
{
    /**
     * @var string
     *
     * @Assert\NotBlank()
     */
    public $name;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     * @Assert\Email()
     */
    public $email;

    /**
     * @var string
     *
     * @Assert\NotBlank()
     */
    public $address;
}

[galliard]

BoShurik, но есть же группы https://symfony.com/doc/current/validation/groups.html

[BoShurik]

galliard, сложно без конкретного примера, но чаще всего группы используются если
- У вас не DTO, а Entity (к примеру, разделить редактирование и создание). В случае использования DTO, они чаще всего разные на редактирование и создание
- Надо валидировать объект в зависимости от его содержимого. В этом случае логика проставления группы может быть вынесена во все тот же резолвер

Если все-таки они нужны я бы прокидывал их через request attributes

@Route(path="/submit", name="order_submit", defaults={"validation_groups": {"Group1", "Group2"} })

И в резолвере обращался бы

$validationGroups = $request->attributes->get('validation_groups', null);

[siller444]

galliard, идея действительно хорошая, я использую валидационные группы на DTO-шках ибо не хочу плодить много resolver-ов и DTO-шек.
Если у вас есть еще варианты, поделитесь)
Данный способ проверил, работает! Еще раз спасибо BoShurik )))

[BoShurik]

siller444, ну если не хотите плодить резолверы, то можно что-то вроде этого использовать:

class ModelResolver implements ArgumentValueResolverInterface
{
    /**
     * @var SerializerInterface
     */
    private $serializer;

    /**
     * @var ValidatorInterface
     */
    private $validator;

    /**
     * @var string
     */
    private $namespace;

    public function __construct(
        SerializerInterface $serializer, 
        ValidatorInterface $validator, 
        $namespace = 'App\\DTO\\'
    ) {
        $this->serializer = $serializer;
        $this->validator = $validator;
        $this->namespace = $namespace;
    }

    /**
     * @inheritDoc
     */
    public function resolve(Request $request, ArgumentMetadata $argument)
    {
        $model = $this->serializer->deserialize($request->getContent(), $argument->getType());

        $validationGroups = $request->attributes->get('validation_groups', null);
        $violations = $this->validator->validate($model, null, $validationGroups);
        if ($violations->count() > 0) {
            throw new ValidationException($violations);
        }

        yield $model;
    }

    /**
     * @inheritDoc
     */
    public function supports(Request $request, ArgumentMetadata $argument)
    {
        return strpos($argument->getType(), $this->namespace) === 0;
    }
}