Блог Александра Денисюка

PHP-программист

Вконтакте Твиттер Хабрахабр

Любые предложения или замечания принимаю на
почту a@denisyuk.by или на номер +375 (29) 203-79-48.
Ctrl + ↑ Позднее

Обработчики запросов вместо контроллеров

Вашему внимание представляю перевод статьи Goodbye controllers, hello request handlers от Jens Segers, который опубликовал её в своём блоге. Если переводить буквально, то статья в русском переводе должна называться «Прощайте контроллеры, да здравствуют обработчики запросов», но я решил назвать её проще — «Обработчики запросов вместо контроллеров». Вся статья сводится к тому, что все действия контроллеров нужно выносить в отдельные исполняемые классы. Как, зачем и почему читайте ниже.


За последние годы в ландшафте PHP многое изменилось. Мы стали использовать больше паттернов программирования и таких принципов, как DRY и SOLID. Но почему мы всё ещё используем контроллеры?

Если вам доводилось работать над большими приложениями, возможно, вы заметили, что рано или поздно контроллеры становятся толстыми. Даже при внедрении репозиториев или сервисов в контроллеры, со временем количество зависимостей, методов и строк кода неизбежно растёт.

Позвольте представить вам обработчики запросов (request handlers). Концепция очень проста, но малоизвестна среди PHP-разработчиков. Обработчик запроса является контроллером, но ограничен одним действием. Эта концепция очень похожа на шаблон Action-Domain-Responder, предложенная Paul M. Jones, альтернативой шаблону MVC, которая фокусируется на более «чистых» запросах и ответах (request-response) для веб-приложений.

Модель Action-Domain-Responder (ADR), которая является объектно ориентированной надстройкой над MVC. Оперирует понятиями близкими к доменной области приложения.

Хороший способ создания обработчиков запросов — использование вызываемых классов. Вызываемые классы — это классы, которые используют магический метод __invoke() в PHP, превращая их в исполняемые, что позволяет из класса сделать функцию. Вот простой пример вызываемого класса:

<?php

class Greeting
{
    public function __invoke($name)
    {
        echo 'Hello ' . $name;
    }
}

$welcome = new Greeting();

// Hello John Doe
$welcome('John Doe');

На данный момент вы, скорее всего, спрашиваете себя: «Зачем мне это нужно?». Это имеет смысл при ожидании маршрутизатором callback-функций или конкретных зависимостей. Проще говоря, не нужно парсить строку и разбивать её на контроллер и метод. Вы можете сразу указать свою зависимость из http-слоя. Посмотрите наглядный пример, как обработчики запросов уже сейчас можно регистрировать в Laravel или Slim:

<?php

Route::get('/{name}', Greeting::class);

А теперь сравните это с тем, что обычно происходит в ваших проектах:

<?php

Route::get('/{name}', 'SomeController@greeting');

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

Принцип единственной ответственности

На мой взгляд, контроллеры со многими видами действий нарушают принцип единственной ответственности (SRP) из SOLID. Обработчики запросов, наоборот, решают эту проблему через разделение методов контроллеров на свои собственные независимые классы, что упрощает их обслуживание, рефакторинг и тестирование.

Ниже приведен пример двух обработчиков запросов, которые вынесены из двух методов, вшитых в UserController (редактирование и обновление данных пользователя):

<?php

class EditUserHandler
{
    public function __construct(
        UserRepository $repository,
        Twig $twig
    ) {
        /* ... */
    }

    public function __invoke(Request $request, Response $response)
    {
        /* ... */
    }
}

class UpdateUserHandler
{
    public function __construct(
        UserRepository $repository,
        UpdateUserValidator $validator,
        ImageManager $resizer,
        Filesystem $storage
    ) {
        /* ... */
    }

    public function __invoke(Request $request, Response $response)
    {
        /* ... */
    }
}

Это подводит нас к следующему преимуществу.

Тестируемость

Как давно вы писали модульные тесты для своих контроллеров? Вероятно, вы закончили созданием смешанных зависимостей, которые даже не были связаны с вашим тестом. Поскольку обработчики запросов разделяют различные действия контроллера на отдельные классы, вам нужно только вводить или связывать mock-объекты для конкретного действия.

Недавно Jeffrey Way в своём Твиттере дал совет по тестированию: сделайте свои классы тестов как можно более конкретными, а затем используйте каждый тест для описания важного правила/способности (rule/ability).

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

Рефакторинг

