Установка

1

$ composer require symfony/cache

Контракти кешу проти PSR-6

Даний компонент включає в себе два різних підходи до кешування:

Кешування PSR-6:

Базова система кешування, яка включає в себе "пули" та "об'єкти" кешу.

Контракти кешування :

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

Контракти кешування

Всі адаптери підтримують контракти кешування. Вони містять лише два методи: get() та delete(). Методу set() немає, так як метод get() як отримує, так і встановлює значення кешу.

Перше, що вам необхідно зробити, - інстанціювати адаптер кешу. В цьому прикладі використовується FilesystemAdapter:

1
2
3

use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$cache = new FilesystemAdapter();

Тепер ви можете добувати та видаляти кешовані дані, використовуючі цей об'єкт. Перший аргумент методу get() - це ключ, довільний рядок, який ви асоціюєте з кешованим значенням, щоб ви могли добути його пізніше. Другий аргумент - PHP викликаєме, яке виконується, коли ключ не знайдено в коді, щоб згенерувати та повернути значення:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

use Symfony\Contracts\Cache\ItemInterface;

// Викличне буде виконано лише у разі невдачі кешу.
$value = $cache->get('my_cache_key', function (ItemInterface $item): string {
    $item->expiresAfter(3600);

    // ... виконати якийсь HTTP-запит або складні обчислення
    $computedValue = 'foobar';

    return $computedValue;
});

echo $value; // 'foobar'

// ... та видалити ключ кешу
$cache->delete('my_cache_key');

Створення підпросторів імен

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

У таких випадках Symfony дозволяє створювати різні контексти кешу за допомогою просторів імен. Простір імен кешу — це довільний рядок, який ідентифікує набір пов'язаних елементів кешу. Усі адаптери кешу, що надаються компонентом, реалізують NamespacedPoolInterface, який надає метод withSubNamespace().

Цей метод дозволяє вам присвоювати простори імен кешованим елементам, ясно додаючи префікс до їхніх ключів:

1
2
3
4
5
6
7

$userCache = $cache->withSubNamespace(sprintf('user-%d', $user->getId()));

$userCache->get('dashboard_data', function (ItemInterface $item): string {
    $item->expiresAfter(3600);

    return '...';
});

У цьому прикладі обʼєкт кешу використовує ключ dashboard_data, але він буде внутрішньо збережений під простором імен, що засновується на поточному ID користувача. Це обробляється автоматично, тому вам не потрібно вручну додавати префікси на кшталт user-27.dashboard_data.

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

1
2
3
4
5
6
7
8

$localeCache = $cache->withSubNamespace($request->getLocale());

$flagCache = $cache->withSubNamespace(
    $featureToggle->isEnabled('new_checkout') ? 'checkout-v2' : 'checkout-v1'
);

$channel = $request->attributes->get('_route')?->startsWith('api_') ? 'api' : 'web';
$channelCache = $cache->withSubNamespace($channel);

Не існує вбудованого способу інвалидації кешу за простором імен. Натомість рекомендованим підходом є зміна самого простору імен. З цієї причини розповсюджено включення статичного або динамічного версіонування даних у простір імен кешу:

1
2
3
4
5
6
7
8
9

// для простих додатків може бути достатньо просто збільшувати статичний номер версії
$userCache = $cache->withSubNamespace(sprintf('v1-user-%d', $user->getId()));

// інші додатки можуть використовувати динамічне версіонування, засноване на даті (наприклад, щомісячно)
$userCache = $cache->withSubNamespace(sprintf('%s-user-%d', date('Ym'), $user->getId()));

// або навіть інвалидувати кеш за умови зміни даних користувача
$checksum = hash('xxh128', $user->getUpdatedAt()->format(DATE_ATOM));
$userCache = $cache->withSubNamespace(sprintf('user-%d-%s', $user->getId(), $checksum));

1
2
3
4
5
6
7
8
9

use Symfony\Contracts\Cache\ItemInterface;

$beta = 1.0;
$value = $cache->get('my_cache_key', function (ItemInterface $item): string {
    $item->expiresAfter(3600);
    $item->tag(['tag_0', 'tag_1']);

    return '...';
}, $beta);

Загальне кешування (PSR-6)

Щоб використовувати загальні можливості кешування PSR-6, вам знадобиться вивчити його ключові концепти:

Об'єкт

Одна одиниця інформації, яка зберігається у вигляді пари ключ-значення, де ключ - унікальний ідентифікатор інформації, а значення - його зміст; див. статтю Обʼєкти кешу, щоб дізнаится більше.

Пул

Логічне сховище об'єктів кешу. Всі операції кешу (зберігання об'єктів, пошук об'єктів та ін.) виконуються через пул. Додатки можуть визначати стільки пулів, скіль необхідно.

Адаптер

Реадізує сам механізм кешування, щоб зберігати інформацію в файловій системі, базі даних та ін. Компонент надає декілька готових до використання адаптерів для розповсюджених бек-ендів кешування (Redis, APCu, Doctrine, PDO, і т.д.)

Базове застосування (PSR-6)

Ця частина компонента є реалізацією PSR-6, що означає, що його базовий API співпадає з визначеним в стандарті. До того, як кешувати інформацію, створіть пул кешу, використовуючи будь-які вбудовані адаптери. Наприклад, щоб створити кеш, заснований на файловій системі, інстанціюйте FilesystemAdapter:

1
2
3

use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$cache = new FilesystemAdapter();

Тепер ви можете створювати, добувати, оновлювати та видаляти об'єкти, використовуючи цей пул кешу:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

// створіть новий об'єкт, намагаючись отримати його з кешу
$productsCount = $cache->getItem('stats.products_count');

// призначте значення об'єкту та збережіть його
$numProducts->set(4711);
$cache->save($numProducts);

// добудьте об'єкт кешу
$productsCount = $cache->getItem('stats.products_count');
if (!$productsCount->isHit()) {
    // ... об'єкет не існує в кеші
}
// добудьте значення, що зберігається об'єктом
$total = $productsCount->get();

// видаліть об'єкт кешу
$cache->deleteItem('stats.products_count');

Щоб побачити список усіх підтримуваних адаптерів, див. Пули кешу та підтримувані адаптери.

Маршалінг (серіалізація) даних

Symfony використовує маршалерів (класи, що реалізують MarshallerInterface), щоб обробляти об'єкти кешування перед їх збереженням.

DefaultMarshaller використовує PHP-функцію serialize() за замовчуванням, але ви можете опціонально використовувати функцію
igbinary_serialize() з розширення Igbinary:

1
2
3
4
5
6
7
8
9

use Symfony\Component\Cache\Adapter\RedisAdapter;
use Symfony\Component\Cache\Marshaller\DefaultMarshaller;
use Symfony\Component\Cache\Marshaller\DeflateMarshaller;

$marshaller = new DeflateMarshaller(new DefaultMarshaller());
// ви можете за бажанням використати розширення Igbinary, якщо воно у вас встановлене
// $marshaller = new DeflateMarshaller(new DefaultMarshaller(useIgbinarySerialize: true));

$cache = new RedisAdapter(new \Redis(), 'namespace', 0, $marshaller);

Існують інші маршалери, які можуть шифрувати або стискати дані перед зберіганням.

Просунуте використання