MODX - Кэширование

В этой статье познакомимся с процессом кэширования и его реализацией в MODX Revolution.

Что такое кэширование

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

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

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

Как кэширование организовано в MODX Revo

По умолчанию кэш в CMS MODX Revolution находится в файлах и расположен в директории core/cache/.

Для обработки кэша в MODX используется провайдеры (по умолчанию: xPDOFileCache). Файлы кэша в данном каталоге находится не в корне, они распределены по разделам.

Раздел - это кэш с данными определённого вида (например, ресурсами). Раздел можно представить как директорию в каталоге core/cache/.

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

Например, одним разделам кэша можно назначить провайдер xPDOFileCache, а другим xPDOMemCache.

В MODX Revolution доступны следующие провайдеры: xPDOFileCache (по умолчанию), xPDOAPCCache (для Alternative PHP Cache), xPDOMemCache (для memcache), xPDOMemCached (для memcached), xPDOWinCache (для WinCache).

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

Кэш менеджеры (xPDOFileCache, xPDOAPCCache, xPDOMemCache, xPDOMemCached и xPDOWinCache) являются производными от класса xPDOCache и предоставляют единую API для записи, чтения и удаления кэш записей.

Основные разделы кэша и их краткое описание

MODX Revolution имеет следующие разделы (справочная информация):

action_map

Содержит массив всех идентификаторов контроллеров и пространств имён, доступных в менеджере.

auto_publish

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

context_settings

Этот раздел используется для хранения настроек контекстов. Каждый контекст в этом разделе имеет свой файл, в котором содержится карта ресурсов (идентификаторы родителей и детей), карта псевдонимов, плагины, используемые в контексте и политика доступа.

db

Раздел кэша db предназначен для хранения результирующих наборов, запрошенных из базы данных с помощью методов getObject, getCollection и т.п. Этот кэш используется при включении параметра cache_db в настройках системы или тогда, когда данный параметр активирован в настройках контекста.
Этот кэш обычно применяется тогда, когда доступ к базе является более затратным действием, чем использование процессорного времени.

includes

Данный раздел используется как временное хранилище для исходных кодов php файлов (сниппетов и плагинов). Используется ядром MODX во время их выполнения. Файлы в этом кэше имеют формат: 23.include.cache.php (23 - это id сниппета или плагина).

logs

Данный раздел используется в качестве хранилища log файлов системы.

menu

Этот раздел содержит кэш меню менеджера (админки).

mgr

Данный раздел использует Smarty в качестве своего хранилища для записи в него временных файлов.

resource

Содержит кэш ресурсов, организованный с учётом контекста и id (файлы в этом кэше имеют формат 7.cache.php (7 - это id ресурса)). Каждый файл содержится метаданные ресурса, его кэшированное представление с не кэшированными тегами (_content), политику доступа для ресурса и элементов, а также их исходные коды (используются в процессе обработки ресурса).

rss

Данный раздел использует MagpieRSS в качестве каталога для записи своих временных файлов.

scripts

Содержит исходные коды сниппетов и плагинов, которые впоследствии будут записаны в кэш директорию includes.

setup

Используется системой MODX при установке.

system_settings

Содержит настройки системы MODX. Этот раздел загружается первым. Для его обработки нельзя назначить альтернативный кэшер (т.е. всегда используется только xPDOFileCache).

Чтобы изменить провайдер кэша для определенного раздела кэша, просто создайте новый системный (или контекстный) параметр с именем cache_PARTITION_handler (например, cache_resource_handler - для раздела resource) и присвойте ему значение обработчика кэша, который вы хотите использовать для его обработки (например, xPDOMemCache).

Настройка кэширования в MODX Revo

В MODX Revolution управление кэшированием может осуществляться посредством:

• изменения значений системных настроек (область действия - весь сайт);
• кэшированного или не кэшированного (с восклицательным знаком) вызова чанков, сниппетов и плейсхолдеров (область действия - указанный элемент);
• установки или снятия флажка в поле ресурса "Кэшируемый" (область действия - указанный ресурс);
• методов modCacheManager (программное управление кэшированием).

