作為觀察者模式(Observer)的一種變形,很多 MV*框架(比如:Dojo、Backbone.js)中都提供發(fā)布/訂閱模型來(lái)對(duì)代碼進(jìn)行解耦。cordova.js 中也提供了一個(gè)自定義的 pub-sub 模型,基于該模型提供了一些事件通道,用來(lái)控制通道中的事件什么時(shí)候以什么樣的順序被調(diào)用,以及各個(gè)事件通道的調(diào)用。
src/common/channel.js 的代碼結(jié)構(gòu)也是一個(gè)很經(jīng)典的定義結(jié)構(gòu)(構(gòu)造函數(shù)、實(shí)例、修改函數(shù)原型共享實(shí)例方法),它提供事件通道上事件的訂閱(subscribe)、撤消訂閱(unsubscribe)、調(diào)用(fire)。最后發(fā)布了8個(gè)事件通道。
源碼如下:
Java 代碼
// file: src/common/channel.js
define("cordova/channel", function(require, exports, module) {
var utils = require('cordova/utils'),
nextGuid = 1;
// ①事件通道的構(gòu)造函數(shù)
var Channel = function(type, sticky) {
// 通道名稱
this.type = type;
// 通道上的所有事件處理函數(shù)Map(索引為guid)
this.handlers = {};
// 通道的狀態(tài)(0:非sticky, 1:sticky但未調(diào)用, 2:sticky已調(diào)用)
this.state = sticky ? 1 : 0;
// 對(duì)于sticky事件通道備份傳給fire()的參數(shù)
this.fireArgs = null;
// 當(dāng)前通道上的事件處理函數(shù)的個(gè)數(shù)
this.numHandlers = 0;
// 訂閱第一個(gè)事件或者取消訂閱最后一個(gè)事件時(shí)調(diào)用自定義的處理
this.onHasSubscribersChange = null;
},
// ②事件通道外部接口
channel = {
// 把指定的函數(shù)h訂閱到c的各個(gè)通道上,保證h在每個(gè)通道的最后被執(zhí)行
join: function(h, c) {
var len = c.length,
i = len,
f = function() {
if (!(--i)) h();
};
// 把事件處理函數(shù)h訂閱到c的各個(gè)事件通道上
for (var j=0; j<len; j++) {
// 必須是sticky事件通道
if (c[j].state === 0) {
throw Error('Can only use join with sticky channels.');
}
c[j].subscribe(f);
}
// 執(zhí)行h
if (!len) h();
},
// 創(chuàng)建事件通道
create: function(type) {
return channel[type] = new Channel(type, false);
},
// 創(chuàng)建sticky事件通道
createSticky: function(type) {
return channel[type] = new Channel(type, true);
},
// 保存deviceready事件之前要調(diào)用的事件
deviceReadyChannelsArray: [],
deviceReadyChannelsMap: {},
// 設(shè)置deviceready事件之前必須要完成的事件
waitForInitialization: function(feature) {
if (feature) {
var c = channel[feature] || this.createSticky(feature);
this.deviceReadyChannelsMap[feature] = c;
this.deviceReadyChannelsArray.push(c);
}
},
// 以前版本的代碼,現(xiàn)在好像沒(méi)有用!
initializationComplete: function(feature) {
var c = this.deviceReadyChannelsMap[feature];
if (c) {
c.fire();
}
}
};
// 這個(gè)應(yīng)該放入utils里,就是一個(gè)函數(shù)的判斷
function forceFunction(f) {
if (typeof f != 'function') throw "Function required as first argument!";
}
// ③修改函數(shù)原型共享實(shí)例方法-----------------------
// 向事件通道訂閱事件處理函數(shù)(subscribe部分)
// f:事件處理函數(shù) c:事件的上下文(可省略)
Channel.prototype.subscribe = function(f, c) {
// 事件處理函數(shù)校驗(yàn)
forceFunction(f);
// 如果是被訂閱過(guò)的sticky事件,就直接調(diào)用。
if (this.state == 2) {
f.apply(c || this, this.fireArgs);
return;
}
var func = f,
guid = f.observer_guid;
// 如果事件有上下文,要先把事件函數(shù)包裝一下帶上上下文
if (typeof c == "object") { func = utils.close(c, f); }
// 自增長(zhǎng)的ID
if (!guid) {
guid = '' + nextGuid++;
}
// 把自增長(zhǎng)的ID反向設(shè)置給函數(shù),以后撤消訂閱或內(nèi)部查找用
func.observer_guid = guid;
f.observer_guid = guid;
// 判斷該guid索引的事件處理函數(shù)是否存在(保證訂閱一次)
if (!this.handlers[guid]) {
// 訂閱到該通道上(索引為guid)
this.handlers[guid] = func;
// 通道上的事件處理函數(shù)的個(gè)數(shù)增1
this.numHandlers++;
if (this.numHandlers == 1) {
// 訂閱第一個(gè)事件時(shí)調(diào)用自定義的處理(比如:第一次按下返回按鈕提示“再按一次...”)
this.onHasSubscribersChange && this.onHasSubscribersChange();
}
}
};
// 撤消訂閱通道上的某個(gè)函數(shù)(guid)
Channel.prototype.unsubscribe = function(f) {
// 事件處理函數(shù)校驗(yàn)
forceFunction(f);
// 事件處理函數(shù)的guid索引
var guid = f.observer_guid,
// 事件處理函數(shù)
handler = this.handlers[guid];
if (handler) {
// 從該通道上撤消訂閱(索引為guid)
delete this.handlers[guid];
// 通道上的事件處理函數(shù)的個(gè)數(shù)減1
this.numHandlers--;
if (this.numHandlers === 0) {
// 撤消訂閱最后一個(gè)事件時(shí)調(diào)用自定義的處理
this.onHasSubscribersChange && this.onHasSubscribersChange();
}
}
};
// 調(diào)用所有被發(fā)布到該通道上的函數(shù)
Channel.prototype.fire = function(e) {
var fail = false,
fireArgs = Array.prototype.slice.call(arguments);
// sticky事件被調(diào)用時(shí),標(biāo)示為已經(jīng)調(diào)用過(guò)。
if (this.state == 1) {
this.state = 2;
this.fireArgs = fireArgs;
}
if (this.numHandlers) {
// 把該通道上的所有事件處理函數(shù)拿出來(lái)放到一個(gè)數(shù)組中。
var toCall = [];
for (var item in this.handlers) {
toCall.push(this.handlers[item]);
}
// 依次調(diào)用通道上的所有事件處理函數(shù)
for (var i = 0; i < toCall.length; ++i) {
toCall[i].apply(this, fireArgs);
}
// sticky事件是一次性全部被調(diào)用的,調(diào)用完成后就清空。
if (this.state == 2 && this.numHandlers) {
this.numHandlers = 0;
this.handlers = {};
this.onHasSubscribersChange && this.onHasSubscribersChange();
}
}
};
// ④創(chuàng)建事件通道(publish部分)-----------------------
// (內(nèi)部事件通道)頁(yè)面加載后DOM解析完成
channel.createSticky('onDOMContentLoaded');
// (內(nèi)部事件通道)Cordova的native準(zhǔn)備完成
channel.createSticky('onNativeReady');
// (內(nèi)部事件通道)所有Cordova的JavaScript對(duì)象被創(chuàng)建完成可以開始加載插件
channel.createSticky('onCordovaReady');
// (內(nèi)部事件通道)所有自動(dòng)load的插件js已經(jīng)被加載完成
channel.createSticky('onPluginsReady');
// Cordova全部準(zhǔn)備完成
channel.createSticky('onDeviceReady');
// 應(yīng)用重新返回前臺(tái)
channel.create('onResume');
// 應(yīng)用暫停退到后臺(tái)
channel.create('onPause');
// (內(nèi)部事件通道)應(yīng)用被關(guān)閉(window.onunload)
channel.createSticky('onDestroy');
// ⑤設(shè)置deviceready事件之前必須要完成的事件
// ***onNativeReady和onPluginsReady是平臺(tái)初期化之前要完成的。
channel.waitForInitialization('onCordovaReady');
channel.waitForInitialization('onDOMContentLoaded');
module.exports = channel;
});
參考:
http://stackoverflow.com/questions/13512949/why-would-one-use-the-publish-subscribe-pattern-in-js-jquery