深入Vue-Router源码分析路由实现原理
使用Vue开发SPA应用,离不开vue-router,那么vue和vue-router是如何协作运行的呢,下面从使用的角度,大白话帮大家一步步梳理下vue-router的整个实现流程。
到发文时使用的版本是:
- vue (v2.5.0)
- vue-router (v3.0.1)
一、vue-router 源码结构
github 地址:https://github.com/vuejs/vue-router
components下是两个组件<router-view> 和 <router-link>
history是路由方式的封装,提供三种方式
util下主要是各种功能类和功能函数
create-matcher和create-router-map是生成匹配表
index是VueRouter类,也整个插件的入口
Install 提供安装的方法
先整体展示下vue-router使用方式,请牢记一下几步哦。
import Vue from 'vue' import VueRouter from 'vue-router' //注册插件 如果是在浏览器环境运行的,可以不写该方法 Vue.use(VueRouter) // 1. 定义(路由)组件。 // 可以从其他文件 import 进来 const User = { template: '<div>用户</div>' } const Role = { template: '<div>角色</div>' } // 2. 定义路由 // Array,每个路由应该映射一个组件。 const routes = [ { path: '/user', component: User }, { path: '/home', component: Home } ] // 3. 创建 router 实例,并传 `routes` 配置 const router = new VueRouter({ routes }) // 4. 创建和挂载根实例。 // 记得要通过 router 对象以参数注入Vue, // 从而让整个应用都有路由功能 // 使用 router-link 组件来导航. // 路由出口 // 路由匹配到的组件将渲染在这里 const app = new Vue({ router, template: ` <div> <h1>Basic</h1> <ul> <li><router-link to="https://www.jb51.net/">/</router-link></li> <li><router-link to="/user">用户</router-link></li> <li><router-link to="/role">角色</router-link></li> <router-link tag="li" to="/user">/用户</router-link> </ul> <router-view></router-view> </div> ` }).$mount('#app')
分析开始
第一步
Vue是使用.use( plugins )方法将插件注入到Vue中。
use方法会检测注入插件VueRouter内的install方法,如果有,则执行install方法。
注意:如果是在浏览器环境,在index.js内会自动调用.use方法。如果是基于node环境,需要手动调用。
if (inBrowser && window.Vue) { window.Vue.use(VueRouter) }
Install解析 (对应目录结构的install.js)
该方法内主要做了以下三件事:
1、对Vue实例混入beforeCreate钩子操作(在Vue的生命周期阶段会被调用)
2、通过Vue.prototype定义router、router、route 属性(方便所有组件可以获取这两个属性)
3、Vue上注册router-link和router-view两个组件
export function install (Vue) { if (install.installed && _Vue === Vue) return install.installed = true _Vue = Vue const isDef = v => v !== undefined const registerInstance = (vm, callVal) => { let i = vm.$options._parentVnode if (isDef(i) && isDef(i = i.data) && isDef(i = i.registerRouteInstance)) { i(vm, callVal) } } Vue.mixin({ //对Vue实例混入beforeCreate钩子操作 beforeCreate () { if (isDef(this.$options.router)) { this._routerRoot = this this._router = this.$options.router this._router.init(this) Vue.util.defineReactive(this, '_route', this._router.history.current) } else { this._routerRoot = (this.$parent && this.$parent._routerRoot) || this } registerInstance(this, this) }, destroyed () { registerInstance(this) } }) //通过Vue.prototype定义$router、$route 属性(方便所有组件可以获取这两个属性) Object.defineProperty(Vue.prototype, '$router', { get () { return this._routerRoot._router } }) Object.defineProperty(Vue.prototype, '$route', { get () { return this._routerRoot._route } }) //Vue上注册router-link和router-view两个组件 Vue.component('RouterView', View) Vue.component('RouterLink', Link) const strats = Vue.config.optionMergeStrategies // use the same hook merging strategy for route hooks strats.beforeRouteEnter = strats.beforeRouteLeave = strats.beforeRouteUpdate = strats.created }
第二步 生成router实例
const router = new VueRouter({ routes })
生成实例过程中,主要做了以下两件事
1、根据配置数组(传入的routes)生成路由配置记录表。
2、根据不同模式生成监控路由变化的History对象
注:History类由HTML5History、HashHistory、AbstractHistory三类继承
history/base.js实现了基本history的操作
history/hash.js,history/html5.js和history/abstract.js继承了base,只是根据不同的模式封装了一些基本操作
第三步 生成vue实例