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) => `Hello ${name}!`)

// Prints "Hello name!"
console.log(nuxtApp.$hello('name'))

如上例所示，$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', () => {
    /* your code goes here */
  })
  nuxtApp.hook('vue:error', (..._args) => {
    console.log('vue:error')
    // 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.ac.cn/api/application.html#application-api 中了解更多信息。

`ssrContext`

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

Nuxt 通过 ssrContext 公开了以下属性

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

`payload`

payload 将数据和状态变量从服务器端公开到客户端。在从服务器端传递后，以下键将在客户端可用

serverRendered (布尔值) - 指示响应是否已进行服务器端渲染。
data (对象) - 当您使用 useFetch 或 useAsyncData 从 API 端点获取数据时，结果负载可以从 payload.data 中访问。此数据被缓存，并且有助于防止在多次发出相同请求时重复获取相同的数据。
```
<script setup lang="ts">
const { data } = await useAsyncData('count', () => $fetch('/api/count'))
</script>
```
在使用上例中的 useAsyncData 获取 count 的值后，如果访问 payload.data，您将看到 { count: 1 } 记录在其中。
当从 ssrcontext 访问相同的 payload.data 时，您也可以在服务器端访问相同的值。

state (对象) - 当您在 Nuxt 中使用 useState 组合式函数设置共享状态时，此状态数据可以通过 payload.state.[name-of-your-state] 访问。

plugins/my-plugin.ts

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

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

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

观看 Alexander Lichter 关于序列化负载的视频，尤其是在涉及类的情况下。

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

plugins/date-time-payload.ts

/**
 * This kind of plugin runs very early in the Nuxt lifecycle, before we revive the payload.
 * You will not have access to the router or other Nuxt-injected properties.
 *
 * Note that the "DateTime" string is the type identifier and must
 * be the same on both the reducer and the reviver.
 */
export default definePayloadPlugin((nuxtApp) => {
  definePayloadReducer('DateTime', (value) => {
    return value instanceof DateTime && value.toJSON()
  })
  definePayloadReviver('DateTime', (value) => {
    return DateTime.fromISO(value)
  })
})

`isHydrating`

使用 nuxtApp.isHydrating (布尔值) 检查 Nuxt 应用是否正在客户端进行水合。

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()
    // the Vue/Nuxt compiler loses context here because of the try/catch block.
  } catch (e) {
    user = null
  }
  if (!user) {
    // apply the correct Nuxt context to our `navigateTo` call.
    return nuxtApp.runWithContext(() => navigateTo('/auth'))
  }
})

用法

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

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

runWithContext 将返回 functionWithContext 返回的任何内容。

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

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

// --- Vue internal ---
const _vueInstance = null
const getCurrentInstance = () => _vueInstance
// ---

// Vue / Nuxt sets a global variable referencing to current component in _vueInstance when calling setup()
async function setup() {
  getCurrentInstance() // Works
  await someAsyncOperation() // Vue unsets the context in same tick before async operation!
  getCurrentInstance() // null
}

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

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

const __instance = getCurrentInstance() // Generated by Vue compiler
getCurrentInstance() // Works!
await someAsyncOperation() // Vue unsets the context
__restoreInstance(__instance) // Generated by Vue compiler
getCurrentInstance() // Still works!

有关 Vue 实际执行的操作的更详细说明，请参阅 unjs/unctx#2 (comment)。

解决方案

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

Nuxt 在内部使用 unjs/unctx 来支持类似于 Vue 的插件和中间件的组合式 API。这使得像 navigateTo() 这样的组合式 API 可以在不直接将 nuxtApp 传递给它们的情况下工作——将组合式 API 的 DX 和性能优势带到整个 Nuxt 框架。

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

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

剩余问题

自动恢复上下文的 unjs/unctx 转换在包含 await 的 try/catch 语句中似乎存在错误，最终需要解决此问题才能消除对上述建议的解决方法的需求。

原生异步上下文

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

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

在文档 > 指南 > 进一步了解 > 实验性功能#asynccontext 中了解更多信息。

tryUseNuxtApp

此函数的工作原理与 useNuxtApp 完全相同，但在上下文不可用时返回 null 而不是抛出异常。

您可以将其用于不需要 nuxtApp 的组合式 API，或者只是在没有异常的情况下检查上下文是否可用。

示例用法

composable.ts

export function useStandType() {
  // Always works on the client
  if (tryUseNuxtApp()) {
    return useRuntimeConfig().public.STAND_TYPE
  } else {
    return process.env.STAND_TYPE
  }
}

useLoadingIndicator

此组合式 API 使您可以访问应用程序页面的加载状态。

useNuxtData

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