В современных IDE есть мощные варианты рефакторинга. Но если вы привязываете методы контроллеров к маршрутам в конфигурационных файлах (например, Laravel или Slim), то вы сталкнётесь с проблемой замены старых вызовов (строчных) на название объектов. Ничего не поделать. Вот так должно выглядеть:

<?php

Route::get('/{name}', Greeting::class);

И это намного проще, чем такой вариант:

<?php

Route::get('/{name}', 'SomeController@greeting');

Вывод

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

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

Ссылки по теме
1) Porto (Software Architectural Pattern)
   https://github.com/Mahmoudz/Porto

2) Action-Domain-Responder
   https://github.com/pmjones/adr

3) Request-Driven Development
   http://martinbean.co.uk/blog/2017/01/05/request-driven-development/

4) Classes vs. Namespaces
   http://antonkril.github.io/classes-vs-namespaces
2017   ADR   mvc   php   SOLID   SRP   паттерны   перевод

Специальная заметка для тех, кто задаёт вопросы

Ко мне часто обращаются за помощью в программировании: найти ошибку, подсказать решение, написать скрипт и тому подобное. В основном это друзья, читатели блога или люди пришедшие с поиска на мои статьи. Они задают вопросы двух типов: 1) ответ, который помещается в комментарий; 2) ответ, который не помещается в комментарий. На первый тип вопросов я отвечаю сразу, будь то это почта или комментарий в блоге.

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

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

а отдохните 45 минут от компьютера;
б сформулируйте простой поисковой запрос;
в поищите примеры в документации;
г посмотрите в StackOverflow на английском;
д забудьте про копипаст и начинайте думать.

Способы хранения временных данных в PHP

PHP позволяет хранить временные данные в ОЗУ или файлах. Это реализовано с помощью потоков чтения-записи php://memory и php://temp, которые можно открыть через fopen() и управлять данными в файлоподобной обёртке до завершения скрипта. После окончания работы PHP уничтожит все временные данные, если их намеренно не сохранить. Куда записать временные данные:

Способ                 Описание
————————————————————————————————————————————————————————————————————————————————————
php://memory           Записывает и всегда хранит данные в ОЗУ. С помощью fopen()
                       можно работать как с обычным файлом. Сохранить данные можно
                       копированием в другой поток stream_copy_to_stream() или
                       передачей контента stream_get_contents() в другой обработчик.

php://temp             Создаёт файл во временной папке, когда размер данных
                       превышает 2 Мбайт. До этого все записанные данные
                       хранятся в ОЗУ. Временная папка определяется аналогично
                       функции sys_get_temp_dir().

php://temp/maxmemory:0 Обнуляет максимальный размер данных в байтах для хранения
                       в памяти и с первым байтом создаёт файл во временной папке.
                       Можно установить свой лимит стартового хранения данных в
                       ОЗУ путем добавления /maxmemory:NN, где NN — это
                       максимальный размер данных в байтах для хранения в памяти
                       перед использованием временного файла.

tmpfile()              Создаёт временный файл с уникальным именем в режиме
                       чтения и записи r+, а затем возвращает файловый указатель.
                       Ничем не отличается от php://temp/maxmemory:0, кроме
                       способа вызова. URI временного файла можно получить
                       с помощью функции stream_get_meta_data() и сохранить данные
                       через копирование файла copy() по URI.

Все временные файлы автоматически удаляются, а ОЗУ очищается после завершения скрипта. php://memory и php://temp нельзя будет переиспользовать, т. к. после закрытия потоков невозможно сослаться на них. Как правило, сохранность временных данных, по необходимости, достигается путём копирования. Ниже привожу два примера, которые демонстрируют работу со временными данными:

<?php

///////
// 1 //
///////

// Откроем поток php://memory
$temp_data = fopen('php://memory', 'w+');

// Запишем "Hello, world!"
fwrite($temp_data, 'Hello, world!');

// Извлечём метаданные из потока
stream_get_meta_data($temp_data);

// Array
// (
//     [timed_out]    => false
//     [blocked]      => true
//     [eof]          => false
//     [wrapper_type] => PHP
//     [stream_type]  => MEMORY
//     [mode]         => w+b
//     [unread_bytes] => 0
//     [seekable]     => true
//     [uri]          => php://memory
// )

// Сбросим курсор
rewind($temp_data);

// Получим "Hello, world!"
stream_get_contents($temp_data);

// Создадим новый файл data.txt
$fh = fopen('data.txt', 'w+');

// Сбросим курсор ещё раз
rewind($temp_data);

