用 KnockoutJS(簡稱 ko)做 MVVM 的時候,一定會碰到一種尷尬:ViewModel 定義時根本沒這個屬性,是執行到某個互動之後才需要它。最典型的例子是清單編輯——使用者點「編輯」,我們希望把該列狀態切換成 Edit,但資料模型裡從來沒有 Edit 這個欄位,於是 data-bind 在渲染時就丟出錯誤。
要解決它,得先分清楚 ko 的兩種綁定情境。
最普通的用法,observable 一建立就有初始值:
$(function () {
var viewModel = function () {
var self = this;
self.text = ko.observable(1);
};
ko.applyBindings(new viewModel());
});
對應的 UI:
<div data-bind='text:text'</div>
呈現:
observable 不給初始值,之後再由外部填入:
$(function () {
var viewModel = function () {
var self = this;
self.text = ko.observable();
};
ko.applyBindings(new viewModel());
});
如果 text 只是一般值型別,寫法和上面完全相同。但若它是個物件,而你想在模板裡直接存取它的子屬性,就要改用 with:
<div data-bind='with:text'> <div data-bind="text:property"</div> </div>
with 會把綁定上下文的 this 換成該物件,於是裡層就能直接寫 property。要注意的是它同時也換掉了 $data 的意義,巢狀太深時反而難讀,實務上建議控制层数。
問題來了:如果連「要綁哪個屬性」都不確定,ko 內建的 binding 幫不上忙,因為它在 applyBindings 的當下就試圖解析屬性名稱,找不到就報錯。這時候唯一的路是擴充一個自訂 binding handler。
先做擴充:
ko.bindingHandlers.ext = {
update: function (element, valueAccessor, allBindingsAccessor, viewModel, bindingContext) {
var value = ko.utils.unwrapObservable(valueAccessor());
for (var handler in value) {
if (value.hasOwnProperty(handler)) {
if (typeof viewModel[value[handler]] == 'undefined') {
viewModel[value[handler]] = ko.observable();
}
ko.bindingHandlers[handler].update(element, function () {
return viewModel[value[handler]];
});
}
}
}
};
這段的巧思在於:它把 ext 的參數當成一份「委託清單」。key 是要真正執行的 ko 內建 binding 名稱(text、value、checked…),value 則是 ViewModel 上的屬性名稱字串。update 執行時,若該屬性還不存在就順手補一個空 observable,然後把更新工作轉交給對應的內建 handler。
ViewModel 這次可以空空如也:
$(function () {
var viewModel = function () { };
ko.applyBindings(new viewModel());
});
HTML 端這樣宣告,並附一個按鈕方便測試:
<div data-bind="ext:{text: 'text'}"></div>
<!--事件 便於 測試-->
<a href="javascript:void(0)" data-bind="click:function(){$data.text(1);}">更改text值</a>
呈現:
ext:{text:'text', value:'text'},同一屬性餵給多個 handler 也沒問題。不過還是要提醒一句:動態屬性很方便,但它把「欄位名稱」從程式碼裡搬到了字串裡,編譯期與 refactor 工具都幫不上忙,錯字也不會報錯、只會靜靜地綁到一個永遠為空的 observable 上。像清單的編輯狀態這種真的因情境而異的欄位,用它很划算;固定欄位還是老實宣告比較好維護。另外 ko 3.x 之後已有 ko.observable 加上初始屬性宣告、或直接用 fromJS 映射的寫法,如果是新專案,可以優先評估那些方案。