深刻理解Vuex 框架

Vuex是一個專爲Vue服務,用於管理頁面數據狀態、提供統一數據操做的生態系統。它集中於MVC模式中的Model層,規定全部的數據操做必須經過 action – mutation – state change 的流程來進行,再結合Vue的數據視圖雙向綁定特性來實現頁面的展現更新。統一的頁面狀態管理以及操做處理,可讓複雜的組件交互變得簡單清晰,同時可在調試模式下進行時光機般的倒退前進操做,查看數據改變過程,使code debug更加方便。vue

最近在開發的項目中用到了Vuex來管理總體頁面狀態,遇到了不少問題。決定研究下源碼,在答疑解惑以外,能深刻學習其實現原理。react

先將問題拋出來,使學習和研究更有針對性:git

  1. 使用Vuex只需執行 Vue.use(Vuex),並在Vue的配置中傳入一個store對象的示例,store是如何實現注入的?
  2. state內部是如何實現支持模塊配置和模塊嵌套的?
  3. 在執行dispatch觸發action(commit同理)的時候,只需傳入(type, payload),action執行函數中第一個參數store從哪裏獲取的?
  4. 如何區分state是外部直接修改,仍是經過mutation方法修改的?
  5. 調試時的「時空穿梭」功能是如何實現的?

注:本文對有Vuex有實際使用經驗的同窗幫助更大,能更清晰理解Vuex的工做流程和原理,使用起來更駕輕就熟。初次接觸的同窗,能夠先參考Vuex官方文檔進行基礎概念的學習。github

1、框架核心流程

進行源碼分析以前,先了解一下官方文檔中提供的核心思想圖,它也表明着整個Vuex框架的運行流程。
vuex-core
如圖示,Vuex爲Vue Components創建起了一個完整的生態圈,包括開發中的API調用一環。圍繞這個生態圈,簡要介紹一下各模塊在覈心流程中的主要功能:vuex

  • Vue Components:Vue組件。HTML頁面上,負責接收用戶操做等交互行爲,執行dispatch方法觸發對應action進行迴應。
  • dispatch:操做行爲觸發方法,是惟一能執行action的方法。
  • actions:操做行爲處理模塊。負責處理Vue Components接收到的全部交互行爲。包含同步/異步操做,支持多個同名方法,按照註冊的順序依次觸發。向後臺API請求的操做就在這個模塊中進行,包括觸發其餘action以及提交mutation的操做。該模塊提供了Promise的封裝,以支持action的鏈式觸發。
  • commit:狀態改變提交操做方法。對mutation進行提交,是惟一能執行mutation的方法。
  • mutations:狀態改變操做方法。是Vuex修改state的惟一推薦方法,其餘修改方式在嚴格模式下將會報錯。該方法只能進行同步操做,且方法名只能全局惟一。操做之中會有一些hook暴露出來,以進行state的監控等。
  • state:頁面狀態管理容器對象。集中存儲Vue components中data對象的零散數據,全局惟一,以進行統一的狀態管理。頁面顯示所需的數據從該對象中進行讀取,利用Vue的細粒度數據響應機制來進行高效的狀態更新。
  • getters:state對象讀取方法。圖中沒有單獨列出該模塊,應該被包含在了render中,Vue Components經過該方法讀取全局state對象。

Vue組件接收交互行爲,調用dispatch方法觸發action相關處理,若頁面狀態須要改變,則調用commit方法提交mutation修改state,經過getters獲取到state新值,從新渲染Vue Components,界面隨之更新。api

2、目錄結構介紹

打開Vuex項目,看下源碼目錄結構。數組

dir_structure

Vuex提供了很是強大的狀態管理功能,源碼代碼量卻很少,目錄結構劃分也很清晰。先大致介紹下各個目錄文件的功能:promise

  • module:提供module對象與module對象樹的建立功能;
  • plugins:提供開發輔助插件,如「時光穿梭」功能,state修改的日誌記錄功能等;
  • helpers.js:提供action、mutations以及getters的查找API;
  • index.js:是源碼主入口文件,提供store的各module構建安裝;
  • mixin.js:提供了store在Vue實例上的裝載注入;
  • util.js:提供了工具方法如find、deepCopy、forEachValue以及assert等方法。

