（四十七）Vue Router之路由守卫

上一篇：（四十六）Vue Router组件所独有的两个钩子activate、deactivated

概念

路由守卫是在前端应用中用于控制和管理路由导航的机制。它们允许开发人员在路由导航事件发生之前或之后执行一些逻辑。

路由守卫可以用于实现以下功能：

• 身份验证：通过在路由导航之前检查用户的身份验证状态，可以防止未经授权的用户访问受保护的页面。如果用户未登录或没有足够的权限，可以重定向到登录页面或显示适当的提示信息。
• 授权：除了身份验证外，路由守卫还可以检查用户是否具有足够的权限访问某个页面或执行某个操作。如果用户权限不足，可以阻止导航或采取其他适当的措施。
• 数据预加载：在加载某个路由之前，可以使用路由守卫来预加载所需的数据。这可以提高用户体验，减少页面加载时间，并确保页面所需的数据在渲染之前已经准备好。

全局路由守卫

全局路由守卫是应用于整个路由系统的守卫机制。它们会在每次路由导航事件发生时触发，并允许开发人员执行一些全局级别的逻辑。

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

• 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 函数在任何给定的导航守卫中都被严格调用一次。它可以出现多于一次，但是只能在所有的逻辑路径都不重叠的情况下，否则钩子永远都不会被解析或报错。
这里有一个在用户未能验证身份时重定向到 /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()
})

全局路由守卫分类：

• 全局前置路由守卫
• 全局解析路由守卫
• 全局后置路由守卫

执行顺序：

• 全局前置路由守卫 (beforeEach)按照注册顺序执行。
• 解析路由守卫 (beforeResolve)按照注册顺序执行。
• 路由组件实例化和渲染。
• 全局后置路由守卫 (afterEach)按照注册顺序执行。

全局前置守卫

当一个导航触发时，初始化的时候和每次路由切换之前调用，全局前置守卫按照创建顺序调用。守卫是异步解析执行，此时导航在所有守卫 resolve 完之前一直处于等待中。
你可以使用 router.beforeEach 注册一个全局前置守卫：

const router = new VueRouter({ ... })

//全局前置路由守卫---初始化的时候和每次路由切换之前调用
router.beforeEach((to, from, next) => {
  // ...
})

全局解析守卫

全局解析守卫是一个在路由导航之前触发的守卫机制，用于在路由进入组件之前预加载所需的数据。它可以在整个路由系统中应用，确保数据在组件渲染之前已经准备好。

const router = new VueRouter({ ... })

router.beforeResolve((to, from, next) => {
  // 在路由导航之前触发，可以执行解析逻辑或其他操作
  // 在这里可以预加载数据或执行其他全局级别的处理

  next(); // 确保继续路由导航
});

全局后置路由守卫

全局后置路由守卫是Vue Router中的一种路由守卫，用于在路由导航完成后执行一些操作。它可以用于记录页面访问日志、执行统计分析或其他需要在路由导航后进行的全局级别处理。

和其他守卫不同的是，这些钩子不会接受 next 函数也不会改变导航本身：

const router = new VueRouter({ ... })

//全局后置路由守卫---初始化的时候和每次路由切换之后被调用
router.afterEach((to, from) => {
  // 在路由导航完成后触发，可以执行一些操作
  // 在这里可以记录页面访问日志、执行统计分析或其他全局级别的处理
});

独享路由守卫

在Vue Router中，你可以使用全局独享路由守卫来为特定的路由配置独立的守卫。全局独享路由守卫提供了更细粒度的控制，可以在特定路由上执行一些操作或验证逻辑。全局独享路由守卫可以通过在路由配置中的beforeEnter字段中定义一个守卫函数来实现。

const router = new VueRouter({
  routes: [
    {
      path: '/xxx',
      component: xxx,
      beforeEnter: (to, from, next) => {
        // 在进入路由之前触发，可以执行一些操作或验证逻辑
        // 在这里可以进行身份验证或其他特定路由级别的处理

        next(); // 确保继续路由导航
      }
    },
    // 其他路由配置...
  ]
});

组件内的守卫

可以在组件内部定义路由守卫，以便在特定组件中执行相关的操作或验证逻辑。这种类型的守卫被称为组件内的路由守卫（Component Guard）。Vue Router提供了以下几种组件内的路由守卫：

• beforeRouteEnter：在进入路由之前被调用。它在组件实例被创建之前被调用，因此在该守卫中无法直接访问组件实例this。
• beforeRouteUpdate(2.2 新增)：在当前路由改变，但是该组件被复用时调用。它可以用于响应路由参数的变化，以及在组件复用时执行一些逻辑。可以访问组件实例 this
• beforeRouteLeave：在离开当前路由之前被调用。可以用于确认是否离开当前页面、保存表单等操作。可以访问组件实例 this

beforeRouteEnter

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

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

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

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

beforeRouteUpdate

在当前路由改变，但是该组件被复用时调用，举例来说，对于一个带有动态参数的路径 /foo/:id，在 /foo/1 和 /foo/2 之间跳转的时候，由于会渲染同样的 Foo 组件，因此组件实例会被复用。而这个钩子就会在这个情况下被调用。

beforeRouteUpdate (to, from, next) {
  // 可以使用 `this`
}

beforeRouteLeave

导航离开该组件的对应路由时调用

beforeRouteLeave(to, from, next) {
    // 可以访问组件实例 `this`
}

完整的导航解析流程

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 的回调函数，创建好的组件实例会作为回调函数的参数传入。