这篇文章主要介绍了 vue-router 路由导航守卫钩子的使用总结。
一、什么是导航钩子
官方解释:vue-router 提供的导航钩子主要用来拦截导航,让它完成跳转或取消。有多种方式可以在路由导航发生时执行钩子:全局的,单个路由独享的,或者组件级的。
也就是说:导航钩子就是用来监听路由的变化,当路由发生改变的时候就去触发 vue-router 的导航钩子。
二、路由守卫
路由守卫主要分为以下几种:
- 全局守卫
- 路由独享守卫
- 组件内守卫
下面将对每一个导航钩子进行详细讲解。
全局守卫
1. 全局前置守卫 router.beforeEach
-
注册守卫:
const router = new VueRouter({ ... }) router.beforeEach((to, from, next) => { // ... }) -
作用:
当一个导航触发时,全局前置守卫按照创建顺序调用。守卫是异步解析执行,此时导航在所有守卫
resolve完之前一直处于 等待中 的状态。 -
参数:
-
to: Route:即将要进入的目标(路由对象) -
from: Route:当前导航正要离开的路由 -
next: Function:一定要调用该方法来resolve这个钩子。执行效果依赖next方法的调用参数。next():进行管道中的下一个钩子。如果全部钩子执行完了,则导航的状态就是confirmed(确认的)。next(false):中断当前的导航。如果浏览器的 URL 改变了 (可能是用户手动或者浏览器后退按钮),那么 URL 地址会重置到from路由对应的地址。【也就是说,给next方法一个false参数的话,vue-router会中断当前的导航强制回到from的地址,无论你怎么手动修改地址都没用,就是不让你跳转】next('/')或next({ path: '/' }):跳转到一个不同的地址。当前的导航被中断,然后进行一个新的导航。你可以向next传递任意位置对象,且允许设置诸如replace: true、name: 'home'之类的选项以及任何用在router-link的toprop或router.push中的选项。但是,这个要慎用,因为它也会触发钩子的。next(error):(2.4.0+) 如果传入next的参数是一个Error实例,则导航会被终止且该错误会被传递给router.onError()注册过的回调。
注意:
next方法必须要调用,否则钩子函数无法resolved。
并且,确保next函数在任何给定的导航守卫中都被严格调用一次。它可以出现多于一次,但是只能在所有的逻辑路径都不重叠的情况下,否则钩子永远都不会被解析或报错。
-
2. 全局解析守卫 router.beforeResolve(2.5.0 新增)
使用 router.beforeResolve 注册一个全局解析守卫,使用和 router.beforeEach 类似。
区别是 在导航被确认之前,同时在所有组件内守卫和异步路由组件被解析之后,解析守卫就被调用。
3. 全局后置守卫 router.afterEach
注册全局后置钩子:
router.afterEach((to, from) => {
// ...
})
这些钩子不会接受 next 函数,也不会改变导航本身。
路由独享守卫
1. beforeEnter
就是说:单个路由独享的导航钩子,它是在路由配置上直接进行定义的。
const router = new VueRouter({
routes: [
{
path: '/foo',
component: Foo,
beforeEnter: (to, from, next) => {
// ...
next(); // 同样的不加的话导航就一直是等待中
}
}
]
})
参数和用法同全局前置守卫是一样的,两个路由对象(to 和 from)和一个 next() 方法。
组件内守卫
1. beforeRouteEnter
该守卫 不能 访问 this,因为守卫在导航确认前被调用,因此即将登场的新组件还没被创建。
不过,可以通过传一个回调给 next() 来访问组件实例。在导航被确认的时候执行回调,并且把组件实例作为回调方法的参数。
beforeRouteEnter (to, from, next) {
next(vm => {
// 通过 vm 访问组件实例
})
}
注意
beforeRouteEnter是支持给next传递回调的唯一守卫。对于beforeRouteUpdate和beforeRouteLeave来说,this已经可用了,所以不支持传递回调,因为没有必要了。
2. beforeRouteUpdate(2.2新增)
beforeRouteUpdate (to, from, next) {
this.name = to.params.name
next()
}
3. beforeRouteLeave
这个离开守卫通常用来禁止用户在还未保存修改前突然离开。该导航可以通过 next(false) 来取消。
beforeRouteLeave (to, from, next) {
const answer = window.confirm('Do you really want to leave? you have unsaved changes!')
if (answer) {
next()
} else {
next(false)
}
}
组件内守卫具体使用方法如下:
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
}
}
三、导航解析流程
- 导航被触发。
- 在失活的组件里调用
beforeRouteLeave守卫。 - 调用全局的
beforeEach守卫。 - 在重用的组件里调用
beforeRouteUpdate守卫 (2.2+)。 - 在路由配置里调用
beforeEnter。 - 解析异步路由组件。
- 在被激活的组件里调用
beforeRouteEnter。 - 调用全局的
beforeResolve守卫 (2.5+)。 - 导航被确认。
- 调用全局的
afterEach钩子。 - 触发
DOM更新。 - 调用
beforeRouteEnter守卫中传给next的回调函数,创建好的组件实例会作为回调函数的参数传入。
四、总结
其实 官方文档 已经写得很好了(毕竟vuejs的作者尤大可是国人呐!),在这里我只是稍加总结以及加入了一些自己的理解。我们只需要稍微实践一下基本都可以理解了~
希望以上内容可以帮助到大家。有任何问题欢迎讨论留言,最后不要忘记一键三连哦~。
各位 加油!
本文详细介绍了Vue.js中路由守卫的使用方法,包括全局守卫、路由独享守卫和组件内守卫等,解释了如何利用这些守卫来控制路由的跳转和导航。

5017

被折叠的 条评论
为什么被折叠?



