Vue Router 导航守卫



  • 定义和用法

    vue-router 提供的导航守卫主要用来通过跳转或取消的方式守卫导航。有多种机会植入路由导航过程中:全局的, 单个路由独享的, 或者组件级的。
    记住参数或查询的改变并不会触发进入/离开的导航守卫。你可以通过观察 $route 对象来应对这些变化,或使用 beforeRouteUpdate 的组件内守卫
  • 全局前置守卫

    你可以使用 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('/') 或者 next({ path: '/' }): 跳转到一个不同的地址。当前的导航被中断,然后进行一个新的导航。你可以向 next 传递任意位置对象,且允许设置诸如 replace: true、name: 'home' 之类的选项以及任何用在 router-link 的 to prop 或 router.push 中的选项。
    • next(error): (2.4.0+) 如果传入 next 的参数是一个 Error 实例,则导航会被终止且该错误会被传递给 router.onError() 注册过的回调。
    确保要调用 next 方法,否则钩子就不会被 resolve
  • 全局解析守卫

    在 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` 访问组件实例
       })
    }
    
    
    注意 beforeRouteEnter 是支持给 next 传递回调的唯一守卫。对于 beforeRouteUpdatebeforeRouteLeave 来说,this 已经可用了,所以不支持传递回调,因为没有必要了。
    beforeRouteUpdate (to, from, next) {
       // just use `this`
       this.name = to.params.name
       next()
    }
    
    
    这个离开守卫通常用来禁止用户在还未保存修改前突然离开。该导航可以通过 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)
       }
     }
    
    
  • 完整的导航解析流程

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

    定义路由的时候可以配置 meta 字段:
    const router = new VueRouter({
       routes: [
          {
             path: '/foo',
             component: Foo,
             children: [
                {
                   path: 'bar',
                   component: Bar,
                   // a meta field
                   meta: { requiresAuth: true }
                }
             ]
          }
       ]
    })
    
    
    那么如何访问这个 meta 字段呢?
    首先,我们称呼 routes 配置中的每个路由对象为 路由记录。路由记录可以是嵌套的,因此,当一个路由匹配成功后,他可能匹配多个路由记录。
    例如,根据上面的路由配置,/foo/bar 这个 URL 将会匹配父路由记录以及子路由记录。
    一个路由匹配到的所有路由记录会暴露为 $route 对象 (还有在导航守卫中的路由对象) 的 $route.matched 数组。因此,我们需要遍历 $route.matched 来检查路由记录中的 meta 字段。
    下面例子展示在全局导航守卫中检查元字段:
    router.beforeEach((to, from, next) => {
       if (to.matched.some(record => record.meta.requiresAuth)) {
          // 此路线需要验证,请检查是否已登录
          // 如果不是,请重定向到登录页面。
          if (!auth.loggedIn()) {
             next({
                path: '/login',
                query: { redirect: to.fullPath } 
             })
          } else {
             next()
          }
       } else {
          next() // 确保一定要调用 next()
       }
    })