Управление кэшированием посредством изменения системных настроек

Общие настройки кэширования, влияющие на весь сайт, устанавливаются в системных настройках. Для этого необходимо нажать в админке MODX (в главном меню) на значок шестерёнки -> выбрать пункт "Системные настройки" -> раздел "Core" -> подраздел "Кэширование".

Название ключей и их назначение:

cache_action_map (по умолчанию: да)

Включает кэширование карты контроллеров (для ускорения загрузки страниц панели управления).

cache_alias_map (по умолчанию: да)

Включает кэширование карты ресурсов (добавление URI ресурсов в кэш контекста). Эту опцию рекомендуется устанавливать в положение "Да" только для небольших сайтов. А для сайтов с огромных количеством ресурсов её отключать.

cache_context_settings (по умолчанию: да)

Включает кэширование настроек контекстов для более быстрой загрузки страниц.

cache_db (по умолчанию: нет)

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

cache_db_expires (по умолчанию: 0)

Время (в секундах) для хранения кэша db. Если установить значение, равное 0, то время жизни кэша будет не ограниченным.

cache_db_session (по умолчанию: нет)

При включении данной опции и cache_db, сессии, хранящиеся в базе данных, тоже будут кэшироваться.

cache_db_session_lifetime (по умолчанию: нет)

Время (в секундах), которое определяет период жизни кэша сессий.

cache_default (по умолчанию: да)

Устанавливает, необходимо ли при создании ресурса, делать его кэшируемым (устанавливать флажок cacheable в положение "Да").

cache_disabled (по умолчанию: нет)

Если установить данному параметру значение "Да", то он отключить весь механизм кэширования MODX Revolution (не рекомендуется).

cache_expires (по умолчанию: 0)

Это значение (в секундах) устанавливает время жизни кэша MODX. Значение 0 задаёт неограниченное время его жизни.

cache_format (по умолчанию: 0)

Формат хранения кэша. 0 - в формате массива PHP, 1 - в JSON, 2 - в сериализованном виде.

cache_handler (по умолчанию: xPDOFileCache)

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

cache_lang_js (по умолчанию: да)

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

cache_lexicon_topics (по умолчанию: да)

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

cache_noncore_lexicon_topics (по умолчанию: да)

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

cache_resource (по умолчанию: Да)

Включает частичное кэширование ресурсов. Будут задействованы только те ресурсы, у которых параметр "Кэшируемый" установлен. Выключение данной опции отключит кэширование всех ресурсов.

cache_resource_expires (по умолчанию: 0)

Устанавливает период жизни кэша ресурсов (в секундах). Значение 0 позволяет хранить кэш ресурсов неограниченное время.

cache_scripts (по умолчанию: да)

Если включено, то MODX будет кэшировать все скрипты (сниппеты и плагины) в кэш (файлы) для увеличения скорости их загрузки. MODX рекомендует оставить эту настройку включённой.

cache_system_settings (по умолчанию: Да)

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

clear_cache_refresh_trees (по умолчанию: Нет)

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

syncsite_default (по умолчанию: Да)

Если параметр имеет значение "Да", то сохранение ресурса будет приводить к автоматической очистке кэша.

Настройка кэширования ресурсов

В MODX управление кэшированием ресурсов осуществляется:

• посредством изменения системных настроек cache_resource, cache_resource_expires и cache_default (глобальные настройки, влияющие на все ресурсы);
• с помощью флажка "Кэшируемый" (включает или отключает кэш отдельно взятого ресурса).

Кэш ресурсов в MODX расположен в директории /core/cache/resource/. Он построен с учётом контекста, к которому принадлежит ресурс. Имена файлов в этом кэше имеют следующий формат:

5.cache.php  

Цифра в начале имени - это значение id ресурса.

Управление кэшированием элементов

