来自《JavaScript 标准参考教程(alpha)》,by 阮一峰
JavaScript提供了一个内部数据结构,用来描述一个对象的属性的行为,控制它的行为。这被称为“属性描述对象”(attributes object)。每个属性都有自己对应的属性描述对象,保存该属性的一些元信息。
下面是属性描述对象的一个实例。
{ value: 123, writable: false, enumerable: true, configurable: false, get: undefined, set: undefined }属性描述对象提供6个元属性。
(1)value
value存放该属性的属性值,默认为undefined。
(2)writable
writable存放一个布尔值,表示属性值(value)是否可改变,默认为true。
(3)enumerable
enumerable存放一个布尔值,表示该属性是否可枚举,默认为true。如果设为false,会使得某些操作(比如for...in循环、Object.keys())跳过该属性。
(4)configurable
configurable存放一个布尔值,表示“可配置性”,默认为true。如果设为false,将阻止某些操作改写该属性,比如,无法删除该属性,也不得改变该属性的属性描述对象(value属性除外)。也就是说,configurable属性控制了属性描述对象的可写性。
(5)get
get存放一个函数,表示该属性的取值函数(getter),默认为undefined。
(6)set
set存放一个函数,表示该属性的存值函数(setter),默认为undefined。
Object.getOwnPropertyDescriptor方法可以读出对象自身属性的属性描述对象。
var o = { p: 'a' }; Object.getOwnPropertyDescriptor(o, 'p') // Object { value: "a", // writable: true, // enumerable: true, // configurable: true // }上面代码表示,使用Object.getOwnPropertyDescriptor方法,读取o对象的p属性的属性描述对象。
Object.defineProperty方法允许通过定义属性描述对象,来定义或修改一个属性,然后返回修改后的对象。它的格式如下。
Object.defineProperty(object, propertyName, attributesObject)上面代码中,Object.defineProperty方法接受三个参数,第一个是属性所在的对象,第二个是属性名(它应该是一个字符串),第三个是属性的描述对象。比如,新建一个o对象,并定义它的p属性,写法如下。
var o = Object.defineProperty({}, 'p', { value: 123, writable: false, enumerable: true, configurable: false }); o.p // 123 o.p = 246; o.p // 123 // 因为writable为false,所以无法改变该属性的值如果属性已经存在,Object.defineProperty方法相当于更新该属性的属性描述对象。
需要注意的是,Object.defineProperty方法和后面的Object.defineProperties方法,都有性能损耗,会拖慢执行速度,不宜大量使用。
如果一次性定义或修改多个属性,可以使用Object.defineProperties方法。
var o = Object.defineProperties({}, { p1: { value: 123, enumerable: true }, p2: { value: 'abc', enumerable: true }, p3: { get: function () { return this.p1 + this.p2 }, enumerable:true, configurable:true } }); o.p1 // 123 o.p2 // "abc" o.p3 // "123abc"上面代码中的p3属性,定义了取值函数get。这时需要注意的是,一旦定义了取值函数get(或存值函数set),就不能将writable设为true,或者同时定义value属性,会报错。
var o = {}; Object.defineProperty(o, 'p', { value: 123, get: function() { return 456; } }); // TypeError: Invalid property. // A property cannot both have accessors and be writable or have a value,上面代码同时定义了get属性和value属性,结果就报错。
Object.defineProperty()和Object.defineProperties()的第三个参数,是一个属性对象。它的writable、configurable、enumerable这三个属性的默认值都为false。
var obj = {}; Object.defineProperty(obj, 'foo', { configurable: true }); Object.getOwnPropertyDescriptor(obj, 'foo') // { // value: undefined, // writable: false, // enumerable: false, // configurable: true // }上面代码中,定义obj对象的foo属性时,只定义了可配置性configurable为true。结果,其他元属性都是默认值。
writable属性为false,表示对应的属性的值将不得改写。
var o = {}; Object.defineProperty(o, 'p', { value: "bar" }); o.p // bar o.p = 'foobar'; o.p // bar Object.defineProperty(o, 'p', { value: 'foobar', }); // TypeError: Cannot redefine property: p上面代码由于writable属性默认为false,导致无法对p属性重新赋值,但是不会报错(严格模式下会报错)。不过,如果再一次使用Object.defineProperty方法对value属性赋值,就会报错。
configurable属性为false,将无法删除该属性,也无法修改attributes对象(value属性除外)。
var o = {}; Object.defineProperty(o, 'p', { value: 'bar', }); delete o.p o.p // "bar"上面代码中,由于configurable属性默认为false,导致无法删除某个属性。
enumerable属性为false,表示对应的属性不会出现在for...in循环和Object.keys方法中。
var o = { p1: 10, p2: 13, }; Object.defineProperty(o, 'p3', { value: 3, }); for (var i in o) { console.log(i, o[i]); } // p1 10 // p2 13上面代码中,p3属性是用Object.defineProperty方法定义的,由于enumerable属性默认为false,所以不出现在for...in循环中。
属性描述对象的属性,被称为“元属性”,因为它可以看作是控制属性的属性。
JavaScript的最初版本,in 运算符和基于它的for...in循环,会遍历对象实例的所有属性,包括继承的属性。
var obj = {}; 'toString' in obj // true上面代码中,toString不是obj对象自身的属性,但是in运算符也返回true,导致被for...in循环遍历,这显然不太合理。后来就引入了“可枚举性”这个概念,只有可枚举的属性,才会被for...in循环遍历,同时还规定原生继承的属性都是不可枚举的,这样就保证了for...in循环的可用性。
可枚举性(enumerable)用来控制所描述的属性,是否将被包括在for...in循环之中。具体来说,如果一个属性的enumerable为false,下面三个操作不会取到该属性。
for..in循环 Object.keys方法 JSON.stringify方法因此,enumerable可以用来设置“秘密”属性。
var o = {a: 1, b: 2}; o.c = 3; Object.defineProperty(o, 'd', { value: 4, enumerable: false }); o.d // 4 for (var key in o) { console.log(o[key]); } // 1 // 2 // 3 Object.keys(o) // ["a", "b", "c"] JSON.stringify(o) // "{a:1, b:2, c:3}"上面代码中,d属性的enumerable为false,所以一般的遍历操作都无法获取该属性,使得它有点像“秘密”属性,但不是真正的私有属性,还是可以直接获取它的值。
基本上,JavaScript原生提供的属性都是不可枚举的,用户自定义的属性都是可枚举的。
与枚举性相关的几个操作的区别的是,for...in循环包括继承自原型对象的属性,Object.keys方法只返回对象本身的属性。如果需要获取对象自身的所有属性,不管是否可枚举,可以使用Object.getOwnPropertyNames方法,详见下文。
考虑到JSON.stringify方法会排除enumerable为false的值,有时可以利用这一点,为对象添加注释信息。
var car = { id: 123, color: 'red', ownerId: 12 }; var owner = { id: 12, name: 'Jack' }; Object.defineProperty(car, 'ownerInfo', { value: owner, enumerable: false }); car.ownerInfo // {id: 12, name: "Jack"} JSON.stringify(car) // "{"id": 123,"color": "red","ownerId": 12}"上面代码中,owner对象作为注释部分,加入car对象。由于ownerInfo属性不可枚举,所以JSON.stringify方法最后输出car对象时,会忽略ownerInfo属性。
这提示我们,如果你不愿意某些属性出现在JSON输出之中,可以把它的enumerable属性设为false。
可配置性(configurable)决定了是否可以修改属性描述对象。也就是说,当configurable为false的时候,value、writable、enumerable和configurable都不能被修改了。
var o = Object.defineProperty({}, 'p', { value: 1, writable: false, enumerable: false, configurable: false }); Object.defineProperty(o,'p', {value: 2}) // TypeError: Cannot redefine property: p Object.defineProperty(o,'p', {writable: true}) // TypeError: Cannot redefine property: p Object.defineProperty(o,'p', {enumerable: true}) // TypeError: Cannot redefine property: p Object.defineProperties(o,'p',{configurable: true}) // TypeError: Cannot redefine property: p上面代码首先定义对象o,并且定义o的属性p的configurable为false。然后,逐一改动value、writable、enumerable、configurable,结果都报错。
需要注意的是,writable只有在从false改为true会报错,从true改为false则是允许的。
var o = Object.defineProperty({}, 'p', { writable: true, configurable: false }); Object.defineProperty(o,'p', {writable: false}) // 修改成功至于value,只要writable和configurable有一个为true,就允许改动。
var o1 = Object.defineProperty({}, 'p', { value: 1, writable: true, configurable: false }); Object.defineProperty(o1,'p', {value: 2}) // 修改成功 var o2 = Object.defineProperty({}, 'p', { value: 1, writable: false, configurable: true }); Object.defineProperty(o2,'p', {value: 2}) // 修改成功另外,configurable为false时,直接对该属性赋值,不报错,但不会成功。
var o = Object.defineProperty({}, 'p', { value: 1, configurable: false }); o.p = 2; o.p // 1上面代码中,o对象的p属性是不可配置的,对它赋值是不会生效的。
可配置性决定了一个变量是否可以被删除(delete)。
var o = Object.defineProperties({}, { p1: { value: 1, configurable: true }, p2: { value: 2, configurable: false } }); delete o.p1 // true delete o.p2 // false o.p1 // undefined o.p2 // 2上面代码中的对象o有两个属性,p1是可配置的,p2是不可配置的。结果,p2就无法删除。
需要注意的是,当使用var命令声明变量时,变量的configurable为false。
var a1 = 1; Object.getOwnPropertyDescriptor(this,'a1') // Object { // value: 1, // writable: true, // enumerable: true, // configurable: false // }而不使用var命令声明变量时(或者使用属性赋值的方式声明变量),变量的可配置性为true。
a2 = 1; Object.getOwnPropertyDescriptor(this,'a2') // Object { // value: 1, // writable: true, // enumerable: true, // configurable: true // } // 或者写成 window.a3 = 1; Object.getOwnPropertyDescriptor(window, 'a3') // Object { // value: 1, // writable: true, // enumerable: true, // configurable: true // }上面代码中的this.a3 = 1与a3 = 1是等价的写法。window指的是浏览器的顶层对象。
这种差异意味着,如果一个变量是使用var命令生成的,就无法用delete命令删除。也就是说,delete只能删除对象的属性。
var a1 = 1; a2 = 1; delete a1 // false delete a2 // true a1 // 1 a2 // ReferenceError: a2 is not defined可写性(writable)决定了属性的值(value)是否可以被改变。
var o = {}; Object.defineProperty(o, 'a', { value: 37, writable: false }); o.a // 37 o.a = 25; o.a // 37上面代码将o对象的a属性可写性设为false,然后改变这个属性的值,就不会有任何效果。
注意,正常模式下,对可写性为false的属性赋值不会报错,只会默默失败。但是,严格模式下会报错,即使是对a属性重新赋予一个同样的值。
关于可写性,还有一种特殊情况。就是如果原型对象的某个属性的可写性为false,那么派生对象将无法自定义这个属性。
var proto = Object.defineProperty({}, 'foo', { value: 'a', writable: false }); var o = Object.create(proto); o.foo = 'b'; o.foo // 'a'上面代码中,对象proto的foo属性不可写,结果proto的派生对象o,也不可以再自定义这个属性了。在严格模式下,这样做还会抛出一个错误。但是,有一个规避方法,就是通过覆盖属性描述对象,绕过这个限制,原因是这种情况下,原型链会被完全忽视。
Object.defineProperty(o, 'foo', { value: 'b' }); o.foo // 'b'Object.getOwnPropertyNames方法返回直接定义在某个对象上面的全部属性的名称,而不管该属性是否可枚举。
var o = Object.defineProperties({}, { p1: { value: 1, enumerable: true }, p2: { value: 2, enumerable: false } }); Object.getOwnPropertyNames(o) // ["p1", "p2"]一般来说,系统原生的属性(即非用户自定义的属性)都是不可枚举的。
// 比如,数组实例自带length属性是不可枚举的 Object.keys([]) // [] Object.getOwnPropertyNames([]) // [ 'length' ] // Object.prototype对象的自带属性也都是不可枚举的 Object.keys(Object.prototype) // [] Object.getOwnPropertyNames(Object.prototype) // ['hasOwnProperty', // 'valueOf', // 'constructor', // 'toLocaleString', // 'isPrototypeOf', // 'propertyIsEnumerable', // 'toString']上面代码可以看到,数组的实例对象([])没有可枚举属性,不可枚举属性有length;Object.prototype对象也没有可枚举属性,但是有不少不可枚举属性。
对象实例的propertyIsEnumerable方法用来判断一个属性是否可枚举。
var o = {}; o.p = 123; o.propertyIsEnumerable('p') // true o.propertyIsEnumerable('toString') // false上面代码中,用户自定义的p属性是可枚举的,而继承自原型对象的toString属性是不可枚举的。
除了直接定义以外,属性还可以用存取器(accessor)定义。其中,存值函数称为setter,使用set命令;取值函数称为getter,使用get命令。
存取器提供的是虚拟属性,即该属性的值不是实际存在的,而是每次读取时计算生成的。利用这个功能,可以实现许多高级特性,比如每个属性禁止赋值。
var o = { get p() { return 'getter'; }, set p(value) { console.log('setter: ' + value); } };上面代码中,o对象内部的get和set命令,分别定义了p属性的取值函数和存值函数。定义了这两个函数之后,对p属性取值时,取值函数会自动调用;对p属性赋值时,存值函数会自动调用。
o.p // "getter" o.p = 123 // "setter: 123"注意,取值函数Getter不能接受参数,存值函数Setter只能接受一个参数(即属性的值)。另外,对象也不能有与取值函数同名的属性。比如,上面的对象o设置了取值函数p以后,就不能再另外定义一个p属性。
存取器往往用于,属性的值需要依赖对象内部数据的场合。
var o ={ $n : 5, get next() { return this.$n++ }, set next(n) { if (n >= this.$n) this.$n = n; else throw '新的值必须大于当前值'; } }; o.next // 5 o.next = 10; o.next // 10上面代码中,next属性的存值函数和取值函数,都依赖于对内部属性$n的操作。
存取器也可以通过Object.defineProperty定义。
var d = new Date(); Object.defineProperty(d, 'month', { get: function () { return d.getMonth(); }, set: function (v) { d.setMonth(v); } });上面代码为Date的实例对象d,定义了一个可读写的month属性。
存取器也可以使用Object.create方法定义。
var o = Object.create(Object.prototype, { foo: { get: function () { return 'getter'; }, set: function (value) { console.log('setter: '+value); } } });如果使用上面这种写法,属性foo必须定义一个属性描述对象。该对象的get和set属性,分别是foo的取值函数和存值函数。
利用存取器,可以实现数据对象与DOM对象的双向绑定。
Object.defineProperty(user, 'name', { get: function () { return document.getElementById('foo').value; }, set: function (newValue) { document.getElementById('foo').value = newValue; }, configurable: true });上面代码使用存取函数,将DOM对象foo与数据对象user的name属性,实现了绑定。两者之中只要有一个对象发生变化,就能在另一个对象上实时反映出来。
有时,我们需要将一个对象的所有属性,拷贝到另一个对象。ES5没有提供这个方法,必须自己实现。
var extend = function (to, from) { for (var property in from) { to[property] = from[property]; } return to; } extend({}, { a: 1 }) // {a: 1}上面这个方法的问题在于,如果遇到存取器定义的属性,会只拷贝值。
extend({}, { get a() { return 1 } }) // {a: 1}为了解决这个问题,我们可以通过Object.defineProperty方法来拷贝属性。
var extend = function (to, from) { for (var property in from) { Object.defineProperty( to, property, Object.getOwnPropertyDescriptor(from, property) ); } return to; } extend({}, { get a(){ return 1 } }) // { get a(){ return 1 } })这段代码还是有问题,拷贝某些属性时会失效。
extend(document.body.style, { backgroundColor: "red" });上面代码的目的是,设置document.body.style.backgroundColor属性为red,但是实际上网页的背景色并不会变红。但是,如果用第一种简单拷贝的方法,反而能够达到目的。这提示我们,可以把两种方法结合起来,对于简单属性,就直接拷贝,对于那些通过属性描述对象设置的属性,则使用Object.defineProperty方法拷贝。
var extend = function (to, from) { for (var property in from) { var descriptor = Object.getOwnPropertyDescriptor(from, property); if (descriptor && ( !descriptor.writable || !descriptor.configurable || !descriptor.enumerable || descriptor.get || descriptor.set)) { Object.defineProperty(to, property, descriptor); } else { to[property] = from[property]; } } }上面的这段代码,可以很好地拷贝对象所有可遍历(enumerable)的属性。
JavaScript提供了三种方法,精确控制一个对象的读写状态,防止对象被改变。最弱一层的保护是Object.preventExtensions,其次是Object.seal,最强的Object.freeze。
Object.preventExtensions方法可以使得一个对象无法再添加新的属性。
var o = new Object(); Object.preventExtensions(o); Object.defineProperty(o, 'p', { value: 'hello' }); // TypeError: Cannot define property:p, object is not extensible. o.p = 1; o.p // undefined如果是在严格模式下,则会抛出一个错误。
(function () { 'use strict'; o.p = '1' }()); // TypeError: Can't add property bar, object is not extensible不过,对于使用了preventExtensions方法的对象,可以用delete命令删除它的现有属性。
var o = new Object(); o.p = 1; Object.preventExtensions(o); delete o.p; o.p // undefinedObject.isExtensible方法用于检查一个对象是否使用了Object.preventExtensions方法。也就是说,检查是否可以为一个对象添加属性。
var o = new Object(); Object.isExtensible(o) // true Object.preventExtensions(o); Object.isExtensible(o) // false上面代码新生成了一个o对象,对该对象使用Object.isExtensible方法,返回true,表示可以添加新属性。对该对象使用Object.preventExtensions方法以后,再使用Object.isExtensible方法,返回false,表示已经不能添加新属性了。
Object.seal方法使得一个对象既无法添加新属性,也无法删除旧属性。
var o = { p: 'hello' }; Object.seal(o); delete o.p; o.p // "hello" o.x = 'world'; o.x // undefined上面代码中,一个对象执行Object.seal方法以后,就无法添加新属性和删除旧属性了。
Object.seal实质是把属性描述对象的configurable属性设为false,因此属性描述对象不再能改变了。
var o = { p: 'a' }; // seal方法之前 Object.getOwnPropertyDescriptor(o, 'p') // Object { // value: "a", // writable: true, // enumerable: true, // configurable: true // } Object.seal(o); // seal方法之后 Object.getOwnPropertyDescriptor(o, 'p') // Object { // value: "a", // writable: true, // enumerable: true, // configurable: false // } Object.defineProperty(o, 'p', { enumerable: false }) // TypeError: Cannot redefine property: p上面代码中,使用Object.seal方法之后,属性描述对象的configurable属性就变成了false,然后改变enumerable属性就会报错。
可写性(writable)有点特别。如果writable为false,使用Object.seal方法以后,将无法将其变成true;但是,如果writable为true,依然可以将其变成false。
var o1 = Object.defineProperty({}, 'p', { writable: false }); Object.seal(o1); Object.defineProperty(o1, 'p', { writable:true }) // Uncaught TypeError: Cannot redefine property: p var o2 = Object.defineProperty({}, 'p', { writable: true }); Object.seal(o2); Object.defineProperty(o2, 'p', { writable:false }); Object.getOwnPropertyDescriptor(o2, 'p') // { // value: '', // writable: false, // enumerable: true, // configurable: false // }上面代码中,同样是使用了Object.seal方法,如果writable原为false,改变这个设置将报错;如果原为true,则不会有问题。
至于属性对象的value是否可改变,是由writable决定的。
var o = { p: 'a' }; Object.seal(o); o.p = 'b'; o.p // 'b'上面代码中,Object.seal方法对p属性的value无效,是因为此时p属性的writable为true。
Object.isSealed方法用于检查一个对象是否使用了Object.seal方法。
var o = { p: 'a' }; Object.seal(o); Object.isSealed(o) // true这时,Object.isExtensible方法也返回false。
var o = { p: 'a' }; Object.seal(o); Object.isExtensible(o) // falseObject.freeze方法可以使得一个对象无法添加新属性、无法删除旧属性、也无法改变属性的值,使得这个对象实际上变成了常量。
var o = { p: 'hello' }; Object.freeze(o); o.p = 'world'; o.p // hello o.t = 'hello'; o.t // undefined上面代码中,对现有属性重新赋值(o.p = 'world')或者添加一个新属性,并不会报错,只是默默地失败。但是,如果是在严格模式下,就会报错。
var o = { p: 'hello' }; Object.freeze(o); // 对现有属性重新赋值 (function () { 'use strict'; o.p = 'world'; }()) // TypeError: Cannot assign to read only property 'p' of #<Object> // 添加不存在的属性 (function () { 'use strict'; o.t = 123; }()) // TypeError: Can't add property t, object is not extensibleObject.isFrozen方法用于检查一个对象是否使用了Object.freeze()方法。
var obj = { p: 'hello' }; Object.freeze(obj); Object.isFrozen(obj) // true前面说过,如果一个对象被冻结,再对它的属性赋值,在严格模式下会报错。Object.isFrozen方法可以防止发生这样的错误。
var obj = { p: 'hello' }; Object.freeze(obj); if (!Object.isFrozen(obj)) { obj.p = 'world'; }上面代码中,确认obj没有被冻结后,再对它的属性赋值,就不会报错了。
需要注意的是,使用上面这些方法锁定对象的可写性,但是依然可以通过改变该对象的原型对象,来为它增加属性。
var obj = new Object(); Object.preventExtensions(obj); var proto = Object.getPrototypeOf(obj); proto.t = 'hello'; obj.t // hello一种解决方案是,把原型也冻结住。
var obj = Object.seal( Object.create( Object.freeze({x: 1}), { y: { value: 2, writable: true } } ) ); Object.getPrototypeOf(obj).t = "hello"; obj.hello // undefined另外一个局限是,如果属性值是对象,上面这些方法只能冻结属性指向的对象,而不能冻结对象本身的内容。
var obj = { foo: 1, bar: ['a', 'b'] }; Object.freeze(obj); obj.bar.push('c'); obj.bar // ["a", "b", "c"]上面代码中,obj.bar属性指向一个数组,obj对象被冻结以后,这个指向无法改变,即无法指向其他值,但是所指向的数组是可以改变的。
