Где и кто должен делать валидацию?

Question

[Sergei Abramov]

В общем пытаюсь освоить Di, сервисы, репозитории - правильную архитектуру. Делаю тренировочный проект, но возникли вопросы:

Раньше была модель User extend ActiveRecord, и была модель RegistrationForm extend Model
При получении данных, в экшене создавал вторую модель и выполнял метод валидации: $form->load($this->getRequest()->post()) && $form->validate(), далее вызывал метод регистрации. В общем-то все, все это можно было увидеть в примерах yii2.

class AccountController extend BaseController
{
    public function actionRegistration()
    {
        $form = new RegistrationForm($this->getRequest()->post());
        if ($form->validate()) {
            $user = $form->registration();
            return $user->id;
        } else {
            throw new BadRequestHttpException(implode(';, $registration->getFirstErrors()));
        }
    }
}

Сейчас логику регистрации вынес в сервис AccountService, работу с моделью User (поиск, создание, сохранение..) вынес в UserRepository. Сама модель ничего не содержит кроме rules. Но вот куда теперь девать RegistrationForm в которой была валидация пришедших данных?

1) В контроллере валидировать?

$email = Yii::$app->getRequest()->post['email']; 
if (!EmailValidator::validate($email)) {
     throw new BadRequestHttpException('Wrong email');
}

2) Оставить RegistrationForm, но сделать унаследованной от User c переопределенными rules. Передавать заполненную модель в сервис и в сервисе вызывать валидацию. Так пока и сделал:

public function actionRegistration()
    {
        $registrationForm = new RegistrationForm($this->getRequest()->post());
        $user = $this->accountService->registrationUser($registrationForm);
        if ($user) {
            return $this->accountService->generateToken($user)->token;
        } else {
            throw new BadRequestHttpException(implode('; ', $registrationForm->getFirstErrors()));
        }
    }

3) Передавать в сервис массив пришедших данных и там уже каким-нибудь способом валидировать.

В общем хочу понять как правильно делать, где-что должно лежать и запускаться.

Answer 1

[Виталий Хоменко]

1. Да, но не вручную, а через форму, которая за это отвечает - через RegistrationForm. Это же замечательный функционал, глупо его игнорировать. Один раз описываете правила валидации и форма работает.

2. Нет, они выполняют разные роли: форма занимается валидацией входящих данных, а AR-модель хранением. Я настоятельно не рекомендую тесно связывать формы с сущностями, т.е. наследовать одни от других. Их нужно держать раздельно: изменение AR-сущности User никогда не создаст вам проблем в формах, а изменение данных запроса и правил валидации формы RegistrationForm не навредит AR-сущности. Вы сможете менять их независимо друг от друга.

3. Вы должны передать провалидированные данные от контроллера в сервис. А вот как вы это сделаете полностью на ваше усмотрение: грубо массивом, особым value-объектом или предусмотреть передачу заполненной формы RegistrationForm в сервис, который сам сможет извлечь данные и выполнить работу. Важный момент: данные должны быть полностью проверены. Сервис при этом может даже не знать кто его использует, главное соблюдать публичный интерфейс.

Comments

[FanatPHP]

а потом понадобится создать юзера через утилиту командной строки

[Sergei Abramov]

Разделил RegistrationForm и User, делаю валидацию в контроллере, но теперь смотрю на сервис и думаю: а откуда сервис знает что ему пришли валидные данные. В этом экшене да, мы их проверяем, но вот из другого места будут использовать этот сервис и закинут туда уже непроверенные данные. Может надо и там и там делать валидацию? Но тоже какая-то копипаста получается..

[Виталий Хоменко]

Sergei Abramov, в сервисе? Конечно нужно! Сервис должен контролировать данные на своем уровне, только необходимые ему, без учета особенностей сценария, в рамках которого он вызван.

[Виталий Хоменко]

FanatPHP, потому я и уточнил, что это на усмотрение разработчика, в зависимости от задачи. Предпочитаю компромисс между функциональностью и простотой.

[Sergei Abramov]

Еще посидел подумал: двойной валидации можно избежать, т.к. в RegistrationForm после первой валидации уже содержаться ошибки. Для наглядность переименовал в RegistrationData и вроде не плохо получилось:
Controller:

public function actionRegistration()
    {
        $registrationData = Yii::createObject(RegistrationData::class);
        $registrationData->load($this->getRequest()->post(), '');

        $user = $this->accountService->registrationUser($registrationData);
        if ($user) {
            return $this->accountService->generateToken($user)->token;
        } else {
            throw new BadRequestHttpException(implode('; ', $registrationData->getFirstErrors()));
        }
    }

и сервис:

public function registrationUser(RegistrationData $data): ?User
    {
        if (!$data->validate()) {
            return null;
        }
        $user = $this->userRepository->create($data->getAttributes());
        $user->setPassword($data->password);
        if ($this->userRepository->save($user)) {
            return $user;
        }
        return null;
    }

    public function generateToken(User $user): UserToken
    {
        $userToken = $this->userTokenRepository->create([
            'user_id' => $user->id,
            'token' => md5(mktime() . uniqid()),
            'ip' => $this->getRequest()->userIP ?? '127.0.0.1'
        ]);

        if (!$this->userTokenRepository->save($userToken)) {
            throw new Exception('Can\'t save user token');
        }

        return $userToken;
    }

Далее уже буду на интерфейсы переводить зависимости :)

[FanatPHP]

Sergei Abramov, только не этот ужас с implode. Передавать надо массив. Который потом пойдет либо в шаблон, либо в джейсон. И кидать исключение надо прямо в registrationUser. Возврат null - это какой-то каменный век. только не BadRequestHttpException, а ValidationException.

Answer 2

[FanatPHP]

Это хороший вопрос.

Когда форма сама занимается своей валидацией, то тут вариантов немного. Остаемся в контроллере.

Но по-хорошему, если отвлечься от конкретных велосиепедов, плотно увязывающих вывод ХТМЛ и валидацию входящих в модель данных, то в AccountService должен быть метод validate().

Соответственно, из любого места, где нам надо создать юзера, сначала дергаем validate(), а потом по результатам либо выдаем ошибку, либо дергаем create()

Comments

[Sergei Abramov]

А не create ли должен дергать validate внутри себя? Что бы гарантировать, что не пройдут невалидные данные, а то если не дергать публичный validate, то можно отправить кривые данные? Или может тогда в сервис передавать RegistrationForm и и в методе create дергать $form->validate() ? Это будет гарантировать что пришла валидная форма данных, но тогда появляется другая проблема: двойная валидация. Сначала в контроллере, что бы сразу сообщить назад что данные не валидные, а потом в сервисе - для гарантии пришедших данных. Выглядит так себе.

[FanatPHP]

А не create ли должен дергать validate внутри себя?

Можно и так. Я просто не придумал красивый метод коммуникации в этом случае между контроллером и сервисом.
Я просто почему-то не очень люблю ловить исключения. Ме это кажется не очень красивым кодом. Но по сути почему бы и нет - в контроллере заключаем сохранение в трай-кетч, в котором ловим ValidationException, у которого есть метод getValidationErrors().

[dk-web]

FanatPHP, мне очень понравился один "препод" на ютубе. Так его один русскоязычный умник там начал разносить за то, что валидация происходит в контроллере. Что мол это показатель, что человек вообще не разбирается в php и еще лезет учить других.