after
after
允许你安排在响应(或预渲染)完成后执行的工作。这对于不应阻塞响应的任务和其他副作用(如日志记录和分析)非常有用。
它可以在 Server Components(包括 generateMetadata
)、Server Actions、Route Handlers 和 Middleware 中使用。
该函数接受一个回调,该回调将在响应(或预渲染)完成后执行:
app/layout.tsx
TypeScript
import { after } from 'next/server'
// Custom logging function
import { log } from '@/app/utils'
export default function Layout({ children }: { children: React.ReactNode }) {
after(() => {
// Execute after the layout is rendered and sent to the user
log()
})
return <>{children}</>
}
值得注意的是:
after
不是 Dynamic API,调用它不会导致路由变为动态路由。如果它在静态页面中使用,回调将在构建时执行,或者在页面重新验证时执行。
参考
参数
- 一个回调函数,它将在响应(或预渲染)完成后执行。
持续时间
after
将按照平台对你的路由的默认或配置的最大持续时间运行。如果你的平台支持,你可以使用 maxDuration
路由段配置来配置超时限制。
值得注意的是
- 即使响应未能成功完成,
after
也会被执行。包括当抛出错误或调用notFound
或redirect
时。 - 你可以使用 React
cache
来去重after
内部调用的函数。 after
可以嵌套在其他after
调用中,例如,你可以创建包装after
调用的实用函数来添加额外功能。
替代方案
after
的用例是处理次要任务而不阻塞主要响应。它类似于使用平台的 waitUntil()
或从 promise 中移除 await
,但有以下区别:
waitUntil()
:接受一个 promise 并将任务排队在请求的生命周期内执行,而after
接受一个将在响应完成后执行的回调。- 移除
await
:在响应期间开始执行,这会使用资源。在无服务器环境中也不可靠,因为函数在发送响应后立即停止计算,可能会中断任务。
我们建议使用 after
,因为它在设计时考虑了其他 Next.js API 和上下文。
示例
与请求 API 一起使用
你可以在 Server Actions 和 Route Handlers 中的 after
内部使用请求 API,如 cookies
和 headers
。这对于在变更后记录活动很有用。例如:
app/api/route.ts
TypeScript
import { after } from 'next/server'
import { cookies, headers } from 'next/headers'
import { logUserAction } from '@/app/utils'
export async function POST(request: Request) {
// Perform mutation
// ...
// Log user activity for analytics
after(async () => {
const userAgent = (await headers().get('user-agent')) || 'unknown'
const sessionCookie =
(await cookies().get('session-id'))?.value || 'anonymous'
logUserAction({ sessionCookie, userAgent })
})
return new Response(JSON.stringify({ status: 'success' }), {
status: 200,
headers: { 'Content-Type': 'application/json' },
})
}
然而,你不能在 Server Components 中的 after
内部使用这些请求 API。这是因为 Next.js 需要知道树的哪个部分访问请求 API 以支持 Partial Prerendering,但 after
在 React 的渲染生命周期之后运行。
版本历史 | 描述 |
---|---|
v15.1.0 | after 变为稳定版。 |
v15.0.0-rc | 引入 unstable_after 。 |