3、初始化裝載與注入

瞭解大概的目錄及對應功能後,下面開始進行源碼分析。index.js中包含了全部的核心代碼,從該文件入手進行分析。瀏覽器

3.1 裝載實例

先看個簡單的例子:緩存

store.js文件中,加載Vuex框架,建立並導出一個空配置的store對象實例。

而後在index.js中,正常初始化一個頁面根級別的Vue組件,傳入這個自定義的store對象。

問題1所述,以上實例除了Vue的初始化代碼,只是多了一個store對象的傳入。一塊兒看下源碼中的實現方式。

3.2 裝載分析

index.js文件代碼執行開頭,定義局部 Vue 變量,用於判斷是否已經裝載和減小全局做用域查找。

而後判斷若處於瀏覽器環境下且加載過Vue,則執行install方法。

install方法將Vuex裝載到Vue對象上,Vue.use(Vuex) 也是經過它執行,先看下Vue.use方法實現:

如果首次加載,將局部Vue變量賦值爲全局的Vue對象,並執行applyMixin方法,install實現以下:

來看下applyMixin方法內部代碼。若是是2.x.x以上版本,可使用 hook 的形式進行注入,或使用封裝並替換Vue對象原型的_init方法,實現注入。

具體實現:將初始化Vue根組件時傳入的store設置到this對象的$store屬性上,子組件從其父組件引用$store屬性,層層嵌套進行設置。在任意組件中執行 this.$store 都能找到裝載的那個store對象,vuexInit方法實現以下:

看個圖例理解下store的傳遞。

頁面Vue結構圖:
cart_vue_structure

對應store流向:
cart_vue_structure

4、store對象構造

上面對Vuex框架的裝載以及注入自定義store對象進行分析,解決了問題1。接下來詳細分析store對象的內部功能和具體實現,來解答 爲何actions、getters、mutations中能從arguments[0]中拿到store的相關數據? 等問題。

store對象實現邏輯比較複雜,先看下構造方法的總體邏輯流程來幫助後面的理解:

cart_vue_structure

4.1 環境判斷

開始分析store的構造函數,分小節逐函數逐行的分析其功能。

在store構造函數中執行環境判斷,如下都是Vuex工做的必要條件:

  1. 已經執行安裝函數進行裝載;
  2. 支持Promise語法。

assert函數是一個簡單的斷言函數的實現,一行代碼便可實現。

 

4.2 數據初始化、module樹構造

環境判斷後,根據new構造傳入的options或默認值,初始化內部數據。

調用 new Vuex.store(options) 時傳入的options對象,用於構造ModuleCollection類,下面看看其功能。

ModuleCollection主要將傳入的options對象整個構造爲一個module對象,並循環調用 this.register([key], rawModule, false) 爲其中的modules屬性進行模塊註冊,使其都成爲module對象,最後options對象被構形成一個完整的組件樹。ModuleCollection類還提供了modules的更替功能,詳細實現能夠查看源文件module-collection.js

4.3 dispatch與commit設置

繼續回到store的構造函數代碼。

封裝替換原型中的dispatch和commit方法,將this指向當前store對象。dispatch和commit方法具體實現以下:

前面提到,dispatch的功能是觸發並傳遞一些參數(payload)給對應type的action。由於其支持2種調用方法,因此在dispatch中,先進行參數的適配處理,而後判斷action type是否存在,若存在就逐個執行(注:上面代碼中的this._actions[type] 以及 下面的 this._mutations[type] 均是處理過的函數集合,具體內容留到後面進行分析)。

commit方法和dispatch相比雖然都是觸發type,可是對應的處理卻相對複雜,代碼以下。

