Валидировали, валидировали… и вывалидировали! Сравниваем валидаторы данных в PHP

Изображение взято с сайта Michiana Stransportation (Bike Shops)

Если вы еще не в курсе, что такое Kontrolio, предлагаю прочесть первую часть — «Держите свои данные под контролем». Вкратце, это моя библиотека для валидации данных, написанная на PHP.

В предыдущей статье я обещал написать сравнение своей собственной библиотеки с другими имеющимися решениями, так что сегодня мы рассмотрим валидацию с помощью Aura.Filter, Respect Validation, Sirius Validation и Valitron.

Давайте представим, что у нас в разработке есть некий публичный сервис, который предполагает регистрацию пользователей для полного доступа ко всем функциям. Таким образом, форма регистрации будет содержать следующие поля:

1. name. Должно содержать ровно два слова, где первое — имя пользователя, а второе — фамилия.
2. login. Если значение передано, то оно должно только латинские буквы, дефисы и нижнее подчеркивание.
3. email. Должно содержать валидный адрес электронной почты.
4. password. Должен быть установлен и иметь длину не более 64 символов.
5. agreed. Типичный флажок, который пользователь должен установить, чтобы подтвердить своё согласие с условиями сервиса.

Итак, у нас пять полей, которые пользователь должен заполнить, чтобы зарегистрироваться в нашем воображаемом сервисе. Давайте представим, что нам на вход поступили полностью невалидные данные:

$data = [
    'name'  => 'Альберт', // Должно быть два слова
    'login' => '@lbert', // "Запрещенный" символ @
    'email' => 'что-то не то', // Здесь должен быть e-mail
    'password' => '' // Пароль вообще не указан
    // 'agreed' нет в массиве, потому что пользователь не установил флажок
];

Aura.Filter

Валидация с использованием Aura.Filter начинается с фабрики фильтров. Нам необходимо создать так называемый «фильтр субъекта», так как мы будет валидировать массив, а не индивидуальное значение.

Определяем правила

use AuraFilterFilterFactory;

$filter = (new FilterFactory)->newSubjectFilter();

$filter->validate('name')
    ->isNotBlank()
    ->is('two_words')
    ->setMessage('Имя должно состоять из двух слов.');

$filter->validate('login')
    ->isBlankOr('alnum')
    ->setMessage('Если вы указываете логин, он должен содержать только латинские символы.');

$filter->validate('email')
    ->isNotBlank()
    ->is('email')
    ->setMessage('Пожалуйста, напишите корректный адрес эл. почты.');

$filter->validate('password')
   ->isNotBlank()
   ->is('strlenMax', 64)
   ->setMessage('Пожалуйста, напишите пароль.');

$filter->validate('agreed')
    ->is('callback', function($subject, $field) {
   return $subject->{$field} === true;    
})->setMessage('Вам необходимо согласиться с условиями сервиса.');

Как видите, описание правил достаточно простое. Aura.Filter предоставляет целый набор полезных правил «из коробки» и некоторые из них были использованы в примере выше:

1. метод isNotBlank. Указывает, что поле не может иметь пустое значение.
2. alnum. Это правило допускает только латинские буквы.
3. email. И так понятно :)
4. strlenMax. Указывает, что поле не может превышать длину, указанную вторым аргументом метода is.
5. callback. Этот тип правила похож на замыкания из Kontrolio. Он позволяет определить правило в виде замыкания. В это замыкание Aura.Filter передает «субъект», наш массив данных из формы, и поле, в данном случае agreed.

Наверняка вы заметили, что я не указал правило two_words. Естественно, в Aura.Filter такого правила нет, поэтому нам необходимо его создать. Как гласит документация, это делается с помощью отдельного класса для правила:

/**
 * Правило, которое валидирует имя пользователя.
 * Имя пользователя состоит из двух слов: имени и фамилии, разделенных одним пробелом.
 */
class UserNameRule
{
    /**
     * Валидирует имя пользователя.
     *
     * @param object|array $subject
     * @param string $field
     * @param int $max
     *
     * @return bool
     */
    public function __invoke($subject, $field, $max = null)
    {
        $value = $subject->{$field};

        if ( ! is_scalar($value)) {
            return false;
        }

        return (bool) preg_match('/^[A-Za-z]+s[A-Za-z]+$/u', $value);
    }
}

