缓存中间件

缓存中间件使用 Web 标准的 Cache API。

缓存中间件目前支持使用自定义域的 Cloudflare Workers 项目和使用 Deno 1.26+ 的 Deno 项目。也可与 Deno Deploy 一起使用。

Cloudflare Workers 遵守 Cache-Control 标头并返回缓存的响应。有关详细信息，请参阅 Cloudflare 文档中的缓存。Deno 不遵守标头，因此如果需要更新缓存，则需要实现自己的机制。

有关每个平台的说明，请参见下面的用法。

导入

import { Hono } from 'hono'
import { cache } from 'hono/cache'

用法

Cloudflare Workers

app.get(
  '*',
  cache({
    cacheName: 'my-app',
    cacheControl: 'max-age=3600',
  })
)

Deno

// 对于 Deno 运行时，必须使用 `wait: true`
app.get(
  '*',
  cache({
    cacheName: 'my-app',
    cacheControl: 'max-age=3600',
    wait: true,
  })
)

选项

必需 cacheName: string | (c: Context) => string | Promise<string>

缓存的名称。可用于存储具有不同标识符的多个缓存。

可选 wait: boolean

一个布尔值，指示 Hono 是否应在继续请求之前等待 cache.put 函数的 Promise 解析。对于 Deno 环境，必须为 true。默认值为 false。

可选 cacheControl: string

Cache-Control 标头的指令字符串。有关更多信息，请参阅 MDN 文档。如果未提供此选项，则不会向请求添加 Cache-Control 标头。

可选 vary: string | string[]

在响应中设置 Vary 标头。如果原始响应标头已包含 Vary 标头，则将合并值，并删除任何重复项。将其设置为 * 将导致错误。有关 Vary 标头及其对缓存策略的影响的更多详细信息，请参阅 MDN 文档。

可选 keyGenerator: (c: Context) => string | Promise<string>

为 cacheName 存储中的每个请求生成密钥。这可用于根据请求参数或上下文参数缓存数据。默认值为 c.req.url。

可选 cacheableStatusCodes: number[]

应缓存的状态码数组。默认值为 [200]。使用此选项可缓存具有特定状态码的响应。

app.get(
  '*',
  cache({
    cacheName: 'my-app',
    cacheControl: 'max-age=3600',
    cacheableStatusCodes: [200, 404, 412],
  })
)