什么是导航守卫

vue-router 提供的导航守卫主要用来通过跳转或取消的方式守卫导航。通俗点讲就是一个拦截器。

导航守卫分类

全局守卫

beforeEach、beforeResolve、afterEach(在路由实例对象注册使用)

路由守卫

beforeEnter(在路由配置项中项定义)

组件守卫

beforeRouteEnter、beforeRouteUpdate、beforeRouteLeave(在组件属性中定义)

守卫详解

每个守卫方法接收三个参数:

to: Route: 即将要进入的目标 路由对象
from: Route
: 当前导航正要离开的路由
next: Function: 一定要调用该方法来 resolve 这个钩子。执行效果依赖 next 方法的调用参数。

  • next(): 进行管道中的下一个钩子。如果全部钩子执行完了,则导航的状态就是 confirmed (确认的)。
  • next(false): 中断当前的导航。如果浏览器的 URL 改变了 (可能是用户手动或者浏览器后退按钮),那么 URL 地址会重置到 from 路由对应的地址。
  • next('/') 或者 next({ path: '/' }): 跳转到一个不同的地址。当前的导航被中断,然后进行一个新的导航。你可以向 next 传递任意位置对象,且允许设置诸如 replace: truename: 'home' 之类的选项以及任何用在 router-link 的 to prop 或 router.push 中的选项。
  • next(error): (2.4.0+) 如果传入 next 的参数是一个 Error 实例,则导航会被终止且该错误会被传递给 router.onError() 注册过的回调。

全局守卫详解(在路由的index.js页面设置)

全局前置守卫(beforeEach)

// 全局前置守卫 确保要调用 next 方法,否则钩子就不会被 resolved。
router.beforeEach((to, from, next) => {
    var username = 'miofly'
    if (username === 'miofly') { // 用户是miofly才进入下一个页面
        console.log('beforeEach全局前置守卫被调用')
        next() // 进行管道中的下一个钩子,必须调用
    } else { // 如果不是回到主页
        // 如果直接写next('/indexs'),会造成死循环(dead loop)
        // 这是因为,执行next('/indexs')这个跳转,会触发beforeEach方法,
        // 这时候,就会造成,又执行next('/indexs')  这样的死循环,所以还要再加一层判断
        if (to.path === '/indexs') {
            next()
        } else {
            next('/indexs')
        }
    }
})

全局解析守卫(beforeResolve) 

// 全局解析守卫
// 和 router.beforeEach 类似,区别是在导航被确认之前,同时在所有组件内守卫和异步路由组件被解析之后,解析守卫就被调用。
router.beforeResolve((to, from, next) => {
    console.log('beforeResolve全局解析守卫被调用')
    next()
})

全局后置钩子(afterEach) 

// 全局后置钩子
// 可以注册全局后置钩子,然而和守卫不同的是,这些钩子不会接受 next 函数也不会改变导航本身:
router.afterEach((to, from) => {
    console.log('afterEach全局后置钩子被调用')
})

路由守卫(beforeEnter)

{
    path: '/test',
    component: testIndex,
    beforeEnter: (to, from, next) => {
        console.log('beforeEnter路由独享的守卫被调用')
        next()
    },
}

组件守卫

mounted () { // 这不是组件守卫,留作测试用
    console.log('mounted被调用了')
},
beforeRouteEnter (to, from, next) {
    console.log('beforeRouteEnter被调用:在渲染该组件的对应路由被 confirm 前调用')
    // 在渲染该组件的对应路由被 confirm 前调用
    // 不!能!获取组件实例 `this` 因为当守卫执行前,组件实例还没被创建
    // 可以通过传一个回调给 next来访问组件实例。在导航被确认的时候执行回调,并且把组件实例作为回调方法的参数。
    next(vm => {
        // 通过 `vm` 访问组件实例
        console.log(vm)
    })
},
// beforeRouteEnter 是支持给 next 传递回调的唯一守卫。
// 对于 beforeRouteUpdate 和 beforeRouteLeave 来说,this 已经可用了,所以不支持传递回调,因为没有必要了。
beforeRouteUpdate (to, from, next) {
    // 在当前路由改变,但是该组件被复用时调用
    // 举例来说,对于一个带有动态参数的路径 /foo/:id,在 /foo/1 和 /foo/2 之间跳转的时候,
    // 由于会渲染同样的 Foo 组件,因此组件实例会被复用。而这个钩子就会在这个情况下被调用。
    // 可以访问组件实例 `this`
    console.log('beforeRouteUpdate被调用:在当前路由改变,但是该组件被复用时调用')
    next()
   
},
beforeRouteLeave (to, from, next) {
    // 导航离开该组件的对应路由时调用
    // 可以访问组件实例 `this`
    const answer = window.confirm('是否确认离开当前页面')
    if (answer) {
        console.log('beforeRouteLeave被调用:导航离开该组件的对应路由时调用')
        next()
    } else {
        next(false)
    }
},

导航守卫执行顺序详解

当进入testIndex这个组件时,导航守卫执行顺序如下:

global beforeEach > router beforeEnter > component beforeRouteEnter > global beforeResolve > global afterEach > mounted

当从 testIndex这个组件返回首页时,导航守卫执行顺序如下:

component beforeRouteLeave => global beforeEach => global beforeResolve => global afterEach
 

排除beforeRouteUpdate,其余六个导航钩子的执行时机其实很好理解。大体按照leave、before、enter、resolve、after的顺序并全局优先的思路执行。beforeRouteUpdate的触发是在动态路由情形下,比如 path: '/user/:userName' 这条路由,当页面不变更只动态的改变参数userName时,beforeRouteUpdate便会触发。

导航守卫执行顺序流程图

完整的流程图如下 
导航守卫执行顺序流程图

完整的导航解析流程 

  1. 导航被触发。
  2. 在失活的组件里调用离开守卫。
  3. 调用全局的 beforeEach 守卫。
  4. 在重用的组件里调用 beforeRouteUpdate 守卫 
  5. 在路由配置里调用 beforeEnter
  6. 解析异步路由组件。
  7. 在被激活的组件里调用 beforeRouteEnter
  8. 调用全局的 beforeResolve 守卫
  9. 导航被确认。
  10. 调用全局的 afterEach 钩子。
  11. 触发 DOM 更新。
  12. 用创建好的实例调用 beforeRouteEnter 守卫中传给 next 的回调函数。

Logo

前往低代码交流专区

更多推荐