生命周期钩子

Nuxt 提供了一个强大的钩子系统，可以通过钩子扩展几乎每个方面。

在 Docs > Guide > Going Further > Hooks 中查看详情

App 钩子（运行时）

查看 app 源代码以获取所有可用的钩子。

钩子	参数	环境	描述
`app:created`	`vueApp`	服务端与客户端	当创建初始 `vueApp` 实例时调用。
`app:error`	`err`	服务端与客户端	当发生致命错误时调用。
`app:error:cleared`	`{ redirect? }`	服务端与客户端	当发生致命错误时调用。
`vue:setup`	-	服务端与客户端	当初始化 Nuxt 根时调用。此回调必须是同步的。
`vue:error`	`err, target, info`	服务端与客户端	当 vue 错误向上传播到根组件时调用。了解更多。
`app:rendered`	`renderContext`	服务端	完成 SSR 渲染后调用。
`app:redirected`	-	服务端	在 SSR 重定向之前调用。
`app:beforeMount`	`vueApp`	客户端	在挂载应用之前调用，仅在客户端侧调用。
`app:mounted`	`vueApp`	客户端	当 Vue 应用在浏览器中初始化并挂载完成时调用。
`app:suspense:resolve`	`appComponent`	客户端	在 Suspense 解析事件发生时调用。
`app:manifest:update`	`{ id, timestamp }`	客户端	检测到你的应用有更新版本时调用。
`app:data:refresh`	`keys?`	客户端	当调用 `refreshNuxtData` 时调用。
`link:prefetch`	`to`	客户端	当观察到 `<NuxtLink>` 发生预取时调用。
`page:start`	`pageComponent?`	客户端	在 `NuxtPage` 内部的 Suspense pending 事件上调用。
`page:finish`	`pageComponent?`	客户端	在 `NuxtPage` 内部的 Suspense resolved 事件上调用。
`page:loading:start`	-	客户端	当开始进行路由导航（在解析之前）或当页面 key 发生变化时调用。如果页面被复用（例如在 `definePageMeta` 中使用静态 `key`），在页面组件的 `setup()` 不会重新运行的情况下也可能触发。
`page:loading:end`	-	客户端	在 `page:finish` 之后调用
`page:transition:finish`	`pageComponent?`	客户端	在页面过渡 onAfterLeave 事件之后调用。
`dev:ssr-logs`	`logs`	客户端	使用从服务器传递到客户端的日志数组调用（如果启用了 `features.devLogs`）。
`page:view-transition:start`	`transition`	客户端	当启用了实验性的 viewTransition 支持后、在调用 `document.startViewTransition` 之后调用。`transition` 参数是一个带有 `types` 属性的 `ViewTransition` 对象（`ViewTransitionTypeSet`），该属性可以读取或修改。

Nuxt 钩子（构建时）

查看 schema 源代码以获取所有可用钩子。

