Object.defineProperty()和Object.defineProperties()

转载链接

一、Object.defineProperty()

1. 定义

Object.defineProperty()方法是直接在对象上定义一个新属性，或者修改对象的现有属性，并返回此对象
>语法：Object.defineProperty(obj,prop,descriptor)
-obj：要定义属性的对象
-prop：要定义或者修改的属性的名称或Symbol
-descriptor：要定义或者修改的属性描述符
-返回值：被修改后的对象

2. Object.defineProperty()和常见的对象赋值操作( .prop / [‘prop’] )的区别

• Object.defineProperty()方法可以精确地添加或修改对象的属性，可以修改默认的额外选项或配置，默认情况下，该方法添加的属性值是不可枚举且不可修改的。

• 而通过赋值操作添加的普通属性是可枚举的，在枚举对象属性时会被枚举到（for…in或Object.keys方法），可以改变、删除这些属性。

3. 关于Object.defineProperty()方法的第三个参数descriptor，即要定义或者修改的属性描述符

对象里目前存在的属性描述符有两种主要形式：数据描述符和存取描述符

1） 数据描述符是一个具有值的属性，存取描述符是由getter函数和setter函数所描述的属性，这两种描述符都是对象，共享以下可选键值

• configurable
  当且仅当该属性的 configurable 键值为 true 时，该属性的描述符才能够被改变，同时该属性也能从对应的对象上被删除。
  默认为 false。

• enumerable
  当且仅当该属性的 enumerable 键值为 true 时，该属性才会出现在对象的枚举属性中。
  默认为 false。

数据描述符还具有以下可选键值：

• value
  该属性对应的值。可以是任何有效的 JavaScript 值（数值，对象，函数等）。
  默认为 undefined。

• writable
  当且仅当该属性的 writable 键值为 true 时，属性的值，也就是上面的 value，才能被赋值运算符改变。
  默认为 false。

2）存取描述符具有以下可选键值：

• get
  属性的 getter 函数，如果没有 getter，则为 undefined。当访问该属性时，会调用此函数。执行时不传入任何参数，但是会传入 this 对象（由于继承关系，这里的this并不一定是定义该属性的对象）。该函数的返回值会被用作属性的值。
  默认为 undefined。

• set
  属性的 setter 函数，如果没有 setter，则为 undefined。当属性值被修改时，会调用此函数。该方法接受一个参数（也就是被赋予的新值），会传入赋值时的 this 对象。
  默认为 undefined。

描述符默认值汇总

• 拥有布尔值的键 configurable、enumerable 和 writable 的默认值都是 false。
• 属性值和函数的键 value、get 和 set 字段的默认值为 undefined。

如果一个描述符不具有 value、writable、get 和 set 中的任意一个键，那么它将被认为是一个数据描述符。
如果一个描述符同时拥有 value 或 writable 和 get 或 set 键，则会产生一个异常。

4. 实例 - 自定义setters和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 }]

下面这个例子中，getter 总是会返回一个相同的值。

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

5. 继承属性

如果访问者的属性是被继承的，它的 get 和 set 方法会在子对象的属性被访问或者修改时被调用。如果这些方法用一个变量存值，该值会被所有对象共享。

function myclass() {
}

var value;
Object.defineProperty(myclass.prototype, "x", {
  get() {
    return value;
  },
  set(x) {
    value = x;
  }
});

var a = new myclass();
var b = new myclass();
a.x = 1;
console.log(b.x); // 1

这可以通过将值存储在另一个属性中解决。在 get 和 set 方法中，this 指向某个被访问和修改属性的对象。

function myclass() {
}

Object.defineProperty(myclass.prototype, "x", {
  get() {
    return this.stored_x;
  },
  set(x) {
    this.stored_x = x;
  }
});

var a = new myclass();
var b = new myclass();
a.x = 1;
console.log(b.x); // undefined

不像访问者属性，值属性始终在对象自身上设置，而不是一个原型。然而，如果一个不可写的属性被继承，它仍然可以防止修改对象的属性。

function myclass() {
}

myclass.prototype.x = 1;
Object.defineProperty(myclass.prototype, "y", {
  writable: false,
  value: 1
});

var a = new myclass();
a.x = 2;
console.log(a.x); // 2
console.log(myclass.prototype.x); // 1
a.y = 2; // Ignored, throws in strict mode
console.log(a.y); // 1
console.log(myclass.prototype.y); // 1

二、Object.defineProperties()

Object.defineProperties()方法是直接在对象上定义多个新属性，或者修改对象的多个现有属性，并返回此对象

语法：Object.defineProperties(obj,props)
-obj：要定义属性的对象
-props：属性对象，属性名为对象的属性名，属性值为对应属性的属性描述符（描述符参考上面的）
-返回值：被修改后的对象

实例：

let obj = { name: "ll" };
Object.defineProperties(obj, {
  age: {
    value: 18,
    enumerable: true,
  },
  sex: {
    value: "女",
    writable: true,
  },
});
console.log(obj);//{name: "ll", age: 18, sex: "女"}
console.log(Object.keys(obj));//["name", "age"]