---
title: "生命周期钩子"
description: "Nuxt 提供了一个强大的钩子系统，可以通过钩子扩展几乎每个方面。"
canonical_url: "https://nuxt.zhcndoc.com/docs/4.x/guide/going-further/hooks"
---
# 生命周期钩子

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

<tip>

钩子系统由 [unjs/hookable](https://github.com/unjs/hookable) 提供支持。

</tip>

## Nuxt 钩子（构建时）

这些钩子可用于 [Nuxt 模块](https://nuxt.zhcndoc.com/docs/4.x/guide/modules) 和构建上下文。

### 在 `nuxt.config.ts` 内

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  hooks: {
    close: () => { },
  },
})
```

### 在 Nuxt 模块中

```js
import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options, nuxt) {
    nuxt.hook('close', async () => { })
  },
})
```

<read-more to="https://nuxt.zhcndoc.com/docs/4.x/api/advanced/hooks#nuxt-hooks-build-time">

探索所有可用的 Nuxt 钩子。

</read-more>

## 应用钩子（运行时）

应用钩子主要可由 [Nuxt 插件](https://nuxt.zhcndoc.com/docs/4.x/directory-structure/app/plugins) 用于接入渲染生命周期，但也可以在 Vue 组合式函数中使用。

```ts [app/plugins/test.ts]
export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('page:start', () => {
    /* 你的代码写在这里 */
  })
})
```

<read-more to="https://nuxt.zhcndoc.com/docs/4.x/api/advanced/hooks#app-hooks-runtime">

探索所有可用的应用钩子。

</read-more>

## 服务器钩子（运行时）

这些钩子可用于 [服务器插件](https://nuxt.zhcndoc.com/docs/4.x/directory-structure/server#server-plugins)，以接入 Nitro 的运行时行为。

```ts [~~/server/plugins/test.ts]
export default defineNitroPlugin((nitroApp) => {
  nitroApp.hooks.hook('render:html', (html, { event }) => {
    console.log('render:html', html)
    html.bodyAppend.push('<hr>由自定义插件追加')
  })

  nitroApp.hooks.hook('render:response', (response, { event }) => {
    console.log('render:response', response)
  })
})
```

<read-more to="https://nuxt.zhcndoc.com/docs/4.x/api/advanced/hooks#nitro-app-hooks-runtime-server-side">

详细了解可用的 Nitro 生命周期钩子。

</read-more>

## 添加自定义钩子

你可以通过扩展 Nuxt 的钩子接口来定义自定义钩子支持。

```ts
import type { HookResult } from '@nuxt/schema'

declare module '#app' {
  interface RuntimeNuxtHooks {
    'your-nuxt-runtime-hook': () => HookResult
  }
  interface NuxtHooks {
    'your-nuxt-hook': () => HookResult
  }
}

declare module 'nitropack/types' {
  interface NitroRuntimeHooks {
    'your-nitro-hook': () => void
  }
}
```


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.