Перейти к содержимому
M
Все статьи
Технологии 8 мин чтения

Кэш в Moodle: MUC, Cache API в плагине и почему данные «не обновляются»

Как устроен кэш Moodle (MUC): режимы, хранилища, определения в db/caches.php, использование в плагине и причины, по которым данные остаются старыми.

Как устроен кэш Moodle (MUC): режимы, хранилища, определения в db/caches.php, использование в плагине и причины, по которым данные остаются старыми.

«Я поменяла настройку, а на сайте всё по-старому». «Новая оценка появилась у одного преподавателя и не появилась у другого». Многие такие жалобы — результат работы кэша, а не ошибка в данных. Moodle кэширует почти всё: языковые строки, структуру курса, права, результаты запросов. Ниже — как это устроено и как вести себя плагину, чтобы не ломать ни скорость, ни свежесть данных.

Три режима кэша

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

РежимОбласть видимостиЖивётПример использования
ApplicationВесь сайт, все пользователиМежду запросами, пока не удалят или не истечёт срокСправочник направлений, результат тяжёлой выборки
SessionОдин пользователь в одной сессииДо конца сессииВыбранные фильтры, вычисленные пользовательские права
RequestОдин запросДо конца запросаРезультат функции, вызываемой в цикле много раз

Описание подсистемы есть на странице Cache API (MUC).

Определение кэша в плагине

Кэш плагина объявляют в файле db/caches.php:

defined('MOODLE_INTERNAL') || die();

$definitions = [
    'directions' => [
        'mode'               => cache_store::MODE_APPLICATION,
        'simplekeys'         => true,
        'simpledata'         => true,
        'ttl'                => 3600,
        'staticacceleration' => true,
        'staticaccelerationsize' => 30,
    ],
];

Название и описание для интерфейса администратора задаются строкой cachedef_directions в языковом файле плагина. Параметры подбирают по данным. simplekeys говорит, что ключи — только буквы, цифры и подчёркивание, и ядро пропустит их подготовку. simpledata означает, что значения — скаляры или простые массивы без объектов, и их можно сохранять без дополнительной упаковки. ttl — срок жизни записи в секундах. staticacceleration держит последние обращения в памяти процесса, что ускоряет повторные чтения в одном запросе.

Использование в коде:

$cache = \cache::make('local_example', 'directions');

$value = $cache->get($key);
if ($value === false) {
    $value = local_example_load_directions();   // дорогая операция
    $cache->set($key, $value);
}

Метод get() возвращает false, если записи нет. Поэтому значение false в самих данных кэшировать нельзя: вы не отличите его от промаха. Для таких случаев сохраняйте обёртку или используйте иное значение-маркер. Для массовых операций есть get_many() и set_many(), они заметно дешевле циклов из одиночных вызовов, особенно на сетевых хранилищах.

После добавления или изменения db/caches.php поднимите версию плагина: определения регистрируются при обновлении.

Хранилища: куда на самом деле пишет MUC

Определение говорит, что кэшировать. Куда складывать, выбирает администратор в «Плагины → Кэширование → Конфигурация». Там каждому режиму сопоставлены хранилища, а отдельным определениям можно назначить собственное.

ХранилищеОсобенности
Файловое (по умолчанию)Работает из коробки, лежит в moodledata/cache и localcache; на нескольких серверах каждый видит своё
RedisОбщее для кластера, годится для application и session, требует отдельного сервиса
MemcachedОбщее, быстрое, без постоянного хранения; данные могут пропасть при перезапуске
APCuВ памяти PHP-процесса одного сервера, быстрое; общим для кластера не бывает

На странице конфигурации есть тест производительности хранилищ: он показывает, насколько быстро работает выбранный вариант на вашем сервере. Если сайт нагружен, переход на Redis для сессий и application-кэша обычно заметно разгружает диск; подробнее о том, как это связано с общей скоростью СДО, написано в статье почему Moodle тормозит.

Почему данные «не обновляются»

Что видноПричинаЧто сделать
Правка шаблона или CSS не виднаКэш тем и шаблонов, браузерный кэш JS/CSSОчистить кэши; для разработки включить режим разработчика и отключить кэш шаблонов
Новая языковая строка не появиласьКэш языковых строкОчистить кэши или кэш строк на странице языковой настройки
Права пользователя не изменилисьКэшированы данные ролей и сессия пользователяПользователю выйти и войти; после массовых правок очистить кэши
Правка PHP «не применяется»OPcache держит старый байткодСбросить OPcache или перезапустить PHP-FPM, особенно если отключена проверка меток времени
На разных серверах разные данныеЛокальное файловое хранилище у каждого сервераПеревести application-кэши на общее хранилище
Свой кэш плагина показывает староеНе сбрасывается при изменении исходных данных, большой ttlУдалять запись при изменении данных, применить события инвалидации

