类型

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）。

示例

命名路由中间件

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

export default defineNuxtPlugin(() => {
  addRouteMiddleware('named-middleware', () => {
    console.log('named middleware added in Nuxt plugin')
  })
})

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

全局路由中间件

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

• 直接将函数作为第一个参数传递而不指定名称。它将自动被视为全局中间件，并在每次路由更改时应用。

  plugins/my-plugin.ts

  export default defineNuxtPlugin(() => {
    addRouteMiddleware((to, from) => {
      console.log('anonymous global middleware that runs on every route change')
    })
  })
  

• 设置一个可选的第三个参数 { global: true }，以指示路由中间件是否为全局。

  plugins/my-plugin.ts

  export default defineNuxtPlugin(() => {
    addRouteMiddleware('global-middleware', (to, from) => {
        console.log('global middleware that runs on every route change')
      },
      { global: true }
    )
  })