Система MODX позволяет управлять кэшированием чанков, сниппетов и плейсхолдеров. Осуществляется это посредством флага (восклицательного знака) в конструкции вызова этого элемента.

Данный флаг является не обязательным. Если его не указывать, то вызов элемента будет кэшированным. Это означает, что при вызове элемента, система MODX будет проверять есть ли результат его работы в кэше. Если он есть, то система MODX просто возьмёт его оттуда. Если же его нет, то этот элемент будет запущен на выполнение. После завершения выполнения система MODX сохранит результат его работы в кэш (для использования в следующих вызовах).

// Кэшируемый вызов сниппет
[[snippet]]
// Кэшируемый чанк
[[$chunk]]
// Кэшируемый плейсхолдер
[[+placeholder]]

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

// Не кэшируемый вызов сниппет
[[!snippet]]
// Не кэшируемый чанк
[[!$chunk]]
// Не кэшируемый плейсхолдер
[[!+placeholder]]

Программное управление кэшированием

В MODX работа с кэшем осуществляется посредством modCacheManager, который является расширением класса xPDOCacheManager.

modCacheManager предоставляет следующие методы для работы с кэшем:

• add($key, $var, $lifetime = 0, $options = array()) - необходим для добавления значения в кэш (но только если это значение не существует или срок его хранения вышел);
• replace($key, $var, $lifetime = 0, $options = array()) - используется для замены одного (существующего) кэшированного значения на другое;
• set($key, $var, $lifetime = 0, $options = array()) - используется для установки значения в кэш не зависимого от того есть ли оно в кэше или нет;
• delete ($key, $options = array()) - удаляет кэшированное значение из кэша;
• get ($key, $options = array()) - применяется для получения кэшированное значение из кэша;
• refresh ($key, $options = array()) - предназначен для удаление всех разделов кэша или какого-то конкретного.

Массив $options может содержать следующие ключи:

• xPDO::OPT_CACHE_KEY - указывает раздел кэша;
• xPDO::OPT_CACHE_HANDLER - задаёт провайдер кэша (как правило, данный ключ нет смысла указывать, для назначения провайдера для раздела кэша используйте системные настройки (параметр cache_PARTITION_handler));
• xPDO::OPT_CACHE_EXPIRES - устанавливает длительность хранения кэша в секундах.

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

Удаление всего кэша MODX:

$modx->cacheManager->refresh();

Удаление кэша контекстов web и en из раздела context_settings:

