最近在一個客戶專案裡,我得把 ECMAScript 5 的能力用到底,結果撞上一個很有意思的問題。問題的起點是一個再常見不過的模式:mixin——把一個物件的屬性或方法併入另一個物件。
多數 mixin 的實作長這樣:
function mixin(receiver, supplier) {
for (var property in supplier) {
if (supplier.hasOwnProperty(property)) {
receiver[property] = supplier[property];
}
}
}
一個 for 迴圈走過 supplier 的所有屬性,逐一賦值給 receiver。幾乎每個 JavaScript 函式庫都有類似機制,讓你能寫出這樣的程式碼:
mixin(object, {
name: "Nicholas",
sayName: function() {
console.log(this.name);
}
});
object.sayName(); // outputs "Nicholas"
object 拿到了屬性 name 與方法 sayName()。這一切在 ECMAScript 3 裡運作良好,但換到 ECMAScript 5 就未必了。
(function() {
// 稍後才會填入
var name;
mixin(object, {
get name() {
return name;
}
});
// 假設這是「稍後」
name = "Nicholas";
}());
console.log(object.name); // undefined
這個例子看起來有點刻意,但它精準地重現了問題。被 mixin 的屬性用上了 ECMAScript 5 的新特性——getter 屬性存取器。getter 引用了一個尚未初始化的區域變數 name,所以此時讀出來是 undefined。
之後 name 被賦了值,按理说 getter 應該能回傳有效結果。然而 object.name 永遠是 undefined。
仔細看 mixin() 的那個迴圈:它並沒有把屬性「搬」到另一個物件上,而是建立了一個同名的新屬性,並把 supplier 那邊 getter 的返回值抄了過來。
也就是說,實際發生的事等價於:
receiver.name = supplier.name;
receiver.name 被建立,值取自 supplier.name。supplier.name 有 getter 回傳區域變數 name,而那一刻 name 還是 undefined,所以 receiver.name 存下來的就是 undefined。receiver.name 本身並沒有 getter,因此它的值永遠不會改變。
正確做法是把屬性描述符(descriptor)整體搬過去。純 ECMAScript 5 版本的 mixin 應該這樣寫:
function mixin(receiver, supplier) {
Object.keys(supplier).forEach(function(value, property) {
Object.defineProperty(receiver, property,
Object.getOwnPropertyDescriptor(supplier, property));
});
}
這裡 Object.keys() 取回一個陣列,包含 supplier 的所有可列舉屬性;接著用 forEach() 遍歷;再用 Object.getOwnPropertyDescriptor() 取得每個屬性的完整描述符。
描述符裡含有該屬性的全部資訊,getter 與 setter 都在其中,所以可以直接交給 Object.defineProperty(),在 receiver 上建立一個一模一樣的屬性。換成這個版本,前面的問題就消失了:getter 被正確地從 supplier 傳到 receiver。
如果專案仍得支援老環境,就寫成有回退機制的版本:
function mixin(receiver, supplier) {
if (Object.keys) {
Object.keys(supplier).forEach(function(value, property) {
Object.defineProperty(receiver, property,
Object.getOwnPropertyDescriptor(supplier, property));
});
} else {
for (var property in supplier) {
if (supplier.hasOwnProperty(property)) {
receiver[property] = supplier[property];
}
}
}
}
結論很簡單:只要你打算用 mixin(),一定要確認它在 ECMAScript 5 環境下真的正常,特別是牽涉到 getter 與 setter 的時候。否則,你很可能會掉進跟我一樣的坑。