---
title: "NuxtApp"
description: "在 Nuxt 中，您可以在组合函数、组件和插件中访问运行时应用上下文。"
canonical_url: "https://nuxt.zhcndoc.com/docs/3.x/guide/going-further/nuxt-app"
---
# NuxtApp

> 在 Nuxt 中，您可以在组合函数、组件和插件中访问运行时应用上下文。

在 Nuxt 中，您可以在组合函数、组件和插件中访问运行时应用上下文。

::read-more{to="https://v2.nuxt.com/docs/internals-glossary/context/#the-context" target="_blank"}
在 Nuxt 2 中，这被称为 **Nuxt 上下文**。
::

## Nuxt App 接口

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/guide/going-further/internals#the-nuxtapp-interface"}
跳转到 `NuxtApp` 接口文档。
::

## Nuxt 上下文

许多组合函数和工具，无论是内置还是用户自定义，可能需要访问 Nuxt 实例。这个实例并不存在于应用的每个地方，因为每个请求都会创建一个新的实例。

目前，Nuxt 上下文只能在 [插件](https://nuxt.zhcndoc.com/docs/3.x/directory-structure/plugins)、[Nuxt 钩子](https://nuxt.zhcndoc.com/docs/3.x/guide/going-further/hooks)、[Nuxt 中间件](https://nuxt.zhcndoc.com/docs/3.x/directory-structure/middleware)（如果使用 `defineNuxtRouteMiddleware` 包装）和[设置函数](https://vuejs.org/api/composition-api-setup)（在页面和组件中）中访问。

如果在无法访问上下文的情况下调用组合函数，您可能会收到一条错误消息：“需要访问 Nuxt 实例的组合函数是在插件、Nuxt 钩子、Nuxt 中间件或 Vue 设置函数之外调用的。”在这种情况下，您也可以使用 [`nuxtApp.runWithContext`](https://nuxt.zhcndoc.com/docs/3.x/api/composables/use-nuxt-app#runwithcontext) 在此上下文中显式调用函数。

## 访问 NuxtApp

在组合函数、插件和组件中，您可以通过 [`useNuxtApp()`](https://nuxt.zhcndoc.com/docs/3.x/api/composables/use-nuxt-app) 访问 `nuxtApp`：

```ts [composables/useMyComposable.ts]
export function useMyComposable () {
  const nuxtApp = useNuxtApp()
  // 访问运行时 nuxt 应用实例
}
```

如果您的组合函数不总是需要 `nuxtApp`，或者您只想检查它是否存在，因为 [`useNuxtApp`](https://nuxt.zhcndoc.com/docs/3.x/api/composables/use-nuxt-app) 会抛出异常，则可以改用 [`tryUseNuxtApp`](https://nuxt.zhcndoc.com/docs/3.x/api/composables/use-nuxt-app#tryusenuxtapp)。

插件中也会将 `nuxtApp` 作为第一个参数传入，使用起来更加方便。

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/directory-structure/plugins"}
::

## 提供辅助方法

您可以提供辅助方法，使其在所有组合函数和应用中都可用。这通常在 Nuxt 插件中完成。

```ts
const nuxtApp = useNuxtApp()
nuxtApp.provide('hello', name => `Hello ${name}!`)

console.log(nuxtApp.$hello('name')) // 输出 "Hello name!"
```

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/directory-structure/plugins#providing-helpers"}
可以通过在插件中返回带有 `provide` 键的对象来注入辅助方法。
::

::read-more{to="https://v2.nuxt.com/docs/directory-structure/plugins/#inject-in-root--context" target="_blank"}
在 Nuxt 2 插件中，这被称为 **inject 函数**。
::

---

- [源码](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/nuxt.ts)


## Sitemap

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