Vue3 路由(Vue Router)

本章节我们将为大家介绍 Vue 路由。

Vue 路由允许我们通过不同的 URL 访问不同的内容。

通过 Vue 可以实现多视图的单页 Web 应用（single page web application，SPA）。

Vue.js 路由需要载入 vue-router 库

中文文档地址：vue-router 文档。

Vue Router 负责将 URL 路径与应用中的组件进行映射，当用户在应用中浏览时，URL 会更新，但页面不会重新加载，从而提供流畅的用户体验。

上图展示了一个两层级的嵌套路由结构：

• 顶层 (App.vue 的 <router-view>) 负责渲染独立布局（如 Login.vue）或主框架布局（Layout.vue）。
• 主框架布局 (Layout.vue) 内部包含第二个 <router-view>，用于渲染功能页面的子组件（如 Dashboard.vue、User.vue），从而实现页头、侧边栏和页脚的持久化显示。
• 未匹配的路径最终会导向独立的 page404.vue。

核心组成部分

安装

npm 安装

npm install vue-router

npm（国内镜像）

推荐使用淘宝镜像：

npm install -g cnpm --registry=https://registry.npmmirror.com
cnpm install vue-router@4

直接下载 / CDN

https://unpkg.com/vue-router@4

基本应用

1、创建路由表

// src/router/index.js
import { createRouter, createWebHistory } from 'vue-router'
import Home from '../views/Home.vue'
import About from '../views/About.vue'

const routes = [
  { path: '/', component: Home },
  { path: '/about', component: About }
]

export default createRouter({
  history: createWebHistory(),
  routes
})

2、在应用中挂载

// main.js
import { createApp } from 'vue'
import App from './App.vue'
import router from './router'

createApp(App).use(router).mount('#app')

3、页面出口

<router-view></router-view>

4、跳转

<router-link to="/about">About</router-link>

5、动态路由

{ path: '/user/:id', component: User }

访问 /user/10，$route.params.id === '10'。

6、懒加载

const About = () => import('../views/About.vue')

7、导航守卫（鉴权）

router.beforeEach((to, from, next) => {
  next()
})

8、重定向

{ path: '/old', redirect: '/' }

9、404

{ path: '/:pathMatch(.*)*', component: NotFound }

简单实例

Vue.js + vue-router 可以很简单的实现单页应用。

<router-link> 是一个组件，该组件用于设置一个导航链接，切换不同 HTML 内容。 to 属性为目标地址， 即要显示的内容。

以下实例中我们将 vue-router 加进来，然后配置组件和路由映射，再告诉 vue-router 在哪里渲染它们。代码如下所示：

router-link

请注意，我们没有使用常规的 a 标签，而是使用一个自定义组件 router-link 来创建链接。这使得 Vue Router 可以在不重新加载页面的情况下更改 URL，处理 URL 的生成以及编码。我们将在后面看到如何从这些功能中获益。

router-view

router-view 将显示与 url 对应的组件。你可以把它放在任何地方，以适应你的布局。

点击过的导航链接都会加上样式 class ="router-link-exact-active router-link-active"。

应用实例

以下例子涵盖了路由的定义、创建、挂载、导航和渲染五个核心步骤。

1. main.js (入口文件)

2. router/index.js (路由配置)

3. App.vue (根组件)

当您运行此应用时：

• 点击 Home 链接，URL 变为 /，<router-view> 中显示 Home Page 组件内容。
• 点击 About 链接，URL 变为 /about，<router-view> 中显示 About Us 组件内容。
• 点击 404 Demo 链接，URL 变为 /nonexistent，<router-view> 中显示 404 Not Found 组件内容。

<router-link> 相关属性

接下来我们可以了解下更多关于 <router-link> 的属性。

to

表示目标路由的链接。 当被点击后，内部会立刻把 to 的值传到 router.push()，所以这个值可以是一个字符串或者是描述目标位置的对象。

<!-- 字符串 -->
<router-link to="home">Home</router-link>
<!-- 渲染结果 -->
<a href="home">Home</a>

<!-- 使用 v-bind 的 JS 表达式 -->
<router-link v-bind:to="'home'">Home</router-link>

<!-- 不写 v-bind 也可以，就像绑定别的属性一样 -->
<router-link :to="'home'">Home</router-link>

<!-- 同上 -->
<router-link :to="{ path: 'home' }">Home</router-link>

<!-- 命名的路由 -->
<router-link :to="{ name: 'user', params: { userId: 123 }}">User</router-link>

<!-- 带查询参数，下面的结果为 /register?plan=private -->
<router-link :to="{ path: 'register', query: { plan: 'private' }}">Register</router-link>

replace

设置 replace 属性的话，当点击时，会调用 router.replace() 而不是 router.push()，导航后不会留下 history 记录。

<router-link :to="{ path: '/abc'}" replace></router-link>

append

设置 append 属性后，则在当前 (相对) 路径前添加其路径。例如，我们从 /a 导航到一个相对路径 b，如果没有配置 append，则路径为 /b，如果配了，则为 /a/b

<router-link :to="{ path: 'relative/path'}" append></router-link>

tag

有时候想要 <router-link> 渲染成某种标签，例如 <li>。 于是我们使用 tag prop 类指定何种标签，同样它还是会监听点击，触发导航。

<router-link to="/foo" tag="li">foo</router-link>
<!-- 渲染结果 -->
<li>foo</li>

active-class

设置 链接激活时使用的 CSS 类名。可以通过以下代码来替代。

<style>
   ._active{
      background-color : red;
   }
</style>
<p>
   <router-link v-bind:to = "{ path: '/route1'}" active-class = "_active">Router Link 1</router-link>
   <router-link v-bind:to = "{ path: '/route2'}" tag = "span">Router Link 2</router-link>
</p>

注意这里 class 使用 active-class="_active"。

exact-active-class

配置当链接被精确匹配的时候应该激活的 class。可以通过以下代码来替代。

<p>
   <router-link v-bind:to = "{ path: '/route1'}" exact-active-class = "_active">Router Link 1</router-link>
   <router-link v-bind:to = "{ path: '/route2'}" tag = "span">Router Link 2</router-link>
</p>

event

声明可以用来触发导航的事件。可以是一个字符串或是一个包含字符串的数组。

<router-link v-bind:to = "{ path: '/route1'}" event = "mouseover">Router Link 1</router-link>

以上代码设置了 event 为 mouseover ，及在鼠标移动到 Router Link 1 上时导航的 HTML 内容会发生改变。

Vue Router (v4, Vue 3) 核心 API 手册

一、createRouter 配置项

二、History 工厂

三、RouteRecord (路由表项)

四、路由导航 (Router 实例方法)

五、导航守卫

六、<router-link> 属性

七、<router-view> 属性

八、Route (当前路由对象)

该对象通过 useRoute() 或 this.$route 获取。

九、组合式 API (Composition API)

十、编程式导航 (完整示例)