The second step is to let the filter factory know about our new rule. It’s done by passing the first argument as an array of rules to the filter factory:

Следущий шаг — уведомить Aura.Filter о том, что мы создали новое правило и хотим его использовать. Это делается с помощью передачи массива правил в первый аргумент фабрики:

use AuraFilterFilterFactory;

$rules = [
    'two_words' => function() {
        return new UserNameRule;
    }
];

$filter = (new FilterFactory($rules))->newSubjectFilter();

Теперь наше правило two_words может быть использовано так же, как и любое другое правило из стандартной поставки.

Обратная связь

Как вы помните, входящие данные, которые мы валидируем, — полностью невалидны, потому что каждое поле содержит некорректное значение или не содержит его вовсе. Поэтому предполагается, что в результате валидации мы получим ошибки и соответствующие сообщения о них.

Валидируем с Aura.Filter мы следующим образом:

$valid = $filter->apply($data);

if ( ! $valid) {
    $failures = $filter->getFailures();
    $messages = $failures->getMessages();
}

В $messages записывается массив, поэтому для вывода сообщений нам потребуется два вложенных foreach:

<ul class="errors">
    <?php
    foreach ($messages as $field => $errors) {
       foreach ($errors as $error) {
            printf('<li class="error">%s</li>', $error);
        }
    }
    ?>
</ul>

Respect Validation

Вторая библиотека, использованная мной в сравнении, — относительно популярное решение под названием Respect Validation. Раз люди ей доверяют, думаю, там есть что посмотреть.

Для чистоты эксперимента при сравнении библиотек мы будем использовать один и тот же набор данных, определенный в начале:

use RespectValidationValidator as v;

$data = [
    'name'  => 'Альберт', // Должно быть два слова
    'login' => '@lbert', // "Запрещенный" символ @
    'email' => 'что-то не то', // Здесь должен быть e-mail
    'password' => '' // Пароль вообще не указан
    // 'agreed' нет в массиве, потому что пользователь не установил флажок
];

Определяем правила

Как и в случае с Aura.Filter, нам необходимо собственное правило валидации для имени пользователя, поэтому давайте с него и начнем:

namespace MyNamespace;

use RespectValidationRulesAbstractRule;

class UserNameRule extends AbstractRule
{
    public function validate($input)
    {
        return (bool) preg_match('/^[A-Za-z]+s[A-Za-z]+$/u', $input);
    }
}

Внешнее API правил практически идентично Aura.Filter, только используется метод validate() вместо магии __invoke(). Мне оно, это API, показалось более простым и понятным. Ну, и к Kontrolio оно ближе :)

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

use RespectValidationExceptionsNestedValidationException;

class UserNameRuleException extends NestedValidationException
{
    //
}

Ну и наконец-то мы можем провалидировать наши данные. Для начала мы передаем валидатору наше новое правило, чтобы он узнал о нем, и мы смогли его использовать в дальнейшем. В Respect Validation это делается вызовом метода with() с передачей пространства имен, в котором находятся нестандартные правила.

