Vue Router学习(十三)——全局导航守卫源码解析

前言

我们花了两节介绍了全局导航守卫、组件导航守卫的含义与用法。本节我们从源码的角度去解析一下导航守卫,加深对导航守卫的理解。

源码解析

全局导航守卫有三个,在github上打开源码,在router.ts文件就能找到三个全局守卫,首先我们就从守卫的初始化入手。

初始化

在router.ts中搜索beforeEach第一个结果就是beforeEach的ts类型,剩余两个就在其下面:

  • beforeEach,存在于接口Router类型中,具体的ts类型为:
  • beforeResolve的ts类型跟beforeEach是一样的,其中参数guard就是to,from,next:
  • afterEach的类型的参数跟前面有所不同,具体为to、from、failure:

三者的都会返回一个移除该钩子的函数,到此我们就知道三者的ts类型,继续搜索关键字会发现三者在实例化router中的初始值:

js 复制代码
beforeEach: beforeGuards.add,
beforeResolve: beforeResolveGuards.add,
afterEach: afterGuards.add,

三个守卫对应着三个guards,这三个guards是声明好的变量,对应的值也很简单就是将对应的ts类型用useCallbacks方法进行了创建:

js 复制代码
const beforeGuards = useCallbacks<NavigationGuardWithThis<undefined>>()
const beforeResolveGuards = useCallbacks<NavigationGuardWithThis<undefined>>()
const afterGuards = useCallbacks<NavigationHookAfter>()

在utils文件夹中我们可以找到callbacks文件里面就有useCallbacks方法:

该方法中有两个方法,一个add将参数添加到list中,并且返回当前值;一个reset将list清空,最后返回一个对象,其中list是通过slice 方法进行了拷贝。该方法主要用于收集导航守卫,在讲解导航守卫的时候我们也提到,可以有多个守卫。全局守卫的值就是add函数,全局守卫写法的根由就在此,我们将守卫函数当做参数调用beforeEach就能被收集到列表中:

js 复制代码
router.beforeEach((to, from) => {
})
// 也就是
useCallbacks.add((to, from) => {
})

执行

全局导航守卫是在导航时触发的,我们肯定需要找导航相关的逻辑,而导航方式有多种,这里我们以router.push方式为例解析,这里重点解析全局守卫相关代码。

  1. push方法会调用pushWithRedirect方法,该方法接收to参数。
  2. 导航过程有错误会通过createRouterError 创建错误,在返回结果中调用;无错误执行navigate 导航。
  3. 在navigate中会调用runGuardQueue ,在第一个.then中就能找到beforeEach: 我们可以看到上面函数return了runGuardQueue并且.then了下去,这里可以考虑下是何目的。
  4. 在runGuardQueue中会循环收集到的前置守卫,也就是beforeGuards.list(),然后执行guardToPromiseFn将结果添加到新数组guards中。
  5. 找到guardToPromiseFn,我们可以看到该函数声明三次也就是函数重载。
    该函数会返回一个Promise构造函数,在函数中会声明一个next函数 ,该函数会进行判断执行对应的导航流程。beforeEach中能够返回结果,这个结果就是通过next执行的。 6.beforResolve跟beforeEach逻辑基本一样,上面我们提到函数.then了下去,就是为了执行导航守卫流程
    7.回到pushWithRedirect方法中执行完navigate之后,继续往下走就是triggerAfterEach方法,用来执行afterEach:

afterGuards的list就是收集到的后置守卫,循环后置守卫然后执行runWithContext 函数,该函数主要为了兼容vue版本。

总结

以上就是导航守卫的源码解读,总结下来全局导航守卫执行过程就是收集、在导航过程中循环执行守卫钩子函数。

相关推荐
琹箐3 分钟前
ant-design4.xx实现数字输入框; 某些输入法数字需要连续输入两次才显示
前端·javascript·anti-design-vue
程序员-小李3 分钟前
VuePress完美整合Toast消息提示
前端·javascript·vue.js
Uyker1 小时前
从零开始制作小程序简单概述
前端·微信小程序·小程序
EndingCoder5 小时前
React从基础入门到高级实战:React 实战项目 - 项目三:实时聊天应用
前端·react.js·架构·前端框架
阿阳微客6 小时前
Steam 搬砖项目深度拆解:从抵触到真香的转型之路
前端·笔记·学习·游戏
德育处主任Pro7 小时前
『React』Fragment的用法及简写形式
前端·javascript·react.js
CodeBlossom7 小时前
javaweb -html -CSS
前端·javascript·html
打小就很皮...8 小时前
HBuilder 发行Android(apk包)全流程指南
前端·javascript·微信小程序
集成显卡9 小时前
PlayWright | 初识微软出品的 WEB 应用自动化测试框架
前端·chrome·测试工具·microsoft·自动化·edge浏览器
前端小趴菜059 小时前
React - 组件通信
前端·react.js·前端框架