router–导航守卫
vue-router 提供的导航守卫主要用来通过跳转或取消的方式守卫导航。有多种机会植入路由导航过程中:全局的, 单个路由独享的, 或者组件级的。
!参数或查询的改变并不会触发进入/离开的导航守卫 。你可以通过 观察 $route 对象 来应对这些变化,或使用 beforeRouteUpdate 的组件内守卫。
全局前置守卫
你可以使用 router.beforeEach 注册一个全局前置守卫:
const router = new VueRouter({...})
router.beforeEach((to,from,next)=>{
//...
})
当一个导航触发时,全局前置守卫按照创建顺序调用。守卫是异步解析执行,此时导航在所有守卫 resolve 完之前一直处于 等待中 。
每个守卫方法接收三个参数:
**to: Route : **即将要进入的目标(路由对象)
路由对象--------
r o u t e . p a t h ∗ ∗ 类型 : s t r i n g 字符串,对应当前路由的路径,总是解析为绝对路径 ∗ ∗ route.path** 类型: string 字符串,对应当前路由的路径,总是解析为绝对路径 ** route.path∗∗类型:string字符串,对应当前路由的路径,总是解析为绝对路径∗∗route.params
类型: Object 一个 key/value 对象,包含了动态片段和全匹配片段,如果没有路由参数,就是一个空对象。
$route.query
类型: Object 一个 key/value 对象,表示 URL 查询参数。例如,对于路径 /foo?user=1,则有 r o u t e . q u e r y . u s e r = = 1 ,如果没有查询参数,则是个空对象 ∗ ∗ route.query.user == 1,如果没有查询参数,则是个空对象 ** route.query.user==1,如果没有查询参数,则是个空对象∗∗route.hash**
类型: string 当前路由的 hash 值 (带 #) ,如果没有 hash 值,则为空字符串
r o u t e . f u l l P a t h ∗ ∗ 类型 : s t r i n g 完成解析后的 U R L ,包含查询参数和 h a s h 的完整路径 ∗ ∗ route.fullPath** 类型: string 完成解析后的 URL,包含查询参数和 hash 的完整路径 ** route.fullPath∗∗类型:string完成解析后的URL,包含查询参数和hash的完整路径∗∗route.matched
类型: Array 一个数组,包含当前路由的所有嵌套路径片段的路由记录 。路由记录就是 routes 配置数组中的对象副本 (还有在 children 数组)。
r o u t e . n a m e ∗ ∗ 当前路由的名称 ∗ ∗ route.name** 当前路由的名称 ** route.name∗∗当前路由的名称∗∗route.redirectedFrom 如果存在重定向,即为重定向来源的路由的名字
next() //进行管道中的下一个钩子,如果钩子执行完了则导航状态是confirmed(确定的)
next(false): //中断当前导航---URL地址重置到from路由对应地址
next('/') or next({path:'/'}) //跳转到一个不同的地址,当前导航被中断,进行一个新导航,可以向next传递任意位置对象---replace:name,name:'home',以及router-link Props(下面有详细内容...)或router.push中的选项
next(error) //如果传入 next 的参数是一个 Error 实例,则导航会被终止且该错误会被传递给 router.onError() 注册过的回调
确保 next 函数在任何给定的导航守卫中都被严格调用一次。它可以出现多于一次,但是只能在所有的逻辑路径都不重叠的情况下,否则钩子永远都不会被解析或报错
router-link Props
to
//required 表示目标路由的链接。当被点击后,内部会立刻把 to 的值传到 router.push(),所以这个值可以是一个字符串或者是描述目标位置的对象
<!-- 字符串 -->
<router-link to="home">Home</router-link>
<!-- 渲染结果 -->
<a href="home">Home</a>
replace
//默认值: false 设置 replace 属性的话,当点击时,会调用 router.replace() 而不是 router.push(),于是导航后不会留下 history 记录
<router-link :to="{ path: '/abc'}" replace></router-link>
append
//默认值: false 设置 append 属性后,则在当前 (相对) 路径前添加基路径。例如,我们从 /a 导航到一个相对路径 b,如果没有配置 append,则路径为 /b,如果配置了,则为 /a/b
<router-link :to="{ path: 'relative/path'}" append></router-link>
tag
//默认值: "a" 有时候想要 <router-link> 渲染成某种标签,例如 <li>。 于是我们使用 tag prop 类指定何种标签,同样它还是会监听点击,触发导航
<router-link to="/foo" tag="li">foo</router-link>
<!-- 渲染结果 -->
<li>foo</li>
active-class
//默认值: "router-link-active" 设置链接激活时使用的 CSS 类名。默认值可以通过路由的构造选项 linkActiveClass 来全局配置
exact
//默认值: false “是否激活”默认类名的依据是包含匹配 。 举个例子,如果当前的路径是 /a 开头的,那么 <router-link to="/a"> 也会被设置 CSS 类名。 按照这个规则,每个路由都会激活 <router-link to="/">!想要链接使用“精确匹配模式”,则使用 exact 属性
全局解析守卫
2.5.0新增
在 2.5.0+ 你可以用 router.beforeResolve 注册一个全局守卫。这和 router.beforeEach 类似,区别是在导航被确认之前,同时在所有组件内守卫和异步路由组件被解析之后 ,解析守卫就被调用。
全局后置钩子
你也可以注册全局后置钩子,然而和守卫不同的是,这些钩子不会接受 next 函数也不会改变导航本身:
router.afterEach((to,from)=>{
//...
})
路由独享守卫
你可以在路由配置上直接定义 beforeEnter 守卫
const router = new VueRouter({
routes: [
{
path: '/foo',
component: Foo,
beforeEnter: (to, from, next) => {
// ...
}
}
]
})
用法与全局前置守卫的参数时一样的
组件内的守卫
最后,你可以在路由组件内直接定义以下路由导航守卫
beforeRouteEnter
beforeRouteUpdate 2.2新增
beforeRouteLeave
const Foo = {
template: `...`,
beforeRouteEnter(to, from, next) {
// 在渲染该组件的对应路由被 confirm 前调用
// 不!能!获取组件实例 `this`
// 因为当守卫执行前,组件实例还没被创建
},
beforeRouteUpdate(to, from, next) {
// 在当前路由改变,但是该组件被复用时调用
// 举例来说,对于一个带有动态参数的路径 /foo/:id,在 /foo/1 和 /foo/2 之间跳转的时候,
// 由于会渲染同样的 Foo 组件,因此组件实例会被复用。而这个钩子就会在这个情况下被调用。
// 可以访问组件实例 `this`
},
beforeRouteLeave(to, from, next) {
// 导航离开该组件的对应路由时调用
// 可以访问组件实例 `this`
}
}
beforeRouteEnter 守卫 不能 访问 this,因为守卫在导航确认前被调用,因此即将登场的新组件还没被创建。
不过,你可以通过传一个回调给 next来访问组件实例。在导航被确认的时候执行回调,并且把组件实例作为回调方法的参数。
beforeRouteEnter (to, from, next) {
next(vm => {
// 通过 `vm` 访问组件实例
})
}
完整的导航解析流程
- 导航被触发
- 在失活的组件里调用 beforeRouteLeave 守卫。
- 调用全局的 beforeEach 守卫
- 在重用的组件里调用 beforeRouteUpdate 守卫 (2.2+)。
- 在路由配置里调用 beforeEnter
- 解析异步路由组件。
- 在被激活的组件里调用 beforeRouteEnter。
- 调用全局的 beforeResolve 守卫 (2.5+)。
- 导航被确认。
- 调用全局的 afterEach 钩子。
- 触发 DOM 更新。
- 调用 beforeRouteEnter 守卫中传给 next 的回调函数,创建好的组件实例会作为回调函数的参数传入