addRouteMiddleware
addRouteMiddleware() 是一个辅助函数,用于在应用程序中动态添加中间件。
路由中间件是存储在 Nuxt 应用程序的
middleware/
目录中的导航守卫(除非另行设置)。类型
addRouteMiddleware (name: string | RouteMiddleware, middleware?: RouteMiddleware, options: AddRouteMiddlewareOptions = {})
参数
名称
- 类型:
string
|RouteMiddleware
可以是字符串或类型为 RouteMiddleware
的函数。函数将下一个路由 to
作为第一个参数,将当前路由 from
作为第二个参数,两者都是 Vue 路由对象。
了解更多关于路由对象可用属性的信息。
中间件
- 类型:
RouteMiddleware
第二个参数是类型为 RouteMiddleware
的函数。与上面相同,它提供了 to
和 from
路由对象。如果 addRouteMiddleware()
中的第一个参数已作为函数传递,则它将成为可选参数。
选项
- 类型:
AddRouteMiddlewareOptions
可选的 options
参数允许您将 global
的值设置为 true
以指示路由中间件是全局的还是非全局的(默认设置为 false
)。
示例
匿名路由中间件
匿名路由中间件没有名称。它将函数作为第一个参数,使第二个 middleware
参数冗余。
plugins/my-plugin.ts
export default defineNuxtPlugin(() => {
addRouteMiddleware((to, from) => {
if (to.path === '/forbidden') {
return false
}
})
})
命名路由中间件
命名路由中间件将字符串作为第一个参数,将函数作为第二个参数。
在插件中定义时,它会覆盖位于 middleware/
目录中任何具有相同名称的现有中间件。
plugins/my-plugin.ts
export default defineNuxtPlugin(() => {
addRouteMiddleware('named-middleware', () => {
console.log('named middleware added in Nuxt plugin')
})
})
全局路由中间件
设置一个可选的第三个参数 { 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 }
)
})