Последняя строка — самая частая причина при самописных плагинах. Кэш нужно не только заполнять, но и сбрасывать там, где меняется источник. Простое правило: любая запись в таблицу, из которой строится кэш, вызывает $cache->delete($key) или $cache->purge() для всего определения. Для связанных изменений в разных плагинах существуют события инвалидации: в определении перечисляют названия в invalidationevents, а любой код сбрасывает все такие кэши вызовом cache_helper::purge_by_event(). Так, например, смену ролей или структуры курсов видят сразу несколько подсистем.

Очистка кэшей: что и когда

  • «Разработка → Очистить кэши» в интерфейсе: сбрасывает почти всё; на загруженном сайте первые минуты после этого он работает медленнее, пока кэши прогреваются.
  • php admin/cli/purge_caches.php: то же из консоли, нужно запускать от пользователя веб-сервера, иначе файлы кэша получат неверные права.
  • Выборочная очистка на странице конфигурации кэширования: можно сбросить один конкретный кэш, не трогая остальные.
  • Программный сброс из плагина: cache_helper::purge_by_definition('local_example', 'directions').

Очистка на рабочей СДО в разгар сессии — тоже риск: десятки пользователей одновременно запускают пересборку. Делайте её в спокойное время и после крупных изменений, в частности при обновлении Moodle.

Разбор типичной ситуации: справочник устарел

Плагин показывает методисту список групп курса и для скорости кэширует его на сутки. Методист создаёт группу через стандартный интерфейс Moodle, возвращается в плагин и не видит её. Данные верны, баг в другом: запись в таблицу групп произошла вне плагина, и сбрасывать кэш было некому. Срок жизни в сутки превратил это в «сломалось до завтра».

Есть три способа исправить ситуацию. Первый: сократить ttl до минут, если данных немного и промахи дёшевы. Второй: подписаться на события создания, изменения и удаления групп и сбрасывать запись из наблюдателя. Третий: описать в определении кэша события инвалидации, чтобы сброс происходил по общему имени события. Выбор зависит от цены промаха: если пересчёт занимает секунды, достаточно короткого срока; если минуты, нужна точная инвалидация.

Статическое ускорение и объекты

Режим staticacceleration удерживает прочитанные значения в памяти процесса. Если в кэше лежат объекты, их возвращается ссылка, а не копия, поэтому изменение объекта после get() меняет и то, что хранится в ускорителе, и следующее чтение в том же запросе вернёт уже изменённое. Для простых данных проблемы нет, и именно поэтому в определении стоит указывать simpledata. Если нужно хранить сложную структуру, получив её, работайте с копией.

Ещё одно следствие: данные в кэше не должны зависеть от пользователя, если режим application. Кэш общий, и если результат собран с учётом прав первого обратившегося, остальные получат чужие права. Для зависимых от пользователя вычислений берите session-режим или включайте идентификатор пользователя в ключ.

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

Методы кэша: справка

Метод или классДля чего
\cache::make($component, $area)Получить кэш по определению из db/caches.php
get($key) / set($key, $value)Прочитать и записать одно значение; промах возвращает false
get_many() / set_many()Пакетное чтение и запись, дешевле цикла
has($key)Проверить наличие записи, не читая значение
delete($key)Удалить одну запись при изменении источника
purge()Очистить все записи определения
cache_helper::purge_by_definition()Очистить кэш другого плагина по компоненту и области
cache_helper::purge_by_event()Сбросить все кэши, подписанные на событие инвалидации

Три ошибки, которые я вижу чаще всего

Первая: ключи строятся из данных пользователя без учёта режима, и один человек получает чужой результат. Вторая: кэшируется значение, которое само может быть false, и каждый запрос считается «промахом». Третья: после правки db/caches.php забывают поднять версию, и плагин обращается к определению, которого система ещё не знает, получая исключение о неизвестном кэше. Все три проверяются одним коротким тестом: создать кэш, записать значение, прочитать его от другого пользователя и после изменения источника.

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

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

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

Нужна помощь с Moodle?

Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.