Практические решения | Разработка

Кэш в Joomla – разбираемся в деталях

Joomla
Добавление в избранное
Сохранить
Кэш в Joomla – разбираемся в деталях

Зачем использовать кэш?

Все просто. Получение ранее сохраненной информации намного быстрее (в 10 или более раз), чем её первоначальная генерация. Если вам нужен радикальный пример – книга является долгосрочным кэшем знаний её авторов. Аккумулирование этих знаний может занять годы, в то время как чтение этого кэша намного быстрее.

Но давайте вернемся к Joomla, и если быть более точным, здесь мы имеем дело с кэшированием веб-приложения – созданием временных статических копий динамических страниц (или более мелких единиц информации). Кэширование свойственно для веб-приложений, так как типичный веб-сайт отображает один и тот же контент снова и снова, и без кэша приходилось бы все генерировать заново для каждого показа страницы. Система кэширования временно сохраняет сгенерированную кодом информацию в объекте кэша, и отдает её обратно, когда она запрашивается следующим пользователем.

Типы кэша в Joomla

Кэш страницы (Page cache)

Делает снимки целой страницы, включая всё: компоненты, модули, плагины и шаблон. Это самый быстрый, но при этом наименее гибкий подход кэширования. Для его активации необходимо включить плагин «Система – Кэш».

Кэш страницы

Прогрессивный кэш (Progressive cache)

Это тип кэша появился в Joomla 1.6. Он делает снимки каждого уникального набора модулей (обычно каждой страницы). Влияет на все модули и работает как слой над кэшем модулей, переопределяя их настройки. Показывает контент индивидуально для каждого посетителя. Включается при установке уровня кэша в значение «Прогрессивный» в общих настройках сайта.

Прогрессивный кэш

Стандартный кэш (Conservative cache)

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

Кэш модуля и представления компонента

Они формируют своеобразную группу, так как оба создают статическую копию полных выходных данных компонента или модуля. Это наиболее распространённый тип кэша, который иногда приравнивают к кэшированию в Joomla в общем.

Его позитивной стороной является то, что он хорошо проявляет себя в плане скорости. А негативная сторона заключается в том, что он отключает любое взаимодействие пользователь<->расширение<->фреймворк, пока не истечет закэшированная копия. Это означает, что он не подходит для компонентов или модулей, которые реагируют на действия пользователя или отображают часто изменяемый контент.

Так как закэшированная копия модуля или компонента содержит только собственные выходные данные, любой внешний файл, который будет вызван с помощью таких методов как $document->addStyleSheet() не будет подключен. Были придуманы различные обходные решения, но все они требуют дополнительных вычислительных ресурсов, что уменьшает эффект использования кэширования.

Кэширование представления компонента

Кэширование представления компонента осуществляется с помощью метода display($cachable, $safeurlparams) контроллера. Для этого параметр $cachebale необходимо установить в значение true, а через параметр $urlparams передать массива URL-параметров и их типов фильтра:

$cachable = true;
 
$safeurlparams = array(
    'catid' => 'INT',
    'id' => 'INT',
    'cid' => 'ARRAY',
    'limit' => 'UINT',
    'limitstart' => 'UINT',
    'filter_order' => 'CMD',
    'filter_order_Dir' => 'CMD',
    'filter-search' => 'STRING',
    'lang' => 'CMD',
    'Itemid' => 'INT'
);
 
parent::display($cachable, $safeurlparams);

При этом массив URL-параметров формирует уникальный cache id.

Кэш представления компонента

Режимы кэширования модуля

Существует 5 различных режимов кэширования модуля. Три из них активируются через поле cachemode в XML-файле манифеста модуля:

<field name="cachemode"
    type="hidden"
    default="itemid">
    <option value="itemid"></option>
</field>

  • static - будет использоваться один кэш-файл для всех страниц с одинаковыми параметрами модуля. Рекомендуется для модулей, которые не меняются.
  • itemid – изменяется при смене Itemid. Такой режим больше всего подходит для динамических модулей, которые изменяются от страницы к странице, например: меню, изображения контента и т.п.
  • oldstatic - обратно совместимый с Joomla 1.5 режим.

Еще два режима кэширования должны вызываться непосредственно из модуля:

  • safeuri - Id кэша создается из массива URL-параметров, так же как в компоненте. Используйте этот режим, если модуль зависит от параметров URL, а не Itemid (например модуль, который отображает изображение в зависимости от категории). Свойство $cacheparams->modeparams является массивом URL-параметров и их типов фильтра.
  • Id - модуль устанавливает свой собственный кэш в зависимости от собственной формулы, которая передается через $cacheparams->modeparams

Для использования этих двух режимов, вместо поля cachemode используйте поле owncache в XML-файле манифеста:

<field
    name="owncache"
    type="list"
    default="1"
    label="COM_MODULES_FIELD_CACHING_LABEL"
    description="COM_MODULES_FIELD_CACHING_DESC">
    <option value="1">JGLOBAL_USE_GLOBAL</option>
    <option value="0">COM_MODULES_FIELD_VALUE_NOCACHING</option>
</field>

И далее вызовите метод JModuleHelper::moduleCache($module, $moduleparams, $cacheparams) из точки входа модуля.

