导航守卫

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

全局前置守卫

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

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

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

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

可以返回的值如下:

  • false: 取消当前的导航。如果浏览器的 URL 改变了(可能是用户手动或者浏览器后退按钮),那么 URL 地址会重置到 from 路由对应的地址。
  • 一个路由地址: 通过一个路由地址跳转到一个不同的地址,就像你调用 router.push() 一样,你可以设置诸如 replace: truename: 'home' 之类的配置。当前的导航被中断,然后进行一个新的导航,就和 from 一样。

如果遇到了意料之外的情况,可能会抛出一个 Error。这会取消导航并且调用 router.onError() 注册过的回调。

如果什么都没有,undefined 或返回 true则导航是有效的,并调用下一个导航守卫

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

  1. router.beforeEach(async (to, from) => {
  2. // canUserAccess() 返回 `true` 或 `false`
  3. return await canUserAccess(to)
  4. })

可选的第三个参数 next

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

  1. // BAD
  2. router.beforeEach((to, from, next) => {
  3. if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
  4. // 如果用户未能验证身份,则 `next` 会被调用两次
  5. next()
  6. })

下面是正确的版本:

  1. // GOOD
  2. router.beforeEach((to, from, next) => {
  3. if (to.name !== 'Login' && !isAuthenticated) next({ name: 'Login' })
  4. else next()
  5. })

全局解析守卫

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

  1. router.beforeResolve(async to => {
  2. if (to.meta.requiresCamera) {
  3. try {
  4. await askForCameraPermission()
  5. } catch (error) {
  6. if (error instanceof NotAllowedError) {
  7. // ... 处理错误,然后取消导航
  8. return false
  9. } else {
  10. // 意料之外的错误,取消导航并把错误传给全局处理器
  11. throw error
  12. }
  13. }
  14. }
  15. })

router.beforeResolve 是一个理想的位置,可以在用户无法进入页面的情况下,获取数据或进行任何其他你想避免的操作。

全局后置钩子

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

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

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

它们也反映了 navigation failures 作为第三个参数:

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

了解更多关于 navigation failures 的信息在它的指南中。

路由独享的守卫

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

  1. const routes = [
  2. {
  3. path: '/users/:id',
  4. component: UserDetails,
  5. beforeEnter: (to, from) => {
  6. // reject the navigation
  7. return false
  8. },
  9. },
  10. ]

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

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

  1. function removeQueryParams(to) {
  2. if (Object.keys(to.query).length)
  3. return { path: to.path, query: {}, hash: to.hash }
  4. }
  5. function removeHash(to) {
  6. if (to.hash) return { path: to.path, query: to.query, hash: '' }
  7. }
  8. const routes = [
  9. {
  10. path: '/users/:id',
  11. component: UserDetails,
  12. beforeEnter: [removeQueryParams, removeHash],
  13. },
  14. {
  15. path: '/about',
  16. component: UserDetails,
  17. beforeEnter: [removeQueryParams],
  18. },
  19. ]

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

组件内的守卫

最后,你可以在路由组件内直接定义路由导航守卫(传递给路由配置的)

可用的配置 API

你可以为路由组件添加以下配置:

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

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

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

  1. beforeRouteEnter (to, from, next) {
  2. next(vm => {
  3. // 通过 `vm` 访问组件实例
  4. })
  5. }

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

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

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

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

使用组合 API

如果你正在使用组合 API 和 setup 函数来编写组件,你可以通过 onBeforeRouteUpdateonBeforeRouteLeave 分别添加 update 和 leave 守卫。 请参考组合 API 部分以获得更多细节。

完整的导航解析流程

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