鏈式呼叫(method chaining)在 JavaScript 裡非常流行,寫過 jQuery 的人一定很有感——$(...).addClass('a').show().css(...) 一路串到底。它的實作原理其實單純得令人意外。
只要讓原型上定義的每個方法都回傳「呼叫它的那個實例」,鏈式呼叫就成立了。《JavaScript 設計模式》書中給了一個精簡的示範:
(function() {
function _$(els) {
this.elements = [];
for (var i = 0, len = els.length; i < len; ++i) {
var element = els[i];
if (typeof element == 'string') { element = document.getElementById(element); }
this.elements.push(element);
}
};
_$.prototype = {
each: function(fn) {
for (var i = 0, len = this.elements.length; i < len; ++i) { fn.call(this, this.elements[i]); }
return this;
},
setStyle: function(prop, val) {
this.each(function(el) { el.style[prop] = val; });
return this;
},
show: function() {
var that = this;
this.each(function(el) { that.setStyle('display', 'block'); });
return this;
},
addEvent: function(type, fn) {
var add = function(el) {
if (window.addEventListener) { el.addEventListener(type, fn, false); }
else if (window.attachEvent) { el.attachEvent('on'+type, fn); }
};
this.each(function(el) { add(el); });
return this;
}
};
window.$ = function() { return new _$(arguments); };
})();
每個方法結尾都以 return this 收束,把當前物件交棒給鏈上的下一個方法。
但如果資料是透過非同步請求取得的,回傳 this 就不管用了——請求還沒回來,鏈早就跑完。Dustin Diaz(也是該書作者之一)提出了一個很漂亮的解法:做一個 Queue,先把回呼排進隊列,等回應抵達再一次冲刷(flush)。
function Queue() {
this._methods = []; // 存放回呼
this._response = null; // 保存回應內容
this._flushed = false; // 是否已冲刷
}
Queue.prototype = {
add: function(fn) {
if (this._flushed) { fn(this._response); } // 已冲刷則立即執行
else { this._methods.push(fn); } // 否則排入隊列
},
flush: function(resp) {
if (this._flushed) { return; } // 只冲刷一次
this._response = resp;
this._flushed = true;
while (this._methods[0]) { this._methods.shift()(resp); }
}
};
有了這個工具,就能寫出一個「從伺服器取內容並塞進選取元素」的 jQuery 外掛,而且看起來跟同步鏈一樣自然:
(function($) {
$.fn.fetch = function(url) {
var queue = new Queue;
this.each(function() {
var el = this;
queue.add(function(resp) { $(el).html(resp); });
});
$.ajax({
url: url,
dataType: 'html',
success: function(html) { queue.flush(html); }
});
return this;
};
})(jQuery);
於是鏈式呼叫得以繼續往下走:
$("<div/>")
.fetch('/server/navigation.html')
.addClass('column')
.appendTo('#side');
若隊列裡有很多步都需要等伺服器回應,Diaz 也給了示範:把 each 階段要做的加工寫成排隊函式,回應到達後依序處理。
fetchTweet(url).linkify().filterBadWords().appendTo('#status');
原文下方的評論提出了幾個好問題。例如 $.fn.fetch 只是把內容塞進元素,真的有需要 Queue 嗎?jQuery 現成的 $.fn.load 就能勝任;若隊列裡只有一個回呼,寫成直接呼叫 success 反而更直白:
(function($) {
$.fn.fetch = function(url) {
var queue = new Queue;
this.each(function() {
var el = this;
$.ajax({
url: url,
type: 'get',
dataType: 'json',
success: function(resp) { $(el).html(resp['text1']); }
});
});
return this;
};
})(jQuery);
換句話說,Queue 的價值取決於鏈上真的有幾個非同步步驟需要排隊。這也是設計模式最容易被忽略的一課:先確認問題存在,再引入抽象。