v3.16
Nuxt on GitHub

addRouteMiddleware

源代码
addRouteMiddleware() 是一个辅助函数，用于在您的应用中动态添加中间件。
路由中间件是存储在 Nuxt 应用的 middleware/ 目录中的导航守卫（除非另行设置）。

类型

function addRouteMiddleware (name: string, middleware: RouteMiddleware, options?: AddRouteMiddlewareOptions): void
function addRouteMiddleware (middleware: RouteMiddleware): void

interface AddRouteMiddlewareOptions {
  global?: boolean
}

参数

name

  • 类型：string | RouteMiddleware

可以是字符串或 RouteMiddleware 类型的函数。函数以下一个路由 to 作为第一个参数，当前路由 from 作为第二个参数，两者均为 Vue 路由对象。

了解更多关于路由对象可用属性的信息。

middleware

  • 类型：RouteMiddleware

第二个参数是 RouteMiddleware 类型的函数。与上述相同，它提供 to 和 from 路由对象。如果 addRouteMiddleware() 的第一个参数已传入函数，则此参数变为可选。

options

  • 类型：AddRouteMiddlewareOptions

可选的 options 参数允许您将 global 设置为 true，以指示路由中间件是否为全局中间件（默认为 false）。

示例

命名路由中间件

命名路由中间件通过提供字符串作为第一个参数和函数作为第二个参数来定义：

plugins/my-plugin.ts
export default defineNuxtPlugin(() => {
  addRouteMiddleware('named-middleware', () => {
    console.log('在 Nuxt 插件中添加的命名中间件')
  })
})

在插件中定义时，它会覆盖 middleware/ 目录中任何同名的现有中间件。

全局路由中间件

全局路由中间件可以通过以下两种方式定义：

  • 直接将函数作为第一个参数传递，不带名称。它将自动被视为全局中间件，并在每次路由更改时应用。
    plugins/my-plugin.ts
    export default defineNuxtPlugin(() => {
  addRouteMiddleware((to, from) => {
    console.log('在每次路由更改时运行的匿名全局中间件')
  })
})
  • 设置可选的第三个参数 { global: true }，以指示路由中间件是否为全局中间件。
    plugins/my-plugin.ts
    export default defineNuxtPlugin(() => {
  addRouteMiddleware('global-middleware', (to, from) => {
      console.log('在每次路由更改时运行的全局中间件')
    },
    { global: true }
  )
})