基础
安装请看官方文档router-vue
基础路由匹配
html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script src="https://unpkg.com/vue-router/dist/vue-router.js"></script>
<div id="app">
<h1>Hello App!</h1>
<p>
<!-- 使用 router-link 组件来导航. -->
<!-- 通过传入 `to` 属性指定链接. -->
<!-- <router-link> 默认会被渲染成一个 `<a>` 标签 -->
<router-link to="/foo">Go to Foo</router-link>
<router-link to="/bar">Go to Bar</router-link>
</p>
<!-- 路由出口 -->
<!-- 路由匹配到的组件将渲染在这里 -->
<router-view></router-view>
</div>
js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// 1. 定义 (路由) 组件。
// 可以从其他文件 import 进来
const Foo = { template: '<div>foo</div>' }
const Bar = { template: '<div>bar</div>' }
// 2. 定义路由
// 每个路由应该映射一个组件。 其中"component" 可以是
// 通过 Vue.extend() 创建的组件构造器,
// 或者,只是一个组件配置对象。
// 我们晚点再讨论嵌套路由。
const routes = [
{ path: '/foo', component: Foo },
{ path: '/bar', component: Bar }
]
// 3. 创建 router 实例,然后传 `routes` 配置
// 你还可以传别的配置参数, 不过先这么简单着吧。
const router = new VueRouter({
routes // (缩写) 相当于 routes: routes
})
// 4. 创建和挂载根实例。
// 记得要通过 router 配置参数注入路由,
// 从而让整个应用都有路由功能
const app = new Vue({
router
}).$mount('#app')
// 现在,应用已经启动了!
@vue/cli4.x中使用
全局注册
src目录下新建router文件夹,并新建index.js文件。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import vue from 'vue'
import vueRouter from 'vue-router'
//引入需要调用的组件
import xxx from '@/component/...'
//注册路由
Vue.use(VueRouter);
//定义路径对象
const routes = [{
path: '...',
name: '...',
component: 'xxx',
redirect: '...', // 重定向到其他路由
children: [{
... //如果该路由有子组件。。。
}]
}];
//定义路由模式(hash或者history)
const mode = 'history';
//定义路由
const router = new VueRouter({
routes,
mode,
});
//抛出路由
export default router;
在main.js中将其全局注册。
1
2
3
4
5
6
7
8
9
10
import Vue from 'vue'
import App from './App.vue'
import router from './router' //引入router包
Vue.config.productionTip = false;
new Vue({
render: h=>h(App),
router
}).$mount('#app');
在App.vue(入口组件)中的template中放置路由输出的位置<router-view>。
1
2
3
4
5
6
7
8
9
10
11
12
<template>
<div id='app' style='height: 100%;background:#EEF2F5'>
<router-view></router-view>
</div>
</template>
<script>
export default{
name: 'App',
component
}
</script>
此时 App.vue 中展示的一般是根路由地址‘\’或者由根路由地址重定向后的路由地址。
若需要展示其子路由,只需要在父级路由地址对应的组件下找一个位置放置<router-view>即可(即嵌套路由)
动态路由匹配
路由参数
routes中路由配置:
1
2
3
4
5
6
7
8
9
10
const = routes: [
...
// 动态路径参数 以冒号开头
{
path: '/user/:id',
user: 'user'
component: xxx
}
]
})
<router-link>传送
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<template>
<div id='user'>
<router-link :to="{name:'user',params:{id: id}}"></router-link>
</div>
</template>
<script>
export default{
data(){
return {
id: '123'
}
}
}
</script>
$router.push传送
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<template>
<div id='user'>
//非命名路由传送
<button v-on:click='toUser'>to user<button>
//命名路由传送
<button v-on:click='toUserName'>to user by name</button>
</div>
</template>
<script>
export default{
data(){
return {
id: '123'
}
},
method:{
toUser(){
this.$router.push({ path: `/newdetail/${row.id}` });
},
toUserName(){
this.$router.push({ name: 'user', params: { id: id } });
}
}
}
</script>
匹配所有路由,或404NotFound
这一小节官网copy的
常规参数只会匹配被 ‘/‘分隔的 URL 片段中的字符。如果想匹配任意路径,我们可以使用通配符 (‘*’):
1
2
3
4
5
6
7
8
{
// 会匹配所有路径
path: '*'
}
{
// 会匹配以 `/user-` 开头的任意路径
path: '/user-*'
}
当使用通配符路由时,请确保路由的顺序是正确的,也就是说含有通配符的路由应该放在最后。
路由 { path: '\*' } 通常用于客户端 404 错误。如果你使用了History 模式,请确保正确配置你的服务器。
当使用一个通配符时,$route.params 内会自动添加一个名为 pathMatch 参数。它包含了 URL 通过通配符被匹配的部分:
1
2
3
4
5
6
// 给出一个路由 { path: '/user-*' }
this.$router.push('/user-admin')
this.$route.params.pathMatch // 'admin'
// 给出一个路由 { path: '*' }
this.$router.push('/non-existing')
this.$route.params.pathMatch // '/non-existing'
嵌套路由
一般在App.vue中的<router-view>是顶层路由;
嵌套路由就是在顶层路由配置的地址所对应组件的模板中的<router-view>。
要在嵌套的出口中渲染组件,需要在顶层路由下添加children配置。
编程式的导航(官网介绍)
除了使用 <router-link>创建 a 标签来定义导航链接,我们还可以借助 router 的实例方法,通过编写代码来实现。
router.push(location, onComplete?, onAbort?)
注意:在 Vue 实例内部,你可以通过 $router 访问路由实例。因此你可以调用 this.$router.push。
想要导航到不同的 URL,则使用 router.push 方法。这个方法会向 history 栈添加一个新的记录,所以,当用户点击浏览器后退按钮时,则回到之前的 URL。
当你点击 <router-link> 时,这个方法会在内部调用,所以说,点击 <router-link :to=”…”> 等同于调用 router.push(…)。
声明式 | 编程式 |
---|---|
<router-link :to=”…”> | router.push(…) |
该方法的参数可以是一个字符串路径,或者一个描述地址的对象。例如:
1
2
3
4
5
6
7
8
9
10
11
// 字符串
router.push('home')
// 对象
router.push({ path: 'home' })
// 命名的路由
router.push({ name: 'user', params: { userId: '123' }})
// 带查询参数,变成 /register?plan=private
router.push({ path: 'register', query: { plan: 'private' }})
注意:如果提供了 path,params 会被忽略,上述例子中的 query并不属于这种情况。取而代之的是下面例子的做法,你需要提供路由的 name 或手写完整的带有参数的 path:
1
2
3
4
5
const userId = '123'
router.push({ name: 'user', params: { userId }}) // -> /user/123
router.push({ path: `/user/${userId}` }) // -> /user/123
// 这里的 params 不生效
router.push({ path: '/user', params: { userId }}) // -> /user
同样的规则也适用于 router-link 组件的to属性。
在 2.2.0+,可选的在 router.push 或 router.replace 中提供 onComplete 和 onAbort 回调作为第二个和第三个参数。这些回调将会在导航成功完成 (在所有的异步钩子被解析之后) 或终止 (导航到相同的路由、或在当前导航完成之前导航到另一个不同的路由) 的时候进行相应的调用。在 3.1.0+,可以省略第二个和第三个参数,此时如果支持 Promise,router.push 或 router.replace 将返回一个 Promise。
注意: 如果目的地和当前路由相同,只有参数发生了改变 (比如从一个用户资料到另一个 /users/1 -> /users/2),你需要使用 beforeRouteUpdate 来响应这个变化 (比如抓取用户信息)。
router.replace(location, onComplete?, onAbort?)
跟 router.push 很像,唯一的不同就是,它不会向 history 添加新记录,而是跟它的方法名一样 —— 替换掉当前的 history 记录。
声明式 | 编程式 |
---|---|
<router-link :to=”…” replace> | router.replace(…) |
router.go(n)
这个方法的参数是一个整数,意思是在 history 记录中向前或者后退多少步,类似
1
window.history.go(n)
例:
1
2
3
4
5
6
7
8
9
10
11
12
// 在浏览器记录中前进一步,等同于 history.forward()
router.go(1)
// 后退一步记录,等同于 history.back()
router.go(-1)
// 前进 3 步记录
router.go(3)
// 如果 history 记录不够用,那就默默地失败呗
router.go(-100)
router.go(100)
操作 History
你也许注意到 router.push、 router.replace 和 router.go 跟 window.history.pushState、 window.history.replaceState 和 window.history.go (opens new window)好像, 实际上它们确实是效仿 window.history API 的。
因此,如果你已经熟悉 Browser History APIs (opens new window),那么在 Vue Router 中操作 history 就是超级简单的。
还有值得提及的,Vue Router 的导航方法 (push、 replace、 go) 在各类路由模式 (history、 hash 和 abstract) 下表现一致。
命名视图
someTimes!想在同级展示多个视图,Rather than 嵌套展示;(就可以用命名视图了)
1
2
3
<router-view class="view one"></router-view>
<router-view class="view two" name="a"></router-view>
<router-view class="view three" name="b"></router-view>
在同一级下(同一个路由地址),多个视图就需要对应多个组件:
1
2
3
4
5
6
7
8
9
10
const routes = [
{
path: '/',
components: {
default: def, //对应html中view one
a: one, //对应html中view two
b: two //对应html中view three
}
}
]
重定向和别名
重定向
同样是在router下routes数组中进行编写代码。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
const routes = [
{
//普通重定向
path: '/',
redirect: '/home'
},
{
//重定向至命名路由
path: '/a',
redirect: {
name: 'home'
}
},
{
//重定向为一个方法,动态返回重定向的目标
path: '/b',
redirect: to=>{
//方法接收 目标路由to 作为参数
return `/${to}`
}
}
]
别名
“重定向”的意思是,当用户访问 /a时,URL 将会被替换成 /b,然后匹配路由为 /b,那么“别名”又是什么呢?
/a 的别名是 /b,意味着,当用户访问 /b 时,URL 会保持为 /b,但是路由匹配则为 /a,就像用户访问 /a 一样。
上面对应的路由配置为:
1
2
3
4
5
const router = new VueRouter({
routes: [
{ path: '/a', component: A, alias: '/b' }
]
})
“别名”的功能让你可以自由地将 UI 结构映射到任意的 URL,而不是受限于配置的嵌套路由结构。