【vue-系列】vue-router原始碼分析

這是一篇集合了從如何檢視 vue-router原始碼（v3.1.3），到 vue-router原始碼解析，以及擴充套件了相關涉及的知識點，科普了完整的導航解析流程圖，一時讀不完，建議收藏。

如何檢視vue-router原始碼

檢視原始碼的方法有很多，下面是我自己讀vue-router原始碼的兩種方法，大家都是怎麼檢視原始碼的，歡迎在評論區留言。

檢視vue-router原始碼 方法一：

1. 下載好 vue-router 原始碼，安裝好依賴。
2. 找到 build/config.js 修改 module.exports，只保留 es，其它的註釋。

module.exports = [
    {
        file: resolve('dist/vue-router.esm.js'),
        format: 'es'
    }
].map(genConfig)
複製程式碼

3. 在根目錄下建立一個 auto-running.js 檔案，用於監聽src檔案的改變的指令碼，監聽到vue-router 原始碼變更就從新構建vue-router執行 node auto-running.js 命令。auto-running.js的程式碼如下：

const { exec } = require('child_process')
const fs = require('fs')

let building = false

fs.watch('./src', {
  recursive: true
}, (event, filename) => {
  if (building) {
    return
  } else {
    building = true
    console.log('start: building ...')
    exec('npm run build', (err, stdout, stderr) => {
      if (err) {
        console.log(err)
      } else {
        console.log('end: building: ', stdout)
      }
      building = false
    })
  }
})
複製程式碼

4.執行 npm run dev命令，將 vue-router 跑起來

檢視vue-router原始碼方法二：

一般專案中的node_modules的vue-router的src不全 不方便檢視原始碼；

所以需要自己下載一個vue-router的完整版，看到哪裡不清楚了，就去vue-router的node_modules的 dist>vue-router.esm.js 檔案裡去打debugger。

為什麼要在vue-router.esm.js檔案裡打點而不是vue-router.js；是因為webpack在進行打包的時候用的是esm.js檔案。

為什麼要在esm.js檔案中打debugger

在vue-router原始碼的 dist/目錄，有很多不同的構建版本。

版本	UMD	Common JS	ES Module(基於構建工具使用)	ES Modules(直接用於瀏覽器)
完整版	vue-router.js	vue-router.common.js	vue-router.esm.js	vue-router.esm.browser.js
完整版（生產環境）	vue-router.min.js			vue-router.esm.browser.min.js

• 完整版：同時包含編譯器和執行時的版本
• UMD：UMD版本可以通過 <script> 標籤直接用在瀏覽器中。
• CommonJS: CommonJS版本用來配合老的打包工具比如webpack1。
• ES Module: 有兩個ES Modules構建檔案：
  1. 為打包工具提供的ESM，ESM被設計為可以被靜態分析，打包工具可以利用這一點來進行“tree-shaking”。
  2. 為瀏覽器提供的ESM，在現代瀏覽器中通過 <script type="module"> 直接匯入

現在清楚為什麼要在esm.js檔案中打點，因為esm檔案為打包工具提供的esm，打包工具可以進行“tree-shaking”。

vue-router專案src的目錄樹

.
├── components
│   ├── link.js
│   └── view.js
├── create-matcher.js
├── create-route-map.js
├── history
│   ├── abstract.js
│   ├── base.js
│   ├── errors.js
│   ├── hash.js
│   └── html5.js
├── index.js
├── install.js
└── util
    ├── async.js
    ├── dom.js
    ├── location.js
    ├── misc.js
    ├── params.js
    ├── path.js
    ├── push-state.js
    ├── query.js
    ├── resolve-components.js
    ├── route.js
    ├── scroll.js
    ├── state-key.js
    └── warn.js
複製程式碼

vue-router的使用

vue-router 是vue的外掛，其使用方式跟普通的vue外掛類似都需要按照、外掛和註冊。 vue-router的基礎使用在 vue-router 專案中 examples/basic，注意程式碼註釋。

// 0.在模組化工程中使用，匯入Vue和VueRouter
import Vue from 'vue'
import VueRouter from 'vue-router'


// 1. 外掛的使用，必須通過Vue.use()明確地安裝路由
// 在全域性注入了兩個元件 <router-view> 和 <router-link>,
// 並且在全域性注入 $router 和 $route，
// 可以在例項化的所有的vue元件中使用 $router路由例項、$route當前路由物件
Vue.use(VueRouter)

// 2. 定義路由元件
const Home = { template: '<div>home</div>' }
const Foo = { template: '<div>foo</div>' }
const Bar = { template: '<div>bar</div>' }
const Unicode = { template: '<div>unicode</div>' }

// 3. 建立路由例項 例項接收了一個物件引數，
// 引數mode:路由模式，
// 引數routes路由配置 將元件對映到路由
const router = new VueRouter({
  mode: 'history',
  routes: [
    { path: '/', component: Home },
    { path: '/foo', component: Foo },
    { path: '/bar', component: Bar },
    { path: '/é', component: Unicode }
  ]
})

