Object.defineProperty(obj, prop, descriptor)
該方法容許精確添加或修改對象的屬性。經過賦值來添加的普通屬性會建立在屬性枚舉期間顯示的屬性(for...in
或 Object.keys
方法), 這些值能夠被改變,也能夠被刪除。這種方法容許這些額外的細節從默認值改變。默認狀況下,使用Object.defineProperty()
添加的屬性值是不可變的。數組
`Object.defineProperties(obj, props)`、` Object.defineProperties`本質上定義了`obj` 對象上`props`的`可枚舉屬性`相對應的全部屬性。 `Object.defineProperties(obj, props)`實現
function defineProperties(obj, properties) { function convertToDescriptor(desc) { function hasProperty(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); } function isCallable(v) { // NB: modify as necessary if other values than functions are callable. return typeof v === 'function'; } if (typeof desc !== 'object' || desc === null) throw new TypeError('bad desc'); var d = {}; if (hasProperty(desc, 'enumerable')) d.enumerable = !!desc.enumerable; if (hasProperty(desc, 'configurable')) d.configurable = !!desc.configurable; if (hasProperty(desc, 'value')) d.value = desc.value; if (hasProperty(desc, 'writable')) d.writable = !!desc.writable; if (hasProperty(desc, 'get')) { var g = desc.get; if (!isCallable(g) && typeof g !== 'undefined') throw new TypeError('bad get'); d.get = g; } if (hasProperty(desc, 'set')) { var s = desc.set; if (!isCallable(s) && typeof s !== 'undefined') throw new TypeError('bad set'); d.set = s; } if (('get' in d || 'set' in d) && ('value' in d || 'writable' in d)) throw new TypeError('identity-confused descriptor'); return d; } if (typeof obj !== 'object' || obj === null) throw new TypeError('bad obj'); properties = Object(properties); var keys = Object.keys(properties); var descs = []; for (var i = 0; i < keys.length; i++) descs.push([keys[i], convertToDescriptor(properties[keys[i]])]); for (var i = 0; i < descs.length; i++) Object.defineProperty(obj, descs[i][0], descs[i][1]); return obj; }
### 參數瀏覽器
`obj `在其上定義或修改屬性的對象。 `prop` 要定義或修改的屬性的名稱。 `descriptor` 將被定義或修改的屬性描述符。 `返回值 ` `被傳遞給函數的對象`。 `props` 要定義其可枚舉屬性或修改的屬性描述符的對象。對象中存在的屬性描述符主要有兩種:`數據描述符`和`訪問器描述符`。描述符具備如下鍵: 數據描述符和存取描述符均具備如下可選鍵值: 對象裏目前存在的屬性描述符有兩種主要形式:數據描述符和存取描述符。數據描述符是一個具備值的屬性,該值多是可寫的,也可能不是可寫的。`存取描述符`是由`getter-setter`函數對描述的屬性。描述符必須是這兩種形式之一;不能同時是二者。 `configurable` true 當且僅當該屬性描述符的類型能夠被改變而且該屬性能夠從對應對象中刪除。`默認爲 false` `enumerable` true 當且僅當在枚舉相應對象上的屬性時該屬性顯現。` 默認爲 false` for ... in obj obj.keys() 實現內部原理 數據描述符同時具備如下可選鍵值: `value` 與屬性關聯的值。能夠是任何有效的JavaScript值(數字,對象,函數等)。 ` 默認爲 undefined`. `writable` true當且僅當與該屬性相關聯的值能夠用assignment operator改變時。 `默認爲 false` 當須要些一些不能夠被更改的屬性時可使用 存取描述符同時具備如下可選鍵值: `get `做爲該屬性的 getter 函數,若是沒有 getter 則爲undefined。函數返回值將被用做屬性的值。默認爲 undefined `set `做爲屬性的 setter 函數,若是沒有 setter 則爲undefined。函數將僅接受參數賦值給該屬性的新值。默認爲 undefined 若是一個描述符不具備value,writable,get 和 set 任意一個關鍵字,那麼它將被認爲是一個數據描述符。若是一個描述符同時有(value或writable)和(get或set)關鍵字,將會產生一個異常。 記住,這些選項不必定是自身屬性,若是是繼承來的也要考慮。爲了確認保留這些默認值,你可能要在這以前凍結 Object.prototype,明確指定全部的選項,或者將__proto__屬性指向null。
使用 __proto__ var obj = {}; var descriptor = Object.create(null); // 沒有繼承的屬性 // 默認沒有 enumerable,沒有 configurable,沒有 writable descriptor.value = 'static'; Object.defineProperty(obj, 'key', descriptor); // 顯式 Object.defineProperty(obj, "key", { enumerable: false, configurable: false, writable: false, value: "static" }); // 循環使用同一對象 function withValue(value) { var d = withValue.d || ( withValue.d = { enumerable: false, writable: false, configurable: false, value: null } ); d.value = value; return d; } // ... 而且 ... Object.defineProperty(obj, "key", withValue("static")); // 若是 freeze 可用, 防止代碼添加或刪除對象原型的屬性 // (value, get, set, enumerable, writable, configurable) (Object.freeze||Object)(Object.prototype);
###做用: ☆建立屬性 當描述符中省略某些字段時,這些字段將使用它們的默認值。擁有布爾值的字段的默認值都是false。value,get和set字段的默認值爲undefined。一個沒有get/set/value/writable定義的屬性被稱爲「通用的」,並被「鍵入」爲一個數據描述符。 ``` var o = {}; // 建立一個新對象 在對象中添加一個屬性與數據描述符的示例 Object.defineProperty(o, "a", { value : 37, writable : true, enumerable : true, configurable : true }); // 對象o擁有了屬性a,值爲37 // 在對象中添加一個屬性與存取描述符的示例 var bValue; Object.defineProperty(o, "b", { get : function(){ return bValue; }, set : function(newValue){ bValue = newValue; }, enumerable : true, configurable : true }); o.b = 38; // 對象o擁有了屬性b,值爲38 // 改變bValue也沒法改變o.b console.log(bValue); // o.b的值如今老是與bValue相同,除非從新定義o.b // 數據描述符和存取描述符不能混合使用 Object.defineProperty(o, "conflict", { value: 0x9f91102, get: function() { return 0xdeadbeef; } }); throws a TypeError: value appears only in data descriptors, get appears only in accessor descriptors ``` ☆修改屬性 若是屬性已經存在,`Object.defineProperty()`將嘗試根據描述符中的值以及對象當前的配置來修改這個屬性。若是舊描述符將其`configurable` 屬性設置爲`false`,則該屬性被認爲是`「不可配置的」`,而且沒有屬性能夠被改變(除了單向改變 `writable` 爲 `false`)。當屬性不可配置時,不能在數據和訪問器屬性類型之間切換。 當試圖改變不可配置屬性(除了writable 屬性以外)的值時會拋出{jsxref("TypeError")}},除非當前值和新值相同。 1 `Writable` 屬性 當writable屬性設置爲false時,該屬性被稱爲「不可寫」。它不能被從新分配。 試圖寫入非可寫屬性不會改變它,也不會引起錯誤。 ``` var o = {}; // Creates a new object Object.defineProperty(o, 'a', { value: 37, writable: false }); console.log(o.a); // logs 37 o.a = 25; // No error thrown // (it would throw in strict mode, // even if the value had been the same) console.log(o.a); // logs 37. The assignment didn't work. // strict mode (function() { 'use strict'; var o = {}; Object.defineProperty(o, 'b', { value: 2, writable: false }); o.b = 3; // throws TypeError: "b" is read-only return o.b; // returns 2 without the line above }());
2 `Enumerable `特性 enumerable定義了對象的屬性是否能夠在 for...in 循環和 Object.keys() 中被枚舉默認是true。
var o = {}; Object.defineProperty(o, "a", { value : 1, enumerable:true }); Object.defineProperty(o, "b", { value : 2, enumerable:false }); Object.defineProperty(o, "c", { value : 3 }); // enumerable defaults to false o.d = 4; // 若是使用直接賦值的方式建立對象的屬性,則這個屬性的enumerable爲true for (var i in o) { console.log(i); } 打印 'a' 和 'd' (in undefined order) Object.keys(o); // ["a", "d"] o.propertyIsEnumerable('a'); // true o.propertyIsEnumerable('b'); // false o.propertyIsEnumerable('c'); // false ``` 3 Configurable 特性 configurable特性表示對象的屬性是否能夠被刪除,以及除writable特性外的其餘特性是否能夠被修改。 若是o.a的configurable屬性爲true,則不會拋出任何錯誤,而且該屬性將在最後被刪除。 var o = {}; Object.defineProperty(o, "a", { get : function(){return 1;}, configurable : false } ); //爲true時,不會報錯 結果爲12 undefined(能夠刪除) // throws a TypeError Cannot redefine property: a Object.defineProperty(o, "a", {configurable : true}); // // throws a TypeError Object.defineProperty(o, "a", {enumerable : true}); // // throws a TypeError (set was undefined previously) Object.defineProperty(o, "a", {set : function(){}}); // // throws a TypeError (even though the new get does exactly the same thing) Object.defineProperty(o, "a", {get : function(){return 1;}}); // // throws a TypeError Object.defineProperty(o, "a", {value : 12}); console.log(o.a); // logs 1 delete o.a; // Nothing happens console.log(o.a); // logs 1 ``` ☆ 添加多個屬性和默認值 考慮特性被賦予的默認特性值很是重要,一般,使用點運算符和Object.defineProperty()爲對象的屬性賦值時,數據描述符中的屬性默認值是不一樣的,以下例所示。 ``` var o = {}; o.a = 1; // 等同於 : Object.defineProperty(o, "a", { value : 1, writable : true, configurable : true, enumerable : true }); // 另外一方面, Object.defineProperty(o, "a", { value : 1 }); // 等同於 : Object.defineProperty(o, "a", { value : 1, writable : false, configurable : false, enumerable : false }); ``` ☆ 通常的 `Setter` 和 `Getters` 下面的例子展現瞭如何實現一個自存檔對象。 當設置temperature 屬性時,archive 數組會獲取日誌條目。 ``` function Archiver() { var temperature = null; var archive = []; Object.defineProperty(this, 'temperature', { get: function() { console.log('get!'); return temperature; }, set: function(value) { temperature = value; archive.push({ val: temperature }); } }); this.getArchive = function() { return archive; }; } var arc = new Archiver(); arc.temperature; // 'get!' arc.temperature = 11; arc.temperature = 13; arc.getArchive(); // [{ val: 11 }, { val: 13 }] ``` // 或 ``` var pattern = { get: function () { return 'I alway return this string,whatever you have assigned'; }, set: function () { this.myname = 'this is my name string'; } }; function TestDefineSetAndGet() { Object.defineProperty(this, 'myproperty', pattern); } var instance = new TestDefineSetAndGet(); instance.myproperty = 'test'; // 'I alway return this string,whatever you have assigned' console.log(instance.myproperty); // 'this is my name string' console.log(instance.myname); ``` ☆ ☆兼容性問題 1 數組的 length 屬性重定義是可能的,可是會受到通常的重定義限制。(length 屬性初始爲 non-configurable,non-enumerable 以及 writable。對於一個內容不變的數組,改變其 length 屬性的值或者使它變爲 non-writable 是可能的。可是改變其可枚舉性和可配置性或者當它是 non-writable 時嘗試改變它的值或是可寫性,這二者都是不容許的。)然而,並非全部的瀏覽器都容許 Array.length 的重定義。 在 Firefox 4 至 22 版本中嘗試去重定義數組的 length 屬性都會拋出一個 TypeError 異常。 有些版本的Chrome中,Object.defineProperty() 在某些狀況下會忽略不一樣於數組當前length屬性的length值。有些狀況下改變可寫性並不起做用(也不拋出異常)。同時,好比Array.prototype.push的一些數組操做方法也不會考慮不可讀的length屬性。 有些版本的Safari中,Object.defineProperty() 在某些狀況下會忽略不一樣於數組當前length屬性的length值。嘗試改變可寫性的操做會正常執行而不拋出錯誤,但事實上並未改變屬性的可寫性。 只在Internet Explorer 9及之後版本和Firefox 23及之後版本中,才完整地正確地支持數組length屬性的從新定義。目前不要依賴於重定義數組length 屬性可以起做用,或在特定情形下起做用。與此同時,即便你可以依賴於它,你也沒有合適的理由這樣作。 2 Internet Explorer 8 具體案例 Internet Explorer 8 實現了 Object.defineProperty() 方法,但 只能在 DOM 對象上使用。 須要注意的一些事情: 嘗試在原生對象上使用 Object.defineProperty()會報錯。 屬性特性必須設置一些特定的值。對於數據屬性描述符,configurable, enumerable 和 writable 特性必須所有設置爲 true;對於訪問器屬性描述符,configurable 必須設置爲 true,enumerable 必須設置爲 false。(?) 任何試圖提供其餘值(?)將致使一個錯誤拋出。 從新配置一個屬性首先須要刪除該屬性。若是屬性沒有刪除,就如同從新配置前的嘗試。