代理,顧名思義就是代替別人做事。GoF 對代理模式的定義是:為其他物件提供一種代理,以控制對這個物件的存取。代理模式讓代理物件掌握對具體物件的引用,而代理本身幾乎可以是任何東西——檔案、資源、記憶體中的物件,或某些難以複製的東西。
假如 dudu 要送酸奶小妹玫瑰花,卻不知道她的聯絡方式,或者不好意思自己送,於是委託大叔代送。這時候大叔就是代理。
// 先聲明美女物件
var girl = function (name) {
this.name = name;
};
// 這是 dudu
var dudu = function (girl) {
this.girl = girl;
this.sendGift = function (gift) {
alert("Hi " + girl.name + ", dudu 送你一個禮物:" + gift);
}
};
// 大叔是代理
var proxyTom = function (girl) {
this.girl = girl;
this.sendGift = function (gift) {
(new dudu(girl)).sendGift(gift); // 替 dudu 送花咯
}
};
呼叫方式非常簡單:
var proxy = new proxyTom(new girl("酸奶小妹"));
proxy.sendGift("999朵玫瑰");
呼叫端只跟 proxyTom 打交道,真實的送禮行為被藏在代理內部。這就是代理的本質:介面保持一致,存取路徑多了一層。
來看一個更實用的場景。我們有一個影片播放列表,需要在點擊單個連結(或全選)時,在該連結下方顯示影片簡介與 play 按鈕,點 play 才真正播放。列表結構如下:
<h1>Dave Matthews vids</h1>
<p><span id="toggle-all">全選/反選</span></p>
<ol id="vids">
<li><input type="checkbox" checked><a href="https://new.music.yahoo.com/videos/--2158073">Gravedigger</a></li>
<li><input type="checkbox" checked><a href="https://new.music.yahoo.com/videos/--4472739">Save Me</a></li>
<li><input type="checkbox" checked><a href="https://new.music.yahoo.com/videos/--45286339">Crush</a></li>
<li><input type="checkbox" checked><a href="https://new.music.yahoo.com/videos/--2144530">Don't Drink The Water</a></li>
<li><input type="checkbox" checked><a href="https://new.music.yahoo.com/videos/--217241800">Funny the Way It Is</a></li>
<li><input type="checkbox" checked><a href="https://new.music.yahoo.com/videos/--2144532">What Would You Say</a>
</li>
</ol>
分析需求:既要監控 a 連結的點擊,也要監控「全選/反選」的點擊,然後請求伺服器查詢影片資訊,組裝 HTML 顯示在 li 元素的最後。點擊 play 才真正播放。


