Skip to main content

Welcome to a Grasp lesson

Create a free account to keep studying and create your own study path.

Lesson 2

Vue Router: Multi-Page Routing and Route Guards

Recommended resources

好的,我们开始今天的课程。

简介

你好!在上一节课中,我们回顾了如何使用 Vue 3 的组合式 API(ref 和 reactive)来构建独立的、具有响应式数据的组件。这是构建动态界面的基础。

然而,一个完整的应用程序是由多个页面和视图构成的。今天的学习目标是使用 Vue Router 配置多页面路由及路由守卫。我们将学习如何将这些独立的组件组织成一个用户可以导航的单页应用(SPA),并实现一个至关重要的功能:保护需要用户登录才能访问的页面。

这节课将为我们的全栈项目搭建起前端应用的“骨架”,是连接用户界面和后端逻辑的关键一环。



1. 理解客户端路由(Client-Side Routing)

在你之前的开发经验中,你可能已经很熟悉多页面应用(MPA),即每次点击链接都会从服务器请求一个新的 HTML 页面。而 Vue 这类现代前端框架通常用于构建单页应用(Single-Page Application, SPA)。

在 SPA 中,应用在初始加载时从服务器获取一个 HTML 文件和相关的 JavaScript。之后的所有页面切换,都是由前端的 JavaScript(也就是 Vue Router)动态地替换组件内容,而无需重新加载整个页面。这带来了更快、更流畅的用户体验,感觉更像一个桌面应用。

为了直观地理解这个过程,请观看下面这个视频的开头部分。

Vue JS 3 Tutorial for Beginners #8 - The Vue Router

这个视频来自 Net Ninja 频道,它清晰地解释了什么是单页应用,以及 Vue Router 是如何在浏览器端拦截请求并动态切换组件的。

请观看视频从 00:00 到 02:37 的部分,重点理解“只从服务器请求一次 HTML”以及“Vue 拦截请求并切换组件”这两个核心概念。



2. 配置基本路由

要在 Vue 项目中使用路由,我们需要依赖 vue-router 这个官方库。配置它的核心步骤非常直接,并且高度模块化。

  1. 安装: 在你的项目目录下运行 npm install vue-router@4。
  2. 创建路由配置文件: 通常在 src 目录下创建一个 router 文件夹,并在其中新建 index.js 或 index.ts。
  3. 定义路由规则: 在该文件中,定义一个路由数组,每个路由都是一个对象,将一个 URL 路径 (path) 映射到一个组件 (component)。
  4. 创建并导出路由实例: 使用 createRouter 函数创建路由实例。
  5. 在 main.js 中注册: 导入路由实例,并通过 app.use() 将其注册到 Vue 应用中。

为了让你快速掌握这些步骤和核心 API,请阅读下面这篇来自掘金社区的指南。

全面拥抱Vue3,Vue-Router4 快速上手指南!

这篇《Vue-Router4 快速上手指南》用中文清晰地列出了配置路由的基本步骤和核心代码。它将是你很好的参考手册。

请阅读文章的“2. 配置步骤”、“3. 声明路由出口 router-view” 和 “4. 设置路由链接 router-link”这几个部分。重点关注代码结构和关键函数(createRouter, createWebHistory)的用法。

阅读完后,我们总结一下最关键的两个自定义标签:

  • <router-link to="/path">:用于生成导航链接。它会被渲染成一个 <a> 标签,但它的优点是能阻止浏览器默认的页面刷新行为,并触发 Vue Router 的导航。
  • <router-view>:这是一个占位符,它会根据当前 URL 动态渲染匹配到的路由组件。

动态路由与嵌套路由

在真实项目中,我们经常需要更灵活的路由配置。

  • 动态路由:用于匹配一类模式的 URL,例如 /users/1 和 /users/2 都指向同一个用户详情组件。我们通过在 path 中使用冒号来定义参数,如 /users/:id。在组件内部,可以使用组合式 API useRoute().params.id 来获取这个动态参数。

  • 嵌套路由:用于构建复杂的页面布局,例如一个用户中心页面,左侧是菜单,右侧根据点击的菜单项(如“我的资料”、“我的订单”)显示不同的内容。

Vue Router 嵌套路由示意图
这张图直观地展示了嵌套路由的原理。根组件 `App.vue` 中的 `<router-view>` 渲染父级路由组件(如 `Home.vue`),而父级组件内部的 `<router-view>` 则负责渲染子路由组件(如 `Kitchen.vue`)。

为了将这些概念串联起来,请观看下面视频的几个片段。虽然视频中使用的是 Options API,但路由配置的核心思想是完全一致的。

Vue JS 3 Tutorial for Beginners #8 - The Vue Router

我们将继续观看 Net Ninja 的视频,来直观地学习如何定义和使用动态路由、嵌套路由以及编程式导航。

请分段观看: 动态路由 (24:56 - 29:32):学习如何定义带参数的路由(如 /jobs/:id)以及如何在组件中通过 $route.params.id 获取参数。 重定向与 404 页面 (36:36 - 41:55):学习如何将一个旧路径重定向到新路径,以及如何创建一个“404 Not Found”页面来捕获所有未匹配的路由。 编程式导航 (41:55 - 47:47):了解如何用 JavaScript 代码(如 this.$router.push())来跳转页面,这在用户登录成功后跳转等场景非常有用。

组合式 API 的用法

