useNuxtApp

访问 Nuxt 应用程序的共享运行时上下文。

useNuxtApp 是一个内置的组合函数，提供了一种访问 Nuxt 共享运行时上下文（也称为 Nuxt 上下文）的方法，该上下文在客户端和服务器端均可用（但在 Nitro 路由中不可用）。它帮助您访问 Vue 应用程序实例、运行时钩子、运行时配置变量和内部状态，例如 ssrContext 和 payload。

app.vue

<script setup lang="ts">
const nuxtApp = useNuxtApp()
</script>

如果在您的作用域中无法获取运行时上下文，调用 useNuxtApp 将抛出异常。您可以改用 tryUseNuxtApp 来处理不需要 nuxtApp 的组合函数，或者仅检查上下文是否可用而不抛出异常。

方法

`provide (name, value)`

nuxtApp 是一个运行时上下文，您可以使用 Nuxt 插件进行扩展。使用 provide 函数创建 Nuxt 插件，以在您的 Nuxt 应用程序中的所有组合函数和组件中提供值和辅助方法。

provide 函数接受 name 和 value 参数。

const nuxtApp = useNuxtApp()
nuxtApp.provide('hello', (name) => `你好 ${name}！`)

// 打印 "你好 名字！"
console.log(nuxtApp.$hello('名字'))

如上例所示，$hello 已成为 nuxtApp 上下文的新自定义部分，并且在所有可访问 nuxtApp 的地方都可用。

`hook(name, cb)`

nuxtApp 中可用的钩子允许您自定义 Nuxt 应用程序的运行时行为。您可以在 Vue.js 组合函数和 Nuxt 插件中使用运行时钩子来介入渲染生命周期。

hook 函数适用于通过在渲染生命周期的特定点挂钩来添加自定义逻辑。hook 函数主要用于创建 Nuxt 插件。

查看运行时钩子以了解 Nuxt 调用的可用运行时钩子。

plugins/test.ts

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.hook('page:start', () => {
    /* 您的代码写在这里 */
  })
  nuxtApp.hook('vue:error', (..._args) => {
    console.log('vue:错误')
    // if (import.meta.client) {
    //   console.log(..._args)
    // }
  })
})

`callHook(name, ...args)`

callHook 在调用任何现有钩子时返回一个 Promise。

await nuxtApp.callHook('my-plugin:init')

属性

useNuxtApp() 暴露以下属性，您可以使用它们来扩展和自定义您的应用程序，并共享状态、数据和变量。

`vueApp`

vueApp 是全局 Vue.js 应用程序实例，您可以通过 nuxtApp 访问它。

一些有用的方法：

component() - 如果同时传递名称字符串和组件定义，则注册全局组件；如果仅传递名称，则检索已注册的组件。
directive() - 如果同时传递名称字符串和指令定义，则注册全局自定义指令；如果仅传递名称，则检索已注册的指令（示例）。
use() - 安装 Vue.js 插件（示例）。

阅读更多 https://vuejs.org/api/application.html#application-api.

`ssrContext`

ssrContext 在服务器端渲染期间生成，仅在服务器端可用。

Nuxt 通过 ssrContext 暴露以下属性：

url (string) - 当前请求的 URL。
event (unjs/h3 请求事件) - 访问当前路由的请求和响应。
payload (object) - NuxtApp 的负载对象。

`payload`

payload 将服务器端的数据和状态变量暴露给客户端。从服务器端传递后，以下键将在客户端可用：

serverRendered (boolean) - 指示响应是否由服务器端渲染。
data (object) - 当您使用 useFetch 或 useAsyncData 从 API 端点获取数据时，生成的负载可以通过 payload.data 访问。此数据会被缓存，帮助您避免重复获取相同数据的请求。
```
<script setup lang="ts">
const { data } = await useAsyncData('count', () => $fetch('/api/count'))
</script>
```
```
export default defineEventHandler(event => {
  return { count: 1 }
})
```
在上述示例中，使用 useAsyncData 获取 count 值后，如果您访问 payload.data，将看到记录的 { count: 1 }。
当通过 ssrcontext 访问相同的 payload.data 时，您也可以在服务器端访问相同的值。

state (object) - 当您在 Nuxt 中使用 useState 组合函数设置共享状态时，此状态数据通过 payload.state.[您的状态名称] 访问。

plugins/my-plugin.ts

export const useColor = () => useState<string>('color', () => '粉色')

export default defineNuxtPlugin((nuxtApp) => {
  if (import.meta.server) {
    const color = useColor()
  }
})

还可以使用更高级的类型，例如 ref、reactive、shallowRef、shallowReactive 和 NuxtError。
自 Nuxt v3.4 起，可以为 Nuxt 不支持的类型定义自己的 reducer/reviver。

在下面的示例中，我们为 Luxon DateTime 类定义了一个 reducer（或序列化器）和一个 reviver（或反序列化器），使用负载插件。

plugins/date-time-payload.ts

/**
 * 这种插件在 Nuxt 生命周期中很早就运行，在恢复负载之前。
 * 您无法访问路由器或其他 Nuxt 注入的属性。
 *
 * 请注意，“DateTime”字符串是类型标识符，
 * 在 reducer 和 reviver 中必须相同。
 */
export default definePayloadPlugin((nuxtApp) => {
  definePayloadReducer('DateTime', (value) => {
    return value instanceof DateTime && value.toJSON()
  })
  definePayloadReviver('DateTime', (value) => {
    return DateTime.fromISO(value)
  })
})

`isHydrating`

使用 nuxtApp.isHydrating (boolean) 检查 Nuxt 应用程序是否正在客户端进行 hydration。

components/nuxt-error-boundary.ts

