← Cloudflare Workers / workers / runtime-apis

Cache

Cache API ↗ umožňuje jemně granulární řízení čtení a zápisu z globální síť Cloudflare ↗ cache.

Cache API je dostupné globálně, ale obsah mezipaměti se nereplikuje mimo datové centrum, ve kterém vznikl. Klíč GET /users odpověď může být uložena do mezipaměti v datovém centru, kde vznikla, ale v jiném datovém centru neexistuje, dokud tam není výslovně vytvořena.

Workers nasazené na vlastních doménách mají přístup k funkčnímu cache operace. Totéž platí pro Pages functions, ať už jsou připojeny k vlastním doménám, nebo *.pages.dev domén.

Jakékoli operace Cache API v editoru dashboardu Cloudflare Workers a Playground náhledy nebudou mít žádný vliv. U Workerů, před kterými je Cloudflare Access, Cache API aktuálně není k dispozici.

caches.default API je silně inspirováno rozhraním Cache API webových prohlížečů, existuje ale několik důležitých rozdílů. Prostředí Cloudflare Workers runtime například zpřístupňuje jediný globální objekt cache.

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

Další instance Cache můžete vytvářet a spravovat pomocí caches.open ↗ metoda.

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

Naše implementace Cache API respektuje následující hlavičky HTTP v odpovědi předané do put():

• Cache-Control
  • Ovládá direktivy ukládání do mezipaměti. To je v souladu s Direktivy Cloudflare Cache-Control. Viz Edge TTL pro seznam kódů HTTP odpovědí a jejich TTL, když Cache-Control direktivy nejsou přítomny.
• Cache-Tag
  • Umožňuje později vymazat prostředky podle tagu (tagů).
• ETag
  • Umožňuje cache.match() k vyhodnocení podmíněných požadavků pomocí If-None-Match.
• Expires string
  • Řetězec určující, kdy prostředek přestane platit.
• Last-Modified
  • Umožňuje cache.match() k vyhodnocení podmíněných požadavků pomocí If-Modified-Since.

Liší se to od Cache API webového prohlížeče v tom, že nerespektuje žádné hlavičky požadavku ani odpovědi.

cache.put(request, response);

• put(request, response) : Promise

  • Pokusí se přidat odpověď do mezipaměti s daným požadavkem jako klíčem. Vrací promise, který se vyhodnotí na undefined bez ohledu na to, zda se odpověď do mezipaměti úspěšně uložila.

• request string | Request

  • Buď řetězec, nebo Request objekt, který slouží jako klíč. Pokud je předán řetězec, je interpretován jako URL pro nový objekt Request.

• response Odpověď

  • A Response objekt k uložení pod daným klíčem.

cache.put vyvolá chybu, pokud:

• request předaná je jiná metoda než GET.
• response předaný má status z 206 Partial Content ↗.
• response předaný obsahuje hlavičku Vary: *. Hodnota Vary hlavička je hvězdička (*). Viz Specifikace Cache API ↗ s dalšími informacemi.

cache.put vrací 413 chybu, pokud Cache-Control nařizuje neukládat do mezipaměti, nebo pokud je odpověď příliš velká.

cache.match(request, options);

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

  • Vrátí Promise obalující objekt odpovědi přiřazený k danému požadavku.

• request string | Request

  • Řetězec nebo Request objekt použitý jako vyhledávací klíč. Řetězce jsou interpretovány jako URL pro nový Request objekt.

• options

  • Může obsahovat jednu možnou vlastnost: ignoreMethod (Boolean). Když true, požadavek se považuje za GET požadavek bez ohledu na jeho skutečnou hodnotu.

Na rozdíl od Cache API prohlížeče Cloudflare Workers nepodporuje ignoreSearch nebo ignoreVary možnosti na match(). Tohoto chování dosáhnete odstraněním query řetězců nebo HTTP hlaviček na put() čas.

Naše implementace Cache API respektuje následující hlavičky HTTP v požadavku předaném do match():

• Range

  • Vede k 206 odpověď, pokud je nalezena odpovídající odpověď s hlavičkou Content-Length. Vaše mezipaměť Cloudflare vždy respektuje požadavky na rozsah, i když Accept-Ranges hlavička je součástí odpovědi.

• If-Modified-Since

  • Vede k 304 odpověď, pokud je nalezena odpovídající odpověď s Last-Modified hlavičky s hodnotou před časem uvedeným v If-Modified-Since.

• If-None-Match

  • Vede k 304 odpověď, pokud je nalezena odpovídající odpověď s ETag hlavičky s hodnotou, která odpovídá hodnotě v If-None-Match.

cache.match generuje 504 chybovou odpověď, pokud požadovaný obsah chybí nebo mu vypršela platnost. Cache API toto 504 přímo do Worker skriptu, ale místo toho vrací undefined. Přesto podkladové 504 je stále viditelné v Cloudflare Logs.

Pokud používáte Cloudflare Logs, můžete vidět tyto 504 odpovědi s RequestSource z edgeWorkerCacheAPI. I to je očekávané chování, pokud asset v cache chyběl nebo mu vypršela platnost. Mějte na paměti, že edgeWorkerCacheAPI požadavky jsou již odfiltrované v jiných zobrazeních, jako je Cache Analytics. Chcete-li tyto požadavky odfiltrovat nebo filtrovat požadavky pouze od koncových uživatelů vašeho webu, přečtěte si Filtrování koncových uživatelů.

cache.delete(request, options);

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

Odstraní Response objekt z mezipaměti a vrátí Promise pro booleovskou odpověď:

• true: Odpověď byla uložena do mezipaměti, ale nyní je smazána
• false: Odpověď nebyla v okamžiku mazání v mezipaměti.

• request string | Request

  • Řetězec nebo Request objekt použitý jako vyhledávací klíč. Řetězce jsou interpretovány jako URL pro nový Request objekt.

• options objekt

  • Může obsahovat jednu možnou vlastnost: ignoreMethod (Boolean). Metodu požadavku považujte za GET bez ohledu na její skutečnou hodnotu.

• Jak funguje mezipaměť
• Příklad: ukládání do mezipaměti pomocí fetch()
• Příklad: použití Cache API
• Příklad: cachování POST požadavků