// 4. 建立和掛載根例項
// 通過router引數注入到vue裡 讓整個應用都有路由引數
// 在應用中通過元件<router-view>，進行路由切換
// template裡有寫特殊用法 我們晚點討論
new Vue({
  router,
  data: () => ({ n: 0 }),
  template: `
    <div id="app">
      <h1>Basic</h1>
      <ul>
        <!-- 使用 router-link 建立a標籤來定義導航連結. to屬性為執行連結-->
        <li><router-link to="/">/</router-link></li>
        <li><router-link to="/foo">/foo</router-link></li>
        <li><router-link to="/bar">/bar</router-link></li>
        <!-- 通過tag屬性可以指定渲染的標籤 這裡是li標籤  event自定義了事件-->
        <router-link tag="li" to="/bar" :event="['mousedown', 'touchstart']">
          <a>/bar</a>
        </router-link>
        <li><router-link to="/é">/é</router-link></li>
        <li><router-link to="/é?t=%25ñ">/é?t=%ñ</router-link></li>
        <li><router-link to="/é#%25ñ">/é#%25ñ</router-link></li>
        <!-- router-link可以作為slot，插入內容，如果內容中有a標籤，會把to屬性的連結給內部的a標籤 -->
        <router-link to="/foo" v-slot="props">
          <li :class="[props.isActive && 'active', props.isExactActive && 'exact-active']">
            <a :href="props.href" @click="props.navigate">{{ props.route.path }} (with v-slot).</a>
          </li>
        </router-link>
      </ul>
      <button id="navigate-btn" @click="navigateAndIncrement">On Success</button>
      <pre id="counter">{{ n }}</pre>
      <pre id="query-t">{{ $route.query.t }}</pre>
      <pre id="hash">{{ $route.hash }}</pre>
      
      <!-- 路由匹配到的元件將渲染在這裡 -->
      <router-view class="view"></router-view>
    </div>
  `,

  methods: {
    navigateAndIncrement () {
      const increment = () => this.n++
      // 路由註冊後，我們可以在Vue例項內部通過 this.$router 訪問路由例項，
      // 通過 this.$route 訪問當前路由
      if (this.$route.path === '/') {
        // this.$router.push 會向history棧新增一個新的記錄
        // <router-link>內部也是呼叫來 router.push，實現原理相同
        this.$router.push('/foo', increment)
      } else {
        this.$router.push('/', increment)
      }
    }
  }
}).$mount('#app')
複製程式碼

使用 this.$router 的原因是並不想使用者在每個獨立需要封裝路由的元件中都匯入路由。<router-view> 是最頂層的出口，渲染最高階路由匹配的元件，要在巢狀的出口中渲染元件，需要在 VueRouter 的引數中使用 children 配置。

注入路由和路由例項化都幹了點啥

Vue提供了外掛序號產生器制是，每個外掛都需要實現一個靜態的 install方法，當執行 Vue.use 註冊外掛的時候，就會執行 install 方法，該方法執行的時候第一個引數強制是 Vue物件。

為什麼install的外掛方法第一個引數是Vue

Vue外掛的策略，編寫外掛的時候就不需要inport Vue了，在註冊外掛的時候，給外掛強制插入一個引數就是 Vue 例項。

install 為什麼是 static 方法

類的靜態方法用 static 關鍵字定義，不能在類的例項上呼叫靜態方法，只能夠通過類本身呼叫。這裡的 install 只能vue-router類呼叫，他的例項不能呼叫(防止vue-router的例項在 外部呼叫)。

vue-router注入的時候時候，install了什麼

// 引入install方法
import { install } from './install'

export default class VueRouter {
    // 在VueRouter類中定義install靜態方法
    static install: () => void;
}

// 給VueRouter.install複製
VueRouter.install = install

// 以連結的形式引入vue-router外掛 直接註冊vue-router
if (inBrowser && window.Vue) {
  window.Vue.use(VueRouter)
}
複製程式碼

在 vue-router原始碼中，入口檔案是 src/index.js，其中定義了 VueRouter 類，在VueRouter類中定義靜態方法 install，它定義在 src/install.js中。

src/install.js檔案中路由註冊的時候install了什麼

import View from './components/view'
import Link from './components/link'

// 匯出Vue例項
export let _Vue

// install 方法 當Vue.use(vueRouter)時 相當於 Vue.use(vueRouter.install())
export function install (Vue) {
  // vue-router註冊處理 只註冊一次即可
  if (install.installed && _Vue === Vue) return
  install.installed = true

  // 儲存Vue例項，方便其它外掛檔案使用
  _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-router的時候，給所有的vue元件混入兩個生命週期beforeCreate、destroyed
   * 在beforeCreated中初始化vue-router，並將_route響應式
   */
  Vue.mixin({
    beforeCreate () {
      // 如果vue的例項的自定義屬性有router的話，把vue例項掛在到vue例項的_routerRoot上
      if (isDef(this.$options.router)) {
        // 給大佬遞貓 把自己遞大佬
        this._routerRoot = this

        // 把VueRouter例項掛載到_router上
        this._router = this.$options.router

        // 初始化vue-router，init為核心方法，init定義在src/index.js中，晚些再看
        this._router.init(this)

        // 將當前的route物件 隱式掛到當前元件的data上，使其成為響應式變數。
        Vue.util.defineReactive(this, '_route', this._router.history.current)
      } else {
        // 找爸爸，自身沒有_routerRoot，找其父元件的_routerRoot
        this._routerRoot = (this.$parent && this.$parent._routerRoot) || this
      }
      registerInstance(this, this)
    },
    destroyed () {
      registerInstance(this)
    }
  })

  /**
   * 給Vue新增例項物件$router和$route
   * $router為router例項
   * $route為當前的route
   */
  Object.defineProperty(Vue.prototype, '$router', {
    get () { return this._routerRoot._router }
  })

  Object.defineProperty(Vue.prototype, '$route', {
    get () { return this._routerRoot._route }
  })

  /**
   * 注入兩個全域性元件
   * <router-view>
   * <router-link>
   */
  Vue.component('RouterView', View)
  Vue.component('RouterLink', Link)

  /**
   * Vue.config 是一個物件，包含了Vue的全域性配置
   * 將vue-router的hook進行Vue的合併策略
   */
  const strats = Vue.config.optionMergeStrategies
  // use the same hook merging strategy for route hooks
  strats.beforeRouteEnter = strats.beforeRouteLeave = strats.beforeRouteUpdate = strats.created
}
複製程式碼

