觀察者模式又叫發布訂閱模式(Publish/Subscribe),它定義了一種一對多的依賴關係:多個觀察者同時監聽同一個主題物件,當主題狀態改變時,所有觀察者都會收到通知並自動更新。
1. 支援簡單的廣播式通信,一次通知所有已訂閱的物件;
2. 頁面載入後,主題與觀察者可以動態掛上關聯,靈活性高;
3. 主題與觀察者之間是抽象耦合,雙方可以各自獨立擴展與複用。
JavaScript 裡最直觀的觀察者實作就是回呼函式。先定義一個 pubsub 物件,內部提供訂閱、退訂、發布三個方法:
var pubsub = {};
(function (q) {
var topics = {}, // 存放回呼函式的集合
subUid = -1;
// 發布
q.publish = function (topic, args) {
if (!topics[topic]) { return false; }
setTimeout(function () {
var subscribers = topics[topic],
len = subscribers ? subscribers.length : 0;
while (len--) {
subscribers[len].func(topic, args);
}
}, 0);
return true;
};
// 訂閱,回傳一組 token 供日後退訂使用
q.subscribe = function (topic, func) {
if (!topics[topic]) { topics[topic] = []; }
var token = (++subUid).toString();
topics[topic].push({ token: token, func: func });
return token;
};
// 退訂
q.unsubscribe = function (token) {
for (var m in topics) {
if (topics[m]) {
for (var i = 0, j = topics[m].length; i < j; i++) {
if (topics[m][i].token === token) {
topics[m].splice(i, 1);
return token;
}
}
}
}
return false;
};
}(pubsub));
使用方式:
// 訂閱
pubsub.subscribe('example1', function (topics, data) {
console.log(topics + ": " + data);
});
// 發布
pubsub.publish('example1', 'hello world!');
pubsub.publish('example1', ['test', 'a', 'b', 'c']);
pubsub.publish('example1', [{ 'color': 'blue' }, { 'text': 'hello' }]);
用起來很順手,但缺點是退訂時必須拿到訂閱時回傳的 token。改成先存變數即可:
// 把訂閱結果存起來,以便後續退訂
var testSubscription = pubsub.subscribe('example1', function (topics, data) {
console.log(topics + ": " + data);
});
pubsub.publish('example1', 'hello world!');
pubsub.publish('example1', ['test', 'a', 'b', 'c']);
// 退訂
setTimeout(function () {
pubsub.unsubscribe(testSubscription);
}, 0);
// 再發布一次,驗證是否已停止輸出
pubsub.publish('example1', 'hello again! (this will fail)');
function Observer() {
this.fns = [];
}
Observer.prototype = {
subscribe: function (fn) {
this.fns.push(fn);
},
unsubscribe: function (fn) {
this.fns = this.fns.filter(function (el) {
if (el !== fn) { return el; }
});
},
update: function (o, thisObj) {
var scope = thisObj || window;
this.fns.forEach(function (el) {
el.call(scope, o);
});
}
};
// 測試
var o = new Observer;
var f1 = function (data) {
console.log('Robbin: ' + data + ',趕緊干活了!');
};
var f2 = function (data) {
console.log('Randall: ' + data + ',找他加點工資去!');
};
o.subscribe(f1);
o.subscribe(f2);
o.update("Tom 回來了!");
o.unsubscribe(f1); // 退訂 f1
o.update("Tom 回來了!"); // 再驗證一次
如果瀏覽器提示找不到 filter 或 forEach,通常是版本太舊不支援這兩個標準方法,可以自行補上:
if (!Array.prototype.forEach) {
Array.prototype.forEach = function (fn, thisObj) {
var scope = thisObj || window;
for (var i = 0, j = this.length; i < j; ++i) {
fn.call(scope, this[i], i, this);
}
};
}
if (!Array.prototype.filter) {
Array.prototype.filter = function (fn, thisObj) {
var scope = thisObj || window, a = [];
for (var i = 0, j = this.length; i < j; ++i) {
if (!fn.call(scope, this[i], i, this)) { continue; }
a.push(this[i]);
}
return a;
};
}
如果希望多個物件都具備發布訂閱能力,可以寫一個通用物件,再用 make 方法把能力「武裝」到目標物件上:
var observer = {
addSubscriber: function (callback) { // 訂閱
this.subscribers[this.subscribers.length] = callback;
},
removeSubscriber: function (callback) { // 退訂
for (var i = 0; i < this.subscribers.length; i++) {
if (this.subscribers[i] === callback) {
delete (this.subscribers[i]);
}
}
},
publish: function (what) { // 發布
for (var i = 0; i < this.subscribers.length; i++) {
if (typeof this.subscribers[i] === 'function') {
this.subscribers[i](what);
}
}
},
make: function (o) { // 讓物件 o 具備觀察者能力
for (var i in this) {
o[i] = this[i];
o.subscribers = [];
}
}
};
接著讓 blogger 與 user 兩個物件都具備觀察者能力:
var blogger = {
recommend: function (id) {
this.publish('dudu 推薦了這篇文章:' + id);
}
};
var user = {
vote: function (id) {
this.publish('有人投票了!ID=' + id);
}
};
observer.make(blogger);
observer.make(user);
訂閱時把不同的回呼函式掛到不同主題上,同一個函式也可以同時訂閱多個主題:
var tom = {
read: function (what) {
console.log('Tom 看到了:' + what)
}
};
var mm = {
show: function (what) {
console.log('mm 看到了:' + what)
}
};
blogger.addSubscriber(tom.read);
blogger.addSubscriber(mm.show);
blogger.recommend(123);
blogger.removeSubscriber(mm.show); // 退訂
blogger.recommend(456);
user.addSubscriber(mm.show); // 另一個主題的訂閱
user.vote(789);
jQuery 1.7 之後提供了 on / off,只要包一層就能得到觀察者:
(function ($) {
var o = $({});
$.subscribe = function () { o.on.apply(o, arguments); };
$.unsubscribe = function () { o.off.apply(o, arguments); };
$.publish = function () { o.trigger.apply(o, arguments); };
}(jQuery));
呼叫方式比前三個版本都乾淨:
function handle(e, a, b, c) {
// e 是事件物件,可忽略
console.log(a + b + c);
};
$.subscribe("/some/topic", handle);
$.publish("/some/topic", ["a", "b", "c"]); // 輸出 abc
$.unsubscribe("/some/topic", handle); // 依回呼函式退訂
// 也可以傳匿名函式
$.subscribe("/some/topic", function (e, a, b, c) {
console.log(a + b + c);
});
$.publish("/some/topic", ["a", "b", "c"]); // 輸出 abc
// 注意:這裡退訂用的是主題名稱,而不是回呼函式
$.unsubscribe("/some/topic");
這個版本的關鍵差異在於:訂閱與退訂都以字串主題名為依據,所以即使是匿名函式也能被順利退訂。
當某個物件的狀態改變需要同步通知其他物件,而你事先並不確切知道有多少個物件需要被通知時,就是觀察者模式的最佳舞臺。
說到底,觀察者模式做的就是解耦——讓雙方都依賴抽象而非具體實作,於是任何一邊的變動都不會牽動另一邊。這也是它在事件系統、資料綁定、訊息通知等場景中被反覆使用的原因。