JavaScript 中 Object.defineProperty 的用法

在 JavaScript 中，常經過下面方式，添加或修改對象的屬性：

obj.name = 'John'

除此以外，還能經過 Object.defineProperty() 方法，添加或修改對象的屬性。更重要的是，除了目標對象 obj，屬性名稱 prop 外，方法能傳入屬性描述符 descriptor，以實現更復雜的性質。屬性描述符是一個對象，有兩種形式：一種是數據描述符，另外一種是存取描述符。

Object.defineProperty(obj, prop, descriptor)

數據描述符

數據描述符支持如下特性：

• enumerable：表示對象是否能夠被枚舉。默認爲 false，表示不能被枚舉，for...in 和 Object.keys()中沒法枚舉該屬性，對JSON.stringify()也有影響。
• configurable：表示對象屬性是否能夠被刪除，以及除value和writable特性外的其它特性可否被修改。默認爲 false，表示屬性不能刪除，特性不能修改。
• value：屬性對應的值，默認爲 undefined。
• writable：默認爲 false，表示只讀，沒法給該屬性賦值。在嚴格模式中，給只讀屬性賦值會報錯。寬鬆模式中，給只讀屬性賦值不會生效。

// 示例1，等同於 obj.name = 'John'
var obj = {}
Object.defineProperty(obj, 'name', { 
  value: 'John',
  writable: true,
  configerable: true,
  enumerable: true
})

// 示例2，將 name 屬性設置爲只讀
'use strict'
var obj = {}
Object.defineProperty(obj, 'name', {
  value: 'John',
  writable: false,
  configerable: true,
  enumerable: true
})
obj.name = 'Joy'  // TypeError

// 示例3，將 name 屬性設置爲不可枚舉
var obj = {}
Object.defineProperty(obj, 'name', { 
  value: 'John',
  writable: true,
  configerable: true,
  enumerable: false
})
console.log(obj.name)  // John
console.log(Object.keys(obj))  // []

// 示例4，將 name 屬性設置不可配置(不可刪除，除value和writable特性外的其它特性不可被修改)
var obj = {}
Object.defineProperty(obj, 'name', { 
  value: 'John',
  writable: true,
  configerable: false,
  enumerable: true
})
delete obj.name  // false
Object.defineProperty(obj, 'name', { enumerable: false })  // TypeError

存儲描述符

存儲描述符支持如下特性：

• enumerable：同上。
• configurable：同上。
• set：設置 setter 方法，當修改屬性時，會執行該方法，新屬性值做爲參數。默認值爲 undefined。
• get：設置 getter 方法，當訪問屬性時，會執行該方法。默認值爲 undefined。

// 示例5，使用 get 和 set，計數屬性讀寫的次數
var obj = {}, name = '', count1 = 0, count2 = 0
Object.defineProperty(obj, 'name', { 
  get: function () { 
    console.log('Read ' + (++count1) + ' times')
    return name
  },
  set: function (newVal) {
    console.log('Write ' + (++count2) + ' times')
    name = newVal
  }
})
obj.name  // Read 1 times
obj['name']  // Read 2 times
obj.name = 'Joy'  // Write 1 times
obj.name = 'Jack'  // Write 2 times

注意事項

另外要注意三點，一是兩種描述符不一樣的屬性不能共用；二是添加屬性時，未傳入的特性會被設置成默認值，而修改特性時，未傳入的特性維持原樣；三是以下：

Object.defineProperty(obj, 'name', { value: 'John' })
// 屬性是隻讀，不可配置，且不可枚舉的。等同於
Object.defineProperty(obj, 'name', { 
  value: 'John',
  writable: false,
  configerable: false,
  enumerable: false
})

obj.name = 'John'
// 屬性可寫的，可配置的，可枚舉的。等同於
Object.defineProperty(obj, 'name', { 
  value: 'John',
  writable: true,
  configerable: true,
  enumerable: true
})

實際應用

例若有一個對象 Student，具備 name 和 age 兩個屬性，若是不但願將年齡被設置的太大或過小，該怎麼作？咱們能夠添加一個 setter 和 getter 方法，每次要修改 age 時，經過 setter 方法來修改屬性，經過 getter 方法讀取屬性：

function Student (name, age) {
  this.name = name
  this.setAge = function (val) { 
    age = val
    if (age < 0) age = 0
    if (age > 100) age = 100
  }
  this.getAge = function () { return age }
}

var s = new Student('John', 16)
s.setAge(25)
console.log(s.getAge())  // 25
s.setAge(-5)
console.log(s.getAge())  // 0
s.setAge(500)
console.log(s.getAge())  // 100

看似很美好，但每次讀取或修改屬性都有調用一次 setter 或 getter 方法，徒增了不少代碼。使用 Object.defineProperty方法，不須要多餘的代碼，直接用最原始的方式讀取和修改屬性：

function Student (name, age) {
  this.name = name
  var _age = age
  Object.defineProperty(this, 'age', {
    get: function () { return _age },
    set: function (val) {
      _age = val
      if (_age < 0) _age = 0
      if (_age > 100) _age = 100
    }
  })
}

var s = new Student('John', 16)
s.age = 25
console.log(s.age)  // 25
s.age = -5
console.log(s.age)  // 0
s.age = 500
console.log(s.age)  // 100

批量處理

Object.defineProperties()方法能夠批量添加或修改屬性：

var obj = {}
Object.defineProperties(obj, {
  name: { value: 'John', emunerable: true },
  age: { value: 20, emunerable: true }
})

Object.create()方法能夠在建立對象時，批量添加屬性：

var obj = Object.create(Object.prototype, {
  name: { value: 'John', emunerable: true },
  age: { value: 20, emunerable: true } 
})

還能夠經過字面量方式，建立包含 setter 和 getter 屬性的對象：

var obj = {
  get name() {
    return 'John'
  },
  set name(val) {
    console.log(val)
  },
  get age() {
    return 18
  }
}

參考

• MDN Object.defineProperty()
• 《深刻理解 JavaScript》