• 首页
  • vue
  • TypeScript
  • JavaScript
  • scss
  • css3
  • html5
  • php
  • MySQL
  • redis
  • jQuery
  • 导航守卫

    正如其名,vue-router提供的导航守卫主要用来通过跳转或取消的方式守卫导航。有多种机会植入路由导航过程中:全局的,单个路由独享的,或者组件级的。

    全局前置守卫

    你可以使用router.beforeEach注册一个全局前置守卫:

    const router = createRouter({ ... })
    
    router.beforeEach((to, from) => {
      // ...
      // 返回 false 以取消导航
      return false
    })
    

    当一个导航触发时,全局前置守卫按照创建顺序调用。守卫是异步解析执行,此时导航在所有守卫resolve完之前一直处于等待中


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

    • to:即将要进入的目标,用一种标准化的方式。
    • from:当前导航正要离开的路由,用一种标准化的方式。

    可以返回的值如下:

    • false:取消当前的导航。如果浏览器的 URL 改变了(可能是用户手动或者浏览器后退按钮),那么 URL 地址会重置到from路由对应的地址。
    • 一个路由地址:通过一个路由地址跳转到一个不同的地址,就像你调用router.push()一样。你可以设置诸如replace: truename:'home'之类的配置。当前的导航被中断,然后进行一个新的导航,就和from一样。
    • Error:如果遇到了意料之外的情况,可能会抛出一个错误throw error。这会取消导航并且调用router.onError()注册过的回调。
    • undefinedtrue:如果什么都没有undefined或返回true,则导航是有效的,并调用下一个导航守卫。


    以上所有都同async函数和Promise工作方式一样:

     router.beforeEach(async (to, from) => {
       // 检查用户是否已登录,避免无限重定向
       if (!isAuthenticated && to.name !== 'Login') {
         // 将用户重定向到登录页面
         return { name: 'Login' }
       }
     })
    
    router.beforeEach(async (to, from) => {
      // canUserAccess() 返回 `true` 或 `false`
      const canAccess = await canUserAccess(to)
      if (!canAccess) return '/login'
    })
    


    可选的第三个参数next

    在之前的 Vue Router 版本中,也是可以使用第三个参数next的。这是一个常见的错误来源,可以通过 RFC 来消除错误。然而,它仍然是被支持的,这意味着你几乎可以向任何导航守卫传递第三个参数。在这种情况下,确保next在任何给定的导航守卫中都被严格调用一次。它可以出现多于一次,但是只能在所有的逻辑路径都不重叠的情况下,否则钩子永远都不会被resolvedrejected。这里有一个在用户未能验证身份时重定向到/login的错误用例:

    // BAD
    router.beforeEach((to, from, next) => {
      if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
      // 如果用户未能验证身份,则 `next` 会被调用两次
      next()
    })
    
    
    下面是正确的版本:
    router.beforeEach((to, from, next) => {
      if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
      else next()
    })
    


    next()函数的几种用法:

    • next():进行下一个钩子。如果全部钩子执行完了,则导航的状态就是 confirmed(确认的)。
    • next('/login')next({path:'/login'})next({name:'Login'}):跳转到新地址。
    • next(false):中断当前的导航。
    • next(error):如果传入的参数是一个Error实例,则导航会被终止,且该错误会被传递给router.onError()注册过的回调。
    router.beforeEach((to, from, next) => {
        document.title = to.meta.title;
        if (to.meta.needLogin && !$store.state.isLogin) {
          next({
            path: '/login'
          })
        }
        else {
          next()
        }
      })
    


    全局解析守卫

    你可以用router.beforeResolve注册一个全局守卫。这和router.beforeEach类似,因为它在每次导航时都会触发,但是确保在导航被确认之前,同时在所有组件内守卫和异步路由组件被解析之后,解析守卫就被正确调用。这里有一个例子,确保用户可以访问自定义路元信息meta属性中的requiresCamera的路由:

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

    router.beforeResolve获取数据执行任何其他操作的理想位置。比如,如果用户无法进入页面时,你希望避免执行的操作。


    全局后置钩子

    你也可以注册全局后置钩子,然而和守卫不同的是,这些钩子不接受next()函数,也不会改变导航本身:

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

    它们对于声明更改页面标题 title 等辅助功能以及许多其他事情都很有用。

    它们也反映了Navigation Failure(导航故障)作为,第三个参数failure

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


    路由独享的守卫

    你可以在路由配置上直接定义beforeEnter守卫:

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

    beforeEnter守卫,只在进入路由时触发,不会在paramsqueryhash改变时触发。例如,从/users/2进入到/users/3或者从/users/2#info进入到/users/2#projects。它们只有在进入一个不同的路由导航时,才会被触发。

    你也可以将一个函数数组传递给beforeEnter,这在为不同的路由重用守卫时很有用:

    function removeQueryParams(to) {
      if (Object.keys(to.query).length)
        return { path: to.path, query: {}, hash: to.hash }
    }
    
    function removeHash(to) {
      if (to.hash) return { path: to.path, query: to.query, hash: '' }
    }
    
    const routes = [
      {
        path: '/users/:id',
        component: UserDetails,
        beforeEnter: [removeQueryParams, removeHash],
      },
      {
        path: '/about',
        component: UserDetails,
        beforeEnter: [removeQueryParams],
      },
    ]
    

    请注意,你也可以通过使用路径 meta 字段和全局导航守卫来实现类似的行为。


    组件内的守卫

    最后,你可以在路由组件内直接定义以下路由导航守卫:

    • beforeRouteEnter
    • beforeRouteUpdate
    • beforeRouteLeave
    const UserDetails = {
      template: `...`,
      beforeRouteEnter(to, from) {
        // 在渲染该组件的对应路由被验证前调用
        // 不能获取组件实例 `this` 。因为当守卫执行时,组件实例还没被创建!
      },
      beforeRouteUpdate(to, from) {
        // 在当前路由改变,但是该组件被复用时调用
        // 举例来说,对于一个带有动态参数的路径 `/users/:id`,在 `/users/1` 和 `/users/2` 之间跳转的时候,
        // 由于会渲染同样的 `UserDetails` 组件,因此组件实例会被复用。而这个钩子就会在这个情况下被调用。
        // 因为在这种情况发生的时候,组件已经挂载好了,导航守卫可以访问组件实例 `this`
      },
      beforeRouteLeave(to, from) {
        // 在导航离开渲染该组件的对应路由时调用
        // 与 `beforeRouteUpdate` 一样,它可以访问组件实例 `this`
      },
    }
    


    beforeRouteEnter守卫不能访问this,因为守卫在导航确认前被调用,因此即将登场的新组件还没被创建。

    不过,你可以通过传一个回调给next来访问组件实例。在导航被确认的时候执行回调,并且把组件实例vm作为回调方法的参数。

    beforeRouteEnter (to, from, next) {
      next(vm => {
        // 通过 `vm` 访问组件实例
      })
    }
    

    注意:beforeRouteEnter是支持给next传递回调的唯一守卫。对于beforeRouteUpdatebeforeRouteLeave来说,this已经可用了,所以不支持传递回调,因为没有必要了。

    beforeRouteUpdate (to, from) {
      // just use `this`
      this.name = to.params.name
    }
    


    离开守卫,通常用来禁止用户,在还未保存修改前,突然离开。该导航可以通过返回false来取消。

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


    完整的导航解析流程

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