revalidatePath

revalidatePath 允许您按需清除特定路径的缓存数据。

需要了解:

revalidatePath 在Node.js 和 Edge 运行时中都可用。

只有在访问包含的路径时，revalidatePath 才会使缓存失效。这意味着使用动态路由段调用 revalidatePath 不会立即触发多次重新验证。失效仅在下次访问该路径时发生。

目前，revalidatePath 会使客户端路由器缓存中的所有路由失效。此行为是临时的，将来会更新为仅应用于特定路径。

使用 revalidatePath 仅使服务器端路由缓存中的**特定路径**失效。

参数

revalidatePath(path: string, type?: 'page' | 'layout'): void;

path：表示要重新验证的数据关联的文件系统路径的字符串（例如，/product/[slug]/page），或文字路由段（例如，/product/123）。必须少于 1024 个字符。此值区分大小写。
type：（可选）'page' 或 'layout' 字符串，用于更改要重新验证的路径类型。如果 path 包含动态段（例如，/product/[slug]/page），则需要此参数。如果 path 指的是文字路由段，例如动态页面的 /product/1（例如，/product/[slug]/page），则不应提供 type。

返回值

revalidatePath 不返回值。

示例

重新验证特定 URL

import { revalidatePath } from 'next/cache'
revalidatePath('/blog/post-1')

这将在下次访问页面时重新验证一个特定的 URL。

重新验证页面路径

import { revalidatePath } from 'next/cache'
revalidatePath('/blog/[slug]', 'page')
// or with route groups
revalidatePath('/(main)/blog/[slug]', 'page')

这将在下次访问页面时重新验证与提供的 page 文件匹配的任何 URL。这**不会**使特定页面下方的页面失效。例如，/blog/[slug] 不会使 /blog/[slug]/[author] 失效。

重新验证布局路径

import { revalidatePath } from 'next/cache'
revalidatePath('/blog/[slug]', 'layout')
// or with route groups
revalidatePath('/(main)/post/[slug]', 'layout')

这将在下次访问页面时重新验证与提供的 layout 文件匹配的任何 URL。这将导致具有相同布局的下方页面在下次访问时重新验证。例如，在上述情况下，/blog/[slug]/[another] 也将在下次访问时重新验证。

重新验证所有数据

import { revalidatePath } from 'next/cache'
 
revalidatePath('/', 'layout')

这将清除客户端路由缓存，并在下次访问页面时重新验证数据缓存。

服务器操作

app/actions.ts

'use server'
 
import { revalidatePath } from 'next/cache'
 
export default async function submit() {
  await submitForm()
  revalidatePath('/')
}

路由处理器

app/api/revalidate/route.ts

import { revalidatePath } from 'next/cache'
import type { NextRequest } from 'next/server'
 
export async function GET(request: NextRequest) {
  const path = request.nextUrl.searchParams.get('path')
 
  if (path) {
    revalidatePath(path)
    return Response.json({ revalidated: true, now: Date.now() })
  }
 
  return Response.json({
    revalidated: false,
    now: Date.now(),
    message: 'Missing path to revalidate',
  })
}

这有帮助吗？