// Сохраним временные данные в новый файл
stream_copy_to_stream($temp_data, $fh);

// Закроем ресурс файла data.txt
fclose($fh);

// Закрывать поток php://memory необязательно, т. к. все данные
// будут автоматически уничтожены по завершению скрипта.
// fclose($temp_data);


///////
// 2 //
///////

// Создадим временный файл
$tmpfile = tmpfile();

// Запишем "Hello, world!"
fwrite($tmpfile, 'Hello, world!');

// Извлечём метаданные из потока
stream_get_meta_data($tmpfile);

// Array
// (
//     [timed_out]    => false
//     [blocked]      => true
//     [eof]          => false
//     [wrapper_type] => plainfile
//     [stream_type]  => STDIO
//     [mode]         => r+b
//     [unread_bytes] => 0
//     [seekable]     => true
//     [uri]          => home\user\temp\phpDC08.tmp
// )

// Получаем URI временного файла
$uri = stream_get_meta_data($tmpfile)['uri'];

// Сохраним "Hello, world!" в файл data.txt
copy($uri, 'data.txt');

// Временный файл будет автоматически удалён по завершению
// скрипта. Закрывать открытый дескриптор необязательно.
// fclose($tmpfile);
2017   php   tmpfile   данные   файл

Уменьшаем итерабельную сложность массива в PHP

Задача. Объедините массив, приведённый ниже, таким образом, чтобы по значениям результирующего массива работал поиск array_search() и in_array(). Массив должен быть проходимым за один цикл. Ключи сохранять не обязательно.
$data = [
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
];

На первый взгляд кажется, что можно скормить массив в array_merge() и получить желаемый результат, но array_merge() принимает как минимум два аргумента с массивами, а у нас один. Заметьте, вложенные массивы с данными обёрнуты в ещё один массив. Это усложняет доступ к этим данным. Можно, конечно, обойти весь массив двумя foreach() и извлечь все данные, но такой подход довольно-таки топорный:

<?php

$data = [
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
];

$flattened = [];

foreach ($data as $array) {
    foreach ($array as $key => $value) {
        $flattened[] = $value;
    }
}

var_dump($flattened);

// вернёт [1, 2, 3, 4, 5, 6, 7, 8, 9]

Существует более изящный способ объединить все массивы в один — скормить массив с данными в array_merge(), но через call_user_func_array(). Данная функция вызывает другую функцию с массивом параметров, где первым аргументом идёт название функции, а вторым — параметры в виде индексированного массива. Получается, что массив-обёртку съест call_user_func_array(), а остальные пойдут как аргументы в array_merge() и в итоге мы получим склеенный массив:

<?php

$data = [ // <- съест call_user_func_array()
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
]; // <- съест call_user_func_array()

call_user_func_array('array_merge', $data);

// вернёт [1, 2, 3, 4, 5, 6, 7, 8, 9]

Начиная с версии 5.6 мы можем распаковать массив-обёртку, если перед передаваемым аргументом с массивом данных при вызове функции array_merge() подставим многоточие. Читайте подробнее про списки аргументов переменной длины. В нашем случае массив будет распакован и вложенные в него массивы объединятся:

<?php

$data = [
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
];

array_merge(...$data);

// вернёт [1, 2, 3, 4, 5, 6, 7, 8, 9]

Эти методы выполняют поставленную задачу, но только с двухуровневыми массивами, как на примерах выше. А что, если нужно склеить все значения многоуровневого массива в один? Разумеется необходимо рекурсивно пройти по каждому значению. Делается это с сохранением ключей и без, а также с учётом уровня вложенности. Ниже привожу все известные мне самописные функции:

<?php

///////
// 1 //
///////
if ( ! function_exists('array_flatten') ) {

    /**
     * Выравнивает массив без сохранения ключей
     *
     * @link https://gist.github.com/intedinmamma/246665
     *
     * @param array $data
     * @param array $flattened
     *
     * @return array
     */
    function array_flatten(array $data, array $flattened = [])
    {
        foreach($data as $value) {
            is_array($value)                               ?
            $flattened = array_flatten($value, $flattened) :
            $flattened[] = $value;
        }

        return $flattened;
    }
}

