addRouteMiddleware

源文件
addRouteMiddleware() 是一个用于在应用中动态添加中间件的辅助函数。
路由中间件是存储在 Nuxt 应用 app/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）。

示例

命名路由中间件

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

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

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

全局路由中间件

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

  • 直接将函数作为第一个参数传入，无需命名。它将被自动视为全局中间件，并应用于每次路由变更。
    app/plugins/my-plugin.ts
    export default defineNuxtPlugin(() => {
  addRouteMiddleware((to, from) => {
    console.log('anonymous global middleware that runs on every route change')
  })
})
  • 设置可选的第三个参数 { global: true } 以指明该路由中间件是否为全局中间件。
    app/plugins/my-plugin.ts
    export default defineNuxtPlugin(() => {
  addRouteMiddleware('global-middleware', (to, from) => {
    console.log('global middleware that runs on every route change')
  },
  { global: true },
  )
})