vue-router 提供的 导航守卫 主要用来通过跳转或取消的方式守卫导航。有多种机会植入路由导航过程中:全局的, 单个路由独享的, 或者组件级的。
记住 参数或查询的改变并不会触发进入/离开的导航守卫。你可以通过观察 $route 对象来应对这些变化,或使用 beforeRouteUpdate 的组件内守卫。
可以使用 router.beforeEach 注册全局前置守卫:
router.beforeEach((to, from, next) => {
console.log(to);
console.log(from);
next();
...
})
接收的三个参数:
to : Object,即将要进入的目标,即路由对象;
from : Object,当前导航正要离开的路由;
next : Function,一定要调用该方法来 resolve 这个钩子。执行效果依赖 next 方法的调用参数。
next() : 进行管道中的下一个钩子;
next(false) : 中断当前的导航,如果浏览器的 URL 改变了 (可能是用户手动或者浏览器后退按钮),那么URL地址会重置到 from 路由对应的地址;
next(‘/’) 或者 next({ path: ‘/’ }) : 跳转到一个不同的地址,当前的导航被中断,然后进行一个新的导航。可以向 next 传递任意位置对象,且允许设置诸如 replace:true、name: ‘home’ 之类的选项以及任何用在router-link 的 to prop 或 router.push中的选项;
next(error) : (2.4.0+) 如果传入 next 的参数是一个 Error 实例,则导航会被终止且该错误会被传递给 router.onError() 注册过的回调。
注意:next 函数在任何给定的导航守卫中都只能被严格调用一次。它可以出现多于一次,但是只能在所有的逻辑路径都不重叠的情况下,否则钩子永远都不会被解析或报错。
这里有一个在用户未能验证身份时重定向到 /login 的示例:
// BAD
router.beforeEach((to, from, next) => {
if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
// 如果用户未能验证身份,则 next 会被调用两次
next()
})
// GOOD
router.beforeEach((to, from, next) => {
if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
else next()
})
在 2.5.0+ ,可以使用 router.beforeResolve 注册全局守卫。
这和 router.beforeEach 类似,区别是在导航被确认之前,同时在所有组件内守卫和异步路由组件被解析之后,解析守卫就被调用。
router.beforeResolve((to, from, next) => {
...
})
可以使用 router.afterEach 注册全局后置钩子。
和守卫不同的是,这些钩子不会接受 next 函数也不会改变导航本身。
router.afterEach((to, from) => {
// ...
})
可以在路由配置上直接定义 beforeEnter 守卫:
const routes = [
{
path: '/user',
component: User,
beforeEnter: (to, from, next) => {
// ...
},
},
]
路由独享的守卫与全局前置守卫的方法参数是一样的。
最后,你可以在路由组件内直接定义以下 路由导航守卫:
User组件:
<template>
<div>User</div>
</template>
<script>
export default {
name: 'user',
beforeRouteEnter(to, from, next) {
// 在渲染该组件的对应路由被 confirm 前调用
// 不能获取组件实例 this
// 因为当守卫执行前,组件实例还没被创建
},
beforeRouteUpdate(to, from, next) {
// 在当前路由改变,但是该组件被复用时调用
// 举例来说,对于一个带有动态参数的路径,
// 如 /user/:id,在 /user/1 和 /user/2 之间跳转的时候,
// 由于会渲染同样的 User 组件,因此组件实例会被复用。而这个钩子就会在这个情况下被调用。
// 可以访问组件实例 this
},
beforeRouteLeave(to, from, next) {
// 导航离开该组件的对应路由时调用
// 可以访问组件实例 this
}
}
</script>
beforeRouteEnter 守卫不能访问 this,因为守卫在导航确认前被调用,因此即将登场的新组件还没被创建。
不过,可以通过传一个回调给 next 来访问组件实例,在导航被确认的时候执行回调,并且把组件实例作为回调方法的参数。
beforeRouteEnter (to, from, next) {
next(vm => {
// 通过 vm 访问组件实例
})
}
注意: beforeRouteEnter 是支持给 next 传递回调的唯一守卫。对于 beforeRouteUpdate 和 beforeRouteLeave 来说,this 已经可用了,所以不支持传递回调,因为没有必要了。
beforeRouteUpdate (to, from, next) {
// 使用this
this.name = to.params.name
next()
}
离开守卫 通常用来禁止用户在还未保存修改前突然离开,该导航可以通过 next(false) 来取消。
beforeRouteLeave (to, from) {
if (!finish) return false
}
全局守卫:
单个路由独享守卫:
组件级守卫:
这两个都属于全局守卫,都是在路由跳转之前就会执行的守卫,
只是 beforeEach 比 beforeResolve 执行时间更早。
官网链接: Vue Router