該方法一樣支持2種調用方法。先進行參數適配,判斷觸發mutation type,利用_withCommit方法執行本次批量觸發mutation處理函數,並傳入payload參數。執行完成後,通知全部_subscribers(訂閱函數)本次操做的mutation對象以及當前的state狀態,若是傳入了已經移除的silent選項則進行提示警告。

4.4 state修改方法

_withCommit是一個代理方法,全部觸發mutation的進行state修改的操做都通過它,由此來統一管理監控state狀態的修改。實現代碼以下。

緩存執行時的committing狀態將當前狀態設置爲true後進行本次提交操做,待操做完畢後,將committing狀態還原爲以前的狀態。

4.5 module安裝

綁定dispatch和commit方法以後,進行嚴格模式的設置,以及模塊的安裝(installModule)。因爲佔用資源較多影響頁面性能,嚴格模式建議只在開發模式開啓,上線後須要關閉。

 

4.5.1 初始化rootState

上述代碼的備註中,提到installModule方法初始化組件樹根組件、註冊全部子組件,並將其中全部的getters存儲到this._wrappedGetters屬性中,讓咱們看看其中的代碼實現。

判斷是不是根目錄,以及是否設置了命名空間,若存在則在namespace中進行module的存儲,在不是根組件且不是 hot 條件的狀況下,經過getNestedState方法拿到該module父級的state,拿到其所在的 moduleName ,調用 Vue.set(parentState, moduleName, module.state) 方法將其state設置到父級state對象的moduleName屬性中,由此實現該模塊的state註冊(首次執行這裏,由於是根目錄註冊,因此並不會執行該條件中的方法)。getNestedState方法代碼很簡單,分析path拿到state,以下。

 

4.5.2 module上下文環境設置

 

命名空間和根目錄條件判斷完畢後,接下來定義local變量和module.context的值,執行makeLocalContext方法,爲該module設置局部的 dispatch、commit方法以及getters和state(因爲namespace的存在須要作兼容處理)。

4.5.3 mutations、actions以及getters註冊

定義local環境後,循環註冊咱們在options中配置的action以及mutation等。逐個分析各註冊函數以前,先看下模塊間的邏輯關係流程圖:

complete_flow

下面分析代碼邏輯:

registerMutation方法中,獲取store中的對應mutation type的處理函數集合,將新的處理函數push進去。這裏將咱們設置在mutations type上對應的 handler 進行了封裝,給原函數傳入了state。在執行 commit(‘xxx’, payload) 的時候,type爲 xxx 的mutation的全部handler都會接收到state以及payload,這就是在handler裏面拿到state的緣由。

action和getter的註冊也是同理的,看一下代碼(注:前面提到的 this.actions 以及 this.mutations在此處進行設置)。

action handler比mutation handler以及getter wrapper多拿到dispatch和commit操做方法,所以action能夠進行dispatch action和commit mutation操做。

4.5.4 子module安裝

註冊完了根組件的actions、mutations以及getters後,遞歸調用自身,爲子組件註冊其state,actions、mutations以及getters等。

 

4.5.5 實例結合

前面介紹了dispatch和commit方法以及actions等的實現,下面結合一個官方的購物車實例中的部分代碼來加深理解。

Vuex配置代碼:

Vuex組件module中各模塊state配置代碼部分:

加載上述配置後,頁面state結構以下圖:

cart_state

state中的屬性配置都是按照option配置中module path的規則來進行的,下面看action的操做實例。

Vuecart組件代碼部分:

Vuexcart.js組件action配置代碼部分:

Vue組件中點擊購買執行當前module的dispatch方法,傳入type值爲 ‘checkout’,payload值爲 ‘products’,在源碼中dispatch方法在全部註冊過的actions中查找’checkout’的對應執行數組,取出循環執行。執行的是被封裝過的被命名爲wrappedActionHandler的方法,真正傳入的checkout的執行函數在wrappedActionHandler這個方法中被執行,源碼以下(注:前面貼過,這裏再看一次):

