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。

了解更多关于 RouteLocationNormalized 可用属性的信息，请参阅 Vue Router 文档。

示例

显示错误页面

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

app/middleware/error.ts
export default defineNuxtRouteMiddleware((to) => {
  if (to.params.id === '1') {
    throw createError({ status: 404, statusText: '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 中使用它们。