理解Object.defineProperty的作用

111

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

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

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

Object.defineProperty()

语法:

Object.defineProperty(obj, prop, descriptor)

参数说明:

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

返回值:

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

针对属性,我们可以给这个属性设置一些特性,比如是否只读不可以写;是否可以被for..inObject.keys()遍历。

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

数据描述

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

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

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

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

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

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
}

configurable

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

这个属性起到两个作用:

  1. 目标属性是否可以使用delete删除

  2. 目标属性是否可以再次设置特性

//-----------------测试目标属性是否能被删除------------------------
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

//-----------------测试是否可以再次修改特性------------------------
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'

提示:一旦使用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);
}

设置的特性总结:

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

存取器描述

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

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

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

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

configurable和enumerable同上面的用法。


兼容性

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


参考:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty

你可能感兴趣的

21 条评论
以君为药 · 2017年05月04日

var obj = {}
//第一种情况:writable设置为false,不能重写。
Object.defineProperty(obj,"newKey",{

value:"hello",
writable:false

这个时候特性的 configurable:false 是默认不能修改特性的,下面想要改成:
//第二种情况:writable设置为true,可以重写
Object.defineProperty(obj,"newKey",{

value:"hello",
writable:true

还得再在第一个代码块里增加 configurable:true,才能 redefine newKey 的value 为‘change value’

+2 回复

M不是W · 4月13日

你好作者,getter/setter这块,为什么要定义一个initValue?难道说没有这个中间变量,就无法使用getter和setter取值赋值了吗?这个地方一直搞不清楚是怎么回事,或者说他们为什么这样设计。我明明定义了一个obj,并且获取修改obj的newKey属性,为什么需要借助obj之外其他一个变量initValue?在java中,setter有个传递进入的参数value,如果想修改真是的值,可以this.xxx = value,在js的这个机制里,有this读取对应的值的方法吗?就是搞不清楚为什么有initValue的存在,他自己都是setter方法了,他难道不能直接修改obj.newKey值吗?

+2 回复

0

这个不能直接修改的,加入你在setter中这样做:this.newKey = value;那么就意味着一直给这个对象的属性赋值,一直会触发setter了。会导致堆栈溢出(你可以试下)。

所以采用这种,存变量的方式。

这个变量此时是全局的,当然可以随便修改。如果不能随便该,可以试试闭包的方式,写在函数内部。

戎马 作者 · 4月27日
健儿 · 6月11日

vue的源码解析里面的第一步 就是对定义的data,采用楼主说的定义某对象的方式,进行对data重写,请问重写的意义在于是否 是确定定义的data是可删除的,已经可枚举的,以及定义了get和set方法,而其他属性都是default。

Vue.prototype._obserse = function(obj) {
var value
for(key in obj) {

   if(obj.hasOwnProperty(key)) {
       value = obj[key]
       if(typeof value == 'object') {
           this._obserse(value)
       }
   }

   Object.defineProperty(this.data, key, {
    enumerable: true,  // 可被枚举
       configurable: true, // 可被删除
       get: function() {
           return value
       },
       set: function(newval) {
           if(value != newval) {
               value = newval
           }
       }
   })

}
console.log('this.data', this.data)
}

+1 回复

Gavin · 2017年04月13日

很好,帮助理解了。

回复

梵天白莲 · 2017年12月11日

helpful

回复

fsme · 2017年12月26日

感谢总结哇

回复

chaihongjun · 3月26日

configurable writable enumerable 数据属性的 这几个特性值默认值是true 不是 false 啊!!!

回复

0
伊优yiyou · 3月26日
0

@伊优yiyou 我理解错了,字面量形式情况下是true,使用defineProperty创建的属性默认是false

chaihongjun · 3月26日
0

要亲测一下。

戎马 作者 · 3月26日
空中浮堡 · 3月26日

你好,我想问一下set函数中为什么直接是initValue = value;而不是return value;

回复

1

set是在设置时候触发的,设置的新值通过参数传递过来。而get是在取值触发,取值就是得到一个值,那就是执行了get函数后作为返回值返回了。

戎马 作者 · 3月26日
0

理解了

空中浮堡 · 3月27日
M不是W · 4月13日

另外,如果我在这个作用域中直接修改了initValue的值,那岂不是obj.newKey的值也发生了变化?
obj.newKey = '123';
initValue = 'what the fuck?';
console.log(obj.newKey); // 输出 what the fuck?

回复

0

Object.defineProperty每次只能添加修改一个属性转成getter、setter,可以试试Proxy。

戎马 作者 · 4月27日
0

亲测确实是what the fuck ,最后console的时候触发了getter,执行return initValue,这时候的initValue已经变成了 'what the fuck?'

FrankChencc · 6月11日
M不是W · 4月13日

你在讲解value
属性对应的值,可以使任意类型的值,默认为undefined

那在这个getter中,能否访问到这个value?比如使用this.value的方式,那在setter中能否this.value = set传递的值?

回复

0

当使用了getter或setter方法,不允许使用writable和value这两个属性,此时再读取this.value为undefined,而使用obj.newkey方式使用set或get读取或赋值会导致堆栈溢出,可以理解为像下面函数的执行:

function a(){
    a();
}
Niniun · 4月13日
jackletter · 5月10日

注册个账户,只为添加个评论:
当configurable 设为true之后不是所有的属性描述不允许设置,而是允许设置writable但是只能是从true设置为false

回复

0

谢谢指正

戎马 作者 · 6月7日
载入中...