VueRouter源碼分析(1)--主要執(zhí)行步驟

前言

本文是vue-router 2.x源碼分析的第一篇喷屋,主要看vue-router的整體結(jié)構(gòu)元践!

實例代碼

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
</head>
<body>
    <div id="app">
      <h1>Basic</h1>
      <ul>
        <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>
        <router-link tag="li" to="/bar" :event="['mousedown', 'touchstart']">
          <a>/bar</a>
        </router-link>
      </ul>
      <router-view class="view"></router-view>
    </div>
    <script src='vue.js'></script>
    <script src='vue-router.js'></script>
    <script>
        const Home = { template: '<div>home</div>' }
        const Foo = { template: '<div>foo</div>' }
        const Bar = { template: '<div>bar</div>' }
        //創(chuàng)建router實例
        const router = new VueRouter({
          routes: [
            { path: '/', component: Home },
            { path: '/foo', component: Foo },
            { path: '/bar', component: Bar }
          ]
        })
        //創(chuàng)建vue實例
        new Vue({
          router
        }).$mount('#app')
    </script>
</body>
</html>

1腺律、執(zhí)行Vue.use(VueRouter)

VueRouter是作為Vue的插件存在的漏健,使用Vue.use(VueRouter)的方式侵入Vue非凌,這個操作在引入vue-router.js時就執(zhí)行了,Vue.use方法會執(zhí)行VueRouter的install方法涤垫,看下該方法:

function install (Vue) {
    if (install.installed) { return }
    install.installed = true;
    _Vue = Vue;
    //1姑尺、將$router和$route定義為Vue.prototype的存取器屬性竟终,以便所有組
    //件都可以訪問到蝠猬,注意這個get函數(shù),是返回this.$root._router而不是
    //this._router,這是因為在beforeCreate中將_router放在了vue根實例上
    Object.defineProperty(Vue.prototype, '$router', {
        get: function get () { return this.$root._router }
    });
    Object.defineProperty(Vue.prototype, '$route', {
        get: function get () { return this.$root._route }
    });
    var isDef = function (v) { return v !== undefined; };
    var registerInstance = function (vm, callVal) {
        var i = vm.$options._parentVnode;
        if (isDef(i) && isDef(i = i.data) && isDef(i = i.registerRouteInstance)) {
            i(vm, callVal);
        }
    };
    //2统捶、使用mixin構(gòu)造了一個beforeCreate函數(shù)榆芦,該函數(shù)會在vue實例創(chuàng)建的
    // 時候被調(diào)用
    Vue.mixin({
        beforeCreate: function beforeCreate () {
            if (isDef(this.$options.router)) {
                this._router = this.$options.router;
                //執(zhí)行router的初始化
                this._router.init(this);
                //route定義為響應式以便能在其改變時觸發(fā)vue的更新機制
                Vue.util.defineReactive(this, '_route', this._router.history.current);
            }
            registerInstance(this, this);
        },
        destroyed: function destroyed () {
            registerInstance(this);
        }
    });
    // 3柄粹、增加vue的默認組件
    Vue.component('router-view', View);
    Vue.component('router-link', Link);
    var strats = Vue.config.optionMergeStrategies;
    // use the same hook merging strategy for route hooks
    strats.beforeRouteEnter = strats.beforeRouteLeave = strats.created;
}

以上三件事執(zhí)行完,就開始new VueRouter了