///////
// 2 //
///////
if ( ! function_exists('array_flatten') ) {

    /**
     * Выравнивает массив с сохранением ключей
     *
     * @link http://brandonwamboldt.github.io/utilphp/#array_flatten
     *
     * @param array $data
     * @param bool  $preserve_keys
     * @param array $flattened
     *
     * @return array
     */
    function array_flatten(
        array $data,
        bool $preserve_keys = true,
        array $flattened = []
    ) {
        array_walk_recursive($data, function ($value, $key) use (&$flattened, $preserve_keys) {
            $preserve_keys && !is_int($key) ?
            $flattened[$key] = $value       :
            $flattened[] = $value;
        });

        return $flattened;
    }
}

///////
// 3 //
///////
if ( ! function_exists('array_flatten') ) {

    /**
     * Выравнивает массив с помощью итератора с сохранением ключей или без
     *
     * @link http://stackoverflow.com/a/12205381
     *
     * @param array $data
     * @param bool  $use_keys
     *
     * @return array
     */
    function array_flatten(array $data, bool $use_keys = false)
    {
        $flattened = new \RecursiveIteratorIterator(
            new \RecursiveArrayIterator($data)
        );

        return iterator_to_array($flattened, $use_keys);
    }
}

///////
// 4 //
///////
if ( ! function_exists('array_flatten') ) {

    /**
     * Выравнивает массив по уровню вложенности
     *
     * @link https://github.com/spatie/array-functions#array_flatten
     *
     * @param array $array
     * @param int   $levels
     *
     * @return array
     */
    function array_flatten(array $array, int $levels = -1)
    {
        if ($levels === 0) {
            return $array;
        }

        $flattened = [];

        if ($levels !== -1) {
            --$levels;
        }

        foreach ($array as $value) {
            $flattened = array_merge(
                $flattened,
                is_array($value) ? array_flatten($value, $levels) : [$value]
            );
        }

        return $flattened;
    }
}


Пример для любой из функций array_flatten():

<?php

$data = [
    [1, 2, 3],
    [4, [5, 6, 7], 8],
    [9, [10, 11], 12],
];

array_flatten($data);

// вернёт [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
2017   php   массив

Как сократить вероятность до 50% при четырёх вариантах ответа

Предположим, перед вами тест из четырёх вариантов ответа, из которого только один верный. Вам необходимо извлечь из этих вариантов правильный. Как это сделать, когда вы не знаете ответа на поставленный вопрос в тесте? Можно, конечно же, сразу выбрать один на удачу, но тогда вероятность успеха будет один к четырём или 25%, а это очень низкие шансы:

    1) Ответ А 25%
    2) Ответ Б
    3) Ответ В
    4) Ответ Г

Ещё можно вычеркнуть сразу два варианта ответа и выбрать что-то одно из оставшихся, но, в таком случае, вероятность не сократится до 50%, как хотелось бы, а останутся прежние 25%. На самом деле, этот сценарий забирает у вас ещё 50% дать правильный ответ и остаётся 12,5%, т. к. тот один из двух вариантов миновал смысловую оценку, но это невозможно отобразить математически, значит будет всё-таки 25%, а не 12,5%.

Когда вы по порядку загружаете варианты ответа и пытаетесь сопоставить с заданным вопросом, то ваш предыдущий опыт ранжирует их по степени наибольшего соответствия. Это явление происходит в фоне и вы, скорее всего, даже не догадываетесь об этом. По ощущениям какой-то ответ нравится больше, а какой-то меньше. Я бы не стал сразу выбирать тот, который манит сильнее всего. Перед выбором ещё нужно провести небольшой фокус.

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

    1) Ответ А 25%
    2) Ответ Б 25%
    3) Ответ В
    4) Ответ Г

Я стараюсь не спеша пропускать через себя все варианты и отсеиваю по ощущениям только два самых сомнительных, а это всяко лучше вычёркивания двух наугад. Остаётся два претендента на выбор. Математически ничего не изменилось, т. к. мы не можем доказать, что «отсееные» варианты неправильны, но мы интуитивно понижаем их достоверность и дальше не рассматриваем. Таким образом, остаётся два варианта, один из которых правильный:

    1) Ответ А
    2) Ответ Б
    3) Ответ В
    4) Ответ Г

Как его найти? Всё очень просто, начинайте искать ответ в самом вопросе. Я не советую слушать логику, а искать какие-то зацепки варианта ответа за вопрос: ключевые слова, похожие смысловые ряды, странные названия или то, чего никогда не слышал. Кому-то легче искать неправильный вариант и вписывать правильный. Уж какая стратегия вам больше по душе, разберитесь сами. Но никогда не ставьте ответ на халяву, старайтесь собрать как можно больше подтверждений и только потом выдать ответ.

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

Ctrl + ↓ Ранее