Custom Next.js Cache Handler
如果你想将缓存的页面和数据持久化到耐用存储中,或者在 Next.js 应用程序的多个容器或实例之间共享缓存,可以配置 Next.js 缓存位置。
next.config.js
module.exports = {
cacheHandler: require.resolve('./cache-handler.js'),
cacheMaxMemorySize: 0, // 禁用默认的内存缓存
}
查看自定义缓存处理器的示例并了解更多关于实现的信息。
API 参考
缓存处理器可以实现以下方法:get
、set
、revalidateTag
和 resetRequestCache
。
get()
参数 | 类型 | 描述 |
---|---|---|
key | string | 缓存值的键。 |
返回缓存的值或者如果未找到则返回 null
。
set()
参数 | 类型 | 描述 |
---|---|---|
key | string | 存储数据的键。 |
data | Data 或 null | 要缓存的数据。 |
ctx | { tags: [] } | 提供的缓存标签。 |
返回 Promise<void>
。
revalidateTag()
参数 | 类型 | 描述 |
---|---|---|
tag | string 或 string[] | 要重新验证的缓存标签。 |
返回 Promise<void>
。了解更多关于重新验证数据或revalidateTag()
函数的信息。
resetRequestCache()
此方法在下一个请求之前重置单个请求的临时内存缓存。
返回 void
。
值得注意的是:
revalidatePath
是缓存标签之上的便利层。调用revalidatePath
将调用你的revalidateTag
函数,然后你可以选择是否要基于路径标记缓存键。
平台支持
部署选项 | 支持情况 |
---|---|
Node.js 服务器 | 是 |
Docker 容器 | 是 |
静态导出 | 否 |
适配器 | 平台特定 |
了解如何在自托管 Next.js 时配置 ISR。
版本历史
版本 | 变更 |
---|---|
v14.1.0 | 重命名为 cacheHandler 并变为稳定版。 |
v13.4.0 | incrementalCacheHandlerPath 支持 revalidateTag 。 |
v13.4.0 | incrementalCacheHandlerPath 支持独立输出。 |
v12.2.0 | 引入实验性 incrementalCacheHandlerPath 。 |