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 和 payload。您可以将其视为 运行时核心

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

由于如果上下文当前不可用,useNuxtApp 会抛出异常,如果您的可组合项并非总是需要 nuxtApp,您可以改用 tryUseNuxtApp,它将返回 null 而不是抛出异常。

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

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

nuxtApp 具有以下属性

interface NuxtApp {
  vueApp // the global Vue application: https://vuejs.ac.cn/api/application.html#application-api

  versions // an object containing Nuxt and Vue versions

  // These let you call and add runtime NuxtApp hooks
  // https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts#L18
  hooks
  hook
  callHook

  // Only accessible on server-side
  ssrContext: {
    url
    req
    res
    runtimeConfig
    noSSR
  }

  // This will be stringified and passed from server to client
  payload: {
    serverRendered: true
    data: {}
    state: {}
  }

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

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

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

Nuxt 使用 Node.js 构建和捆绑项目,但也有一个运行时部分。

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

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

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