為了保證 VueRouter 只執行一次，當執行 install 邏輯的時候新增一個標識 installed。用一個全域性變數儲存Vue，方便VueRouter外掛各處對Vue的使用。這個思想就很好，以後自己寫Vue外掛的時候就可以存一個全域性的 _Vue。

VueRouter安裝的核心是通過 mixin，嚮應用的所有元件混入 beforeCreate 和 destroyed鉤子函式。在beforeCreate鉤子函式中，定義了私有屬性_routerRoot 和 _router。

• _routerRoot: 將Vue例項賦值給_routerRoot，相當於把Vue跟例項掛載到每個元件的_routerRoot的屬性上，通過 $parent._routerRoot 的方式，讓所有元件都能擁有_routerRoot始終指向根Vue例項。
• _router：通過 this.$options.router方式，讓每個vue元件都能拿到VueRouter例項

用Vue的defineReactive方法把 _route 變成響應式物件。this._router.init() 初始化了router，init方法在 src/index.js中，init方法很重要，後面介紹。registerInstance 也是後面介紹。

然後給Vue的原型上掛載了兩個物件屬性 $router 和 $route，在應用的所有元件例項上都可以訪問 this.$router 和 this.$route，this.$router 是路由例項，對外暴露了像this.$router.push、this.$router.replace等很多api方法，this.$route包含了當前路由的所有資訊。是很有用的兩個方法。

後面通過 Vue.component 方法定義了全域性的 <router-link> 和 <router-view> 兩個元件。<router-link>類似於a標籤，<router-view> 是路由出口，在 <router-view> 切換路由渲染不同Vue元件。

最後定義了路由守衛的合併策略，採用了Vue的合併策略。

小結

Vue外掛需要提供 install 方法，用於外掛的注入。VueRouter安裝時會給應用的所有元件注入 beforeCreate 和 destoryed 鉤子函式。在 beforeCreate 中定義一些私有變數，初始化了路由。全域性註冊了兩個元件和兩個api。

那麼問題來了，初始化路由都幹了啥

VueRouter類定義很多屬性和方法，我們先看看初始化路由方法 init。初始化路由的程式碼是 this._router.init(this)，init接收了Vue例項，下面的app就是Vue例項。註釋寫的很詳細了，這裡就不文字敘述了。

init (app: any /* Vue component instance */) {
    // vueRouter可能會例項化多次 apps用於存放多個vueRouter例項
    this.apps.push(app)

    // 保證VueRouter只初始化一次，如果初始化了就終止後續邏輯
    if (this.app) {
      return
    }

    // 將vue例項掛載到vueRouter上，router掛載到Vue例項上，哈 給大佬遞貓
    this.app = app

    // history是vueRouter維護的全域性變數，很重要
    const history = this.history

    // 針對不同路由模式做不同的處理 transitionTo是history的核心方法，後面再細看
    if (history instanceof HTML5History) {
      history.transitionTo(history.getCurrentLocation())
    } else if (history instanceof HashHistory) {
      const setupHashListener = () => {
        history.setupListeners()
      }
      history.transitionTo(
        history.getCurrentLocation(),
        setupHashListener,
        setupHashListener
      )
    }

    // 路由全域性監聽，維護當前的route
    // 因為_route在install執行時定義為響應式屬性，
    // 當route變更時_route更新，後面的檢視更新渲染就是依賴於_route
    history.listen(route => {
      this.apps.forEach((app) => {
        app._route = route
      })
    })
  }
複製程式碼

接下來看看 new VueRouter 時constructor做了什麼。

constructor (options: RouterOptions = {}) {
    this.app = null
    this.apps = []
    this.options = options
    this.beforeHooks = []
    this.resolveHooks = []
    this.afterHooks = []
    // 建立 matcher 匹配函式，createMatcher函式返回一個物件 {match, addRoutes} 很重要
    this.matcher = createMatcher(options.routes || [], this)

    // 預設hash模式
    let mode = options.mode || 'hash'

    // h5的history有相容性 對history做降級處理
    this.fallback = mode === 'history' && !supportsPushState && options.fallback !== false
    if (this.fallback) {
      mode = 'hash'
    }
    if (!inBrowser) {
      mode = 'abstract'
    }
    this.mode = mode

    // 不同的mode，例項化不同的History類, 後面的this.history就是History的例項
    switch (mode) {
      case 'history':
        this.history = new HTML5History(this, options.base)
        break
      case 'hash':
        this.history = new HashHistory(this, options.base, this.fallback)
        break
      case 'abstract':
        this.history = new AbstractHistory(this, options.base)
        break
      default:
        if (process.env.NODE_ENV !== 'production') {
          assert(false, `invalid mode: ${mode}`)
        }
    }
}
複製程式碼

constructor 的 options 是例項化路由是的傳參，通常是一個物件 {routes, mode: 'history'}, routes是必傳引數，mode預設是hash模式。vueRouter還定義了哪些東西呢。

...

match (
    raw: RawLocation,
    current?: Route,
    redirectedFrom?: Location
  ): Route {
    return this.matcher.match(raw, current, redirectedFrom)
}

// 獲取當前的路由
get currentRoute (): ?Route {
    return this.history && this.history.current
}
  
init(options) { ... }

beforeEach(fn) { ... }
beforeResolve(fn) { ... }
afterEach(fn) { ... }
onReady(cb) { ... }

push(location) { ... }
replace(location) { ... }
back() { ... }
go(n) { ... }
forward() { ... }

// 獲取匹配到的路由元件
getMatchedComponents (to?: RawLocation | Route): Array<any> {
    const route: any = to
      ? to.matched
        ? to
        : this.resolve(to).route
      : this.currentRoute
    if (!route) {
      return []
    }
    return [].concat.apply([], route.matched.map(m => {
      return Object.keys(m.components).map(key => {
        return m.components[key]
      })
    }))
}

