nuxt logo

文档翻译(非官方)

Nuxt 如何工作?

Nuxt 是一个构建 Web 应用程序的简约但高度可定制的框架。

本指南帮助您更好地理解 Nuxt 内部机制,以便在 Nuxt 之上开发新解决方案和模块集成。

Nuxt 接口

当您使用 nuxt dev 在开发模式下启动 Nuxt 或使用 nuxt build 构建生产应用程序时,会创建一个通用上下文,内部称为 nuxt。它包含与 nuxt.config 文件合并的标准化选项,一些内部状态,以及一个强大的由 unjs/hookable 提供支持的 钩子系统,允许不同组件相互通信。您可以将其视为 构建器核心

此上下文可通过 Nuxt Kit 组合函数在全局范围内使用。因此,每个进程只允许运行一个 Nuxt 实例。

要扩展 Nuxt 接口并挂钩到构建过程的不同阶段,我们可以使用 Nuxt 模块

有关更多详细信息,请查看源代码

NuxtApp 接口

在浏览器或服务器上渲染页面时,会创建一个共享上下文,称为 nuxtApp。此上下文保留 Vue 实例、运行时钩子和内部状态,如 ssrContext 和用于 hydration 的 payload。您可以将其视为 运行时核心

此上下文可以在 Nuxt 插件和 <script setup> 以及 Vue 组合函数中使用 useNuxtApp() 组合函数进行访问。浏览器可以全局使用,但服务器上不行,以避免在用户之间共享上下文。

由于如果当前上下文不可用,useNuxtApp 会抛出异常,因此如果您的组合函数并不总是需要 nuxtApp,可以使用 tryUseNuxtApp 代替,它将返回 null 而不是抛出异常。

要扩展 nuxtApp 接口并挂钩到不同阶段或访问上下文,我们可以使用 Nuxt 插件

有关此接口的更多信息,请查看 Nuxt App

nuxtApp 具有以下属性:

const nuxtApp = {
  vueApp, // 全局 Vue 应用程序: https://vuejs.org/api/application.html#application-api

  versions, // 包含 Nuxt 和 Vue 版本的对象

  // 这些允许您调用和添加运行时 NuxtApp 钩子
  // https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts#L18
  hooks,
  hook,
  callHook,

  // 仅在服务器端可访问
  ssrContext: {
    url,
    req,
    res,
    runtimeConfig,
    noSSR,
  },

  // 这将被字符串化并从服务器传递到客户端
  payload: {
    serverRendered: true,
    data: {},
    state: {}
  }

  provide: (name: string, value: any) => void
}

有关更多详细信息,请查看源代码

运行时上下文 vs. 构建上下文

Nuxt 使用 Node.js 构建和打包项目,但也有运行时部分。

虽然这两个区域都可以扩展,但运行时上下文与构建时是隔离的。因此,除了运行时配置外,它们不应共享状态、代码或上下文!

nuxt.configNuxt 模块 可用于扩展构建上下文,而 Nuxt 插件 可用于扩展运行时。

在为生产构建应用程序时,nuxt build 将在 .output 目录中生成一个独立构建,与 nuxt.configNuxt 模块 无关。