钩子	参数	描述
`kit:compatibility`	`compatibility, issues`	允许扩展兼容性检查。
`ready`	`nuxt`	在 Nuxt 初始化完成且 Nuxt 实例准备好工作时调用。
`close`	`nuxt`	Nuxt 实例正常关闭时调用。
`restart`	`{ hard?: boolean }`	用于重启当前 Nuxt 实例。
`modules:before`	-	在 Nuxt 初始化期间、安装用户模块之前调用。
`modules:done`	-	在 Nuxt 初始化期间、安装用户模块之后调用。
`module:before`	`module`	在设置每个单独的模块之前立即调用。
`module:done`	`module`	在每个单独的模块设置完成后立即调用，包括记录其耗时。
`app:resolve`	`app`	解析 `app` 实例后调用。
`app:templates`	`app`	在生成 `NuxtApp` 期间调用，用于自定义、修改或向构建目录添加新文件（可以是虚拟文件，也可以写入 `.nuxt`）。
`app:templatesGenerated`	`app`	模板编译到虚拟文件系统（vfs）后调用。
`build:before`	-	在 Nuxt bundle 构建器运行之前调用。
`build:done`	-	Nuxt bundle 构建器完成后调用。
`build:manifest`	`manifest`	在 Vite 和 webpack 构建 manifest 期间调用。这允许自定义 Nitro 将用于在最终 HTML 中渲染 `<script>` 和 `<link>` 标签的 manifest。
`builder:generateApp`	`options`	在生成应用之前调用。
`builder:watch`	`event, path`	在开发环境的构建时，当监视器发现项目中的文件或目录发生变化时调用。
`pages:extend`	`pages`	从文件系统扫描页面路由后调用。
`pages:resolved`	`pages`	页面路由通过扫描到的元数据扩展后调用。
`pages:routerOptions`	`{ files: Array<{ path: string, optional?: boolean }> }`	解析 `router.options` 文件时调用。数组中后面的项会覆盖前面的项。
`server:devHandler`	`handler`	在 Nitro 开发服务器上注册开发中间件时调用。
`imports:sources`	`presets`	在设置期间调用，允许模块扩展来源。
`imports:extend`	`imports`	在设置期间调用，允许模块扩展导入。
`imports:context`	`context`	创建 unimport 上下文时调用。
`imports:dirs`	`dirs`	允许扩展导入目录。
`components:dirs`	`dirs`	在 `app:resolve` 期间调用，允许扩展用于扫描可自动导入组件的目录。
`components:extend`	`components`	允许扩展新组件。
`nitro:config`	`nitroConfig`	在初始化 Nitro 之前调用，允许自定义 Nitro 的配置。
`nitro:init`	`nitro`	Nitro 初始化后调用，可用于注册 Nitro 钩子并直接与 Nitro 交互。
`nitro:build:before`	`nitro`	在构建 Nitro 实例之前调用。
`nitro:build:public-assets`	`nitro`	复制公共资源后调用。允许在构建 Nitro 服务器之前修改公共资源。
`prerender:routes`	`ctx`	允许扩展要预渲染的路由。
`build:error`	`error`	构建时发生错误时调用。
`prepare:types`	`options`	在 `@nuxt/cli` 写入 TypeScript 配置文件（`.nuxt/tsconfig.app.json`、`.nuxt/tsconfig.server.json` 等）和 `.nuxt/nuxt.d.ts` 之前调用，允许向 `nuxt.d.ts` 添加自定义引用和声明，或直接修改生成配置中的选项
`listen`	`listenerServer, listener`	开发服务器加载时调用。
`schema:extend`	`schemas`	允许扩展默认 schema。
`schema:resolved`	`schema`	允许扩展已解析的 schema。
`schema:beforeWrite`	`schema`	在写入给定 schema 之前调用。
`schema:written`	-	schema 写入后调用。
`vite:extend`	`viteBuildContext`	允许扩展 Vite 默认上下文。
`vite:extendConfig`	`viteInlineConfig, env`	允许扩展 Vite 默认配置。在 Nuxt 5+ 中已弃用。在 Nuxt 5 中，此钩子作用于共享配置，而不是单独的客户端／服务端配置。
`vite:configResolved`	`viteInlineConfig, env`	允许读取已解析的 Vite 配置。在 Nuxt 5+ 中已弃用。在 Nuxt 5 中，此钩子作用于共享配置，而不是单独的客户端／服务端配置。
`vite:serverCreated`	`viteServer, env`	Vite 服务器创建时调用。
`vite:compiled`	-	Vite 服务器编译完成后调用。
`webpack:config`	`webpackConfigs`	在配置 webpack 编译器之前调用。
`webpack:configResolved`	`webpackConfigs`	允许读取已解析的 webpack 配置。
`webpack:compile`	`options`	就在编译之前调用。
`webpack:compiled`	`options`	资源加载后调用。
`webpack:change`	`shortPath`	WebpackBar 上发生 `change` 时调用。
`webpack:error`	-	如果 WebpackBar 存在错误，在 `done` 时调用。
`webpack:done`	-	在 WebpackBar 上调用 `allDone` 时调用。
`webpack:progress`	`statesArray`	在 WebpackBar 上调用 `progress` 时调用。

Nitro 应用钩子（运行时，服务端）

参考 Nitro 获取所有可用钩子。

钩子	参数	描述	类型
`dev:ssr-logs`	`{ path, logs }`	服务器端	请求周期结束时调用，带有传递给客户端的服务器日志数组。
`render:response`	`response, { event }`	在发送响应之前调用。	response, event
`render:html`	`html, { event }`	在构建 HTML 之前调用。	html, event
`render:island`	`islandResponse, { event, islandContext }`	在构建 island HTML 之前调用。	islandResponse, event, islandContext
`close`	-	Nitro 关闭时调用。	-
`error`	`error, { event? }`	发生错误时调用。	error, event
`request`	`event`	收到请求时调用。	event
`beforeResponse`	`event, { body }`	发送响应前调用。	event, unknown
`afterResponse`	`event, { body }`	发送响应后调用。	event, unknown

报告问题或者在 GitHub 上编辑此页面

插件

Nuxt Kit 提供了一组实用工具来帮助你创建和使用插件。你可以使用这些函数将插件或插件模板添加到你的模块中。

导入 meta

使用 `import.meta` 了解你的代码在哪运行。