1. 程式人生 > >JavaScript---Object.defineProperty()與兩種屬性描述符簡介->資料\存取描述符

JavaScript---Object.defineProperty()與兩種屬性描述符簡介->資料\存取描述符

不得不說MDN網站真心好用, 裡面例子真心不錯.

轉載僅出於學習目的.

Object.defineProperty( ) 方法會直接在一個物件上定義一個新屬性,或者修改一個物件的現有屬性, 並返回這個物件。

語法:

Object.defineProperty(obj, prop, descriptor)

引數

obj
需要被操作的目標物件
prop
目標物件需要定義或修改的屬性的名稱。
descriptor
將被定義或修改的屬性的描述符。

返回值

被傳遞給函式的物件。

描述

該方法允許精確新增或修改物件的屬性。一般情況下,我們為物件新增屬性是通過賦值來建立並顯示在屬性列舉中(for...in

Object.keys 方法), 但這種方式新增的屬性值可以被改變,也可以被刪除。而使用 Object.defineProperty() 則允許改變這些額外細節的預設設定。例如,預設情況下,使用 Object.defineProperty() 增加的屬性值是不可改變的。

屬性描述符

物件裡目前存在的屬性描述符有兩種主要形式:資料描述符存取描述符資料描述符是一個擁有可寫或不可寫值的屬性。存取描述符是由一對 getter-setter 函式功能來描述的屬性。描述符必須是兩種形式之一;不能同時是兩者。

資料描述符和存取描述符均具有以下可選鍵值:

名稱 作用
configurable 當且僅當該屬性的 configurable 為 true 時,該屬性描述符才能夠被改變,同時該屬性也能從對應的物件上被刪除。預設為 false。
enumerable 當且僅當該屬性的 enumerable 為 true 時,該屬性才能夠出現在物件的列舉屬性中。預設為 false。


資料描述符同時具有以下可選鍵值:

名稱 作用
value 該屬性對應的值。可以是任何有效的 JavaScript 值(數值,物件,函式等)。預設為 undefined。
writable 當且僅當該屬性的 writable 為 true 時,該屬性才能被賦值運算子改變。預設為 false。


存取描述符同時具有以下可選鍵值:

名稱 作用
get 一個給屬性提供 getter 的方法,如果沒有 getter 則為 undefined。該方法返回值被用作屬性值。預設為 undefined。
set 一個給屬性提供 setter 的方法,如果沒有 setter 則為 undefined。該方法將接受唯一引數,並將該引數的新值分配給該屬性。預設為 undefined。

示例

建立屬性

如果物件中不存在指定的屬性,Object.defineProperty()就建立這個屬性。當描述符中省略某些欄位時,這些欄位將使用它們的預設值。擁有布林值的欄位的預設值都是falsevalue,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

// 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

Writable 屬性

當屬性特性(property attribute) writable 設定為false時,表示 non-writable,屬性不能被修改

var o = {}; // 建立一個物件

Object.defineProperty(o, "a", { value : 37,
                                writable : false });

console.log(o.a); // 列印 37
o.a = 25; // 沒有錯誤丟擲(在嚴格模式下會丟擲,即使之前已經有相同的值)
console.log(o.a); // 列印 37, 賦值不起作用。

正如上例中看到的,修改一個 non-writable 的屬性不會改變屬性的值,同時也不會報異常。

Enumerable 特性

屬性特性 enumerable 定義了物件的屬性是否可以在 for…in 迴圈和 Object.keys() 中被列舉

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

Configurable 特性

configurable 特性表示物件的屬性是否可以被刪除,以及除 writable 特性外的其他特性是否可以被修改。

var o = {};
Object.defineProperty(o, "a", { get : function(){return 1;}, 
                                configurable : false } );

// throws a TypeError
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
});

一般的 Setters 和 Getters

下面的例子說明了如何實現自我存檔的物件。當 temperature 屬性設定時,archive 陣列會得到一個 log。

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);