middleware

Nuxt 提供中间件功能，可在导航到特定路由前运行代码。

Nuxt 提供了一个可定制的路由中间件框架，可在整个应用程序中使用，非常适合提取你希望在导航到特定路由前运行的代码。

路由中间件有三种类型

  1. 匿名（或内联）路由中间件直接在页面中定义。
  2. 命名路由中间件，放置在 app/middleware/ 目录下，使用时通过异步导入自动加载到页面中。
  3. 全局路由中间件，放置在 app/middleware/ 目录下，文件名带有 .global 后缀，在每次路由更改时都会运行。

前两种路由中间件可以在 definePageMeta 中定义。

中间件名称会规范化为 kebab-case：myMiddleware 变为 my-middleware。
路由中间件在 Nuxt 应用的 Vue 部分中运行。尽管名称相似，但它们与 Nitro 服务器部分中运行的 服务器中间件 完全不同。

使用

路由中间件是导航守卫，接收当前路由和下一个路由作为参数。

middleware/my-middleware.ts
export default defineNuxtRouteMiddleware((to, from) => {
  if (to.params.id === '1') {
    return abortNavigation()
  }
  // In a real app you would probably not redirect every route to `/`
  // however it is important to check `to.path` before redirecting or you
  // might get an infinite redirect loop
  if (to.path !== '/') {
    return navigateTo('/')
  }
})

Nuxt 提供了两个全局可用的辅助函数，可以直接从中间件返回。

  1. navigateTo - 重定向到给定的路由
  2. abortNavigation - 中止导航，并带有可选的错误消息。

与vue-router中的导航守卫不同，不会传递第三个 next() 参数，重定向或路由取消是通过从中件件返回一个值来处理的。

可能的返回值有

  • 无（一个简单的 return 或完全没有返回）- 不会阻止导航，如果存在，将移至下一个中间件函数，否则完成路由导航
  • return navigateTo('/') - 重定向到给定的路径，并将重定向代码设置为302 找到 (Found)如果重定向发生在服务器端
  • return navigateTo('/', { redirectCode: 301 }) - 重定向到给定的路径，并将重定向代码设置为301 永久移动 (Moved Permanently)如果重定向发生在服务器端
  • return abortNavigation() - 停止当前导航
  • return abortNavigation(error) - 以错误拒绝当前导航
在 文档 > 4.x > API > 实用工具 > Navigate To 中阅读更多信息。
在 文档 > 4.x > API > 实用工具 > Abort Navigation 中阅读更多信息。
我们建议使用上述辅助函数来执行重定向或停止导航。在vue-router 文档中描述的其他可能返回值可能有效，但在未来可能会有破坏性更改。

中间件顺序

中间件按以下顺序运行

  1. 全局中间件
  2. 页面定义的中间件顺序（如果有多个中间件使用数组语法声明）

例如，假设你有以下中间件和组件

app/middleware/ 目录
-| middleware/
---| analytics.global.ts
---| setup.global.ts
---| auth.ts
pages/profile.vue
<script setup lang="ts">
definePageMeta({
  middleware: [
    function (to, from) {
      // Custom inline middleware
    },
    'auth',
  ],
})
</script>

你可以预期中间件按以下顺序运行

  1. analytics.global.ts
  2. setup.global.ts
  3. 自定义内联中间件
  4. auth.ts

全局中间件排序

默认情况下，全局中间件按文件名按字母顺序执行。

然而，有时你可能想定义一个特定的顺序。例如，在最后一种情况下，setup.global.ts 可能需要在 analytics.global.ts 之前运行。在这种情况下，我们建议在全局中间件前加上“字母”编号前缀。

目录结构
-| middleware/
---| 01.setup.global.ts
---| 02.analytics.global.ts
---| auth.ts
如果你不熟悉“字母”编号，请记住文件名是作为字符串排序的，而不是作为数值。例如，10.new.global.ts 会排在 2.new.global.ts 之前。这就是示例在个位数前加 0 的原因。

中间件何时运行

如果你的网站是服务端渲染或生成的，初始页面的中间件将在页面渲染时执行一次，然后在客户端再次执行一次。如果你的中间件需要浏览器环境（例如，如果你有一个生成站点、积极缓存响应或想从本地存储中读取值），这可能是必需的。

然而，如果你想避免这种行为，可以这样做

middleware/example.ts
export default defineNuxtRouteMiddleware((to) => {
  // skip middleware on server
  if (import.meta.server) {
    return
  }
  // skip middleware on client side entirely
  if (import.meta.client) {
    return
  }
  // or only skip middleware on initial client load
  const nuxtApp = useNuxtApp()
  if (import.meta.client && nuxtApp.isHydrating && nuxtApp.payload.serverRendered) {
    return
  }
})

即使你在服务器上的中间件中抛出错误并渲染了错误页面，这仍然成立。中间件仍将在浏览器中再次运行。

渲染错误页面是完全独立的页面加载，这意味着任何注册的中间件都将再次运行。你可以在中间件中使用 useError 来检查是否正在处理错误。

在中间件中访问路由

在中间件中访问下一个和上一个路由时，请始终使用 to 和 from 参数。完全避免在此上下文中使用 useRoute() 合成函数。在中间件上下文中，不存在“当前路由”的概念，因为中间件可能会中止导航或重定向到其他路由。useRoute() 合成函数在此上下文中将始终不准确。

有时，你可能会调用一个内部使用 useRoute() 的合成函数，即使你的中间件中没有直接调用，这也会触发此警告。这会导致与上述相同的问题，因此当函数在中间件中使用时，你应该将函数的结构改为接受路由作为参数。
export default defineNuxtRouteMiddleware((to) => {
  // passing the route to the function to avoid calling `useRoute()` in middleware
  doSomethingWithRoute(to)

  // ❌ this will output a warning and is NOT recommended
  callsRouteInternally()
})

动态添加中间件

可以使用 addRouteMiddleware() 辅助函数手动添加全局或命名路由中间件，例如从插件中添加。

export default defineNuxtPlugin(() => {
  addRouteMiddleware('global-test', () => {
    console.log('this global middleware was added in a plugin and will be run on every route change')
  }, { global: true })

  addRouteMiddleware('named-test', () => {
    console.log('this named middleware was added in a plugin and would override any existing middleware of the same name')
  })
})

示例

目录结构
-| middleware/
---| auth.ts

在你的页面文件中，你可以引用此路由中间件

<script setup lang="ts">
definePageMeta({
  middleware: ['auth'],
  // or middleware: 'auth'
})
</script>

现在，在导航到该页面完成之前，auth 路由中间件将被运行。

在 文档 > 4.x > 示例 > 路由 > 中间件 中阅读和编辑实时示例。

在构建时设置中间件

与其在每个页面上使用 definePageMeta，你可以在 pages:extend 钩子中添加命名路由中间件。

nuxt.config.ts
import type { NuxtPage } from 'nuxt/schema'

export default defineNuxtConfig({
  hooks: {
    'pages:extend' (pages) {
      function setMiddleware (pages: NuxtPage[]) {
        for (const page of pages) {
          if (/* some condition */ Math.random() > 0.5) {
            page.meta ||= {}
            // Note that this will override any middleware set in `definePageMeta` in the page
            page.meta.middleware = ['named']
          }
          if (page.children) {
            setMiddleware(page.children)
          }
        }
      }
      setMiddleware(pages)
    },
  },
})