movephp/callback-container

Analysis and serialization of callbacks and closures

, _(*1)

Callback-контейнер

Библиотека представляет собой небольшой класс-обёртку над встроенным в PHP типом callable., _(*2)

Главная особенность этого контейнера - он реализует интерфейс Serializable. Поскольку не всякий callable может быть сериализован, контейнер предоставляет метод isSerializable() для удобной проверки возможности сериализации., _(*3)

Оглавление

• Пример использования
• Допустимые callback аргументы
• Использование с PSR-контейнером
  • Привязка PSR-контейнера после десериализации
• Анализ параметров калбека
• Несериализуемые калбеки
• Практическое применение, пример

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

Рабочий объект контейнера создаётся через фабричный метод make():, _(*4)

use \Movephp\CallbackContainer\Container;
$factory = new Container();
$callback = $factory->make('my_callback');

После чего его можно сериализовать:, _(*5)

if($callback->isSerializable()){
    var_dump(serialize($callback));
}

Или получить соответствующее замыкание:, _(*6)

call_user_func($callback->closure());

Попытка сериализовать контейнер с несериализуемым калбеком вызовет исключение \Movephp\CallbackContainer\Exception\NonSerializableException, _(*7)

Важно: При сериализации CallbackContainer'а с калбеком на основе объекта [$object, 'method'] сохраняется только имя класса объекта. С одной стороны, таким образом снижаются затраты на процесс сериализации/десериализации и исключается возможные проблемы, связанные с тем, что сам переданный $object может быть несериализуемым. С другой стороны, важно позаботиться о том, чтобы после десериализации этот $object мог быть автоматически восстановлен по имени его класса (это возможно, если у него конструктор без аргументов или с использованием PSR-контейнера, см. далее)., _(*8)

Допустимые callback аргументы

В таблице перечислены типы значений, которые может принимать метод make() в качестве аргумента:, _(*9)

Использование с PSR-контейнером

Если в проекте используется DI-контейнер, реализующий интерфейс PSR-11, в качестве аргумента в метод make() можно передать массив, похожий на обычный callable, в котором первым элемементом будет ключ, по которому можно запросить нужный объект в PSR-контейнере., _(*10)

В первую очередь необходимо привязать PSR-контейнер к данной библиотеке:, _(*11)

use \Movephp\CallbackContainer\Container;
$factory = new Container($psrContiner);
$callback = $factory->make(['psr_container_key', 'method']);

Ключом для PSR-контейнера может быть, например, имя интерфейса, или любая строка, для которой $psrContiner->has($key) вернёт TRUE., _(*12)

Привязка PSR-контейнера после десериализации

При сериализации CallbackContainer'а сохраняется только упрощённое представление исходного калбека. Соответственно, если изначально был использован PSR-контейнер, то после десериализации его нужно будет повторно привязать к CallbackContainer'у., _(*13)

Это можно сделать отдельно для каждого десеризованного CallbackContainer'а:, _(*14)

$callback = unserialize($serialized);
$callback->setPsrContainer($psrContiner);

Или можно задать PSR-контейнер глобально для всех будущих CallbackContainer'ов, которые будут созданы напрямую (new Container()) или при десериализации, вызвав предвариетльно статический метод setPsrContainerGlobal():, _(*15)

use \Movephp\CallbackContainer\Container;
Container::setPsrContainerGlobal($psrContiner);
$callback = unserialize($serialized);

Анализ параметров калбека

Кроме прочего CallbackContainer имеет метод parameters(), который возвращает массив объектов класса Movephp\CallbackContainer\Parameter, представляющих параметры, принимаемые заданным калбеком. Ключами этого массива являются имена параметров., _(*16)

Метод parameters() анализирует параметры через Reflection API при первом обращении и запоминает результат при сериализации, таким образом увеличивая общую производительность, например, при извлечении массива CallbackContainer'ов из кеша., _(*17)

Класс Movephp\CallbackContainer\Parameter имеет несколько геттеров для получения подробной информации о параметре:, _(*18)

Несериализуемые калбеки

Если вы хотите использовать возможность сериализации CallbackContainer'а, например, для кеширования с целью повысить производительность приложения, следует не только проверять возможность сериализации каждого элемента через isSerializable(), но также в целом иметь ввиду, какие виды калбеков не могут быть сериализованы. Это:, _(*19)

• Замыкания, т.е. объекты встроенного класса \Closure, которые, как правило, создаются путём объявления анонимных функций.
• Любые callable, связанные с анонимными классами, поскольку такие классы не имеют постоянного имени и их будет невозможно восстановить после десериализации.

Практическое применение, пример

Допустим, существует некий механизм роутинга для приложения, который связывает шаблоны маршрутов с методами классов, и который достаточно сложно устроен, так что имеет смысл постараться закешировать его. Вот условный пример, как это может быть реализовано:, _(*20)

use Movephp\CallbackContainer\Container;

Container::setPsrContainerGlobal($psrContainer);

if ($cache->isHit()) {
    $routes = $cache->get();
} else {
    $callbackFactory = new Container();

    $rules = getRoutingRulesOverWholeProject(); // Собираем по всему проекту шаблоны роутов и связанные с ними калбеки
    $routes = [];
    foreach ($rules as $rule) {
        try {
            $callback = $callbackFactory->make($rule->callback);
        } catch (\Exception $e) {
            $logger->error($e);
            continue;
        }
        $routes[] = [
            'template' => $rule->template,
            'callback' => $callback
        ];
    }

    // Проверяем, что все калбеки сериализуемые
    $serializable = array_reduce(
        $routes,
        function ($result, $route) {
            return $result && $route['callback']->isSerializable();
        },
        true
    );
    if ($serializable) {
        // Кешируем результат
        $cache->set($routes);
        $cachePool->save($cache);
    }
}