addRoutes (routes: Array<RouteConfig>) {
    this.matcher.addRoutes(routes)
    if (this.history.current !== START) {
      this.history.transitionTo(this.history.getCurrentLocation())
    }
}
複製程式碼

在例項化的時候，vueRouter仿照history定義了一些api：push、replace、back、go、forward，還定義了路由匹配器、新增router動態更新方法等。

小結

install的時候先執行init方法，然後例項化vueRouter的時候定義一些屬性和方法。init執行的時候通過 history.transitionTo 做路由過渡。matcher 路由匹配器是後面路由切換，路由和元件匹配的核心函式。所以...en

matcher瞭解一下吧

在VueRouter物件中有以下程式碼:

// 路由匹配器，createMatcher函式返回一個物件 {match, addRoutes}
this.matcher = createMatcher(options.routes || [], this)

...

match (
    raw: RawLocation,
    current?: Route,
    redirectedFrom?: Location
): Route {
    return this.matcher.match(raw, current, redirectedFrom)
}

...

const route = this.match(location, current)
複製程式碼

我們可以觀察到 route 物件通過 this.match() 獲取，match 又是通過 this.matcher.match()，而 this.matcher 是通過 createMatcher 函式處理。接下來我們去看看createMatcher函式的實現。

createMatcher

createMatcher 相關的實現都在 src/create-matcher.js中。

/**
 * 建立createMatcher 
 * @param {*} routes 路由配置
 * @param {*} router 路由例項
 * 
 * 返回一個物件 {
 *  match, // 當前路由的match 
 *  addRoutes // 更新路由配置
 * }
 */
