哇——這是個相當大膽的題目,對吧?我們對「本質」的理解,自然會隨著對問題認知的深入而不斷改變。所以我不打算說得太滿——一年前我所理解的本質其實並不完整,因為我確信自己當時想寫的東西已醞釀了將近半年。因此,這篇文章可以說是我在摸索「如何成功在 JavaScript 中運用用戶端訊息模式」過程中的一則隨筆。
大多數人在描述任何事件或訊息機制時,都喜歡套用「發布者/訂閱者」(pub/sub)這個說法——但我認為這個術語並不能很好地對應到抽象的層次。誠然,從根本上說,確實有東西訂閱了另一些東西發布的事件。然而,發布者與訂閱者究竟在哪個層次上被封裝在一起,很可能讓一個好模式黯然失色。那麼,差別到底在哪裡?
觀察者模式包含了一個被一個或多個觀察者所觀察的物件。一般來說,該物件會記錄所有觀察者的痕跡,通常用一個清單來儲存觀察者註冊的回呼方法,這些正是觀察者為了接收通知而訂閱的。
var observer = { listen : function() { console.log("Yay for more cliché examples..."); } }; var elem = document.getElementById("cliche"); elem.addEventListener("click", observer.listen); 有幾點值得留意:
(註:n 實際上並非無限,只是為了討論方便,指我們永遠達不到的極限。)
中介者模式會在一個物件與一個觀察者之間引入「第三方」,有效地將兩者解耦,並把彼此的溝通方式封裝起來。一個中介者的 API 可能簡單如「發布」、「訂閱」、「取消訂閱」,也可能是某個領域範圍內的實作,用來把這些方法隱藏於某些更有意義的語意之中。我用過的多數伺服器端實作更傾向於領域導向而非單純化,但通用中介者並沒有任何規則限制!把通用中介者想成一位「訊息仲介」並不罕見。無論如何,結果都一樣——特定物件與觀察者之間不再互相直接知曉:
// It's fun to be naive! var mediator = { _subs: {}, // a real subscribe would at least check to make sure the // same callback instance wasn't registered 2x. // Sheesh, where did they find this guy?! subscribe: function(topic, callback) { this._subs[topic] = this._subs[topic] || []; this._subs[topic].push(callback); }, // lolwut? No ability to pass function context? :-) publish : function(topic, data) { var subs = this._subs[topic] || []; subs.forEach(function(cb) { cb(data); }); } } var FatherTime = function(med) { this.mediator = med; }; FatherTime.prototype.wakeyWakey = function() { this.mediator.publish("alarm.clock", { time: "06:00 AM", canSnooze: "heck-no-get-up-lazy-bum" }); } var Developer = function(mediator) { this.mediator = mediator; this.mediator.subscribe("alarm.clock", this.pleaseGodNo); }; Developer.prototype.pleaseGodNo = function(data) { alert("ZOMG, it's " + data.time + ". Please just make it stop."); } var fatherTime = new FatherTime(mediator); var developer = new Developer(mediator); fatherTime.wakeyWakey(); 你可能會想:除了特別純粹的中介者實作外,特定物件不再需要負責保存訂閱者清單,而且「時光老人」(FatherTime)與「開發者」(Developer)這兩個實例永遠不會真正互相知曉,它們只是共享了一份訊息——正如我們稍後會看到的,這是一份很重要的「合約」。「很好,Jim。但這對我來說仍然是發布者/訂閱者,重點到底在哪?」別急,親愛的讀者,繼續往下看。
使用本地的觀察者,還是用中介者來做元件間的(看似遠端)通訊?這該如何取捨?我對這種情況的原則是:一句話總結——太長就不讀了。但實際上要把它串聯起來才是最好的做法。
要我簡潔地說其實很困難,這就像把幾個月來的細致體驗硬壓進一條裝不下 140 字的縫隙裡。現實中,回答這個問題絕不可能簡短,所以還是聽聽長版本的解釋吧。
觀察者除了關心資料映射之外,還有必須參照其他項目的理由嗎?舉例來說,Backbone.View 視圖出於種種原因會直接參照它的模型。這是非常自然的關係——視圖不僅要在模型改變時重新渲染,還需要呼叫模型的處理函式。如果開頭這個問題的答案是「有」,那麼觀察者就是合適的。
如果觀察者與被觀察對象的關係僅僅是依賴資料,那我很樂意採用中介者式的 pub/sub。兩個 Backbone.View 視圖或模型之間的溝通,用觀察者是合適的;比如控制導覽選單的視圖所發出的訊息,正是麵包屑(breadcrumb)元件所需要的(用以響應目前的層級)。元件不需要參照導覽視圖,它只需要導覽視圖提供資訊;更關鍵的是,導覽視圖未必是唯一資訊來源,其他視圖也可能提供。此時,中介者 pub/sub 模式最為理想,而且擴展性良好。
聽起來既美好又周全,但其實還有一個盲點:如果我為物件定義了一個本地事件,既希望觀察者能直接呼叫,又希望訂閱者能間接存取,該怎麼辦?這就是我要強調「串聯」的原因——你把本地事件推送或橋接到訊息總線上去。需要多寫一些程式碼嗎?很可能需要——但這總比把被觀察物件一路傳遞給所有觀察者、讓它們始終緊耦合要好。接著,我們就能好好談談下面兩點……
最初我幾乎只用觀察者模式來在 JavaScript 中觸發事件。這是我們一次又一次遇到的模式,但更受歡迎的用戶端輔助函式庫,其行為方式從根本上說是混合了中介者的,它們提供了看似觀察者模式的 API。我最初撰寫 postal.js 時,開始走向「為萬物搭中介」的極端。在我寫的原型與建構子中,散佈各處的發布與訂閱呼叫並不罕見。當我從這種自然的解耦中受益時,那些非基礎的程式碼開始顯得與基礎部分糾纏不清。建構子到處都要帶上一個通道,訂閱被當作新實例的一部分來建立,原型方法直接發布數值到總線(就連本地訂閱者都不能直接取得,而必須監聽總線才能獲得資訊)。把這些明顯關於總線的東西塞進程式的各個環節,開始像是程式碼的味道。程式碼的「敘事」總是被打斷,諸如「喔,把這個向所有訂閱者發布出去」、「等等!等等!先監聽那個通道的事。好,現在繼續」。我的測試突然開始依賴總線才能做低層次的單元測試,而這感覺有點不對勁。
鐘擺擺向了中間——我意識到自己應該保留一個「本地 API」,並在需要時透過中介者為應用擴展它能觸及的資料。舉例來說,我的 Backbone 視圖與模型,仍然用普通的 Backbone.Events 行為向本地觀察者發送事件(也就是說,模型的變動被它對應的視圖所觀察)。當應用的其他部分需要知道模型變化時,我就透過下面這幾行,把本地事件與總線橋接起來:
var SomeModel = Backbone.Model.extend({ initialize: function() { this.on("change:superImportantField", function(model, value) { postal.publish({ channel : "someChannel", topic : "omg.super.important.field.changed", data : { muyImportante: value, otherFoo: "otherBar" } }); }); } }); 重要的是要認識到:即使有可能透明地把事件推送到訊息總線,本地事件與訊息仍應被視為兩份分開的合約——至少在概念上如此。換句話說,你要能夠修改「內部的/本地的」事件,而不破壞訊息合約。這是必須牢記的重要事實,否則你等於為緊耦合提供了一條新途徑,只是方向走反了而已!
所以理所當然,上述模型可以在沒有訊息總線的情況下被測試;而且如果我移除橋接本地事件與總線之間的邏輯,我的視圖與模型依然運作得毫無阻礙。不過,這可是七行的範例(儘管已經過格式化)。僅僅橋接四個事件,就需要將近三十行程式碼。
那麼,你要如何才能兩全其美——在適合直接觀察者時做本地通知,同時讓相關事件得以擴展,好讓你的物件不必給所有對象都發送一圈——卻又不需要程式碼膨脹?通知要如何才能用極少的程式碼、卻保留更多「味道」呢?
這並不是說上面範例中把事件接入總線的語法或概念有錯(前提是你接受「本地」與「遠端/橋接」事件的區分)。不過,這是一個很好的例子,說明了在程式碼基礎之上培養良好習慣的作用。有時我們會聽到「程式碼實在太多了」這類抱怨(尤其是當程式行數被當成程式碼品質的唯一判準時)。在這種情況下,我表示贊同——那確實是可怕的樣板。以下是我在橋接 Backbone 物件的本地事件到 postal.js 時所使用的模式:
// the logic to wire up publications and subscriptions // exists in our custom MsgBackboneView constructor var SomeView = MsgBackboneView.extend({ className : "i-am-classy", // bridging local events triggered by this view publications: { // This is the more common 'shorthand' syntax // The key name is the name of the event. The // value is "channel topic" in postal. So this // means the bridgeTooFar event will get // published to postal on the "comm" channel // using a topic of "thats.far.enough". By default // the 1st argument passed to the event callback // will become the message payload. bridgeTooFar : "comm thats.far.enough", // However, the longhand approach works like this: // The key is still the event name that will be bridged. // The value is an object that provides a channel name, // a topic (which can be a string or a function returning // a string), and an optional data function that returns // the object that should be the message payload. bridgeBurned: { channel : "comm", topic : "match.lit", data : function() { return { id: this.get("id"), foo: 'bar' }; } }, // This is how we subscribe to the bus and invoke // local methods to handle incoming messages subscriptions: { // The key is the name of the method to invoke. // The value is the "channel topic" to subscribe to. // So this will subscribe to the "hotChannel" channel // with a topic binding of "start.burning.*", and any // message arriving gets routed to the "burnItWithFire" // method on the view. burnItWithFire : "hotChannel start.burning.*" }, burnItWithFire: function(data, envelope) { // do stuff with message data and/or envelope } // other wire-up, etc. }); 顯然,你可以用幾種不同的方式做到這件事——選擇總線式的框架——這比樣板方式少了許多無關內容,而且為 Backbone 開發者所熟知。當你同時掌控事件發送器與訊息總線的實作時,橋接會變得更輕鬆。這裡有一個把 monologue.js 發送器橋接到 postal.js 的例子:
// using the 'monopost' add-on for monologue/postal: // assuming we have a worker instance that has monologue // methods on its prototype chain, etc. The keys are event // topic bindings to match local events to, and if a match is // found, it gets published to the channel specified in the // value (using the same topic value) worker.goPostal({ "match.stuff.like.#" : "ThisChannelYo", "secret.sauce.*" : "SeeecretChannel", "another.*.topic" : "YayMoarChannelsChannel" }); 以不同方式運用樣板,其實是種令人愉快的好習慣。現在我可以各自獨立地測試我的本地物件、橋接程式碼,甚至測試兩者合一後的生產與消費所期待的訊息流程等等。
同樣值得注意的是,如果我需要在上述情境中存取普通的 postal API,沒有什麼能阻攔我這麼做。靈活性絲毫未減——這就等於成功了。
有兩種把資料傳遞給訂閱者的方法,也許可以給它們貼上更「官方」的標籤:
看看這些例子:
// 0-n args this.trigger("someGuyBlogged", "Jim", "Cowart", "JavaScript"); // envelope style this.emit("someGuyBlogged", { firstName: "Jim", lastName: "Cowart", category: "JavaScript" }); /* In an emitter like monologue.js, the emit call above would actually publish an envelope that looked similar to this: { topic: "someGuyBlogged", timeStamp: "2013-02-05T04:54:59.209Z", data : { firstName: "Jim", lastName: "Cowart", category: "JavaScript" } } */ 經過一段時間,我發現信封方式比「0-n 參數」方式省下了非常多(程式碼與心思)。「0-n 參數」途徑的挑戰主要在於兩個原因(就我的經驗而言):第一,很典型地,當事件觸發時,你還記得要傳遞哪一個參數嗎?不記得?好吧,我想我得回去看看觸發的源頭。這顯然不是個好方法,還會打斷程式碼的正常流程。你可以用除錯工具檢測執行時的參數值,並據此推斷它們的「標籤」,但哪個更簡單呢——看到一個「1.21」的參數值、困惑於它的意義,還是檢測一個物件並發現 {千兆瓦:1.21}?第二個原因,是由於伴隨事件傳送的可選資料,以及方法簽名變得更長所帶來的痛苦。
「說實話,Jim,你這是在搭車棚(越扯越遠)。」或許是吧,但一段時間以來,我一直看到程式碼基礎在不斷擴充與變形:原本簡單、只包含一兩個參數的事件,在陸續加入可選參數之後,開始變得畸形:
// 最開始是這樣的 this.trigger("someEvent", "a string!", 99); // 有一天, 它變得包含了一切 this.trigger("someEvent", "string", 99, { sky: "blue" }, [1,2,3,4], true, 0); // 可是等等——第4和第5個參數是可選的,因此也可能傳的是: this.trigger("someEvent", "string", 99, [1,2,3,4], true, 0); // 噢,你還檢查第5個參數的真/假嗎? // 哎呦!現在是早先的參數了…… this.trigger("someEvent", "string", 99, true, 0); 只要有任何資料是可選的,就得圍繞它寫測試。改用信封方式則需要更少的程式碼、更具擴展性,尤其典型的是它能自解釋(感謝這些成員名稱),以便在逐一傳送給訂閱者回呼時,對一個物件進行測試。我仍然會在不得不使用「0-n 參數」的地方沿用舊法,但若是由我決定,我會一律採用信封方式——我的事件發射器與訊息總線都是如此。(這也說明我帶有偏見:monologue 與 postal 共享同一個信封資料結構,只是去掉了 monologue 用不到的通道。)
因此——得承認,用來給訂閱者傳輸資料的結構,是「合約」的一部分。朝信封方式這個方向走,你可以用額外的元資料來描述事件(不必增加額外參數)——這讓方法簽名(合約的一部分)對每個事件與訂閱者保持一致。你也能輕易為訊息結構編制版本(或在必要時增加其他信封層級的資訊)。如果你沿著這個方向做,請務必使用一致的信封結構。
這裡沒有萬靈丹。但你必須對如何命名主題與通道、以及如何設計訊息載荷的結構深思熟慮。我傾向於用兩種方式之一來映射我的模型:一是用單一資料通道,主題前綴採用模型名稱,後接其唯一 id,再透過它的操作({modelType.id.operation})來處理;二是給模型一個專屬通道,主題就是 {id.operation}。一個恆定的習慣是,在模型請求資料時自動響應這個行為。但並不是所有總線上的操作都是請求,也可能有簡單的事件發布給整個應用。你會命名主題來描述事件(理想情況下)嗎?還是你會掉進陷阱,用命名主題來描述某個訂閱者可能的傾向行為?例如,包含「route.changed」抑或「show.customer.ui」主題的訊息——前者表明事件,後者表明命令。做這些決定時務必仔細思考。命令並不壞,但在你需要請求/響應或命令之前,你會驚訝於事件所能描述的數量之龐大。