在 Vue 3 的 <script setup> 中,我们不再使用 this.$route 和 this.$router。取而代之的是两个新的组合式函数:

  • import { useRoute } from 'vue-router':获取当前路由信息对象,相当于 this.$route。
  • import { useRouter } from 'vue-router':获取路由器实例,用于编程式导航,相当于 this.$router。
<script setup>
import { useRoute, useRouter } from 'vue-router'

const route = useRoute(); // 获取当前路由信息
const router = useRouter(); // 获取路由器实例

// 获取路由参数
console.log(route.params.id);

// 编程式导航
function goToHome() {
  router.push('/');
}
</script>


3. 使用路由守卫实现访问控制

现在我们的应用有了多个页面,但有些页面(如用户仪表盘、设置页)我们只希望登录用户才能访问。这就是路由守卫(Navigation Guards) 的用武之地。

路由守卫是在路由即将发生变化时执行的函数,你可以在这里加入逻辑来决定是允许、取消还是重定向本次导航。最常用的是全局前置守卫 router.beforeEach。

实现认证流程

一个典型的认证流程如下:

  1. 在路由定义中,使用 meta 字段为需要认证的路由添加一个标记,例如 meta: { requiresAuth: true }。
  2. 在 router.beforeEach 守卫中,检查即将进入的路由(to)是否包含这个 meta 标记。
  3. 如果需要认证,就检查用户的登录状态(例如,检查 Pinia store 或 localStorage 中是否有 token)。
  4. 如果用户未登录,则中断当前导航,并将其重定向到登录页面。
  5. 如果用户已登录,或者目标路由不需要认证,则放行。

下面这个视频演示了一个非常贴近实战的认证和授权流程。

Vue Router 4: let's work on an App Dev and Auth Flow!

这个视频来自 Faraday Academy 频道,它将带我们实现一个完整的认证流程,包括使用 beforeEach 守卫、meta 字段,甚至还涉及到了基于角色的访问控制(RBAC)的初步概念,这与你的学习目标高度相关。

请分段观看: 导航守卫简介 (40:14 - 44:22):了解 router.beforeEach 的基本概念和用法,它接收 to 和 from 两个参数。 基础认证检查 (50:22 - 56:28):学习如何在守卫中检查一个模拟的认证状态,并在用户未认证时将其重定向到登录页面。这是路由守卫最核心的应用。 使用 meta 字段 (1:13:07 - 1:19:15):学习如何为需要保护的路由组添加 meta: { requiresAuth: true } 标记,并在 beforeEach 中检查此标记。这是实现选择性保护的关键。

视频中展示的 meta 字段合并是一个非常有用的特性:当你在一个父路由上定义了 meta,它的所有子路由都会继承这个 meta 信息,并可以与自身的 meta 合并。这使得为一组嵌套路由统一设置访问权限变得非常方便。

Vue Router Global Guards and Dynamic Title Setting
这张图片展示了路由守卫的另一个常见用途:在导航后(`afterEach`)根据目标路由的 `meta.title` 来动态更新浏览器标签页的标题。

代码实践

下面是一个集成了今天所学知识的 router/index.js 示例代码。你可以将其作为模板,在自己的项目中进行修改。

import { createRouter, createWebHistory } from 'vue-router';
import Home from '../views/Home.vue';
import Login from '../views/Login.vue';
import Dashboard from '../views/Dashboard.vue';

const routes = [
  {
    path: '/',
    name: 'Home',
    component: Home,
  },
  {
    path: '/login',
    name: 'Login',
    component: Login,
  },
  {
    path: '/dashboard',
    name: 'Dashboard',
    component: Dashboard,
    meta: { requiresAuth: true }, // 标记此路由需要认证
  },
  // ... 其他路由
];

const router = createRouter({
  history: createWebHistory(),
  routes,
});

// 全局前置守卫
router.beforeEach((to, from) => {
  // 简单模拟检查 token
  const isLoggedIn = !!localStorage.getItem('token'); 

  // 检查目标路由是否需要认证
  if (to.meta.requiresAuth && !isLoggedIn) {
    // 用户未登录,重定向到登录页
    // return false; // 或者直接取消导航
    return { name: 'Login', query: { redirect: to.fullPath } }; // 推荐做法,登录后可以跳回原页面
  }

  // 如果已登录用户访问登录页,可以将其导向主页
  if (to.name === 'Login' && isLoggedIn) {
    return { name: 'Home' };
  }

  // 其他情况,正常放行
  // 不返回任何值或返回 true
});

export default router;


总结

做得很好!今天我们为应用搭建了导航系统,这是从单个组件迈向完整应用的关键一步。

  • 核心概念:我们理解了 SPA 和客户端路由的原理,学会了使用 vue-router 来管理应用的页面。
  • 路由配置:你现在可以定义静态路由、动态路由和嵌套路由,并使用 <router-link> 和编程式导航在它们之间跳转。
  • 路由守卫:你掌握了使用全局前置守卫 beforeEach 结合 meta 字段来实现页面访问控制。这是一个在全栈开发中至关重要的安全实践。

展望未来

在今天的例子中,我们用 localStorage.getItem('token') 来简单模拟了登录状态的检查。但这还不够健壮和系统化。在下一节课中,我们将学习使用 Pinia 创建和管理全局状态。Pinia 是 Vue 官方推荐的状态管理库,它能帮助我们更优雅、更安全地管理用户的登录状态、信息以及其他需要在整个应用中共享的数据。这将使我们的路由守卫逻辑变得更加强大和可靠。