Свойства объекта, которые передаются в метод moduleCache(), не требуют особых разъяснений. В качестве примера можно взять модуль связанных материалов (mod_related_items), который использует режим safeuri и заменяет некешированную функцию modRelatedItemsHelper::getList($params):

$cacheparams = new stdClass;
$cacheparams->cachemode = 'safeuri';
$cacheparams->class = 'ModRelatedItemsHelper';
$cacheparams->method = 'getList';
$cacheparams->methodparams = $params;
$cacheparams->modeparams = array('id' => 'int', 'Itemid' => 'int');
 
$list = JModuleHelper::moduleCache($module, $params, $cacheparams);

Кэш модуля

Кэш обратного вызова (Callback cache)

Этот тип кэша позволяет дифференцировать различные части расширения и кэшировать только те, которые нужно кэшировать, при этом оставляя динамические части некэшируемыми. Кэширует результаты вызова функции в коде.

Кэш выходных данных (Output cache)

Кэширует выходные данные некоторой части скрипта. В основном это output buffering с кэшированием, и используется довольно редко.

Raw-кэш (Raw cache)

Кэширует любые элементы данных. Полностью контролируется разработчиком – что сохранять, когда сохранять и как классифицировать сохраненные элементы (cache id). Это тип кэша часто используется ядром Joomla для различных операций: список компонентов, список модулей, дерево меню, доступные языки, группы пользователей и т.п.

Обходные решения (Workarounds)

Обходные решения помогают обойти известные ограничения кэширования, такие как невозможность подключения файлов стилей или javascript из модуля или компонента. При использовании кэша представления компонента и кэша обратного вызова, можно включать или выключать определенные обходные решения. Использовать их нужно только тогда, когда закэшированная функция манипулирует хидером (header) или путем (pathway).

setWorkarounds

Метод JCache::setWorkarounds($data,$options=array()) подготавливает данные, которые будут сохранены в кэше вместе с обходными решениями, и принимает следующие опции:

  • nopathway – не сохранять pathway данные
  • nohead - не сохранять header данные
  • nomodules - не сохранять данные модуля
  • modulemode – если nohead равно 0, не сохранять следующие данные модуля: title, description, link, metaTags

getWorkarounds

Метод JCache::getWorkarounds($data,$options=array()) применяет обходные решения над данными, сохраненными с обходными решениями. Он воссоздаёт header, pathway и модули и возвращает основные сохраненные данные. Работает автоматически – конкретное обходное решение выполняется, только если его данные были сохранены отдельно.

Разница в использовании кэша обратного вызова и raw-кэша

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

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

Мы вызываем кэширование при помощи JFactory::getCache(), и если мы используем кэш обратного вызова, наш код должен выглядеть следующим образом:

$cache = JFactory::getCache('somegroup');
 
$result = $cache->get(array('someclass', 'somemethod'), $methodparams, $id, $workarounds, $workaroundoptions);

Последние три параметра в методе get() являются необязательными.

Обратите внимание на то, что этот не тот же метод get(), который мы используем в raw-cache. Кэш обратного вызова автоматически получает данные, если они существуют. Если их нет, то он выполняет обратный вызов, возвращает данные из обратного вызова и сохраняет их до следующего вызова. У кэша обратного вызова не существует метода store()!

При использовании raw-кэша у разработчика есть прямой доступ к методам get() и store(), и за логику ответственен непосредственно разработчик. Этот кэш удобен, когда необходимо сохранить информацию, но не вызов функции (например: xml-данные, картинки, описание товаров и т.п.), или когда необходимо передать большой объем данных из одной страницы на другую.

Ниже приведен код использования raw-кэша:

$cache = JFactory::getCache('somegroup', '');
 
if (!$somevariable = $cache->get('cacheId'))
{
    // выполняем действия и сохраняем результат в $somevariable
 
    // сохраняем $somevariable в кэше
    $cache->store($somevariable, 'cacheId');
}

Чтобы использовать raw-кэш, в качестве второго параметра метода getCache() мы должны передать пустую строку.

Что случится, если несколько кэшей будут работать одновременно?

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

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

Обработчики кэша

Обработчики кэша - это чернорабочие. Именно они выполняют всю черновую работу и сохраняют информацию на выбранном медиа. Для использования кэша должен быть доступен хотя бы один обработчик кэша.

По умолчанию Joomla использует File в качестве обработчика кэша, который использует файлы для сохранения информации. Такой обработчик работает надежно, но он медленнее по сравнению с обработчиками, которые основываются на работе с оперативной памятью. Если файловый обработчик недоступен, то необходимо исправить права доступа к папке cache, чтобы веб-сервер мог записывать в неё информацию.

Файлы также использует обработчик Cache_Lite. Кроме того, в Joomla можно использовать: APC, eAccelerator, Memcached, XCache, WinCache и Redis. Все они используют оперативную память.

Полезные ссылки

Dmitry Rekun
Работаю в банковской сфере, а с веб-разработкой (непосредственно с Joomla) столкнулся в 2007 году. Теперь это моё хобби, а в редких случаях и вторая работа. Какое-то время вёл свой блог, но решил попробовать работать в команде. И вот c 2012 года я здесь :)

Подпишитесь на рассылку новостей CMScafe