Object.defineProperty和Object.freeze、Object.seal

目录

• 一 Object.defineProperty
  • 1.1 用法
  • 1.2 数据描述
    • 1.2.1 value
    • 1.2.2 writable
    • 1.2.3 enumerable
    • 1.2.4 configurable
    • 1.2.5 注意默认值
    • 1.2.6 设置的特性总结：
  • 1.3 存取器描述
    • 1.3.1 getter/setter
    • 1.3.2 configurable和enumerable同上面的用法。
  • 1.4 兼容性
• 二 Object.freeze
  • 2.1 Object.freeze做了三件事情
  • 2.2 例子
• 三 Object.seal
  • 3.1 Object.freeze做了两件事情

一 Object.defineProperty

对象是由多个名/值对组成的无序的集合。对象中每个属性对应任意类型的值。
定义对象可以使用构造函数或字面量的形式：

var obj = new Object;
obj.name = "张三";  //添加描述
obj.say = function(){};  //添加行为

或

var obj = {
  name: "张三",
  say: function(){

  },
};

除了以上添加属性的方式，还可以使用Object.defineProperty定义新属性或修改原有的属性。

1.1 用法

1、 语法：

Object.defineProperty(obj, prop, descriptor)

2、 参数说明：

obj：必需。目标对象
prop：必需。需定义或修改的属性的名字
descriptor：必需。目标属性所拥有的特性

3、返回值：

传入函数的对象。即第一个参数obj

给对象的属性添加特性描述，目前提供两种形式：数据描述和存取器描述。

1.2 数据描述

当修改或定义对象的某个属性的时候，给这个属性添加一些特性：

var obj = {
    test:"hello"
}
//对象已有的属性添加特性描述
Object.defineProperty(obj,"test",{
    configurable:true | false,
    enumerable:true | false,
    value:任意类型的值,
    writable:true | false
});
//对象新添加的属性的特性描述
Object.defineProperty(obj,"newKey",{
    configurable:true | false,
    enumerable:true | false,
    value:任意类型的值,
    writable:true | false
});

数据描述中的属性都是可选的，来看一下设置每一个属性的作用。

1.2.1 value

• 属性对应的值
• 可以使任意类型的值
• 默认为undefined

var obj = {}
//第一种情况：不设置value属性
Object.defineProperty(obj,"newKey",{

});
console.log( obj.newKey );  //undefined
------------------------------
//第二种情况：设置value属性
Object.defineProperty(obj,"newKey",{
    value:"hello"
});
console.log( obj.newKey );  //hello

1.2.2 writable

• 属性的值是否可以被重写。
• 设置为true可以被重写；设置为false，不能被重写。
• 默认为false。

var obj = {}
//第一种情况：writable设置为false，不能重写。
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:false
});
//更改newKey的值
obj.newKey = "change value";
console.log( obj.newKey );  //hello

//第二种情况：writable设置为true，可以重写
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:true
});
//更改newKey的值
obj.newKey = "change value";
console.log( obj.newKey );  //change value

1.2.3 enumerable

• 此属性是否可以被枚举（使用for...in或Object.keys()）。
• 设置为true可以被枚举；设置为false，不能被枚举。
• 默认为false。

var obj = {}
//第一种情况：enumerable设置为false，不能被枚举。
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:false,
    enumerable:false
});

//枚举对象的属性
for( var attr in obj ){
    console.log( attr );  
}

//第二种情况：enumerable设置为true，可以被枚举。
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:false,
    enumerable:true
});

//枚举对象的属性
for( var attr in obj ){
    console.log( attr );  //newKey
}

1.2.4 configurable

• 是否可以删除目标属性或是否可以再次修改属性的特性（writable, configurable, enumerable）。
• 设置为true可以被删除或可以重新设置特性；设置为false，不能被可以被删除或不可以重新设置特性。
• 默认为false。

这个属性起到两个作用：

1. 目标属性是否可以使用delete删除
2. 目标属性是否可以再次设置特性

//-----------------1. 测试目标属性是否能被删除------------------------
var obj = {}
//第一种情况：configurable设置为false，不能被删除。
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:false,
    enumerable:false,
    configurable:false
});
//删除属性
delete obj.newKey;
console.log( obj.newKey ); //hello

//第二种情况：configurable设置为true，可以被删除。
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:false,
    enumerable:false,
    configurable:true
});
//删除属性
delete obj.newKey;
console.log( obj.newKey ); //undefined

//-----------------2. 测试是否可以再次修改特性------------------------
var obj = {}
//第一种情况：configurable设置为false，不能再次修改特性。
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:false,
    enumerable:false,
    configurable:false
});

//重新修改特性
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:true,
    enumerable:true,
    configurable:true
});
console.log( obj.newKey ); //报错：Uncaught TypeError: Cannot redefine property: newKey

//第二种情况：configurable设置为true，可以再次修改特性。
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:false,
    enumerable:false,
    configurable:true
});

//重新修改特性
Object.defineProperty(obj,"newKey",{
    value:"hello",
    writable:true,
    enumerable:true,
    configurable:true
});
console.log( obj.newKey ); //hello

除了可以给新定义的属性设置特性，也可以给已有的属性设置特性

//定义对象的时候添加的属性，是可删除、可重写、可枚举的。
var obj = {
    test:"hello"
}

//改写值
obj.test = 'change value';

console.log( obj.test ); //'change value'

Object.defineProperty(obj,"test",{
    writable:false
})

//再次改写值
obj.test = 'change value again';

