← Cloudflare Workers / workers / runtime-apis

Кеш

Cache API ↗ дает точный контроль над чтением и записью из глобальная сеть Cloudflare ↗ кеш.

Cache API доступен по всему миру, но содержимое кеша не реплицируется за пределы исходного дата-центра. Ключ кеша, GET /users ответ можно кешировать в исходном дата-центре, но в другом дата-центре он появится, только если был создан там явно.

Workers, развёрнутые на пользовательских доменах, имеют доступ к функциональным cache операции. Так же ведут себя и Функции Pages, независимо от того, подключены ли они к пользовательским доменам или *.pages.dev доменов.

Однако любые операции Cache API в редакторе панели управления Cloudflare Workers и Playground превью не будут иметь эффекта. Для Workers, работающих за Cloudflare Access, Cache API пока недоступен.

caches.default API во многом основан на Cache API веб-браузеров, но есть важные отличия. Например, среда выполнения Cloudflare Workers предоставляет единый глобальный объект кеша.

let cache = caches.default;
await cache.match(request);

Вы можете создавать дополнительные экземпляры Cache и управлять ими через caches.open ↗ метод.

let myCache = await caches.open('custom:cache');
await myCache.match(request);

Наша реализация Cache API учитывает следующие заголовки HTTP в ответе, переданном в put():

• Cache-Control
  • Управляет директивами кеширования. Это согласуется с Директивы Cache-Control в Cloudflare. См. Edge TTL список кодов ответа HTTP и соответствующих значений TTL, когда Cache-Control директивы отсутствуют.
• Cache-Tag
  • Позволяет впоследствии очищать ресурсы по тегу (тегам).
• ETag
  • Позволяет cache.match() чтобы обрабатывать условные запросы с If-None-Match.
• Expires строка
  • Строка, которая указывает, когда ресурс становится недействительным.
• Last-Modified
  • Позволяет cache.match() чтобы обрабатывать условные запросы с If-Modified-Since.

Это отличается от Cache API веб-браузера тем, что заголовки запроса и ответа не учитываются.

cache.put(request, response);

• put(request, response) : Promise

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

• request string | Request

  • Либо строка, либо Request объект, который будет использоваться в качестве ключа. Если передана строка, она интерпретируется как URL для нового объекта Request.

• response Response

  • A Response объект для хранения под указанным ключом.

cache.put выбросит ошибку, если:

• request является методом, отличным от GET.
• response переданный имеет status 206 Partial Content ↗.
• response содержит заголовок Vary: *. Значение Vary заголовок представляет собой звёздочку (*). См. Спецификация Cache API ↗, где это описано подробнее.

cache.put возвращает 413 ошибку, если Cache-Control указывает не кешировать, или если ответ слишком большой.

cache.match(request, options);

• match(request, options) : Promise<Response | undefined>

  • Возвращает Promise, оборачивающий объект ответа, привязанный к этому запросу.

• request string | Request

  • Строка или Request объект, используемый как ключ поиска. Строки интерпретируются как URL для нового Request объект.

• options

  • Может содержать только одно свойство: ignoreMethod (логический тип). Когда true, запрос считается GET запрос независимо от его фактического значения.

В отличие от браузерного Cache API, Cloudflare Workers не поддерживают ignoreSearch или ignoreVary параметры для match(). Этого можно добиться, удалив строки запроса или HTTP-заголовки на put() раз.

Наша реализация Cache API учитывает следующие заголовки HTTP в запросе, переданном в match():

• Range

  • Приводит к 206 ответ, если найден подходящий ответ с заголовком Content-Length. Кеш Cloudflare всегда учитывает запросы с диапазоном (Range), даже если Accept-Ranges заголовок присутствует в ответе.

• If-Modified-Since

  • Приводит к 304 ответ, если найден подходящий ответ с Last-Modified заголовка со значением до времени, указанного в If-Modified-Since.

• If-None-Match

  • Приводит к 304 ответ, если найден подходящий ответ с ETag заголовка со значением, совпадающим со значением в If-None-Match.

cache.match генерирует 504 ответ с ошибкой, если запрошенное содержимое отсутствует или устарело. Cache API не предоставляет доступ к этому 504 напрямую в скрипт Worker, а вместо этого возвращает undefined. Тем не менее базовый 504 по-прежнему виден в Cloudflare Logs.

Если вы используете Cloudflare Logs, вы можете увидеть следующие 504 ответов с этим RequestSource edgeWorkerCacheAPI. Это ожидаемо, если закешированный ресурс отсутствовал или устарел. Обратите внимание, что edgeWorkerCacheAPI запросы уже отфильтрованы в других представлениях, например в Cache Analytics. Чтобы отфильтровать эти запросы или оставить только запросы от конечных пользователей вашего сайта, см. Фильтрация конечных пользователей.

cache.delete(request, options);

• delete(request, options) : Promise<boolean>

Удаляет Response объект из кеша и возвращает Promise для булевого ответа:

• true: Ответ был кеширован, но теперь удалён
• false: Ответ отсутствовал в кеше на момент удаления.

• request string | Request

  • Строка или Request объект, используемый как ключ поиска. Строки интерпретируются как URL для нового Request объект.

• options объект

  • Может содержать только одно свойство: ignoreMethod (логический тип). Считайте метод запроса GET независимо от его фактического значения.

• Как работает кеш
• Пример: кеширование с использованием fetch()
• Пример: использование Cache API
• Пример: кеширование запросов POST