前端Backbone源碼解讀(一)
MVC?
MVC是一種GUI軟件的一種架構(gòu)模式。它的目的是將軟件的數(shù)據(jù)層(Model)和視圖(view)分開。Model連接數(shù)據(jù)庫,實(shí)現(xiàn)數(shù)據(jù)的交互。用戶不能直接和數(shù)據(jù)打交道,而是需要通過操作視圖,然后通過controller對事件作出響應(yīng),***才得以改變數(shù)據(jù)。***數(shù)據(jù)改變,通過觀察者模式更新view。(所以在這里需要用到設(shè)計(jì)模式中的觀察者模式)
Smalltalk-80 MVC
Smalltalk-80是早期的對MVC模式的一種實(shí)現(xiàn)。這種模式的目的是分離應(yīng)用的內(nèi)部邏輯和用戶的交互界面。在書中講述了這種模式有幾個特點(diǎn):
- 用戶操作界面(view和controller)和數(shù)據(jù)層(Model)是分離的。
- 數(shù)據(jù)的呈現(xiàn)是由view和controller完成的。它們兩者沒有明顯的分界。(controller并非必須,可以用其他替代,因此就有了MVP和MVVM。)
- controller的任務(wù)就是處理用戶操作view發(fā)出的事件。比如點(diǎn)擊,輸入等等。
- model一旦發(fā)生改變就會通過觀察者模式更新view。
后端
我接觸過python的flask和node的express框架,都是以MVC的形式來組織的。V層用模板引擎呈現(xiàn)頁面,用戶對V層做操作,觸發(fā)訂閱好的事件,然后路由操作數(shù)據(jù)庫,***重新呈現(xiàn)頁面,達(dá)到更新的效果。個人感覺對后端來說,MVC的概念會更加直接和清晰。
前端backbone
廢話很多,下面直接進(jìn)入正題了。MVC在前端開始流行(當(dāng)然現(xiàn)在什么MVVM更火)還是backbone的功勞。backbone的源碼相對于其他框架來說很短(1.3.3版本的有2027行)。所以雖然感覺用backbone寫應(yīng)用很不容易,但是認(rèn)真去讀backbone源碼還是可以加讀懂不少的。我會分三篇文章去分析backbone的源碼。以下:
- backbone的總結(jié)架構(gòu)和Events
- model & collection & view
- sync & router & history
我看過很多人想寫backbone的源碼分析,寫得都很不錯,看了很有收獲,然而...大都都是些了一篇兩篇就停更了,悲傷的故事...希望我能夠堅(jiān)持下來吧。
總體架構(gòu)
終于開始啦!backbone里代碼結(jié)構(gòu)和官方文檔里面的組織方式幾乎是一模一樣的,所以把官方文檔當(dāng)成索引來讀也是很方便的~代碼的整體架構(gòu)如下:
- (function(factory) {
- // 在這里是backbone模塊化的一個接口。支持AMD,CMD和全局變量模式。代碼很好理解。
- })(function(root, factory, _, $) {
- // 各種參數(shù)和函數(shù)的定義
- Backbone.noConflict = function(){};
- var Events = Backbone.Events = {};
- // 然后是各種Events方法的添加
- // Events在Backbone里面非常重要,Model,Collection和View都extend了它。(不知道怎么說才自然...)所以他們都可以發(fā)起訂閱事件,發(fā)起事件。當(dāng)然,用戶也可以自己拿自己的對象拓展一下,那樣也可以訂閱發(fā)起事件了~
- var Model = Backbone.Model = function(){};
- _.extend(Model.prototype, Events, {
- // 這里是各種對Model.prototype的拓展,定義各種方法
- });
- var Collection = Backbone.Collection = function(){};
- _.extend(Collection.prototype, Events, {
- // 這里是各種對Collection.prototype的拓展,定義各種方法
- });
- var View = Backbone.View = function(){};
- _.extend(View.prototype, Events, {
- // 這里是各種對View.prototype的拓展,定義各種方法
- });
- Backbone.sync = function(){};
- Backbone.ajax = function(){};
- var Router = Backbone.Router = function(){};
- _.extend(Router.prototype, Events, {
- // 這里是各種對Router.prototype的拓展,定義各種方法
- });
- var History = Backbone.History = function(){};
- _.extend(History.prototype, Events, {
- // 這里是各種對History.prototype的拓展,定義各種方法
- });
- // 用History定義實(shí)例
- Backbone.history = new History;
- // 接下來是helper函數(shù)extend
- var extend = function(){};
- Model.extend = Collection.extend = Router.extend = View.extend = History.extend = extend;
- // 其他的還有urlError,warpError函數(shù)
- return Backbone;
- });
在這一小節(jié)我順便把除了model & collection & view & sync & router & history相關(guān)之外的都講了先吧
noConflict
防止沖突,如果自己本身全局就有Backbone,可以用noConflict解決沖突。不過,一般都不會有人起一個會沖突的名字吧...
- var previousBackbone = root.Backbone;
- Backbone.noConflict = function() {
- root.Backbone = previousBackbone;
- return this;
- };
extend
這個函數(shù)返回了一個對象。這個對象的屬性,方法,構(gòu)造函數(shù),原型都有了定義,很完整。
- var extend = function(protoProps, staticProps) {
- var parent = this;
- var child;
- // 如果protoProps有構(gòu)造函數(shù)就給child吧。
- if (protoProps && _.has(protoProps, 'constructor')) {
- child = protoProps.constructor;
- } else {
- // 如果沒有就用parent的。
- child = function(){ return parent.apply(this, arguments); };
- }
- // 把parent和staticProps的屬性方法給child吧。
- _.extend(child, parent, staticProps);
- // 定義child的prototype。child是繼承自parent的。這里不直接調(diào)用構(gòu)造函數(shù)。
- child.prototype = _.create(parent.prototype, protoProps);
- child.prototype.constructor = child;
- child.__super__ = parent.prototype;
- return child;
- };
這個函數(shù)理解起來并不困難,但在整個backbone里面很關(guān)鍵。因?yàn)椴还苁荕odel還是Collection還是Router等都需要Events的方法來做一些事件相關(guān)的操作。
- // 大家都需要extend這個方法。
- Model.extend = Collection.extend = Router.extend = View.extend = History.extend = extend;
Events
backbone的Events和nodejs的EventEmmiter有很多類似的地方。其實(shí)本質(zhì)上就是一個發(fā)布訂閱模式的算是比較常見的實(shí)現(xiàn)。
開始這段代碼我看了一個早上,不長,但是里面有一點(diǎn)繞。后來看到這篇文章之后(他講得很棒!選取的角度非常不錯!但是停!更!了!...悲傷...)就開始理解了。但由于版本不同,差別還是不少。
這里我打算從兩個方面來講解這個Events,一個是內(nèi)部對象,一個是主要方法。事實(shí)上,在傳統(tǒng)的發(fā)布訂閱模式中,主要也是這兩個組成部分。由內(nèi)部對象來管理所有的事件,由方法來做訂閱,發(fā)布,取消等的操作。具體來說,就是通過Events當(dāng)中的this的各個屬性,來存儲,管理事件。而外部,則通過on,off,listenTo等方法來操作這些屬性。
具體的bakcbone代碼可以看這里。在文中不會大段大段貼代碼。不過強(qiáng)烈建議對照著看。
Events中的this
Events中的內(nèi)部對象this起得作用是管理所有的事件,所有的監(jiān)聽和所有的被監(jiān)聽。可以嘗試下把官方的todo范例的view里輸出一下console.log(this),其中的_listeningTo, _events, _listenId, _listeners都是Events帶來的內(nèi)部函數(shù)的屬性。下面的關(guān)鍵方法,其實(shí)一定程度上都是操作這些內(nèi)部屬性的方法。其中有一點(diǎn)需要注意,并不是每一個有Events方法的對象都會有著四個屬性。記住一點(diǎn),只有需要的時候才會創(chuàng)建,不需要的時候是沒有的。設(shè)計(jì)模式在這里有很多涉及,可以去了解一下。下面講講這四個內(nèi)部屬性。
- _listeningTo: 當(dāng)前對象所監(jiān)聽的對象。對象里面是一個或多個以被監(jiān)聽對象的_listenId為名字的對象。每一個對象結(jié)構(gòu)如下:
- {
- count: 5, // 監(jiān)聽了幾個事件
- id: 13, // 監(jiān)聽方的id
- listeningTo: Object, // 自身相關(guān)的一些信息(很有趣,里面可以***點(diǎn)擊下去,因?yàn)橐昧俗陨怼2恢烙惺裁从靡?..)
- obj: child, // 被監(jiān)聽的對象
- objId: "12" // 被監(jiān)聽對象id
- }
這里面有很多循環(huán)引用的地方,細(xì)細(xì)看才不會被看繞啊。
Events中的關(guān)鍵方法與函數(shù)
關(guān)鍵方法是寫代碼的時候用到的方法,算是一種接口,可以對內(nèi)部對象的屬性做出改變。
在看backbone的時候,(其實(shí)不單只backbone,大部分寫得良好的,復(fù)用率高的代碼),總會覺得很繁瑣。但其實(shí)這才是良好代碼應(yīng)該有的樣子:函數(shù)分工明確,各司其職,沒有重復(fù)代碼。很值得學(xué)習(xí)。雖然略微增加了閱讀的難度...要認(rèn)真分析函數(shù)在哪里調(diào)用,數(shù)據(jù)的流向等等才能很好地理解。比如一個on函數(shù),里面調(diào)用了internalOn,internalOn函數(shù)傳入了一個onApi,調(diào)用了eventsApi,onApi在eventsApi里面調(diào)用,往_events里面添加了新的事件。這只是一個例子,其他的其實(shí)都類似。
eventsApi(輔助函數(shù))
這是一個有趣的函數(shù),它只是提供一個api接口,起到分流的作用。函數(shù)中根據(jù)不同的name的形式作出不同的調(diào)用調(diào)整。使得代碼得到很好的復(fù)用。傳入的參數(shù)及其作用是:
- iteratee 實(shí)際真正要調(diào)用的函數(shù)
- events 事件,有很多情況中傳入的是this._events
- name 自己起的名字或者之前起的名字,代表了一個事件
- callback 回調(diào)函數(shù),觸發(fā)事件時觸發(fā)
- opts 參數(shù),在iteratee函數(shù)的內(nèi)部有自己的作用
在進(jìn)入它的函數(shù)的時候,會有一個判斷,把整一個函數(shù)內(nèi)部分成三個部分,分別處理三種不同的情況。三種不同的情況分別是name是一個對象,一個有空格的字符串,一個普通字符串。根據(jù)三種不同的情況,對name進(jìn)行處理,然后調(diào)用iteratee函數(shù)。
on
on方法的實(shí)質(zhì)是把事件添加到this._events里面,非常直觀。但是由于函數(shù)調(diào)用感覺好像復(fù)雜了。在on里面調(diào)用了internalOn,internalOn把函數(shù)onApi傳給了eventsApi,eventsApi里面調(diào)用了onApi,然后就把事件的信息push進(jìn)_events中。
onApi(輔助函數(shù))
這個函數(shù)很簡單,處理的事情就是往this._events里面push進(jìn)相應(yīng)的事件。一般是有添加進(jìn)新函數(shù)的時候才會調(diào)用到這個函數(shù)。值的注意的是描述一個事件的時候往往還需要一些其他的參數(shù),這時候就需要options來提供了。
off
off和on其實(shí)類似,只是把上面的onApi換成了offApi函數(shù),其他都是大體一致的。要看offApi的具體實(shí)現(xiàn)可以看下面。
offApi(輔助函數(shù))
取消事件有幾種情況。當(dāng)stopListening調(diào)用它的時候就不需要留下任何監(jiān)聽函數(shù),而用off的時候則還需要留下一些不應(yīng)該刪除的函數(shù)。刪除分兩步,***步是刪除自己的,把監(jiān)聽該對象的listener刪除。再第二部就是把那一個listener的listeningTo刪除。其實(shí)這種刪除方式和后端數(shù)據(jù)庫的一些操作非常相似。刪除是兩個方面的。
listenTo
其實(shí)看上去繁瑣,這個函數(shù)的作用就是構(gòu)建_listeningTo的一個過程。這個對象具體的形式在上面已經(jīng)講解過了。
stopListening
這個函數(shù)就是把對象所有監(jiān)聽的都清除掉。這個函數(shù)的內(nèi)部原理也很簡單,就是把_listeningTo遍歷一遍),***調(diào)用off取消掉所有的被監(jiān)聽者listeners里面的相應(yīng)的監(jiān)聽者。
once & listenToOnce
兩者內(nèi)部很相近,都是調(diào)用eventsApi把要執(zhí)行的函數(shù)onceApi傳進(jìn)去。差別在于once是***是調(diào)用on,而listenToOnce***調(diào)用listenTo。他們都是調(diào)用了一次就off掉的,原理在下面的onceMap介紹里面有講解。
onceMap(輔助函數(shù))
這個地方不好懂的地方是這個offer。offer這里是一個特殊的options。如果之前調(diào)用的once,offer就是off,如果之前調(diào)用的是listenToOnce就是stopListening。意思都是取消放棄監(jiān)聽。然后才調(diào)用回調(diào)函數(shù)。這樣做就達(dá)到“一次性”事件的要求。這里還保留了一個_callback函數(shù)的目的是什么呢?
- once._callback = callback;
這篇文章里說了,在offApi里面有這么一行判斷
- callback !== handler.callback._callback
根據(jù)這個判斷,就會讓一次性函數(shù)不會得以保留,這樣也就達(dá)到了用完一次就刪除的目的。這樣在調(diào)用offer的時候才得以刪除之。
trigger
trigger函數(shù)和之前的一樣,也是委托了eventsApi,把輔助函數(shù)傳進(jìn)去了。具體可以看下面 triggerApi & triggerEvents有詳細(xì)介紹。
triggerApi & triggerEvents (輔助函數(shù))
這兩個trigger的輔助函數(shù)是這樣工作的。在trigger函數(shù)里面把triggerApi函數(shù)傳給了eventsApi調(diào)用,而triggerApi調(diào)用了triggerEvents。在trigger里面先是把參數(shù)取出來。后來參數(shù)會傳到triggerApi里面。然后會開始判斷是否有這個事件啊,還有這個事件是不是“all”事件啊,等等。然后再調(diào)用triggerEvents,在這個函數(shù)里面就是循環(huán)執(zhí)行回調(diào)函數(shù)。(原本代碼注釋寫的迷之優(yōu)化(difficult-to-believe)其實(shí)很好理解,所謂能夠枚舉就枚舉嘛,總是或多或少能優(yōu)化的。)
總結(jié)
寫了一整天....真的好累...怪不得那么多人會放棄....希望明天的自己能夠抖擻精神,堅(jiān)持更新...而且寫得過于詳細(xì)也不是很好。Model& Collection & View這三個部分是很多人寫過的部分。大致簡略一點(diǎn)吧。
在backbone方面還算是小白,如果文章中有錯誤請輕噴,相互學(xué)習(xí)~