export function createMatcher (
  routes: Array<RouteConfig>,
  router: VueRouter
): Matcher {
  const { pathList, pathMap, nameMap } = createRouteMap(routes)

  function addRoutes (routes) {
    createRouteMap(routes, pathList, pathMap, nameMap)
  }

  function match (
    raw: RawLocation,
    currentRoute?: Route,
    redirectedFrom?: Location
  ): Route {

  ...

  return {
    match,
    addRoutes
  }
}
複製程式碼

createMatcher 接收2個引數，routes 是使用者定義的路由配置，router 是 new VueRouter 返回的例項。routes 是一個定義了路由配置的陣列，通過 createRouteMap 函式處理為 pathList, pathMap, nameMap，返回了一個物件 {match, addRoutes} 。也就是說 matcher 是一個物件，它對外暴露了 match 和 addRoutes 方法。

一會我們先了解下 pathList, pathMap, nameMap分別是什麼，稍後在來看createRouteMap的實現。

• pathList：路由路徑陣列，儲存所有的path
• pathMap：路由路徑與路由記錄的對映表，表示一個path到RouteRecord的對映關係
• nameMap：路由名稱與路由記錄的對映表，表示name到RouteRecord的對映關係

RouteRecord

那麼路由記錄是什麼樣子的？

const record: RouteRecord = {
    path: normalizedPath,
    regex: compileRouteRegex(normalizedPath, pathToRegexpOptions),
    components: route.components || { default: route.component },
    instances: {},
    name,
    parent,
    matchAs,
    redirect: route.redirect,
    beforeEnter: route.beforeEnter,
    meta: route.meta || {},
    props:
      route.props == null
        ? {}
        : route.components
          ? route.props
          : { default: route.props }
}
複製程式碼

RouteRecord 是一個物件，包含了一條路由的所有資訊: 路徑、路由正則、路徑對應的元件陣列、元件例項、路由名稱等等。

createRouteMap

createRouteMap 函式的實現在 src/create-route-map中：

/**
 * 
 * @param {*} routes 使用者路由配置
 * @param {*} oldPathList 老pathList
 * @param {*} oldPathMap 老pathMap
 * @param {*} oldNameMap 老nameMap
 */
export function createRouteMap (
  routes: Array<RouteConfig>,
  oldPathList?: Array<string>,
  oldPathMap?: Dictionary<RouteRecord>,
  oldNameMap?: Dictionary<RouteRecord>
): {
  pathList: Array<string>,
  pathMap: Dictionary<RouteRecord>,
  nameMap: Dictionary<RouteRecord>
} {
  // pathList被用於控制路由匹配優先順序
  const pathList: Array<string> = oldPathList || []
  // 路徑路由對映表
  const pathMap: Dictionary<RouteRecord> = oldPathMap || Object.create(null)
  // 路由名稱路由對映表
  const nameMap: Dictionary<RouteRecord> = oldNameMap || Object.create(null)

  routes.forEach(route => {
    addRouteRecord(pathList, pathMap, nameMap, route)
  })

  // 確保萬用字元路由總是在最後
  for (let i = 0, l = pathList.length; i < l; i++) {
    if (pathList[i] === '*') {
      pathList.push(pathList.splice(i, 1)[0])
      l--
      i--
    }
  }

  ...

  return {
    pathList,
    pathMap,
    nameMap
  }
}
複製程式碼

createRouteMap 函式主要是把使用者的路由匹配轉換成一張路由對映表，後面路由切換就是依據這幾個對映表。routes 為每一個 route 執行 addRouteRecord 方法生成一條記錄，記錄在上面展示過了，我們來看看是如何生成一條記錄的。

addRouteRecord

function addRouteRecord (
  pathList: Array<string>,
  pathMap: Dictionary<RouteRecord>,
  nameMap: Dictionary<RouteRecord>,
  route: RouteConfig,
  parent?: RouteRecord,
  matchAs?: string
) {

  //...
  // 先建立一條路由記錄
  const record: RouteRecord = { ... }

  // 如果該路由記錄 巢狀路由的話 就迴圈遍歷解析巢狀路由
  if (route.children) {
    // ...
    // 通過遞迴的方式來深度遍歷，並把當前的record作為parent傳入
    route.children.forEach(child => {
      const childMatchAs = matchAs
        ? cleanPath(`${matchAs}/${child.path}`)
        : undefined
      addRouteRecord(pathList, pathMap, nameMap, child, record, childMatchAs)
    })
  }

  // 如果有多個相同的路徑，只有第一個起作用，後面的會被忽略
  // 對解析好的路由進行記錄，為pathList、pathMap新增一條記錄
  if (!pathMap[record.path]) {
    pathList.push(record.path)
    pathMap[record.path] = record
  }
  // ...
}
複製程式碼

addRouteRecord 函式，先建立一條路由記錄物件。如果當前的路由記錄有巢狀路由的話，就迴圈遍歷繼續建立路由記錄，並按照路徑和路由名稱進行路由記錄對映。這樣所有的路由記錄都被記錄了。整個RouteRecord就是一個樹型結構，其中 parent 表示父的 RouteRecord。

if (name) {
  if (!nameMap[name]) {
    nameMap[name] = record
  }
  // ...
}
複製程式碼

如果我們在路由配置中設定了 name，會給 nameMap新增一條記錄。createRouteMap 方法執行後，我們就可以得到路由的完整記錄，並且得到path、name對應的路由對映。通過path 和 name 能在 pathMap 和 nameMap快速查到對應的 RouteRecord。

export function createMatcher (
  routes: Array<RouteConfig>,
  router: VueRouter
): Matcher {
  //...
  return {
    match,
    addRoutes
  }
}
複製程式碼

還記得 createMatcher 的返回值中有個 match，接下里我們看 match的實現。

match

/**
  * 
  * @param {*} raw 是RawLocation型別 是個url字串或者RawLocation物件
  * @param {*} currentRoute 當前的route
  * @param {*} redirectedFrom 重定向 （不是重要，可忽略）
  */
function match (
  raw: RawLocation,
  currentRoute?: Route,
  redirectedFrom?: Location
): Route {

    // location 是一個物件類似於
    // {"_normalized":true,"path":"/","query":{},"hash":""}
    const location = normalizeLocation(raw, currentRoute, false, router)
    const { name } = location

    // 如果有路由名稱 就進行nameMap對映 
    // 獲取到路由記錄 處理路由params 返回一個_createRoute處理的東西
    if (name) {
      const record = nameMap[name]
      if (process.env.NODE_ENV !== 'production') {
        warn(record, `Route with name '${name}' does not exist`)
      }
      if (!record) return _createRoute(null, location)
      const paramNames = record.regex.keys
        .filter(key => !key.optional)
        .map(key => key.name)

      if (typeof location.params !== 'object') {
        location.params = {}
      }

      if (currentRoute && typeof currentRoute.params === 'object') {
        for (const key in currentRoute.params) {
          if (!(key in location.params) && paramNames.indexOf(key) > -1) {
            location.params[key] = currentRoute.params[key]
          }
        }
      }

      location.path = fillParams(record.path, location.params, `named route "${name}"`)
      return _createRoute(record, location, redirectedFrom)
    
    // 如果路由配置了 path，到pathList和PathMap裡匹配到路由記錄 
    // 如果符合matchRoute 就返回_createRoute處理的東西
    } else if (location.path) {
      location.params = {}
      for (let i = 0; i < pathList.length; i++) {
        const path = pathList[i]
        const record = pathMap[path]
        if (matchRoute(record.regex, location.path, location.params)) {
          return _createRoute(record, location, redirectedFrom)
        }
      }
    }
    // 通過_createRoute返回一個東西
    return _createRoute(null, location)
}
複製程式碼

match 方法接收路徑、但前路由、重定向，主要是根據傳入的raw 和 currentRoute處理，返回的是 _createRoute()。來看看 _createRoute返回了什麼，就知道 match返回了什麼了。

function _createRoute (
    record: ?RouteRecord,
    location: Location,
    redirectedFrom?: Location
  ): Route {
    if (record && record.redirect) {
      return redirect(record, redirectedFrom || location)
    }
    if (record && record.matchAs) {
      return alias(record, location, record.matchAs)
    }
    return createRoute(record, location, redirectedFrom, router)
}
複製程式碼

_createRoute 函式根據有是否有路由重定向、路由重新命名做不同的處理。其中redirect 函式和 alias 函式最後還是呼叫了 _createRoute，最後都是呼叫了 createRoute。而來自於 util/route。

/**
 * 
 * @param {*} record 一般為null
 * @param {*} location 路由物件
 * @param {*} redirectedFrom 重定向
 * @param {*} router vueRouter例項
 */
export function createRoute (
  record: ?RouteRecord,
  location: Location,
  redirectedFrom?: ?Location,
  router?: VueRouter
): Route {
  const stringifyQuery = router && router.options.stringifyQuery

  let query: any = location.query || {}
  try {
    query = clone(query)
  } catch (e) {}

  const route: Route = {
    name: location.name || (record && record.name),
    meta: (record && record.meta) || {},
    path: location.path || '/',
    hash: location.hash || '',
    query,
    params: location.params || {},
    fullPath: getFullPath(location, stringifyQuery),
    matched: record ? formatMatch(record) : []
  }
  if (redirectedFrom) {
    route.redirectedFrom = getFullPath(redirectedFrom, stringifyQuery)
  }
  // 凍結route 一旦建立不可改變
  return Object.freeze(route)
}
複製程式碼

createRoute 可以根據 record 和 location 建立出來最終返回 Route 物件，並且外部不可以修改，只能訪問。Route 物件中有一個非常重要的屬性是 matched，它是通過 formatMatch(record) 計算的：

function formatMatch (record: ?RouteRecord): Array<RouteRecord> {
  const res = []
  while (record) {
    res.unshift(record)
    record = record.parent
  }
  return res
}
複製程式碼

通過 record 迴圈向上找 parent，直到找到最外層，並把所有的 record 都push到一個陣列中，最終飯後就是一個 record 陣列，這個 matched 為後面的渲染元件提供了重要的作用。

小結

matcher的主流程就是通過createMatcher 返回一個物件 {match, addRoutes}, addRoutes 是動態新增路由用的，平時使用頻率比較低，match 很重要，返回一個路由物件，這個路由物件上記錄當前路由的基本資訊，以及路徑匹配的路由記錄，為路徑切換、元件渲染提供了依據。那路徑是怎麼切換的，又是怎麼渲染元件的呢。喝杯誰，我們繼續繼續往下看。

路徑切換

還記得 vue-router 初始化的時候，呼叫了 init 方法，在 init方法裡針對不同的路由模式最後都呼叫了 history.transitionTo，進行路由初始化匹配。包括 history.push 、history.replace的底層都是呼叫了它。它就是路由切換的方法，很重要。它的實現在 src/history/base.js，我們來看看。

transitionTo (
    location: RawLocation,
    onComplete?: Function,
    onAbort?: Function
) {
    // 呼叫 match方法得到匹配的 route物件
    const route = this.router.match(location, this.current)
    
    // 過渡處理
    this.confirmTransition(
        route,
        () => {
            // 更新當前的 route 物件
            this.updateRoute(route)
            onComplete && onComplete(route)
            
            // 更新url地址 hash模式更新hash值 history模式通過pushState/replaceState來更新
            this.ensureURL()
    
            // fire ready cbs once
            if (!this.ready) {
                this.ready = true
                this.readyCbs.forEach(cb => {
                cb(route)
                })
            }
        },
        err => {
            if (onAbort) {
                onAbort(err)
            }
            if (err && !this.ready) {
                this.ready = true
                this.readyErrorCbs.forEach(cb => {
                cb(err)
                })
            }
        }
    )
}
複製程式碼

transitionTo 可以接收三個引數 location、onComplete、onAbort，分別是目標路徑、路經切換成功的回撥、路徑切換失敗的回撥。transitionTo 函式主要做了兩件事：首先根據目標路徑 location 和當前的路由物件通過 this.router.match方法去匹配到目標 route 物件。route是這個樣子的：

const route = {
    fullPath: "/detail/394"
    hash: ""
    matched: [{…}]
    meta: {title: "工單詳情"}
    name: "detail"
    params: {id: "394"}
    path: "/detail/394"
    query: {}
}
複製程式碼

一個包含了目標路由基本資訊的物件。然後執行 confirmTransition方法進行真正的路由切換。因為有一些非同步元件，所以回有一些非同步操作。具體的實現：

confirmTransition (route: Route, onComplete: Function, onAbort?: Function) {
    const current = this.current
    const abort = err => {
      // ...
      onAbort && onAbort(err)
    }
    
    // 如果當前路由和之前路由相同 確認url 直接return
    if (
      isSameRoute(route, current) &&
      route.matched.length === current.matched.length
    ) {
      this.ensureURL()
      return abort(new NavigationDuplicated(route))
    }

    // 通過非同步佇列來交叉對比當前路由的路由記錄和現在的這個路由的路由記錄 
    // 為了能準確得到父子路由更新的情況下可以確切的知道 哪些元件需要更新 哪些不需要更新
    const { updated, deactivated, activated } = resolveQueue(
      this.current.matched,
      route.matched
    )

    // 在非同步佇列中執行響應的勾子函式
    // 通過 queue 這個陣列儲存相應的路由鉤子函式
    const queue: Array<?NavigationGuard> = [].concat(
      // leave 的勾子
      extractLeaveGuards(deactivated),
      // 全域性的 before 的勾子
      this.router.beforeHooks,
      // in-component update hooks
      extractUpdateHooks(updated),
      // 將要更新的路由的 beforeEnter勾子
      activated.map(m => m.beforeEnter),
      // 非同步元件
      resolveAsyncComponents(activated)
    )

    this.pending = route

    // 佇列執行的iterator函式 
    const iterator = (hook: NavigationGuard, next) => {
      if (this.pending !== route) {
        return abort()
      }
      try {
        hook(route, current, (to: any) => {
          if (to === false || isError(to)) {
            // next(false) -> abort navigation, ensure current URL
            this.ensureURL(true)
            abort(to)
          } else if (
            typeof to === 'string' ||
            (typeof to === 'object' &&
              (typeof to.path === 'string' || typeof to.name === 'string'))
          ) {
            // next('/') or next({ path: '/' }) -> redirect
            abort()
            if (typeof to === 'object' && to.replace) {
              this.replace(to)
            } else {
              this.push(to)
            }
          } else {
            // confirm transition and pass on the value
            // 如果有導航鉤子，就需要呼叫next()，否則回撥不執行，導航將無法繼續
            next(to)
          }
        })
      } catch (e) {
        abort(e)
      }
    }

    // runQueue 執行佇列 以一種遞迴回撥的方式來啟動非同步函式佇列的執行
    runQueue(queue, iterator, () => {
      const postEnterCbs = []
      const isValid = () => this.current === route

      // 元件內的鉤子
      const enterGuards = extractEnterGuards(activated, postEnterCbs, isValid)
      const queue = enterGuards.concat(this.router.resolveHooks)
      // 在上次的佇列執行完成後再執行元件內的鉤子
      // 因為需要等非同步元件以及是否OK的情況下才能執行
      runQueue(queue, iterator, () => {
        // 確保期間還是當前路由
        if (this.pending !== route) {
          return abort()
        }
        this.pending = null
        onComplete(route)
        if (this.router.app) {
          this.router.app.$nextTick(() => {
            postEnterCbs.forEach(cb => {
              cb()
            })
          })
        }
      })
    })
}
複製程式碼

檢視目標路由 route 和當前前路由 current 是否相同，如果相同就呼叫 this.ensureUrl 和 abort。

// ensureUrl todo

接下來執行了 resolveQueue函式，這個函式要好好看看：

function resolveQueue (
  current: Array<RouteRecord>,
  next: Array<RouteRecord>
): {
  updated: Array<RouteRecord>,
  activated: Array<RouteRecord>,
  deactivated: Array<RouteRecord>
} {
  let i
  const max = Math.max(current.length, next.length)
  for (i = 0; i < max; i++) {
    if (current[i] !== next[i]) {
      break
    }
  }
  return {
    updated: next.slice(0, i),
    activated: next.slice(i),
    deactivated: current.slice(i)
  }
}
複製程式碼

resolveQueue函式接收兩個引數：當前路由的 matched 和目標路由的 matched，matched 是個陣列。通過遍歷對比兩遍的路由記錄陣列，當有一個路由記錄不一樣的時候就記錄這個位置，並終止遍歷。對於 next 從0到i和current都是一樣的，從i口開始不同，next 從i之後為 activated部分，current從i之後為 deactivated部分，相同部分為 updated，由 resolveQueue 處理之後就能得到路由變更需要更改的部分。緊接著就可以根據路由的變更執行一系列的鉤子函式。完整的導航解析流程有12步，後面會出一篇vue-router路由切換的內部實現文章。盡情期待 ！

路由改變路由元件是如何渲染的

路由的變更之後，路由元件隨之的渲染都是在 <router-view> 元件，它的定義在 src/components/view.js中。

router-view 元件

export default {
  name: 'RouterView',
  functional: true,
  props: {
    name: {
      type: String,
      default: 'default'
    }
  },
  render (_, { props, children, parent, data }) {
    data.routerView = true
    const h = parent.$createElement
    const name = props.name
    const route = parent.$route
    const cache = parent._routerViewCache || (parent._routerViewCache = {})
    let depth = 0
    let inactive = false
    while (parent && parent._routerRoot !== parent) {
      if (parent.$vnode && parent.$vnode.data.routerView) {
        depth++
      }
      if (parent._inactive) {
        inactive = true
      }
      parent = parent.$parent
    }
    data.routerViewDepth = depth
    if (inactive) {
      return h(cache[name], data, children)
    }
    const matched = route.matched[depth]
    if (!matched) {
      cache[name] = null
      return h()
    }
    const component = cache[name] = matched.components[name]
    data.registerRouteInstance = (vm, val) => {     
      const current = matched.instances[name]
      if (
        (val && current !== vm) ||
        (!val && current === vm)
      ) {
        matched.instances[name] = val
      }
    }
    ;(data.hook || (data.hook = {})).prepatch = (_, vnode) => {
      matched.instances[name] = vnode.componentInstance
    }
    let propsToPass = data.props = resolveProps(route, matched.props && matched.props[name])
    if (propsToPass) {
      propsToPass = data.props = extend({}, propsToPass)
      const attrs = data.attrs = data.attrs || {}
      for (const key in propsToPass) {
        if (!component.props || !(key in component.props)) {
          attrs[key] = propsToPass[key]
          delete propsToPass[key]
        }
      }
    }
    return h(component, data, children)
  }
}
複製程式碼

<router-view>是一個渲染函式，它的渲染是用了Vue的 render 函式，它接收兩個引數，第一個是Vue例項，第二個是一個context，通過物件解析的方式可以拿到 props、children、parent、data，供建立 <router-view> 使用。

router-link 元件

支援使用者在具有路由功能的元件裡使用，通過使用 to 屬性指定目標地址，預設渲染成 <a>標籤，支援通過 tag 自定義標籤和插槽。

export default {
  name: 'RouterLink',
  props: {
    to: {
      type: toTypes,
      required: true
    },
    tag: {
      type: String,
      default: 'a'
    },
    exact: Boolean,
    append: Boolean,
    replace: Boolean,
    activeClass: String,
    exactActiveClass: String,
    event: {
      type: eventTypes,
      default: 'click'
    }
  },
  render (h: Function) {
    const router = this.$router
    const current = this.$route
    const { location, route, href } = router.resolve(this.to, current, this.append)
    const classes = {}
    const globalActiveClass = router.options.linkActiveClass
    const globalExactActiveClass = router.options.linkExactActiveClass
    const activeClassFallback = globalActiveClass == null
            ? 'router-link-active'
            : globalActiveClass
    const exactActiveClassFallback = globalExactActiveClass == null
            ? 'router-link-exact-active'
            : globalExactActiveClass
    const activeClass = this.activeClass == null
            ? activeClassFallback
            : this.activeClass
    const exactActiveClass = this.exactActiveClass == null
            ? exactActiveClassFallback
            : this.exactActiveClass
    const compareTarget = location.path
      ? createRoute(null, location, null, router)
      : route
    classes[exactActiveClass] = isSameRoute(current, compareTarget)
    classes[activeClass] = this.exact
      ? classes[exactActiveClass]
      : isIncludedRoute(current, compareTarget)
    const handler = e => {
      if (guardEvent(e)) {
        if (this.replace) {
          router.replace(location)
        } else {
          router.push(location)
        }
      }
    }
    const on = { click: guardEvent }
    if (Array.isArray(this.event)) {
      this.event.forEach(e => { on[e] = handler })
    } else {
      on[this.event] = handler
    }
    const data: any = {
      class: classes
    }
    if (this.tag === 'a') {
      data.on = on
      data.attrs = { href }
    } else {
      const a = findAnchor(this.$slots.default)
      if (a) {
        a.isStatic = false
        const extend = _Vue.util.extend
        const aData = a.data = extend({}, a.data)
        aData.on = on
        const aAttrs = a.data.attrs = extend({}, a.data.attrs)
        aAttrs.href = href
      } else {
        data.on = on
      }
    }
    return h(this.tag, data, this.$slots.default)
  }
}
複製程式碼

<router-link>的特點：

• history 模式和 hash 模式的標籤一致，針對不支援 history的模式會自動降級為 hash 模式。
• 可進行路由守衛，不從新載入頁面

<router-link> 的實現也是基於 render 函式。內部實現也是通過 history.push() 和 history.replace() 實現的。

路徑變化是路由中最重要的功能：路由始終會維護當前的線路，；欲嘔切換的時候會把當前線路切換到目標線路，切換過程中會執行一些列的導航守衛鉤子函式，會更改url, 渲染對應的元件，切換完畢後會把目標線路更新替換為當前線路，作為下一次路徑切換的依據。

知識補充

hash模式和history模式的區別

vue-router 預設是hash模式，使用hash模式時，變更URL，頁面不會重新載入，這種模式從ie6就有了，是一種很穩定的路由模式。但是hash的URL上有個 # 號，看上去很醜，後來HTML5出來後，有了history模式。

history 模式通過 history.pushState來完成url的跳轉而無須重新載入頁面，解決了hash模式很臭的問題。但是老瀏覽器不相容history模式，有些時候我們不得不使用hash模式，來做向下相容。

history 模式，如果訪問一個不存在的頁面時就會返回 404，為了解決這個問題，需要後臺做配置支援：當URL匹配不到任何靜態資源的時候，返回一個index.html頁面。或者在路由配置裡新增一個統一配置的錯誤頁。

為什麼會history會出現這個問題，hash模式不會呢？

hash 模式下，僅 hash 符號之前的內容會被包含在請求中，如 www.abc.com，因此對於後端來說，即使沒有做到對路由的全覆蓋，也不會返回 404 錯誤

history 模式下，前端的 URL 必須和實際向後端發起請求的 URL 一致，如 www.abc.com/book/id。如果後… /book/id 的路由處理，將返回 404 錯誤。

const router = new VueRouter({
    mode: 'history',
    routes: [
        {
            path: '*',
            component: NotFoundComponent
        }
    ]
})
複製程式碼

Vue Router 的 query 與 params 的使用和區別

在 vue-router中有兩個概念 query和params，一開始的時候我對它們分不清，相信也有人分不清。這裡做個彙總，方便記憶理解。

• query的使用

// 帶查詢引數，變成 /register?plan=private
router.push({ path: 'register', query: {plan: 'private'}})
複製程式碼

• params的配置和呼叫
• 路由配置，使用params傳引數，使用name

{
    path: '/detail/:id',
    name: 'detail',
    component: Detail,
}
複製程式碼

• 呼叫 this.$router.push 進行params傳參，使用name，前提需要在路由配置裡設定過名稱。

this.$router.push({
    name: 'detail',
    params: {
        id: '2019'
    }
})
複製程式碼

• params接收引數

const { id } = this.$route.params
複製程式碼

query通常與path使用。query帶查詢引數，params路徑引數。如果提供了path，params會被忽略。

// params 不生效
router.push({ path: '/user', params: { userId }}) // -> /user
複製程式碼

導航守衛

導航 表示路由正在發生變化，vue-router 提供的導航守衛主要用來通過跳轉或者取消的方式守衛導航。導航守衛分為三種：全域性守衛、單個路由守衛和元件內的守衛。

全域性守衛：

• 全域性前置守衛 beforeEach (to, from, next)
• 全域性解析守衛 beforeResolve (to, from, next)
• 全域性後置鉤子 afterEach (to, from)

單個路由守衛：

• 路由前置守衛 beforeEnter (to, from, next)

元件內的守衛：

• 渲染元件的對應路由被confirm前 beforeRouterEnter (to, from, next) next可以是函式，因為該守衛不能獲取元件例項，新元件還沒被建立
• 路由改變，該元件被複用時呼叫 (to, from, next)
• 導航離開該元件對應路由時呼叫 beforeRouteLeave

完整的導航解析流程圖

1. 導航被觸發
2. 在失活的元件裡呼叫離開守衛 beforeRouteLeave
3. 呼叫全域性的 beforeEach 守衛
4. 在重用的元件裡呼叫 beforeRouteUpdate 守衛（2.2+）
5. 在路由配置裡呼叫 beforeEnter
6. 解析非同步路由元件
7. 在被啟用的元件裡呼叫 beforeRouteEnter
8. 呼叫全域性的 beforeResolve守衛
9. 導航被確認
10. 呼叫全域性的 afterEach鉤子
11. 觸發DOM更新
12. 用建立好的例項呼叫 beforeRouterEnter 守衛中傳給next的回撥函式

最後

很多學習 Vue 的小夥伴知識碎片化嚴重，我想整理出系統化的一套關於Vue的學習系列部落格。在自我成長的道路上，也希望能夠幫助更多人進步。

不看後悔，Vue進階系列

• 【vue-進階】vue-router原始碼分析
• 【vue-進階】深入理解Vuex
• 【vue-進階】你不知道的 vue-devtools
• 【vue-進階】vue 和 echats 結合的春天，vue外掛vechart
• 【vue-進階】優雅地用Vue生成動態表單
• 【vue-進階】 Vue2.0 專案配置 ESLint
• 【vue進階】vue2.0 專案配置 Mocha 單元測試

都看到這裡了，趕緊關注 MiaoMiao、點贊、評論留言啦～