沒有 jQuery,我們自己定義一個精簡選擇器:
var $ = function (id) {
return document.getElementById(id);
};
由於 Yahoo 的 json 服務提供了 callback 參數,我們傳入自訂的 callback 來接收資料,查詢字串組裝如下:
var http = {
makeRequest: function (ids, callback) {
var url = 'https://query.yahooapis.com/v1/public/yql?q=',
sql = 'select * from music.video.id where ids IN ("%ID%")',
format = "format=json",
handler = "callback=" + callback,
script = document.createElement('script');
sql = sql.replace('%ID%', ids.join('","'));
sql = encodeURIComponent(sql);
url += sql + '&' + format + '&' + handler;
script.src = url;
document.body.appendChild(script);
}
};
接著是代理物件本身。它做了一件很關鍵的事:把短時間內的多個請求合併成一次:
var proxy = {
ids: [],
delay: 50,
timeout: null,
callback: null,
context: null,
// 設置請求的 id 和 callback 以便在播放的時候觸發回調
makeRequest: function (id, callback, context) {
// 添加到隊列
this.ids.push(id);
this.callback = callback;
this.context = context;
// 設置 timeout
if (!this.timeout) {
this.timeout = setTimeout(function () {
proxy.flush();
}, this.delay);
}
},
// 觸發請求,使用代理職責調用了 http.makeRequest
flush: function () {
// proxy.handler 為請求 yahoo 時的 callback
http.makeRequest(this.ids, 'proxy.handler');
// 請求數據以後,緊接著執行 proxy.handler 方法(裡面有另一個設置的 callback)
// 清除 timeout 和隊列
this.timeout = null;
this.ids = [];
},
handler: function (data) {
var i, max;
// 單個影片的 callback 調用
if (parseInt(data.query.count, 10) === 1) {
proxy.callback.call(proxy.context, data.query.results.Video);
return;
}
// 多個影片的 callback 調用
for (i = 0, max = data.query.results.Video.length; i < max; i += 1) {
proxy.callback.call(proxy.context, data.query.results.Video[i]);
}
}
};
這裡的 50 毫秒 delay 是整個設計的精髓。使用者點「全選」時,六個請求會在同一瞬間湧入,proxy 把它們先塞進 ids 佇列,只開一個 50 毫秒的計時器;期間內陸續送來的請求都只會被收進佇列,不會另開計時器。時間一到,flush 把整批 id 一次送出。於是六次網路往返壓縮成一次——這正是虛擬代理兼批次化的典型手法。
影片處理模組主要有三種子功能:取得資訊、展示資訊、播放影片:
var videos = {
// 初始化播放器代碼,開始播放
getPlayer: function (id) {
return '' +
'<object width="400" height="255" id="uvp_fop" allowFullScreen="true">' +
'<param name="movie" value="https://d.yimg.com/m/up/fop/embedflv/swf/fop.swf"\/>' +
'<param name="flashVars" value="id=v' + id + '&eID=1301797&lang=us&enableFullScreen=0&shareEnable=1"\/>' +
'<param name="wmode" value="transparent"\/>' +
'<embed ' +
'height="255" ' +
'width="400" ' +
'id="uvp_fop" ' +
'allowFullScreen="true" ' +
'src="https://d.yimg.com/m/up/fop/embedflv/swf/fop.swf" ' +
'type="application/x-shockwave-flash" ' +
'flashvars="id=v' + id + '&eID=1301797&lang=us&ympsc=4195329&enableFullScreen=1&shareEnable=1"' +
'\/>' +
'<\/object>';
},
// 拼接信息顯示內容,然後 append 到 li 的底部裡顯示
updateList: function (data) {
var id,
html = '',
info;
if (data.query) {
data = data.query.results.Video;
}
id = data.id;
html += '<img src="' + data.Image[0].url + '" width="50" \/>';
html += '<h2>' + data.title + '<\/h2>';
html += '<p>' + data.copyrightYear + ', ' + data.label + '<\/p>';
if (data.Album) {
html += '<p>Album: ' + data.Album.Release.title + ', ' + data.Album.Release.releaseYear + '<br \/>';
}
html += '<p><a class="play" href="https://new.music.yahoo.com/videos/--' + id + '">» play<\/a><\/p>';
info = document.createElement('div');
info.id = "info" + id;
info.innerHTML = html;
$('v' + id).appendChild(info);
},
// 獲取信息並顯示
getInfo: function (id) {
var info = $('info' + id);
if (!info) {
proxy.makeRequest(id, videos.updateList, videos); // 執行代理職責,並傳入 videos.updateList 回調函數
return;
}
if (info.style.display === "none") {
info.style.display = '';
} else {
info.style.display = 'none';
}
}
};
注意 getInfo 裡的 `if (!info)` 判斷:若該影片的資訊節點還不存在,就交由 proxy 去抓;若已存在,則只是切換顯示與隱藏。這又是一層 caching——同一支影片第二次點擊完全不會再發請求。
現在可以處理點擊事件了。由於連結很多,逐一綁定事件效能不佳,因此改用事件委派掛在 ol 上,再判斷點擊目標是否為 a:
$('vids').onclick = function (e) {
var src, id;
e = e || window.event;
src = e.target || e.srcElement;
// 不是連結的話就不繼續處理了
if (src.nodeName.toUpperCase() !== "A") {
return;
}
// 阻止默認行為
if (typeof e.preventDefault === "function") {
e.preventDefault();
}
e.returnValue = false;
id = src.href.split('--')[1];
// 如果點擊的是已經生成的影片信息區域的連結 play,就開始播放
// 然後 return 不繼續了
if (src.className === "play") {
src.parentNode.innerHTML = videos.getPlayer(id);
return;
}
src.parentNode.id = "v" + id;
videos.getInfo(id); // 這個才是第一次點擊的時候顯示影片信息的處理代碼
};
全選反選的邏輯大同小異:
$('toggle-all').onclick = function (e) {
var hrefs, i, max, id;
hrefs = $('vids').getElementsByTagName('a');
for (i = 0, max = hrefs.length; i < max; i += 1) {
// 忽略 play 連結
if (hrefs[i].className === "play") {
continue;
}
// 忽略沒有選擇的項
if (!hrefs[i].parentNode.firstChild.checked) {
continue;
}
id = hrefs[i].href.split('--')[1];
hrefs[i].parentNode.id = "v" + id;
videos.getInfo(id);
}
};
一、遠端代理。為一個物件在不同定址空間提供本地代表,隱藏「真實物件存在於遠端」這件事實,web service 中的代理類就是典型例子。
二、虛擬代理。用以替換建立成本很高的物件,把真正耗時的實例化延後到必要時才進行。瀏覽器渲染時先顯示佔位、圖片稍後慢慢補上,背後就是虛擬代理保存了真實圖片的路徑與尺寸。
三、安全代理。用來控制存取真實物件的權限,適合不同呼叫端應有不同權限的場景。
四、智慧指引(smart reference)。在存取真實物件時額外處理一些事情,例如引用計數——當引用數歸零,GC 就可以回收該物件。
本文的範例同時用到了虛擬代理(資訊延後載入)與批次化(請求合併),這在真實專案中是非常實用的組合。參考《大話設計模式》。