ES5 引進的 Object.defineProperty 讓我們可以精確控制物件的屬性行為,包括能不能改、能不能列舉,甚至用 getter/setter 攔截讀寫。這是實作「唯讀屬性」與「賦值時附帶副作用」的標準做法。
Object.defineProperty(obj, "prop", propDesc);
如果 obj 上沒有 prop 這個自身屬性,這個函數會為它新增一個並套用指定特性;如果已經存在,則是修改該屬性的特性(可寫性、可列舉性等),同時也可以改值。
var book = {
_year: 2004,
edition: 1
};
Object.defineProperty(book, "year", {
get: function () {
return this._year;
},
set: function (newValue) {
if (newValue > 2004) {
this._year = newValue;
this.edition += newValue - 2004;
}
}
});
book.year = 2005;
alert(book.edition); // 2
這個模式很實用:外部看到的是 year,內部實際存放的是 _year,而所有寫入都會經過 setter 的檢查與連動計算。原本需要寫成 setYear() 的樣式,現在用一般的賦值語法就能完成,介面乾淨得多。
需要補充的是,使用 getter/setter 形式定義的屬性,enumerable 與 configurable 預設都是 false,這和一般賦值建立的屬性不同。若希望它能被 for...in 列舉或日後可刪除,要明確寫上:
Object.defineProperty(book, "year", {
enumerable: true,
configurable: true,
get: function () { return this._year; },
set: function (newValue) {
if (newValue > 2004) {
this._year = newValue;
this.edition += newValue - 2004;
}
}
});
實務上更推薦用字面量語法一次定義多個屬性,程式碼更集中:
Object.defineProperties(book, {
year: {
enumerable: true,
get: function () { return this._year; },
set: function (v) {
if (v > 2004) {
this._year = v;
this.edition += v - 2004;
}
}
},
isbn: {
value: "9787000000000",
writable: false, // 唯讀
enumerable: true
}
});
在標準化之前,部分瀏覽器已經提供了這對方法,寫法如下:
var book = {
_year: 2004,
edition: 1
};
book.__defineGetter__("year", function () {
return this._year;
});
book.__defineSetter__("year", function (newValue) {
if (newValue > 2004) {
this._year = newValue;
this.edition += newValue - 2004;
}
});
book.year = 2005;
alert(book.edition); // 2
功能相同,但這組方法並非標準,僅能作為理解歷史與維護舊程式碼時參考。新專案一律使用 Object.defineProperty;若環境允許(不支援 IE8 以下的話),也可以直接用 ES5 的物件字面量 getter 語法:
var book = {
_year: 2004,
edition: 1,
get year() { return this._year; },
set year(v) {
if (v > 2004) {
this._year = v;
this.edition += v - 2004;
}
}
};
以上就是這次的學習小結,後續仍會持續更新。