Кэширование middleware в Expressive

Ключевым аспектом любого веб приложения является скорость его работы. Архитектурный подход middleware (посредников) позволяет с лёгкостью внедрить систему кэширования.

Суть в том чтобы хранить ответ от URL в отдельном файле (или памяти, используя memcached). Таким образом мы сможем проскочить выполнение целого ряда посредников, выполнив только нужные (к примеру для получения актуальных данных).

Конечно же данный подход приемлем для статического контента. Кэшировать все HTTP запросы нет смысла.

Создание посредника кэширования

Представьте что нам нужно создать простую систему кэширования в приложении Expressive. Можем реализовать это следующим образом:

namespace App\Action;

use Interop\Http\ServerMiddleware\DelegateInterface;
use Interop\Http\ServerMiddleware\MiddlewareInterface as ServerMiddlewareInterface;
use Psr\Http\Message\ServerRequestInterface;
use Zend\Diactoros\Response\HtmlResponse;

class CacheMiddleware implements ServerMiddlewareInterface
{
    protected $config;

    public function __construct(array $config)
    {
        $this->config = $config;
    }

    public function process(ServerRequestInterface $request, DelegateInterface $delegate)
    {
        $url  = str_replace('/', '_', $request->getUri()->getPath());
        $file = $this->config['path'] . $url . '.html';
        if ($this->config['enabled'] && file_exists($file) &&
            (time() - filemtime($file)) < $this->config['lifetime']) {
            return new HtmlResponse(file_get_contents($file));
        }

        $response = $delegate->process($request);
        if ($response instanceof HtmlResponse && $this->config['enabled']) {
            file_put_contents($file, $response->getBody());
        }
        return $response;
    }
}

В этом примере мы придерживались стандарта PSR-15, который предлагает имплементировать интерфейс с методом process(). Это наилучший метод создания посредника в Expressive 2.0.

Идея данного посредника предельно проста. Если кэш система включена, и ключ кэша совпадает с URL запрашиваемой страницы, то вернём данные из кэша в виде HtmlResponse.

Если кэша для данного URL не существует, то отработает основной код посредника, и результат будет записан в кэш.

Конфигурация системы кэширования

В разрезе управления кэшем мы создали ключ cache чтобы указать путь path к файлам, время жизни lifetime в секундах, и ключ enabled для включения/отключения системы кэширования.

Поскольку мы будем хранить кэш в файлах, то нам нужно найти способ определения истёкшего время жизни кэша. Для того чтобы определить время последней модификации файла можем воспользоваться функцией filemtime.

Заметка: если вы выберите memcached в качестве хранилища кэша, то придётся заменить функции file_get_contents и file_put_contents на вызовы Memcached::get и Memcached::set. В этом случае время жизни кэша будет указываться непосредственно при его создания, а очистка будет производиться автоматически.

Для передачи конфигурационных настроек $config создадим фабричный класс. Пример:

namespace App\Action;

use Interop\Container\ContainerInterface;
use Exception;

class CacheFactory
{
    public function __invoke(ContainerInterface $container)
    {
        $config = $container->get('config');
        if (isset($config['cache']) && isset($config['cache']['enabled'])) {
            if ($config['cache']['enabled']) {
                if (!isset($config['cache']['path'])) {
                    throw new Exception('The cache path is not configured');
                }
                if (!isset($config['cache']['lifetime'])) {
                    throw new Exception('The cache lifetime is not configured');
                }
            }
        }
        return new CacheMiddleware($config['cache']);
    }
}

Если мы хотим придерживаться архитектуры Expressive приложения, то конфигурационные настройки можем поместить в каталог config/autoload. К примеру создадим файл config/autoload/cache.local.php со следующим содержимым:

return [
    'cache' => [
      'enabled'  => true,
      'path'     => __DIR__ . '/../../data/cache/',
      'lifetime' => 3600 // in seconds
    ]
];

Наш кэш будет храниться в каталоге /data/cache. Данный контент не должен учитываться вашей системой контроля версиями. Для этого создадим файл .gitignore в каталоге cache и запишем следующие строчки:

*
!.gitignore

И наконец, мы должны активировать нашего посредника CacheMiddleware в качестве сервиса. В нашем примере сервис контейнер реализован на основе компонента zend-servicemanager. Добавим несколько новых строк в файл /config/autoload/cache.global.php:

return [
    'dependencies' => [
        'factories' => [
            App\Action\CacheMiddleware::class => App\Action\CacheFactory::class
        ]
    ]
];

Включение кэша для определённых маршрутов

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

Для этого мы можем указать CacheMiddleware для запуска по запросу к определённым URL.

Подключим CacheMiddleware к маршруту /about:

use App\Action;

$app->get('/about', [
    Action\CacheMiddleware::class,
    Action\AboutAction::class
], 'about');

При обращении к URL /about будут последовательно вызваны CacheMiddleware и AboutAction. $app — объект Zend\Expressive\Application. Это основной класс для запуска приложения Expressive.

Итог

В этом коротком уроке мы рассказали о том как создать простую систему кэширования, придерживаясь стандартов PSR-7 и PSR-15. Архитектура посредников блестяще подходит для создания подобной системы потому что она работает аналогично HTTP запросам. Таким образом, мы можем управлять HTTP запросами, получать HTTP ответы для определённых посредников и помещать данные в кэш.

В данной статье использовался пример expressive приложения zendframework/zend-expressive-skeleton. Подробную информацию сможете найти в официальной документации.

Данный урок подготовлен для вас командой сайта ruseller.com
Источник урока: https://framework.zend.com/blog/2017-04-19-caching-middleware.html
Перевел: Станислав Протасевич
Урок создан: 19 Апреля 2017
Просмотров: 1048
Правила перепечатки


5 последних уроков рубрики "PHP"

  • Фильтрация данных с помощью zend-filter

    Когда речь идёт о безопасности веб-сайта, то фраза "фильтруйте всё, экранируйте всё" всегда будет актуальна. Сегодня поговорим о фильтрации данных.

  • Контекстное экранирование с помощью zend-escaper

    Обеспечение безопасности веб-сайта — это не только защита от SQL инъекций, но и протекция от межсайтового скриптинга (XSS), межсайтовой подделки запросов (CSRF) и от других видов атак. В частности, вам нужно очень осторожно подходить к формированию HTML, CSS и JavaScript кода.

  • Подключение Zend модулей к Expressive

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

  • Совет: отправка информации в Google Analytics через API

    Предположим, что вам необходимо отправить какую-то информацию в Google Analytics из серверного скрипта. Как это сделать. Ответ в этой заметке.

  • Подборка PHP песочниц

    Подборка из нескольких видов PHP песочниц. На некоторых вы в режиме online сможете потестить свой код, но есть так же решения, которые можно внедрить на свой сайт.

^ Наверх ^