2匆绣、創(chuàng)建VueRouter實例(new VueRouter(options))

    function VueRouter (options) {
      if ( options === void 0 ) options = {};
      this.app = null;
      this.apps = [];
      this.options = options;
      this.beforeHooks = [];
      this.resolveHooks = [];
      this.afterHooks = [];
      //1驻右、根據(jù)傳入的options.routes創(chuàng)建matcher對象
      this.matcher = createMatcher(options.routes || [], this);
      //2、根據(jù)傳入的options.mode創(chuàng)建不同的history對象
      var mode = options.mode || 'hash';
      this.fallback = mode === 'history' && !supportsPushState;
      if (this.fallback) {
        mode = 'hash';
      }
      if (!inBrowser) {
        mode = 'abstract';
      }
      this.mode = mode;
      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:
          {
            assert(false, ("invalid mode: " + mode));
          }
      }
    };
  • 先看第一件事崎淳,由routes創(chuàng)建matcher
    //routes長這樣:
    routes: [
        { path: '/', component: Home },
        { path: '/foo', component: Foo },
        { path: '/bar', component: Bar }
    ]
    //經(jīng)過createMatcher處理的matcher長這樣:
    matcher:{
        addRoutes:function addRoutes(routes)
        match:function match( raw, currentRoute, redirectedFrom )
        __proto__:Object
    }
  • 再看第二件事堪夭,由mode創(chuàng)建history
    //mode默認值為'hash',故會創(chuàng)建HashHistory實例
    history:{
        base:""
        current:Object
        errorCbs:Array(0)
        pending:null
        ready:false
        readyCbs:Array(0)
        readyErrorCbs:Array(0)
        router:VueRouter
        __proto__:History
    }

最后創(chuàng)建的router實例長這樣:

    router:{
        afterHooks:Array(0)
        app:null
        apps:Array(0)
        beforeHooks:Array(0)
        fallback:false
        history:HashHistory
        matcher:Object
        mode:"hash"
        options:Object
        resolveHooks:Array(0)
        currentRoute:(...)
        __proto__:Object
    }

創(chuàng)建的具體細節(jié)以后會分析。這兩件事情做完就開始new Vue(options)了拣凹。

3森爽、創(chuàng)建Vue實例(new Vue(options))

創(chuàng)建Vue實例的過程中會調(diào)用beforeCreate函數(shù),故在第一節(jié)中定義的beforeCreate會得到執(zhí)行:

    function beforeCreate () {
      if (isDef(this.$options.router)) {
        //1嚣镜、正式將第二節(jié)創(chuàng)建的router實例掛在this._router上爬迟,這個this
        //是根實例,相當于子組件中的this.$root菊匿,因此在子組件中能通過t
        //his.$router訪問到
        this._router = this.$options.router;
        //2付呕、執(zhí)行router的初始化
        this._router.init(this);
        //3、將_route定義為響應式以便能在其改變時觸發(fā)vue的更新機制
        Vue.util.defineReactive(this, '_route', this._router.history.current);
      }
      //4跌捆、注冊組件實例
      registerInstance(this, this);
    },

這里主要看下第二步router的初始化:

    function init (app /* Vue component instance */) {
          //注意this是VueRouter實例徽职,app是Vue實例
          var this$1 = this;
          //將當前Vue實例app存入VueRouter實例this.apps數(shù)組中,因為一
          //個應用可能不止一個Vue實例佩厚,故用數(shù)組保存活箕。
          this.apps.push(app);
          // main app already initialized.
          if (this.app) {
            return
          }
          //將當前Vue實例app存在VueRouter實例this.app下
          this.app = app;
          var history = this.history;
          //當點擊一個路徑時,頁面會繪制該路徑對應的組件可款,history
          //.transitionTo方法就是干這個事的育韩,后續(xù)再分析
          if (history instanceof HTML5History) {
            history.transitionTo(history.getCurrentLocation());
          } else if (history instanceof HashHistory) {
            var setupHashListener = function () {
              history.setupListeners();
            };
            history.transitionTo(
              history.getCurrentLocation(),
              setupHashListener,
              setupHashListener
            );
          }
          //監(jiān)聽route,一旦route發(fā)生改變就賦值給app._route從而觸發(fā)頁面
          //更新,達到特定route繪制特定組件的目的
          history.listen(function (route) {
            this$1.apps.forEach(function (app) {
              app._route = route;
            });
          });
    };

beforeCreate函數(shù)執(zhí)行完后闺鲸,繼續(xù)Vue實例化的過程筋讨,這里就回到了Vue渲染頁面的過程,如下圖:

渲染過程.png

4摸恍、小結(jié)