handler在這裏就是傳入的checkout函數,其執行須要的commit以及state就是在這裏被傳入,payload也傳入了,在實例中對應接收的參數名爲products。commit的執行也是同理的,實例中checkout還進行了一次commit操做,提交一次type值爲types.CHECKOUT_REQUEST的修改,由於mutation名字是惟一的,這裏進行了常量形式的調用,防止命名重複,執行跟源碼分析中一致,調用 function wrappedMutationHandler (payload) { handler(local.state, payload) } 封裝函數來實際調用配置的mutation方法。

看到完源碼分析和上面的小實例,應該能理解dispatch action和commit mutation的工做原理了。接着看源碼,看看getters是如何實現state實時訪問的。

4.6 store._vm組件設置

執行完各module的install後,執行resetStoreVM方法,進行store組件的初始化。

綜合前面的分析能夠了解到,Vuex其實構建的就是一個名爲store的vm組件,全部配置的state、actions、mutations以及getters都是其組件的屬性,全部的操做都是對這個vm組件進行的。

一塊兒看下resetStoreVM方法的內部實現。

resetStoreVm方法建立了當前store實例的_vm組件,至此store就建立完畢了。上面代碼涉及到了嚴格模式的判斷,看一下嚴格模式如何實現的。

很簡單的應用,監視state的變化,若是沒有經過 this._withCommit() 方法進行state修改,則報錯。

4.7 plugin注入

最後執行plugin的植入。

devtoolPlugin提供的功能有3個:

源碼分析到這裏,Vuex框架的實現原理基本都已經分析完畢。

5、總結

最後咱們回過來看文章開始提出的5個問題。

1.  使用Vuex只需執行 Vue.use(Vuex),並在Vue的配置中傳入一個store對象的示例,store是如何實現注入的?

:Vue.use(Vuex) 方法執行的是install方法,它實現了Vue實例對象的init方法封裝和注入,使傳入的store對象被設置到Vue上下文環境的$store中。所以在Vue Component任意地方都可以經過this.$store訪問到該store。

2.  state內部支持模塊配置和模塊嵌套,如何實現的?

:在store構造方法中有makeLocalContext方法,全部module都會有一個local context,根據配置時的path進行匹配。因此執行如dispatch(‘submitOrder’, payload)這類action時,默認的拿到都是module的local state,若是要訪問最外層或者是其餘module的state,只能從rootState按照path路徑逐步進行訪問。

3.  在執行dispatch觸發action(commit同理)的時候,只需傳入(type, payload),action執行函數中第一個參數store從哪裏獲取的?

:store初始化時,全部配置的action和mutation以及getters均被封裝過。在執行如dispatch(‘submitOrder’, payload)的時候,actions中type爲submitOrder的全部處理方法都是被封裝後的,其第一個參數爲當前的store對象,因此可以獲取到 { dispatch, commit, state, rootState } 等數據。

4.  Vuex如何區分state是外部直接修改,仍是經過mutation方法修改的?

:Vuex中修改state的惟一渠道就是執行 commit(‘xx’, payload) 方法,其底層經過執行 this._withCommit(fn) 設置_committing標誌變量爲true,而後才能修改state,修改完畢還須要還原_committing變量。外部修改雖然可以直接修改state,可是並無修改_committing標誌位,因此只要watch一下state,state change時判斷是否_committing值爲true,便可判斷修改的合法性。

5.  調試時的」時空穿梭」功能是如何實現的?

:devtoolPlugin中提供了此功能。由於dev模式下全部的state change都會被記錄下來,’時空穿梭’ 功能其實就是將當前的state替換爲記錄中某個時刻的state狀態,利用 store.replaceState(targetState) 方法將執行this._vm.state = state 實現。

源碼中還有一些工具函數相似registerModule、unregisterModule、hotUpdate、watch以及subscribe等,若有興趣能夠打開源碼看看,這裏再也不細述。

相關文章
相關標籤/搜索