Cache

Интерфейс Cache представляет собой механизм хранения пары объектов Request / Response, которые кешируются, например, как часть жизненного цикла ServiceWorker. Заметьте, что интерфейс Cache доступен как в области видимости окна, так и в области видимости воркеров. Не обязательно использовать его вместе с сервис воркерами, даже если интерфейс определён в их спецификации.

Для вызывающего скрипта может быть множество именованных объектов Cache. Разработчик сам определяет реализацию того, как скрипт (например, в ServiceWorker) управляет обновлением Cache. Записи в Cache не будут обновлены, пока не будет выполнен явный запрос; их время жизни не истечёт до момента удаления. Используйте CacheStorage.open(cacheName), чтобы открыть определённый именованный объект Cache и затем вызывайте любые методы Cache для управления его состоянием.

Вы также ответственны за периодическую очистку записей кеша. Каждый браузер имеет жёсткие ограничения на объем хранилища кеша, доступный для исходного кода. Браузер делает все, чтобы как можно лучше использовать дисковое пространство, но он может удалить хранилище кеша для скрипта. В основном, браузер либо удаляет все данные из кеша для скрипта, либо не удаляет ничего. Устанавливайте версии кеша в имени и используйте кеш только той версии, которая безопасна для использования. Смотрите Удаление старого кеша.

Примечание: Алгоритм сопоставления ключей зависит от заголовка VARY хранимого значения. Таким образом, сопоставление нового ключа требует одновременно как проверки самого ключа, так и значений для записей в Cache.

Примечание: Кеширующие API не учитывают заголовки кеширования HTTP.

Методы

Cache.match(request, options)

Возвращает Promise, который успешно завершается с нахождением первого совпадения для данного запроса в объекте Cache.

Cache.matchAll(request, options)

Возвращает Promise, который успешно завершается и возвращает массив всех найденных совпадений для данного запроса в объекте Cache.

Cache.add(request)

Принимает в качестве параметра URL, получает данные по нему и добавляет полученный объект ответа в заданный кеш. Функциональный эквивалент вызову fetch() с последующим вызовом Cache.put() для добавления результата в кеш.

Cache.addAll(requests)

Принимает массив URL в качестве параметра, получает данные по ним, добавляет полученные объекты ответов в заданный кеш.

Cache.put(request, response)

Принимает запрос и ответ на него и добавляет их в заданный кеш.

Cache.delete(request, options)

Находит запись Cache, чей ключ является запросом, и, в случае нахождения, удаляет запись Cache и возвращает Promise, успешно завершающийся со значением true. Если же запись Cache не найдена, возвращается false.

Cache.keys(request, options)

Возвращает Promise, который отдаёт массив ключей Cache.

Примеры

Этот пример кода из примера выборочного кеширования сервис воркера. (смотрите работа выборочного кеширования). В коде используется CacheStorage.open(cacheName) для открытия любых объектов Cache с заголовком Content-Type, начинающимся с font/.

Далее используется Cache.match(request, options) для определения того, находится ли уже совпадающий шрифт в кеше, и, если так, то возвращает его. Если же совпадающего шрифта нет, код получает этот шрифт по сети и использует Cache.put(request, response) для кеширования полученного ресурса.

Код обрабатывает исключения, возможные при операции fetch(). Заметьте, что HTTP-ответ с ошибкой (например, 404) не будет вызывать исключения. Будет возвращён нормальный объект ответа с установленным соответствующим кодом ошибки.

Также, пример описывает лучшие практики по заданию версий кеша при работе с сервис воркерами. И хотя в примере лишь один кеш, тот же подход может быть использован для множества кешей. Он сравнивает сокращённый идентификатор кеша с определённым, версионным именем кеша. Код также удаляет весь кеш, для которого не определено имя CURRENT_CACHES.

В примере кода "кеш" это атрибут WorkerGlobalScope сервис воркеров. Он содержит объект CacheStorage, через который можно получить доступ к CacheStorage API.

Примечание: В Chrome, откройте chrome://inspect/#service-workers и кликните по ссылке "inspect" под зарегистрированным сервис воркером чтобы увидеть записи журнала по различным действиям выполняемым скриптом service-worker.js.

js
var CACHE_VERSION = 1;

// Сокращённый идентификатор привязанный к определённой версии кеша.
var CURRENT_CACHES = {
  font: "font-cache-v" + CACHE_VERSION,
};

self.addEventListener("activate", function (event) {
  var expectedCacheNames = Object.keys(CURRENT_CACHES).map(function (key) {
    return CURRENT_CACHES[key];
  });

  // Активный воркер не будет рассматриваться как активированный, пока promise не разрешится успешно.
  event.waitUntil(
    caches.keys().then(function (cacheNames) {
      return Promise.all(
        cacheNames.map(function (cacheName) {
          if (expectedCacheNames.indexOf(cacheName) == -1) {
            console.log("Deleting out of date cache:", cacheName);

            return caches.delete(cacheName);
          }
        }),
      );
    }),
  );
});

self.addEventListener("fetch", function (event) {
  console.log("Handling fetch event for", event.request.url);

  event.respondWith(
    // Открывает объекты Cache, начинающиеся с 'font'.
    caches.open(CURRENT_CACHES["font"]).then(function (cache) {
      return cache
        .match(event.request)
        .then(function (response) {
          if (response) {
            console.log("Found response in cache:", response);

            return response;
          }
        })
        .catch(function (error) {
          // Обрабатывает исключения от match() или fetch().
          console.error("Error in fetch handler:", error);

          throw error;
        });
    }),
  );
});

Спецификации

Specification
Service Workers
# cache-interface

Совместимость с браузерами

BCD tables only load in the browser

Смотрите также