本文演示代码基于 vue-router 4.x
前言vue-router 有几种钩子函数?具体是什么及执行流程是怎样的?
先上思维导图。
分析vue-router 的 钩子函数 ,其实说的就是 导航守卫 。
引用官网的话
“导航” 表示路由正在发生改变。
vue-router 提供的导航守卫主要用来通过 跳转 或 取消 的方式 守卫导航 。有多种机会植入路由导航过程中:全局的, 单个路由独享的, 或者组件级的。
也就是:全局守卫、路由守卫、组件守卫。
代码演示环境搭建先简单搭建一下环境
index.js
代码语言:javascript复制/*
* @Description:一尾流莺
* @Date: 2021-03-21 16:17:56
* @LastEditTime: 2021-07-18 15:14:42
* @FilePath: \vite-project-js\src\router\index.js
*/
import { createRouter, createWebHashHistory } from 'vue-router';
const router = createRouter({
history: createWebHashHistory(),
routes: [
{
path: '/a',
component: () => import('../components/A.vue'),
},
{
path: '/b',
component: () => import('../components/B.vue'),
},
{
path: '/c',
component: () => import('../components/C.vue'),
},
],
});
export default router; main.js
代码语言:javascript复制// index.js
import router from "./router";
createApp(App).use(router).mount("#app"); 页面A
代码语言:javascript复制
我是页面A啊
页面B
代码语言:javascript复制
我是页面B啊
页面C
代码语言:javascript复制
我是页面C啊
通用组件
代码语言:javascript复制
当前页面是这样的,有点丑,凑活看吧,咱也不是来学习 css 的
全局守卫顾名思义,是要定义在全局的,也就是我们 index.js 中的 router 对象。
beforeEach全局前置守卫,在路由跳转前触发,它在 每次导航 时都会触发。
通过 router.beforeEach 注册一个全局前置守卫。
代码语言:javascript复制router.beforeEach((to, from, next) => {
console.log('🚀🚀~ to:', to);
console.log('🚀🚀~ from:', from);
next();
})参数beforeEach 全局前置守卫接收三个参数
to: Route: 即将要进入的目标路由对象from: Route: 当前导航正要离开的路由对象next: Function: 一定要调用该方法不然会阻塞路由。注意: next 参数可以不添加,但是一旦添加,则必须调用一次,否则路由跳转等会停止。
next()方法的几种情况
next(): 进行管道中的下一个钩子。next(false): 中断当前的导航。回到 from 路由对应的地址。next('/') 或者 next({ path: '/' }): 跳转到一个不同的地址,可传递的参数与 router.push 中选项一致。next(error): 导航终止,且该错误会被传递给 router.onError() 注册过的回调。我们把前两个参数打印出来看一下,里面包含路径,参数,元信息等内容。
返回值false:取消当前的导航。null,undefined,true或者直接return:调用下一个导航守卫。定义多个守卫全局前置守卫可以定义多个,根据创建顺序调用。在所有守卫完成之前导航一直处于等待中。
下面这个例子中我们就定义了两个 beforeEach 全局前置守卫。可以看到,只有在两秒以后分别打印出两条日志后才进行页面的跳转。
代码语言:javascript复制//index.js
router.beforeEach((to, from, next) => {
setTimeout(() => {
console.log('🚀🚀~ beforeEach1');
next();
}, 1000);
});
router.beforeEach((to, from, next) => {
setTimeout(() => {
console.log('🚀🚀~ beforeEach2');
next();
}, 1000);
});除了 beforeEach 全局前置守卫之外,其他的全局守卫都可以定义多个,并且在所有守卫完成之前导航一直处于等待中,其他的钩子函数就不进行演示了。
beforeResolve全局解析守卫,在路由跳转前,所有 组件内守卫 和 异步路由组件 被解析之后触发,它同样在 每次导航 时都会触发。
通过 router.beforeResolve 注册一个全局解析守卫。
代码语言:javascript复制router.beforeResolve((to, from, next) => {
next();
})回调参数,返回值和 beforeEach 一样。也可以定义多个全局解析守卫。
afterEach全局后置钩子,它发生在路由跳转完成后,beforeEach 和 beforeResolve 之后,beforeRouteEnter(组件内守卫)之前。它同样在 每次导航 时都会触发。
通过 router.afterEach 注册一个全局后置钩子。
代码语言:javascript复制router.afterEach((to, from) => {
console.log('🚀🚀~ afterEach:');
})这个钩子的两个参数和 beforeEach 中的 to 和 from 一样。然而和其它全局钩子不同的是,这些钩子不会接受 next 函数,也不会改变导航本身。
路由守卫顾名思义,就是跟路由相关的钩子,我们的路由守卫只有一个,就是 beforeEnter。
beforeEnter需要在路由配置上定义 beforeEnter 守卫,此守卫只在进入路由时触发,在 beforeEach 之后紧随执行,不会在 params、query 或 hash 改变时触发。
代码语言:javascript复制//index.js
{
path: '/a',
component: () => import('../components/A.vue'),
beforeEnter: (to, from) => {
console.log('🚀🚀~ beforeEnter ');
},
},beforeEnter 路由守卫的参数是 to、from、next ,同 beforeEach 一样。
组件守卫顾名思义,是定义在路由组件内部的守卫。
beforeRouteEnter代码语言:javascript复制 //A.vue
beforeRouteEnter(to, from,next) {
console.log('🚀🚀~ beforeRouteEnter');
},路由进入组件之前调用,该钩子在全局守卫 beforeEach 和路由守卫 beforeEnter 之后,全局 beforeResolve 和全局 afterEach 之前调用。
参数包括 to,from,next。
该守卫内访问不到组件的实例,也就是 this 为 undefined,也就是他在 beforeCreate 生命周期前触发。
beforeRouteUpdate代码语言:javascript复制 //A.vue
beforeRouteUpdate(to, from) {
console.log('🚀🚀~ beforeRouteUpdate');
},对于 beforeRouteUpdate 来说,this 已经可用了,所以给 next 传递回调就没有必要了。
beforeRouteLeave代码语言:javascript复制 //A.vue
beforeRouteLeave(to, from) {
console.log('🚀🚀~ beforeRouteLeave');
},对于 beforeRouteLeave 来说,this 已经可用了,所以给 next 传递回调就没有必要了。
总结完整的导航解析流程
导航被触发。在失活的组件里调用 beforeRouteLeave 守卫。调用全局的 beforeEach 守卫。在重用的组件里调用 beforeRouteUpdate 守卫。在路由配置里调用 beforeEnter。解析异步路由组件。在被激活的组件里调用 beforeRouteEnter。调用全局的 beforeResolve 守卫。导航被确认。调用全局的 afterEach 钩子。触发 DOM 更新。调用 beforeRouteEnter 守卫中传给 next 的回调函数,创建好的组件实例会作为回调函数的参数传入。上面是官方给出的答案,现在我们用流程图来直观的展示一下。
参考vue-router 官方网站