Backbone.js 自 2010 年問世以來,一直是前端「MV*」框架裡人氣很高的一員。它的可愛之處在於克制:給你 Model、Collection、View、Router 四塊積木,其餘設計決策留給你自己。但自由也意味著容易踩坑,尤其是第一次使用者,往往會在資料參考、視圖粒度、路由參數這些地方反覆跌倒。以下整理一組實務上驗證過的模式。
JavaScript 對原始型別是傳值,對物件則是傳參考。這意味著下面兩行的行為完全不同:
var a = "Hello World";
var b = a; // 複製值
var obj = { hello: 'world' };
var copy = obj; // 複製參考,改 copy 等於改 obj
而 Backbone 的 model.get() 回傳的就是參考本身。看這個例子:
var Person = Backbone.Model.extend({
validate: function (attrs) {
if (isNaN(attrs.address.zipCode)) return "郵遞區號必須是數字!";
},
defaults: {
name: 'John Doe',
address: { street: '1st Street', city: 'Austin', state: 'TX', zipCode: 78701 }
}
});
var person = new Person({ name: 'Phillip W' });
var address = person.get('address');
address.zipCode = 'Hello World'; // 這一步就已經改到模型了
person.set('address', address, { validate: true }); // 驗證確實報錯
console.log(person.get('address')); // 但值已經被改掉了
驗證失敗,資料卻已經髒了——這是最容易讓人查上一整天的那類 bug。解法是在動手前先做一次深拷貝。jQuery 的 $.extend 傳入 true 即可:
var address = $.extend(true, {}, person.get('address'));
Underscore 的 _.extend 是淺拷貝,不適用;Lo-Dash 的 _.clone 則可帶 deep 參數。要留意深拷貝本身有成本,若對象很大或數量成千上萬,效能分析就該列入考慮。
後端回傳的 JSON 結構總是會變。如果視圖直接到處 model.get('rooms'),結構一改就得全專案搜尋替換。把存取收斂到幾個方法裡,成本很低,收益很大。
var Hotel = Backbone.Model.extend({
defaults: {
availableRooms: ["a"],
rooms: { a: { size: 1200, bed: "queen" }, b: { size: 900, bed: "twin" } }
},
getRooms: function () { return $.extend(true, {}, this.get("rooms")); },
getRoomsByBed: function (bed) { return _.where(this.getRooms(), { bed: bed }); }
});
假設端點把 rooms 從物件改成陣列,你只要改 getRooms 一個方法,把它轉回原本的形式,其餘程式碼完全不用動:
getRooms: function () {
var rooms = $.extend(true, {}, this.get("rooms")), newRooms = {};
_.each(rooms, function (room) {
newRooms[room.name] = { size: room.size, bed: room.bed };
});
return newRooms;
}
這個模式同時帶有裝飾與橋接的味道:對外隱藏複製的複雜度,也負責把資料轉成呼叫端期待的形状。
像「目前選中哪一個項目」這種純視覺狀態,放進模型反而拖累序列化。直接存在視圖上更省事:
setSelectedItem: function (event) {
var $item = $(event.currentTarget);
$('#items li a').removeClass('selected');
$item.addClass('selected');
this.selectedItemId = $item.data('id');
return false;
}
判斷標準很實際:若屬性純粹為了呈現(例如容器高度),放視圖;若與底層資料模型有關(例如「只能選一個」這類業務規則),才放模型。反過來,存進模型的資料若沒有對應的端點資源,存檔時容易造成困擾。
初學時常見的寫法是監聽 change 然後整份重繪。視圖一長大,這就會變成維護與效能的雙重負擔。
// 改進前
initialize: function () { this.model.on('change', this.render, this); }
// 改進後
initialize: function () {
this.model.on('change:a', this.renderA, this);
this.model.on('change:b', this.renderB, this);
},
renderA: function () { $('#a', this.$el).html(this.model.get('a')); return this; },
renderB: function () { $('#b', this.$el).html(this.model.get('b')); return this; },
render: function () { this.renderA().renderB(); }
每個渲染函式回傳 this,就能鏈式串接。若想省下大量樣板程式,可以看看 Backbone.StickIt 或 Backbone.ModelBinder 這類鍵值綁定外掛。
Backbone 本身並不強制關注點分離——除非你在建立模型時完全不引用視圖。是否要主動遵守,答案是肯定的。資料層與渲染層一旦糾纏,程式碼很快就會變成沒人敢碰的義大利麵。保持分離之後,模型與集合可以在應用各處自由重複使用,新加入的成員也能一眼看出「業務邏輯在哪、渲染在哪」,同時自然符合單一職責原則。
Backbone 的路由參數是由左至右依序傳入,沒有具名對應。當你同時有 search/:foo、search/:bar、search/:foo/:bar 三種型態時,若都用同一個 search() 函式,就會出現參數錯位。
routes: {
'search/:foo': 'searchFoo',
'search/:bar': 'searchBar',
'search/:foo/:bar': 'search'
},
search: function (foo, bar) { /* 實際邏輯 */ },
searchFoo: function (foo) { this.search(foo, undefined); },
searchBar: function (bar) { this.search(undefined, bar); }
用薄薄的外層函式把參數補齊,路由表就不會膨脹成一堆近似重複的入口。要注意這招無法處理「兩個參數型態相同、無法區分」的情況,例如兩個都是 XXXX-XXXX 格式的 ID。
fetch() 是合併而非取代。模型原本有 x、y、z,端點只回 y 與 z,那麼 x 會保留舊值。
PUT 需要 id。要讓 save() 送出 PUT,模型必須有 id 屬性。若端點用的是 carID 這類命名,0.5 以上版本可用 idAttribute 指定;更舊的版本則在 parse 裡自行映射。
parse: function (response) {
_.each(response.cars, function (car, i) {
response.cars[i].id = response.cars[i].carID;
});
return response;
}
在頁面裡內嵌一段腳本,用後端語言把初始資料直接輸出給模型,可以省掉一次初始化請求,對首屏速度與搜尋引擎抓取都有幫助:
var model = new Model(<%= @hello_world.to_json %>);
Backbone 沒有內建這件事,有兩種常見做法。
回傳錯誤物件,把訊息與對應的 class 一起帶回,視圖集中處理:
// model
validate: function (attrs) {
var errors = [];
if (attrs.a < 0) errors.push({ message: '欄位 a 有問題', 'class': 'a' });
if (attrs.b < 0) errors.push({ message: '欄位 b 有問題', 'class': 'b' });
if (errors.length) return errors;
}
// view
this.model.on('invalid', function (model, errors) {
_.each(errors, function (e) { $('.' + e['class']).addClass('error'); alert(e.message); });
});
廣播自訂事件,讓每個欄位有自己的錯誤事件,視圖各自綁定:
// model
this.trigger('invalid:a', '欄位 a 有問題', this);
// view
this.model.on('invalid:a', function (msg) { $('a').addClass('error'); alert(msg); });
前者適合所有欄位用同一套處理邏輯的情況,後者適合每個欄位需要不同 UI 反應的情況;選錯方向,其中一邊就會長出一段又臭又長的 switch。
當回應的 JSON 格式無效時,即使狀態碼是 200,模型或集合仍會觸發 error 事件。這通常出現在用本機假資料開發的時候,養成用 JSON 驗證器檢查假資料、或在編輯器裝外掛即時提示的習慣,能省下不少時間。
var AlertView = Backbone.View.extend({
set: function (typeOfError, message) {
var $alert = $('.in-page-alert').length ? $('.in-page-alert') : $('.body-alert');
$alert.removeClass('error success warning')
.addClass(typeOfError).html(message)
.fadeIn().delay(5000).fadeOut();
}
});
var alert = new AlertView();
this.model.on('error', function (model, error) { alert.set('error', error); });
先找視圖內的提示容器,找不到就退回全頁層級的容器,這樣訊息風格統一,也不會因為忘了放容器就什麼都看不到。
這聽起來瑣碎,卻是單頁應用最常被忽略的可用性問題。可以擴充 Router,用一份對照表把路由名映射到標題:
this.on('route', function (router, route, params) {
if (that.titles) {
if (that.titles[router]) document.title = that.titles[router];
else if (that.titles.default) document.title = that.titles.default;
}
});
index: function (parameter) {
this.cached.model = this.cached.model || new Model({ parameter: parameter });
this.cached.view = this.cached.view || new View({ model: this.cached.model });
}
反覆進入同一路由時不必重新建立物件,但會佔用記憶體,因此只適合少數高頻畫面。需要重新抓資料時,可在快取存在的前提下呼叫 fetch();更精準的做法是監聽參數變化再抓:
// model
initialize: function () { this.on("change:parameter", this.fetchData, this); }
var Thing = Backbone.View.extend(/** @lends Thing.prototype */{
/** @class Thing
* @augments Backbone.View
* @constructs Thing object */
initialize: function () {},
/** 依 ID 取得資料,找不到時回傳空字串。
* @param {String} id 要查詢的 ID
* @return {String} 資料內容 */
getDataById: function (id) {}
});
搭配 grunt-jsdoc-plugin 這類工具,就能把文件產出納入建置流程。
我自己寫 Backbone 時,會先用 Jasmine 為模型與集合寫測試。先讓測試失敗,再回頭把實作重寫到通過。一開始速度一定比較慢,但當綠燈亮起時,你對資料層的行為會有明確信心,視圖層反而變得非常好寫。
這些模式沒有哪一條是官方硬性規定,但它們共同指向同一件事:Backbone 給你自由,紀律得自己長出來。