【Vue】【Vue Router】导航守卫(路由守卫)

387 阅读4分钟

1. 什么是路由守卫?作用是什么?

路由守卫,又叫路由的导航守卫,也可以理解为路由的生命周期(钩子函数)。
用来通过调整或取消的方式保护我们路由,比如token失效需要重定向到登录页,比如无效路由需要重定向到首页。
从使用范围上可以划分为三种:全局的、组件级的和独享的

2. 分类

2.1. 全局的守卫

全局前置守卫 - router.beforeEach

进入路由之前执行。 当一个导航触发时,全局前置守卫按照创建顺序调用。守卫是异步解析执行,此时导航在所有守卫 resolve 完之前一直处于等待中
可以在这里配置token失效重定向到登录页等清空;

守卫方法接收3个参数:

  • to: 必填参数,即将要进入的目标。
  • from:必填参数,当前导航正要离开的路由
    to和from参数参考示例: { fullPath: "", hash: "", matched: [], meta: {}, name: "", params: {}, path: "", query: {}}
  • next: 可选参数,钩子函数,里面可定义参数,确认下一步路由要做什么。
    next():直接就是进去该路由;
    next({ path: "/login" }):跳转新路由,当前的导航被中断,重定向到一个新的路由;
    next(false):取消进入路由,url地址重置为from路由地址(也就是将要离开的路由地址)。
    设置方式:next('path地址')或者next({path:''})或者next({name:''})
    【注意点】在使用next时需要注意的是:可以多次使用,但是一个逻辑路径中只能使用一次,否则钩子永远都不会被解析或报错。
    报错示例:router.beforeEach((to, from, next) => {next({ name: "login" }); next();}) image.png 正确使用:
    router.beforeEach((to, from, next) => {
        if(XXX) next({ name: "login" });
        else next();
   })

全局解析守卫 - router.beforeResolve

跟“全局前置守卫 - router.beforeEach”类似。在“router.beforeEach”之后,同时在“beforeRouteEnter”所有组件内守卫和异步路由组件被解析之后,解析守卫就被正确调用。
是获取数据或执行任何其他操作(如果用户无法进入页面时你希望避免执行的操作)的理想位置。
更适用于对于分析、更改页面标题、声明页面等辅助功能

官网示例

router.beforeResolve(async to => {
  if (to.meta.requiresCamera) {
    try {
      await askForCameraPermission()
    } catch (error) {
      if (error instanceof NotAllowedError) {
        // ... 处理错误,然后取消导航
        return false
      } else {
        // 意料之外的错误,取消导航并把错误传给全局处理器
        throw error
      }
    }
  }
})

全局后置钩子 - router.afterEach

不接受next函数也不会改变导航本身

官网示例

router.afterEach((to, from) => {
  sendToAnalytics(to.fullPath)
})

2.2. 组件内的守卫

直接在路由组件内定义使用的路路由导航

beforeRouteEnter

在渲染该组件的对应路由被验证前调用
不能获取组件实例 this
因为当守卫执行时,组件实例还没被创建!可以通过传一个回调给 next 来访问组件实例。在导航被确认的时候执行回调,并且把组件实例作为回调方法的参数:

beforeRouteEnter (to, from, next) {
    console.log(this); // undefined
    next(vm => {
      // 通过 `vm` 访问组件实例
      console.log(vm); // 组件实例
    })
}

beforeRouteUpdate

在当前路由改变,但是该组件被复用时调用
举例来说,对于一个带有动态参数的路径 /users/:id,在 /users/1/users/2 之间跳转的时候,由于会渲染同样的 UserDetails 组件,因此组件实例会被复用。而这个钩子就会在这个情况下被调用。
因为在这种情况发生的时候,组件已经挂载好了,导航守卫可以访问组件实例 this

beforeRouteLeave

在导航离开渲染该组件的对应路由时调用。可以访问组件实例 this
通常用来预防用户在还未保存修改前突然离开。该导航可以通过返回 false 来取消。

    beforeRouteLeave (to, from) {
        const answer = window.confirm('Do you really want to leave? you have unsaved changes!')
        if (!answer) return false
    },

image.png

2.3. 独享的守卫

beforeEnter

beforeEnter 守卫 只在进入路由时触发,不会在 paramsquery 或 hash 改变时触发。例如,从 /users/2 进入到 /users/3 或者从 /users/2#info 进入到 /users/2#projects。它们只有在 从一个不同的 路由导航时,才会被触发。
参数用法什么的都一样,调用顺序在全局前置守卫router.beforeEach后面,所以不会被全局守卫覆盖

const routes = [
  {
    path: '/users/:id',
    component: UserDetails,
    beforeEnter: (to, from) => {
      // reject the navigation
      return false
    },
  },
]

3. 完整的导航解析流程

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

【参考】

VueRouter-导航守卫