title: 使用 defineNuxtRouteMiddleware 创建路由中间件

date: 2024/8/10

updated: 2024/8/10

author: cmdragon

excerpt:

本篇文章介绍了如何使用 defineNuxtRouteMiddleware 创建和应用路由中间件。通过示例演示了如何处理错误页面和身份验证逻辑。随着对 Nuxt.js 中间件的理解，你可以更灵活地控制应用的路由行为，从而提升用户体验。

categories:

前端开发

tags:

Nuxt3
路由
中间件
错误处理
认证
重定向
定制逻辑

扫描二维码关注或者微信搜一搜：编程智域前端至全栈交流与成长

使用 defineNuxtRouteMiddleware 创建路由中间件

在 Nuxt.js 中，路由中间件是一种强大的机制，可以在路由进入之前处理特定的逻辑。例如，你可以根据用户的身份验证状态来重定向用户，或者在某些条件不满足时显示错误页面。

什么是路由中间件？

路由中间件是一个函数，它在路由变化之前执行，允许我们在访问特定页面时添加逻辑。它可以帮助你进行身份验证、授权检查、日志记录等。

路由中间件的结构

路由中间件的基本结构如下所示：

javascript 复制代码

const middleware = (to, from) => {
  // 处理逻辑
};

export default defineNuxtRouteMiddleware(middleware);

to：下一个路由的位置对象。
from：当前路由的位置对象。

创建和使用路由中间件

1. 显示错误页面的中间件

我们首先创建一个中间件，用于检测特定条件并显示错误页面。如果参数 id 存在且为 1，我们将抛出一个404错误。

创建 `middleware/error.ts`

javascript 复制代码

export default defineNuxtRouteMiddleware((to) => {
  if (to.params.id === '1') {
    throw createError({ statusCode: 404, statusMessage: '页面未找到' });
  }
});

在这个例子中，如果用户访问的路由包含参数 id 且其值为 1，则抛出一个404的错误，Nuxt会自动重定向到定义的错误页面。

2. 基于身份验证状态的重定向

接下来，我们创建一个中间件，用于检查用户是否已经经过身份验证。如果没有验证，用户将被重定向到登录页面。

创建 `middleware/auth.ts`

javascript 复制代码

export default defineNuxtRouteMiddleware((to, from) => {
  const auth = useState('auth');

  // 检查用户是否登录
  if (!auth.value.isAuthenticated) {
    return navigateTo('/login'); // 重定向到登录页面
  }

  // 如果用户不在仪表盘页面，则重定向到仪表盘
  if (to.path !== '/dashboard') {
    return navigateTo('/dashboard');
  }
});

在上面的代码中，我们使用 useState 获取用户的身份验证状态。如果用户没有登录，我们使用 navigateTo 进行重定向，导向 /login 页面。如果用户不在仪表盘页面，我们也将其重定向到仪表盘。

中间件的注册

在创建好中间件后，Nuxt 会自动识别在 middleware/ 目录下的中间件文件。你可以通过在页面组件中指定中间件来使用它们。例如，在一个页面组件中使用上面的中间件：

在页面中使用中间件

javascript 复制代码

<template>
  <div>
    <h1>欢迎来到仪表盘</h1>
  </div>
</template>

<script>
definePageMeta({
  middleware: ["auth"]
  // 或 middleware: 'auth'
})
</script>

全局使用中间件

如果您希望让每个路由都使用某个中间件，可以在 nuxt.config.ts 文件中注册全局中间件

总结

路由中间件在管理用户访问权限和错误处理方面非常有用。通过 defineNuxtRouteMiddleware，您可以轻松地定义中间件，控制用户如何在 Nuxt 应用程序中流动。

余下文章内容请点击跳转至个人博客页面或者扫码关注或者微信搜一搜：编程智域前端至全栈交流与成长，阅读完整的文章：使用 defineNuxtRouteMiddleware 创建路由中间件 | cmdragon's Blog

使用 defineNuxtRouteMiddleware 创建路由中间件

使用 defineNuxtRouteMiddleware 创建路由中间件

什么是路由中间件？

路由中间件的结构

创建和使用路由中间件

1. 显示错误页面的中间件

创建 middleware/error.ts

2. 基于身份验证状态的重定向

创建 middleware/auth.ts

中间件的注册

在页面中使用中间件

全局使用中间件

总结

往期文章归档：

创建 `middleware/error.ts`

创建 `middleware/auth.ts`