defineNuxtRouteMiddleware

源文件
使用 defineNuxtRouteMiddleware 辅助函数创建命名路由中间件。

路由中间件存储在 Nuxt 应用程序的 app/middleware/ 目录中（除非另有设置）。

类型

签名
export function defineNuxtRouteMiddleware (middleware: RouteMiddleware): RouteMiddleware

interface RouteMiddleware {
  (to: RouteLocationNormalized, from: RouteLocationNormalized): ReturnType<NavigationGuard>
}

参数

middleware

  • 类型：RouteMiddleware

一个函数，它接受两个 Vue Router 的路由位置对象作为参数：第一个是下一个路由 to，第二个是当前路由 from。

在 Vue Router 文档 中了解更多关于 RouteLocationNormalized 的可用属性。

示例

显示错误页面

您可以使用路由中间件来抛出错误并显示有用的错误消息

app/middleware/error.ts
export default defineNuxtRouteMiddleware((to) => {
  if (to.params.id === '1') {
    throw createError({ statusCode: 404, statusMessage: 'Page Not Found' })
  }
})

上述路由中间件将把用户重定向到 ~/error.vue 文件中定义的自定义错误页面，并暴露从中间件传递的错误消息和代码。

重定向

在路由中间件内部，结合使用 useState 和 navigateTo 辅助函数，根据用户的认证状态将他们重定向到不同的路由

app/middleware/auth.ts
export default defineNuxtRouteMiddleware((to, from) => {
  const auth = useState('auth')

  if (!auth.value.isAuthenticated) {
    return navigateTo('/login')
  }

  if (to.path !== '/dashboard') {
    return navigateTo('/dashboard')
  }
})

navigateTo 和 abortNavigation 都是全局可用的辅助函数，您可以在 defineNuxtRouteMiddleware 内部使用它们。