v::with('MyNamespace\');

Теперь все нестандартные правила, находящиеся в пространстве имен MyNamespace, будут «опознаны» валидатором. Следующий шаг — описать необходимые правила и выполнить валидацию.

v::attribute('name', v::userNameRule())
 ->attribute('login', v::alnum('-_'))
 ->attribute('email', v::email())
 ->attribute('password', v::notEmpty()->stringType()->length(null, 64))
 ->attribute('agreed', v::trueVal())
 ->assert((object) $data);

Обратите внимание на то, как мы применяем наше правило к атрибуту name. Здесь название класса правило трансформировалось в название метода валидатора. Остальные правила, в общем-то, интуитивно понятны.

Отдельно стоит сказать о том, зачем мы приводим массив $data к объекту. Дело в том, что Respect Validation принимает на вход объекты, а не массивы. Это следует учесть при разработке с использованием данной библиотеки.

Обратная связь

В отличие от Aura.Filter валидатор Respect выбрасывает исключение, когда валидация провалена. И в этом исключении содержатся сообщения об ошибках валидации. Поэтому пример, который только что был показан, должен быть записан следующим образом:

try {
    v::with('RespectValidationExample\');
    v::attribute('name', v::userNameRule())
     ->attribute('login', v::alnum('-_'))
     ->attribute('email', v::email())
     ->attribute('password', v::notEmpty()->stringType()->length(null, 64))
     ->attribute('agreed', v::trueVal())
     ->assert((object) $data);
} catch (NestedValidationException $ex) {
    $messages = $ex->getMessages();
}

Используя getMessages(), мы получим плоский массив всех сообщений, который валидатор собрал в процессе валидации. Задампив массив, мы получим примерно такой результат:

array(5) {
 [0] => string(29) “Data validation failed for %s”
 [1] => string(60) “login must contain only letters (a-z), digits (0–9) and “-_””
 [2] => string(25) “email must be valid email”
 [3] => string(26) “password must not be empty”
 [4] => string(32) “Attribute agreed must be present”
}

Можно поменять сообщения на свои собственные. Возможно, я как-то не так понял эту библиотеку, но мне этот процесс не показался таким уж очевидным: необходимо использовать метод findMessages() на обработанном исключении, в котором вы определяете сообщения не для атрибутов, а для правил.

$ex->findMessages([
    'userNameRule' => 'Имя пользователя должно состоять из двух слов.',
    'alnum' => 'Ваш логин нам не нравится.',
    'email' => 'Вы явно не хотите давать нам свой e-mail.',
    'notEmpty' => 'Ну и где же ваш пароль?',
    'agreed' => 'Жаль, что вы не согласны.'
]);

Не знаю, в чем ошибка, но есть пара вещей, которые я так и не понял. Вот что мы получим, определив правила вышеуказанным способом:

array(5) {
 [0] => string(40) “Имя пользователя должно состоять из двух слов.”
 [1] => string(31) “Ваш логин нам не нравится.”
 [2] => string(25) “email must be valid email”
 [3] => string(5) “Ну и где же ваш пароль?”
 [4] => string(9) “Жаль, что вы не согласны.”
}

Как видите, сообщение для поля электронной почты не применилось, осталось стандартное. А вот сообщение за индексом 4 наоборот! И это при том, что я использовал не название правила, а название поля. В то время как если бы я использовал название правила (trueVal), моё сообщение бы куда-то затерялось. Комментарии опытных пользователей данной библиотеки очень приветствуются.

Sirius Validation

Ок, давайте перейдем к следующей библиотеке и посмотрим, как она справится со схожими задачами.

Определяем правила

И снова нам необходимо определить правило для имени пользователя. Мы его напишем как-то так:

class UserNameRule extends AbstractRule
{
    // Сообщения об ошибках
    const MESSAGE = 'Имя пользователя должно состоять из двух слов.';
    const LABELED_MESSAGE = '{label} должно состоять из двух слов.';

    public function validate($value, $valueIdentifier = null)
    {
        return (bool) preg_match('/^[A-Za-z]+s[A-Za-z]+$/u', $value);
    }
}

Обратите внимание на разницу в подходах в сравнении с уже рассмотренными библиотеками. Мы определяем два вида сообщений в константах, нежели используя свойства, методы или аргументы правила.

Теперь давайте опишем логику валидации:

$validator = new Validator;

$validator
    ->add('name', 'required | MyAppValidationRuleUserNameRule')
    ->add('login', 'required | alphanumhyphen', null, 'Логин может содержать только латинские буквы, черточки и подчеркивания.')
    ->add('email', 'required | email', null, 'Пожалуйста, укажите корректный e-mail.')
    ->add('password', 'required | maxlength(64)', null, 'Ваш пароль, сударь.')
    ->add('agree', 'required | equal(true)', null, 'Почему же вы не согласились?');

Как видите, набор правил весьма прост и читабелен. Для описания мы используем названия, разделенные горизонтальными черточками. Этот подход похож на тот, что используется в Laravel и Kontrolio.

Четвертый аргумент метода add() описывает сообщение об ошибке валидации, которое Sirius использует, если валидация будет провалена. А почему же мы не добавили сообщение для нашего нового правила UserNameRule?

$validator->add('name', 'required | MyAppValidationRuleUserNameRule')

Так это потому, что сообщения уже описаны в константах класса:

class UserNameRule extends AbstractRule
{
    // Сообщения об ошибках
    const MESSAGE = 'Имя пользователя должно состоять из двух слов.';
...

Другой вариант — использовать метод addMessage() самого валидатора:

$validator->addMessage('email', 'Пожалуйста, укажите корректный e-mail.');

Обратите внимание, что кастомные правила идентифицируются по полному названию их класса, в то время как в Kontrolio можно задать псевдоним/алиас.

Обратная связь

Чтобы выполнить валидацию, мы вызываем метод валидатора validate(), передавая в него данные:

$data = [
    'name'  => 'Альберт', // Должно быть два слова
    'login' => '@lbert', // "Запрещенный" символ @
    'email' => 'что-то не то', // Здесь должен быть e-mail
    'password' => '' // Пароль вообще не указан
    // 'agreed' нет в массиве, потому что пользователь не установил флажок
];

$validator->validate($data);

В отличие от Respect, Sirius не выкинет исключение, а просто вернет false. Сообщения об ошибках валидации можно получить через метод валидатора getMessages(). Он возвращает ошибки, сгруппированные по атрибутам, так что для прохода по ошибкам нам понадобится два цикла foreach:

foreach ($validator->getMessages() as $attribute => $messages) {
    foreach ($messages as $message) {
        echo $message->getTemplate() . "n";
    }
}

Здесь $message — объект класса SiriusValidationErrorMessage, у которого есть метод getTemplate(), возвращающий то самое необходимое нам сообщение.

Valitron

Поехали дальше. Еще одно интересное решение — Valitron. Valitron отличается от остальных реализацией добавления и описания правил валидации.

Определяем правила

Первое отличие: чтобы добавить новое правило, не нужно создавать отдельный класс. Можно просто использовать замыкание, возвращающее булевский результат.

Для добавления кастомных правил в Valitron есть статический метод addRule(), в котором первые два аргумента обязательны, а третий — по желанию. Мне понравился такой способ, так как тут сразу в одном месте указывается идентификатор правила, логика и сообщение об ошибке.

use ValitronValidator;

Validator::addRule('two_words', function($field, $value) {
    return (bool) preg_match('/^[A-Za-z]+s[A-Za-z]+$/u', $value);
}, 'Имя пользователя должно состоять ровно из двух слов.');

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

В Valitron пошли другим путем и на первое место поставили именно правила валидации. Описывая правила, вы как бы применяете атрибуты к этим правилам, а не наоборот.

$validator = new Validator($data);
$validator
    ->rule('two_words', 'name')->label('')
    ->rule('required', [
        'name', 'login', 'email', 'password', 'agreed'
    ])
    ->rule('slug', 'login')
    ->rule('email', 'email')
    ->rule('accepted', 'agreed');

Как видно из примера, в методе rule() мы сначала пишем название правила, а уже затем указываем атрибуты, которые должны соответствовать этому правилу. Более явный пример — правило required, где показано, как атрибуты «принадлежат» этому правилу.

Valitron (как и другие решения, которые мы успели рассмотреть) предоставляет стандартные сообщения об ошибках. Если вы просто воспользуетесь ими, то увидите, что каждое сообщение начинается с названия соответствующего атрибута.

Valitron подставляет имена атрибутов в текст сообщения даже в том случае, когда используются нестандартные сообщения об ошибках. Поэтому мы и воспользовались методом label() с пустой строкой, чтобы убрать имя атрибута.

$validator->rule('two_words', 'name')->label('')

Обратная связь

Конкретно что касается валидации, API библиотеки Valitron практически ничем не отличается от того, что мы уже видели в статье. Чтобы выполнить валидацию мы вызываем метод валидатора validate():

$validator->validate();

Сообщения об ошибках валидации можно получить с помощью метода getErrors():

$validator->errors();

Сообщения здесь группирутся по атрибутам точно так же, как и в Sirius Validation, за исключеним того, что для сообщения нет отдельного класса, и мы получаем обычный многомерный массив.

foreach ($validator->errors() as $attribute => $messages) {
    foreach ($messages as $message) {
        echo $message . "n";
    }
}

Kontrolio

Ну и наконец, последняя библиотека на сегодня — моя собственная разработка под названием Kontrolio.

Определяем правила

Снова, в пятый раз мы создадим правило валидации для имени пользователя. Всё относительно просто и стандартно:

namespace MyProjectValidationRules;

use KontrolioRulesAbstractRule;

class TwoWords extends KontrolioRulesAbstractRule
{
    public function isValid($input = null)
    {
        return (bool) preg_match('/^[A-Za-z]+s[A-Za-z]+$/u', $input);
    }
}

Теперь мы создаем фабрику и регистриуем правило в ней, используя метод extend():

namespace MyProject;

use KontrolioFactory;
use MyProjectValidationRulesTwoWords;

$factory = KontrolioFactory::getInstance()->extend([TwoWords::class]);

После регистрации правила мы можем воспользоваться им в том числе по имени — two_words. Давайте создадим валидатор:

$data = [
    'name'  => 'Альберт', // Должно быть два слова
    'login' => '@lbert', // "Запрещенный" символ @
    'email' => 'что-то не то', // Здесь должен быть e-mail
    'password' => '' // Пароль вообще не указан
    // 'agreed' нет в массиве, потому что пользователь не установил флажок
];

$rules = [
    'name' => 'two_words',
    'login' => 'sometimes|alphadash',
    'email' => 'email',
    'password' => 'length:1,64',
    'agreed' => 'accepted'
];

$messages = [
    'name' => 'Имя пользователя должно состоять из двух слов.',
    'login' => 'Ваш логин нам не нравится.',
    'email' => 'Вы явно не хотите давать нам свой e-mail.',
    'password' => 'Ну и где же ваш пароль?',
    'agreed' => 'Жаль, что вы не согласны.'
];

$validator = $factory->make($data, $rules, $messages);

Мы описали правила, используя синтаксис, схожий с тем, что используется в Laravel, хотя могли использовать и более многословный вариант:

$rules = [
    'name' => new TwoWords,
    'login' => [new Sometimes, new Alphadash],
    'email' => new Email,
    'password' => new Length(1, 64),
    'agreed' => new Accepted
];

Обратная связь

Валидация запускается всё тем же методом validate():

$validator->validate();

Теперь мы можем получить сообщения об ошибках, используя один из методов getErrors() или getErrorsList(). Первый метод позволяет сделать более сложный вывод ошибок, тогда как второй возвращает плоский массив. Используя getErrors() мы можем вывести сообщения как-то так:

<ul class="errors">
    <?php foreach ($errors as $attribute => $messages): ?>
    <li class="errors__attribute">
        <b><?= $attribute; ?></b>
        <ul>
            <?php foreach ($messages as $message): ?>
            <li><?= $message; ?></li>
            <?php endforeach; ?>
        </ul>
    </li>
<?php endforeach; ?>
</ul>

А с getErrorsList() можно сделать более простой список сообщений:

<?php $errors = $validator->getErrorsList(); ?>

<ul class="errors">
    <?php foreach($errors as $error): ?>
        <li class="errors__error"><?= $error; ?></li>
    <?php endforeach; ?>
</ul>

Итог

В данной статье я показал примеры использования следующих библиотек:

1. Aura.Filter
2. Respect Validation
3. Sirius Validation
4. Valitron
5. Kontrolio

«Пример из реального мира» может показаться слишком простым. Я вынужден согласиться, так как, действительно, некоторые возможности библиотек остались за бортом статьи. В принципе, если вам это будет интересно, вы можете изучить их особенности самостоятельно.

Каждая из библиотек предлагает свои фишки, имеет свои тёмные стороны, так что я думаю, что это дело вкуса и задачи — выбрать ту самую.

Благодарю за прочтение. Сделайте правильный выбор :)

Автор: franzose

Источник