以上分析可以看出引入vue-router時代碼的執(zhí)行流程:

  1. 執(zhí)行install方法悉罕。主要做了3件事:a、將$router和$route定義為Vue.prototype的存取器屬性立镶;b壁袄、使用Vue.mixin方法創(chuàng)建了beforeCreate函數(shù);c媚媒、擴充了Vue的默認組件嗜逻,即增加了router-link和router-view兩個組件。
  2. 創(chuàng)建VueRouter實例缭召。主要做了2件事:a栈顷、根據(jù)routes創(chuàng)建matcher逆日;b、根據(jù)mode創(chuàng)建history萄凤。
  3. 創(chuàng)建Vue實例室抽。主要做了1件事:調(diào)用beforeCreate函數(shù),繼而執(zhí)行router.init方法去完善router對象靡努。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末坪圾,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子惑朦,更是在濱河造成了極大的恐慌神年,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,968評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件行嗤,死亡現(xiàn)場離奇詭異已日,居然都是意外死亡,警方通過查閱死者的電腦和手機栅屏,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評論 2 382
  • 文/潘曉璐 我一進店門飘千,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人栈雳,你說我怎么就攤上這事护奈。” “怎么了哥纫?”我有些...
    開封第一講書人閱讀 153,220評論 0 344
  • 文/不壞的土叔 我叫張陵霉旗,是天一觀的道長。 經(jīng)常有香客問我蛀骇,道長厌秒,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,416評論 1 279
  • 正文 為了忘掉前任擅憔,我火速辦了婚禮鸵闪,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘暑诸。我一直安慰自己蚌讼,他們只是感情好,可當我...
    茶點故事閱讀 64,425評論 5 374
  • 文/花漫 我一把揭開白布个榕。 她就那樣靜靜地躺著篡石,像睡著了一般。 火紅的嫁衣襯著肌膚如雪西采。 梳的紋絲不亂的頭發(fā)上凰萨,一...
    開封第一講書人閱讀 49,144評論 1 285
  • 那天,我揣著相機與錄音,去河邊找鬼沟蔑。 笑死湿诊,一個胖子當著我的面吹牛狱杰,可吹牛的內(nèi)容都是我干的瘦材。 我是一名探鬼主播,決...
    沈念sama閱讀 38,432評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼仿畸,長吁一口氣:“原來是場噩夢啊……” “哼食棕!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起错沽,我...
    開封第一講書人閱讀 37,088評論 0 261
  • 序言:老撾萬榮一對情侶失蹤簿晓,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后千埃,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體憔儿,經(jīng)...
    沈念sama閱讀 43,586評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,028評論 2 325
  • 正文 我和宋清朗相戀三年放可,在試婚紗的時候發(fā)現(xiàn)自己被綠了谒臼。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,137評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡耀里,死狀恐怖蜈缤,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情冯挎,我是刑警寧澤底哥,帶...
    沈念sama閱讀 33,783評論 4 324
  • 正文 年R本政府宣布,位于F島的核電站房官,受9級特大地震影響趾徽,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜翰守,卻給世界環(huán)境...
    茶點故事閱讀 39,343評論 3 307
  • 文/蒙蒙 一附较、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧潦俺,春花似錦拒课、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,333評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至肖爵,卻和暖如春卢鹦,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,559評論 1 262
  • 我被黑心中介騙來泰國打工冀自, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留揉稚,地道東北人。 一個月前我還...
    沈念sama閱讀 45,595評論 2 355
  • 正文 我出身青樓熬粗,卻偏偏與公主長得像搀玖,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子驻呐,可洞房花燭夜當晚...
    茶點故事閱讀 42,901評論 2 345

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理灌诅,服務發(fā)現(xiàn),斷路器含末,智...
    卡卡羅2017閱讀 134,601評論 18 139
  • Vue 實例 屬性和方法 每個 Vue 實例都會代理其 data 對象里所有的屬性:var data = { a:...
    云之外閱讀 2,202評論 0 6
  • 三年只為一個人 為了你我丟了魂 我如何打開你心門 最后只剩這傷痕 一切要求我都做 而你劈腿再犯錯 想起曾經(jīng)的承諾 ...
    殺了那只鬼閱讀 223評論 0 0