[dev] Кеширование данных

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

• файловое кеширование (кеш сохраняется на диске)
• кеширование с использованием Memcached
• кеширование в XCache
• и специальный тип кеша (обозначается 'tmp') — данные сохраняются в памяти на время отработки скрипта

Для работы с каждым механизмом есть свой класс PHP. И если Вы захотите написать свой обработчик кеша и использовать какой-то другой механизм (например, Redis), то сделать это можно без особого труда. Досточно создать класс, который будет реализовывать интерфейс ICacheBackend, обеспечивающий доступ к нужной библиотеке.

Настройки кеширования задаются в конфигурационном файле приложения. И те механизмы кеширования, которые разрешено использовать на данном сайте, задаются в конфиг-параметре 'sys.cache.backends'). Если Вы написали свой обработчик, то также должны его добавить в массив 'sys.cache.backends'.

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

Режимы кеширования

Предусмотрены следующие режимы кеширования:

Автокеширование — режим, установленный по умолчанию, когда кеширование вообще включено (конфиг-параметр 'sys.cache.use' равен true). Он подразумевает, что задан определенный тип (механизм) кеширования в конфиг-параметре 'sys.cache.type'. В этом случае вызовы Cache->Set(...) и Cache->Get(...) по умолчанию будут сохранять/доставать из кеша данные с помощью механизма, который задан в 'sys.cache.type'. Фактически, это значит, что подавляющее большинство запросов будет в модулях будет использовать это кеширование.

Кеширование по запросу — это когда кеширование по умолчанию отключено, но при вызове Cache->Set(...) и Cache->Get(...) из модулей передается дополнительный логический параметр, который указывает, что при конкретном вызове кеш нужно включить. Данную опцию можно использовать, например, при выполнении заведомо тяжелых запросов. Или когда для получения набора данных нужно выполнить большое число запросов, а потом еще и обработать полученные данные. В общем, в тех случаях, когда разработчик заведомо понимает, что получение набора данных в этом месте — это очень затратная операция, и кеширование тут крайне необходимо.

Чтобы этот режим был возможен, параметр 'sys.cache.use' должен быть выключен, а тип кеширования в 'sys.cache.type' задан. Если 'sys.cache.type' не задан или заданного в нем механизма кеширования нет в списке 'sys.cache.backends', то кеширование по запросу работать не будет.

Принудительное кеширование — при вызове Cache->Set(...) и Cache->Get(...) может явно задаваться тип кеша (механизм кеширования), который обязательно надо использовать при вызове. Допустимые типы принудительного кеша задаются в конфиг-параметре 'sys.cache.force'. Если они не заданы или указывается тип кеша, которого нет в списке 'sys.cache.backends', то эта опция работать не будет. Обычно этот режим используется с механизмом 'tmp'.

Конкурентные запросы к кешу

При большом трафике возможна ситуация, когда одновременно идет много запросов к одному кешу, который уже «протух». В обычном случае все эти однотипные запросы будут перенаправлены к базе, что значительно увеличивает нагузку на нее. Чтоб этого избежать, сохраняемые в кеше данные дополнительно маркируются временной меткой и заносятся в кеш на несколько бОльший период, чем требуется. И при нескольких одновременных запросах к «протухшему» кешу самый первый запрос вернет значение false и отправится в базу, а остальные запросы в течение определенного времени будут получать старые данные, пока первый запрос не обновит их. Эта опция задается конфиг-параметром 'sys.cache.concurrent_delay'.

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

Вот типичный пример использования кеша

if (false === ($data = $this->Cache_Get($sCacheKey))) {
    $data = $this->oMapper->getContentTypeById($nId);
    $this->Cache_Set($data, $sCacheKey, array('content_update', 'content_new'), 60 * 60 * 24 * 1);
}
return $data;

Сначала идет запрос кеша по ключу $sCacheKey (вызов $this->Cache_Get()). Если данных с таким ключом нет (возвращается false), то данные получаются из базы и заносятся в кеш. Обратите внимание, что время хранения кеша можно задавать в двух форматах:
* число секунд (60 * 60 * 24 * 1 — это сутки)
* строкое значение периода в стандарте ISO. Вот так:

$this->Cache_Set($data, $sCacheKey, array(...), 'P1D'); // срок - сутки (1 день)

Чтобы в данном конкретном месте было выполнено кеширование по запросу, вызов должен быть таким:

$this->Cache_Set($data, $sCacheKey, array(...), 'PT12H', true); // срок - 12 часов

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

$this->Cache_Set($data, $sCacheKey, array(...), 'P1D', 'tmp');

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