console.log( obj.test ); //依然是：'change value'

1.2.5 注意默认值

提示：一旦使用Object.defineProperty给对象添加属性，那么如果不设置属性的特性，那么configurable、enumerable、writable这些值都为默认的false

var obj = {};
//定义的新属性后，这个属性的特性中configurable，enumerable，writable都为默认的值false
//这就导致了neykey这个是不能重写、不能枚举、不能再次设置特性
//
Object.defineProperty(obj,'newKey',{

});

//设置值
obj.newKey = 'hello';
console.log(obj.newKey);  //undefined

//枚举
for( var attr in obj ){
    console.log(attr);
}

1.2.6 设置的特性总结：

value: 设置属性的值
writable: 值是否可以重写。true | false
enumerable: 目标属性是否可以被枚举。true | false
configurable: 目标属性是否可以被删除或是否可以再次修改特性 true | false

1.3 存取器描述

当使用存取器描述属性的特性的时候，允许设置以下特性属性：

var obj = {};
Object.defineProperty(obj,"newKey",{
    get:function (){} | undefined,
    set:function (value){} | undefined
    configurable: true | false
    enumerable: true | false
});

注意：当使用了getter或setter方法，不允许使用writable和value这两个属性

1.3.1 getter/setter

当设置或获取对象的某个属性的值的时候，可以提供getter/setter方法。

• getter 是一种获得属性值的方法
• setter是一种设置属性值的方法。

在特性中使用get/set属性来定义对应的方法。

var obj = {};
var initValue = 'hello';
Object.defineProperty(obj,"newKey",{
    get:function (){
        //当获取值的时候触发的函数
        return initValue;    
    },
    set:function (value){
        //当设置值的时候触发的函数,设置的新值通过参数value拿到
        initValue = value;
    }
});
//获取值
console.log( obj.newKey );  //hello

//设置值
obj.newKey = 'change value';

console.log( obj.newKey ); //change value

注意：get或set不是必须成对出现，任写其一就可以。如果不设置方法，则get和set的默认值为undefined

1.3.2 configurable和enumerable同上面的用法。

1.4 兼容性

在ie8下只能在DOM对象上使用，尝试在原生的对象使用 Object.defineProperty()会报错。

二 Object.freeze

const obj1 = {
    a:1,
};

const obj2 = Object.freeze(obj1);

console.log(obj1 === obj2); // true

console.log(Object.isExtensible(obj2));  // false

Object.getOwnPropertyDescriptor(obj2,'a'); // {value: 1, writable: false, enumerable: true, configurable: false}

2.1 Object.freeze做了三件事情

（1）给对象设置，Object.preventExtension(obj1)，
禁止更改原型，禁止添加属性，
（2）为对象的每一个属性设置，writable:false，
禁止更改属性值，
（3）为对象的每一个属性设置，configurable:false。

• 禁止删除属性
• 禁止再次修改属性的特性，即禁止更改writable为true，禁止更改enumerable为false，禁止更改configuable为true

注：
禁止添加属性，是Object.preventExtensions控制的，
而禁止删除属性，是configuable:false控制的。

2.2 例子

// 1. 禁止更改原型
Object.setPrototypeOf(obj2,{c:3});  
// 非严格模式：Uncaught TypeError: #<Object> is not extensible
// 严格模式：Uncaught TypeError: #<Object> is not extensible

// 2. 禁止添加属性
obj2.b = 2;  
// 非严格模式，静默失败，obj2还是{a:1}
// 严格模式：Uncaught TypeError: Cannot add property b, object is not extensible

// 3. 禁止更改属性值
obj2.a = 2;  
// 非严格模式，静默失败，obj2还是{a:1}
// 严格模式：Uncaught TypeError: Cannot assign to read only property 'a' of object '#<Object>'

// 4. 禁止删除已有属性
delete obj2.a;  
// 非严格模式，返回false
// 严格模式：Uncaught TypeError: Cannot delete property 'a' of #<Object>

/// 5. 禁止更改writable为true
Object.defineProperty(obj2,'a',{
    writable:true,
});  
// 非严格模式：Uncaught TypeError: Cannot redefine property: a
// 严格模式：Uncaught TypeError: Cannot redefine property: a

// 6. 禁止更改enumerable为false
Object.defineProperty(obj2,'a',{
    enumerable:false,
});  
// 非严格模式：Uncaught TypeError: Cannot redefine property: a
// 严格模式：Uncaught TypeError: Cannot redefine property: a

// 7. 禁止更改configuable为true
Object.defineProperty(obj2,'a',{
    configuable:true,
});  
// 非严格模式，静默失败，configuable还是false
// 严格模式：静默失败，configuable还是false

注：
在严格模式下，更改configurable为true，同样是静默失败。

三 Object.seal

const obj1 = {
    a:1,
};

const obj2 = Object.seal(obj1);

console.log(obj1 === obj2); // true

console.log(Object.isExtensible(obj2));  // false

Object.getOwnPropertyDescriptor(obj2,'a'); // {value: 1, writable: true, enumerable: true, configurable: false}

3.1 Object.freeze做了两件事情

（1）给对象设置，Object.preventExtension(obj1)，
禁止更改原型，禁止添加属性，
（2）为对象的每一个属性设置，configurable:false，
禁止更改属性值，

注：
与Object.freeze不同的是，Object.seal后的对象是可写的writable:true。

参考：
MDN-Object.defineProperty()
MDN-Object.seal()()
MDN-Object.freeze()()