Skip to content
The Chat Archive
gpt-4o-2024-11-20· OpenAI WildChat-4.8M (AI2)

Предположим у меня в Laravel php есть маршрут на обновление пользователя, данные которые…

  1. User

    Предположим у меня в Laravel php есть маршрут на обновление пользователя, данные которые передаются на этот роут передаются в dto примерно такого вида

    class UserUpdate{
    	public ?string $email = null
    	public string $first_name;
    	public string $last_name;
    }
    

    в данном случае мы говорим что поля first_name и last_name, у нас точно будут, а email может не быть, но как клиентскому коду, который использует эту dto понять, что когда email null это просто стандартное значение и поле вообще не передавали, а значит его не нужно обновлять, или его действительно передали как null и нужно удалить(занулить) email из базы

  2. Assistant

    Отличный вопрос! Это действительно важное различие — "поле вовсе не передано" и "поле намеренно установлено в null". Чтобы клиентский код корректно различал эти случаи, можно использовать несколько подходов.

    1. Использовать объект Request напрямую для проверки наличия полей

    Laravel позволяет легко проверять, было ли поле передано в запросе при помощи метода has(). Например:

    $request->has('email'); // Вернет true, если поле `email` было передано в запросе, даже если значением будет null.
    
    • Если has('email') возвращает false, значит поле не передано вообще.
    • Если поле есть (пусть даже с null-значением), значит его надо обработать как переданное.

    Для реализации этого в вашем DTO можно передать оригинальный Request при инициализации DTO и получать эти данные динамически.

    class UserUpdate
    {
        private $emailWasProvided = false;
        public ?string $email = null;
        public string $first_name;
        public string $last_name;
    
        public function __construct($data)
        {
            if (array_key_exists('email', $data)) {
                $this->emailWasProvided = true;
                $this->email = $data['email']; // Может быть null
            }
    
            $this->first_name = $data['first_name'];
            $this->last_name = $data['last_name'];
        }
    
        public function wasEmailProvided(): bool
        {
            return $this->emailWasProvided;
        }
    }
    

    В клиентском коде можно будет проверить так:

    $dto = new UserUpdate($request->all());
    
    if ($dto->wasEmailProvided()) {
        if (is_null($dto->email)) {
            // Установить email как null в базе (удалить email)
        } else {
            // Обновить email на указанное значение
        }
    } else {
        // Поле email не обновляем, оно не было передано
    }
    

    2. Использовать концепцию "явного признака наличия значения"

    Можно отказаться от установки null как стандартного значения для необязательных параметров в DTO и использовать вместо этого конструкцию вроде isset. Тогда, если значение будет равно null, это будет явным указанием, что оно передано как null.

    Пример DTO:

    class UserUpdate
    {
        public array $data = [];
    
        public function __construct(array $data)
        {
            $this->data = $data;
        }
    
        public function hasField(string $field): bool
        {
            return array_key_exists($field, $this->data);
        }
    
        public function getField(string $field)
        {
            return $this->data[$field] ?? null;
        }
    }
    

    Использование:

    $dto = new UserUpdate($request->all());
    
    if ($dto->hasField('email')) {
        $email = $dto->getField('email');
        if (is_null($email)) {
            // Установить email как null в базе
        } else {
            // Обновить email
        }
    } else {
        // Поле email не передано, не обновляем
    }
    

    3. Использовать библиотеку для DTO, например spatie/data-transfer-object

    Работа с необязательными полями значительно упрощается при использовании пакетных решений для DTO, например spatie/data-transfer-object. Библиотека позволяет специфицировать, какие поля обязательны, какие нет, а также легко проверять, было ли поле передано.

    Пример использования:

    use Spatie\DataTransferObject\DataTransferObject;
    
    class UserUpdate extends DataTransferObject
    {
        public ?string $email = null;
        public string $first_name;
        public string $last_name;
    
        public bool $emailWasProvided;
    
        public function __construct(array $parameters = [])
        {
            $this->emailWasProvided = array_key_exists('email', $parameters);
            parent::__construct($parameters);
        }
    }
    

    Что выбрать?

    1. Метод Request::has() — если код достаточно простой и в самой модели DTO вытащить данные запроса необязательно.
    2. Явное указание наличия полей в DTO — хорошо, если вы хотите модифицировать DTO самостоятельно.
    3. Готовые библиотеки — удобно для сложных данных, но без необходимости можно обойтись.

    Какой бы метод вы ни выбрали, важно помнить, что поведение должно быть консистентным для всех типов данных — так будет проще поддерживать код.