export default defineComponent({
  setup (_props, { slots, emit }) {
    const nuxtApp = useNuxtApp()
    onErrorCaptured((err) => {
      if (import.meta.client && !nuxtApp.isHydrating) {
        // ...
      }
    })
  }
})

`runWithContext`

您可能因为收到“Nuxt 实例不可用”消息而来到这里。请谨慎使用此方法，并报告导致问题的示例，以便最终在框架层面解决问题。

runWithContext 方法用于调用一个函数并为其提供显式的 Nuxt 上下文。通常，Nuxt 上下文是隐式传递的，您无需担心这一点。然而，在中间件/插件中处理复杂的 async/await 场景时，您可能会遇到在异步调用后当前实例被取消设置的情况。

middleware/auth.ts

export default defineNuxtRouteMiddleware(async (to, from) => {
  const nuxtApp = useNuxtApp()
  let user
  try {
    user = await fetchUser()
    // 由于 try/catch 块，Vue/Nuxt 编译器在这里丢失了上下文。
  } catch (e) {
    user = null
  }
  if (!user) {
    // 为我们的 `navigateTo` 调用应用正确的 Nuxt 上下文。
    return nuxtApp.runWithContext(() => navigateTo('/auth'))
  }
})

用法

const result = nuxtApp.runWithContext(() => functionWithContext())

functionWithContext：任何需要当前 Nuxt 应用程序上下文的函数。此上下文将自动正确应用。

runWithContext 将返回 functionWithContext 返回的内容。

上下文的深入解释

Vue.js 组合 API（以及类似的 Nuxt 组合函数）依赖于隐式上下文。在生命周期中，Vue 将当前组件的临时实例（以及 Nuxt 的临时 nuxtApp 实例）设置为全局变量，并在同一 tick 中取消设置。在服务器端渲染时，来自不同用户的多个请求和 nuxtApp 在同一全局上下文中运行。因此，Nuxt 和 Vue 会立即取消此全局实例，以避免在两个用户或组件之间泄露共享引用。

这意味着什么？组合 API 和 Nuxt 组合函数仅在生命周期内和任何异步操作之前的同一 tick 中可用：

// --- Vue 内部 ---
const _vueInstance = null
const getCurrentInstance = () => _vueInstance
// ---

// Vue / Nuxt 在调用 setup() 时将引用当前组件的全局变量设置为 _vueInstance
async function setup() {
  getCurrentInstance() // 有效
  await someAsyncOperation() // Vue 在异步操作之前取消上下文！
  getCurrentInstance() // null
}

经典的解决方案是第一次调用时将当前实例缓存到局部变量，例如 const instance = getCurrentInstance()，并在下一次组合函数调用中使用它，但问题在于任何嵌套的组合函数调用现在需要显式接受实例作为参数，而不依赖于组合 API 的隐式上下文。这是组合函数的设计限制，而不是问题本身。

为了克服这一限制，Vue 在编译我们的应用程序代码时做了一些幕后工作，并在 <script setup> 的每次调用后恢复上下文：

const __instance = getCurrentInstance() // 由 Vue 编译器生成
getCurrentInstance() // 有效！
await someAsyncOperation() // Vue 取消上下文
__restoreInstance(__instance) // 由 Vue 编译器生成
getCurrentInstance() // 仍然有效！

有关 Vue 实际操作的更详细描述，请参阅 unjs/unctx#2 (评论)。

解决方案

这就是 runWithContext 的用武之地，它可以用来恢复上下文，类似于 <script setup> 的工作方式。

Nuxt 内部使用 unjs/unctx 来支持类似于 Vue 的插件和中间件的组合函数。这使得像 navigateTo() 这样的组合函数无需直接传递 nuxtApp 即可工作——将组合 API 的开发体验和性能优势带入整个 Nuxt 框架。

Nuxt 组合函数与 Vue 组合 API 具有相同的设计，因此需要类似的解决方案来神奇地进行这种转换。查看 unjs/unctx#2（提案）、unjs/unctx#4（转换实现）和 nuxt/framework#3884（Nuxt 集成）。

Vue 目前仅为 <script setup> 支持异步上下文恢复以用于 async/await。在 Nuxt 中，添加了对 defineNuxtPlugin() 和 defineNuxtRouteMiddleware() 的转换支持，这意味着当您使用它们时，Nuxt 会自动进行上下文恢复转换。

剩余问题

unjs/unctx 转换用于自动恢复上下文，在包含 await 的 try/catch 语句中似乎存在 bug，最终需要解决以消除上述解决方法的需要。

原生异步上下文

使用新的实验性功能，可以通过 Node.js AsyncLocalStorage 和新的 unctx 支持启用原生异步上下文支持，使异步上下文原生地对任何嵌套异步组合函数可用，而无需转换或手动传递/调用上下文。

原生异步上下文支持目前在 Bun 和 Node 中有效。

阅读更多 Docs > Guide > Going Further > Experimental Features#asynccontext.

tryUseNuxtApp

此函数与 useNuxtApp 的工作方式完全相同，但如果上下文不可用，则返回 null，而不是抛出异常。

您可以将其用于不需要 nuxtApp 的组合函数，或者仅检查上下文是否可用而不抛出异常。

示例用法：

composable.ts

export function useStandType() {
  // 在客户端始终有效
  if (tryUseNuxtApp()) {
    return useRuntimeConfig().public.STAND_TYPE
  } else {
    return process.env.STAND_TYPE
  }
}

Report an issue or Edit this page on GitHub

useLoadingIndicator

此可组合函数为您提供对应用页面加载状态的访问。

useNuxtData

访问数据获取组合式函数当前的缓存值。

useNuxtApp

观看 Alexander Lichter 关于序列化负载的视频，特别是关于类的部分