PSR-16: Общий интерфейс для кэширующих библиотек

PSR (PHP Standards Recommendations) - это набор рекомендаций по программированию на языке PHP.
Кэширование — это распространенный способ повышения производительности любого проекта, что делает библиотеки кэширования одной из наиболее распространенных функций многих платформ и библиотек. Взаимодействие на этом уровне означает, что библиотеки могут отказаться от своих собственных реализаций кэширования и легко полагаться на ту, которая предоставлена ​​им платформой, или на другую выделенную библиотеку кэширования.

1.1 Введение

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

1.2 Определения

Определения для вызывающей библиотеки, реализации библиотеки, TTL, срока действия и ключа скопированы из PSR-6, поскольку верны те же предположения.

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

• Реализация библиотеки. Эта библиотека отвечает за реализацию этого стандарта для предоставления услуг кэширования любой вызывающей библиотеке. Реализующая библиотека должна предоставить класс, реализующий интерфейс Psr\SimpleCache\CacheInterface. Реализация библиотек должна поддерживать функциональность минимального TTL, как описано ниже, с точностью до целой секунды.

• TTL — время жизни (TTL) элемента — это промежуток времени между тем, когда этот элемент хранится, и тем, как он считается устаревшим. TTL обычно определяется целым числом, представляющим время в секундах, или объектом DateInterval.

• Срок действия (Expiration) — фактическое время, когда элемент устареет. Это значение рассчитывается путем прибавления TTL ко времени хранения объекта.

  Элемент с TTL 300 секунд, хранящийся в 1:30:00, будет иметь срок действия 1:35:00.

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

  Если указан отрицательный или нулевой TTL, элемент ДОЛЖЕН быть удален из кэша, если он существует, поскольку срок его действия уже истек.

• Ключ (Key) — строка, состоящая как минимум из одного символа, которая однозначно идентифицирует кэшированный элемент. Реализующие библиотеки должны поддерживать ключи, состоящие из символов A-Z, a-z, 0-9, _ и . в любом порядке в кодировке UTF-8 и длиной до 64 символов. Реализующие библиотеки могут поддерживать дополнительные символы и кодировки или более длинные длины, но должны поддерживать хотя бы этот минимум. Библиотеки несут ответственность за собственное экранирование строк ключей, но ДОЛЖНЫ иметь возможность возвращать исходную немодифицированную строку ключей. Следующие символы зарезервированы для будущих расширений и не должны поддерживаться реализующими библиотеками: {}()/\@:

• Кэш (Cache) — объект, реализующий Psr\SimpleCache\CacheInterface интерфейс.

• Промах (Miss). Промахи в кэше. При промахе в кэше возвращается ноль, поэтому определить, сохранено ли оно, null невозможно. Это главное отклонение от предположений PSR-6.

1.3 Кэш

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

1.4 Данные

Реализующие библиотеки должны поддерживать все сериализуемые типы данных PHP, включая:

• Строки — символьные строки произвольного размера в любой PHP-совместимой кодировке.
• Целые числа — все целые числа любого размера, поддерживаемые PHP, вплоть до 64-битных знаков.
• Дробные числа — все подписанные значения с плавающей запятой.
• Логическое значение – true и false.
• Null — фактическое null значение.
• Массивы — Индексированные, ассоциативные и многомерные массивы произвольной глубины.
• Объект — любой объект, поддерживающий сериализацию и десериализацию без потерь, например $o == unserialize(serialize($o)). Объекты могут использовать сериализуемый интерфейс PHP, __sleep() или __wakeup() магические методы или аналогичные функции языка, если это необходимо.

Все данные, переданные во реализующую библиотеку, должны быть возвращены точно в том виде, в котором они были переданы. Это включает в себя тип переменной. То есть (string) 5 будет ошибкой, если (int) 5 было числом. Реализации библиотек могут использовать PHP функции serialize() и unserialize() внутри, но это не обязательно. Совместимость с ними просто используется в качестве основы для приемлемых значений объекта.

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

2.1 CacheInterface

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

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

Экземпляр CacheInterface соответствует одной коллекции элементов кэша с одним пространством имен ключей и эквивалентен «Пулу» в PSR-6. Различные экземпляры CacheInterface могут поддерживаться одним и тем же хранилищем данных, но должны быть логически независимыми.

<?php

namespace Psr\SimpleCache;

interface CacheInterface
{
    /**
     * Fetches a value from the cache.
     *
     * @param string $key     The unique key of this item in the cache.
     * @param mixed  $default Default value to return if the key does not exist.
     *
     * @return mixed The value of the item from the cache, or $default in case of cache miss.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function get($key, $default = null);

    /**
     * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
     *
     * @param string                 $key   The key of the item to store.
     * @param mixed                  $value The value of the item to store. Must be serializable.
     * @param null|int|\DateInterval $ttl   Optional. The TTL value of this item. If no value is sent and
     *                                      the driver supports TTL then the library may set a default value
     *                                      for it or let the driver take care of that.
     *
     * @return bool True on success and false on failure.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function set($key, $value, $ttl = null);

    /**
     * Delete an item from the cache by its unique key.
     *
     * @param string $key The unique cache key of the item to delete.
     *
     * @return bool True if the item was successfully removed. False if there was an error.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function delete($key);

    /**
     * Wipes clean the entire cache's keys.
     *
     * @return bool True on success and false on failure.
     */
    public function clear();

    /**
     * Obtains multiple cache items by their unique keys.
     *
     * @param iterable $keys    A list of keys that can obtained in a single operation.
     * @param mixed    $default Default value to return for keys that do not exist.
     *
     * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $keys is neither an array nor a Traversable,
     *   or if any of the $keys are not a legal value.
     */
    public function getMultiple($keys, $default = null);

    /**
     * Persists a set of key => value pairs in the cache, with an optional TTL.
     *
     * @param iterable               $values A list of key => value pairs for a multiple-set operation.
     * @param null|int|\DateInterval $ttl    Optional. The TTL value of this item. If no value is sent and
     *                                       the driver supports TTL then the library may set a default value
     *                                       for it or let the driver take care of that.
     *
     * @return bool True on success and false on failure.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $values is neither an array nor a Traversable,
     *   or if any of the $values are not a legal value.
     */
    public function setMultiple($values, $ttl = null);

    /**
     * Deletes multiple cache items in a single operation.
     *
     * @param iterable $keys A list of string-based keys to be deleted.
     *
     * @return bool True if the items were successfully removed. False if there was an error.
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $keys is neither an array nor a Traversable,
     *   or if any of the $keys are not a legal value.
     */
    public function deleteMultiple($keys);

    /**
     * Determines whether an item is present in the cache.
     *
     * NOTE: It is recommended that has() is only to be used for cache warming type purposes
     * and not to be used within your live applications operations for get/set, as this method
     * is subject to a race condition where your has() will return true and immediately after,
     * another script can remove it, making the state of your app out of date.
     *
     * @param string $key The cache item key.
     *
     * @return bool
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     */
    public function has($key);
}

2.2 CacheException

<?php

namespace Psr\SimpleCache;

/**
 * Interface used for all types of exceptions thrown by the implementing library.
 */
interface CacheException
{
}

2.3 InvalidArgumentException

<?php

namespace Psr\SimpleCache;

/**
 * Exception interface for invalid cache arguments.
 *
 * When an invalid argument is passed, it must throw an exception which implements
 * this interface.
 */
interface InvalidArgumentException extends CacheException
{
}

Ссылка на источник: https://www.php-fig.org/psr/psr-16/