Vue--Router--钩子函数(导航守卫)--详解

素颜马尾好姑娘i 2023-10-01 17:02 10阅读 0赞

原文网址：[Vue--Router--钩子函数(导航守卫)--详解\_IT利刃出鞘的博客-CSDN博客][Vue--Router--_--_IT_-CSDN]

## 简介 ##

**说明**

本文介绍Vue Router（路由）的钩子函数（导航卫士）的使用场景。

Vue Router的导航守卫用法，[官网][Link 1]中介绍的很详细了，本处只介绍使用场景。

**官网**

[导航守卫 | Vue Router][Link 1]

## 全局钩子函数 ##

### **beforeEach()**  ###

**说明**

前置守卫。

每次路由进入时执行。

**示例**

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

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

to: 即将要进入的目标  
from: 当前导航正要离开的路由

to和from的格式：[这里][Link 2]

**返回值**

可以返回的值如下:

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

如果出错了，会抛出一个 Error。这会取消导航并且调用 router.onError() 注册过的回调。

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

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

router.beforeEach(async (to, from) => {
      // canUserAccess() 返回 `true` 或 `false`
      const canAccess = await canUserAccess(to)
      if (!canAccess) return '/login'
    })

**可选的第三个参数 next\#**

在之前的 Vue Router 版本中，也是可以使用 第三个参数 next 的。这是一个常见的错误来源，可以通过 RFC 来消除错误。

它仍然是被支持的，也就是说你可以向任何导航守卫传递第三个参数。此时要确保 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()
    })

### beforeResolve() ###

**说明**

解析守卫。

每次导航时都会触发。（在导航被确认之前、并且所有组件内守卫和异步路由组件被解析之后，本函数被调用。）

router.beforeResolve 是如下操作的理想位置：获取数据；执行用户无法进入页面时你希望避免操作。

**示例**

确保用户可以访问自定义 meta 属性 requiresCamera 的路由：

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

### **afterEach()** ###

**说明**

后置钩子。

每次路由进入之后执行。

钩子和守卫不同：钩子不会接受 next 函数也不会改变导航本身。

**使用场景**

1.  分析、更改页面标题
2.  声明页面等辅助功能

**示例**

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

**第三个参数：failure**

可以使用第三个参数判断错误。见：[这里][Link 3]

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

## **单个路由的钩子函数** ##

### **beforeEnter()** ###

**说明**

*  路由进入时执行。
 *  beforeEnter 守卫只在进入路由时触发。
 *  不会在 params、query 或 hash 改变时触发，例如：
    
     *  从 /users/2 进入到 /users/3
     *  从 /users/2\#info 进入到 /users/2\#projects。它们只有在从一个不同的路由导航时，才会被触发。

**示例**

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

可以将一个函数数组传递给 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 字段][meta]和[全局导航守卫][Link 4]来实现类似的行为。

## **组件内的路由钩子函数** ##

**组件内路由钩子写法**

<template>
      <div>
        这是Demo
      </div>
    </template> 
    
    <script>
    export default {
      name: 'Demo',
      beforeRouteEnter (to, from, next) {
        console.log('来自：' + from.name)
        console.log('去往：' + to.name)
        next()
      }
    }
    </script>
    
    <style scoped>
    </style>

*  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 方法，否则钩子就不会被 resolved。

> 注意：官网上说只有beforeRouteEnter支持next。但我自测，所有钩子都支持next，而且最后必须调用next，否则路由不会跳转！！（这样也无法跳转：不写next，最后返回true）

### beforeRouteEnter() ###

**说明**

进入本路由时执行。（在渲染该组件的对应路由被验证前调用）

不能获取组件实例 \`this\` ！（因为当守卫执行时，组件实例还没被创建！）。解决方法：传一个回调给 next 来访问组件实例。在导航被确认的时候执行回调，并且把组件实例作为回调方法的参数：

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

**示例**

beforeRouteEnter (to, from, next) {
      console.log('来自：' + from.name)
      console.log('去往：' + to.name)
      next(true)
    }

### beforeRouteUpdate() ###

**说明**

路由更新时执行。（在当前路由改变且该组件被复用时调用）。

比如：对于一个带有动态参数的路径 \`/users/:id\`，在 \`/users/1\` 和 \`/users/2\` 之间跳转的时候，由于会渲染同样的 \`UserDetails\` 组件，因此组件实例会被复用。而这个钩子就会在这个情况下被调用。

可以获取组件实例 \`this\` 。（因为组件已经挂载好了）

**示例**

beforeRouteUpdate (to, from, next) {
      console.log('来自：' + from.name)
      console.log('去往：' + to.name)
      next()
    }

### beforeRouteLeave() ###

**说明**

离开本路由时执行。（在导航离开渲染该组件的对应路由时调用）。

与 \`beforeRouteUpdate\` 一样，它可以访问组件实例 \`this\`

**使用场景**

预防用户在还未保存修改前突然离开。该导航可以通过返回 false 来取消。代码如下：

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

## 导航执行流程 ##

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

[Vue--Router--_--_IT_-CSDN]: https://knife.blog.csdn.net/article/details/122762150
[Link 1]: https://router.vuejs.org/zh/guide/advanced/navigation-guards.html
[Link 2]: https://router.vuejs.org/zh/api/#routelocationnormalized
[Link 3]: https://router.vuejs.org/zh/guide/advanced/navigation-failures.html
[meta]: https://router.vuejs.org/zh/guide/advanced/meta.html
[Link 4]: https://router.vuejs.org/zh/guide/advanced/navigation-guards.html#global-before-guards