$modx->cacheManager->refresh(array(
  'context_settings' => array('contexts' => array('web', 'en')
));

Получить значение кэша по ключу comments_17 из раздела comments:

$output = $modx->cacheManager->get('comments_17',array(xPDO::OPT_CACHE_KEY=>'comments'));

Сохранить в кэш comments_17, расположенный в разделе comments, значение переменной $output (время хранения данных в кэше не ограниченное):

$modx->cacheManager->set('comments_17',$output,0,array(xPDO::OPT_CACHE_KEY=>'comments'));

Удалить из раздела main_menu кэш menu_11:

$modx->cacheManager->delete('menu_11',array(xPDO::OPT_CACHE_KEY=>'main_menu'));

Пример, как можно организовать программное кэширования главного двухуровневого меню на сайте, выполненного с помощью компонента navbar Bootstrap 3.

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

Сниппет MainMenu:

<?php

$tplMainMenu = $modx->getOption('$tplMainMenu', $scriptProperties, 'tpl.mainMenuOuter');
$startId = $modx->getOption('startId', $scriptProperties, '0');
$level = $modx->getOption('level', $scriptProperties, '2');
$resources = $modx->getOption('resources', $scriptProperties, '');
$tplParentRow = $modx->getOption('tplParentRow', $scriptProperties, '@INLINE <li class="[[+classnames]] dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">[[+menutitle]] <b class="caret"></b></a><ul class="dropdown-menu">[[+wrapper]]</ul></li>');
$tplOuter = $modx->getOption('tplOuter', $scriptProperties, '@INLINE [[+wrapper]]');
$firstClass = $modx->getOption('firstClass', $scriptProperties, '');
$lastClass = $modx->getOption('lastClass', $scriptProperties, '');

// id текущего ресурса
$id = $modx->resource->id;
// массив родителей
$parentIds = $modx->getParentIds($id);
// количество родителей
$countParent = count($parentIds);
// id файла кэша 
$cacheId = '';

/* получаем id файла кэша */
// если количество родителей 1 или 2, то выполняем следующее...
if ($countParent==1 || $countParent==2) {
  // если у ресурса не установлен флажок "Не показывать в меню"...
  if (!$modx->resource->get('hidemenu')) {
    // id файла кэша устанавливаем равным id ресурсу
    $cacheId = $id;    
  }
  // если у ресурса 2 родителя и последнего установлен флажок "Не показывать в меню"... 
  if ($cacheId=='' && $countParent==2) {
    // получаем id родительского ресурса
    $parentId = $modx->resource->get('parent');
    // получеаем родителя
    $parent = $modx->getObject('modResource', $parentId);
    // если у него не установлен флажок "Не показывать в меню"...
    if (!$parent->get('hidemenu')) {
      // id файла кэша устанавливаем id родительского ресурса
      $cacheId = $parent->get('id');
    }
  }
}
// если родителей 3 или больше и id кэша не найден...
if ($countParent>=3 && $cacheId=='') {
  // проверяем 2 предпоследних родителя
  for ($i=$countParent-3; $i<=$countParent-2; $i++) {
    // получаем id ресурса
    $parent = $modx->getObject('modResource',$parentIds[$i]);
    // если у него не установлен флажок "Не показывать в меню"...
    if (!$parent->get('hidemenu')) {
      //id файла кэша устанавливаем id ресурса
      $cacheId = $parent->get('id');
      // прерываем выполнение цикла
      break;
    }
  }
}

/* формируем имя файла кэша */
// id файла кэша не установлен...
if ($cacheId=='') {
  // формируем имя кэша без id файла кэша
  $name = 'menu';
} else {
  // формируем имя кэша с учётом id файла кэша  
  $name = $cacheId.'.menu';
}

// пытаемся получить кэш по ключу
$output = $modx->cacheManager->get($name, array(xPDO::OPT_CACHE_KEY => 'main_menu'));
// если кэша с указанным ключом нет...
if (empty($output)) {
  // определяем параметры для запуска сниппета pdoMenu
  $scriptPropertiesMenu = array(
    'startId'=>$startId,
    'level'=>$level,
    'resources'=>$resources,
    'tplParentRow'=>$tplParentRow,
    'tplOuter'=>$tplOuter,    
    'firstClass' => $firstClass,
    'lastClass' => $lastClass
  );
  // сохраняем в переменную $output результат работы сниппета pdoMenu
  $output = $modx->runSnippet('pdoMenu',$scriptPropertiesMenu);
  // перезаписываем значение переменной $output для формирования полного меню
  $output = $modx->getChunk($tplMainMenu, array('output' => $output));
  // сохраняем к кэш значение переменной $output
  $modx->cacheManager->set($name,$output,0,array(xPDO::OPT_CACHE_KEY=>'main_menu'));
};
return $output;

Чанк tpl.mainMenuOuter (внешняя обёртка главного меню):

<div class="navbar navbar-default" role="navigation">
  <div class="container-fluid">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"><span class="sr-only">Toggle navigation</span><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span>
      </button>
      <div class="navbar-brand">
        <img src="/assets/images/logo.svg" height="30" alt="Логотип сайта">
      </div>
    </div>
    <div class="collapse navbar-collapse" id="navbar">
      <ul class="nav navbar-nav">[[+output]]</ul>
    </div>
  </div>
</div>

Вызов сниппета MainMenu в шаблоне:

[[!MainMenu? &tplMainMenu=`tpl.mainMenuOuter` &resources=`-1`]]  

После этого в разделе main_menu будет находиться кэши главных меню ресурсов.