JavaScript 中 Object.defineProperty 的用法

VEIGHTZ 发布于2019-08-23 15:56 / 1906人阅读

摘要：默认为，表示不能被枚举，和中无法枚举该属性，对也有影响。表示对象属性是否可以被删除，以及除和特性外的其它特性能否被修改。宽松模式中，给只读属性赋值不会生效。

在 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》

云服务器专线服务 java中枚举的用法 python中for的用法 python中input的用法 php中css的用法

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/102565.html

关于JavaScript对象，你所不知道的事（二）- 再说属性

摘要：但好在还给我们提供了一个方法，每一个对象都有这样一个方法，专门用来判断某个属性是否是该对象的私有属性。如果你想要用对象字面形式，你只能在创建对象时定义访问器属性。在中，我们使用冻结一个对象，并且使用来判断一个对象是否被冻结。说完了对象那些不常用的冷知识，是时候来看看JavaScript中对象属性有哪些有意思的东西了。不出你所料，对象属性自然也有其相应的特征属性，但是这个话题有点复杂...

Richard_Gao 2019-08-21 17:49 评论0 收藏0
JavaScript 对象所有API解析

摘要：创建对象的两种方式推荐该构造器可以接受任何类型的参数，并且会自动识别参数的类型，并选择更合适的构造器来完成相关操作。比如二的成员该属性指向用来构造该函数对象的构造器，在这里为该方法返回的是一个用于描述目标对象的字符串。之前看到【深度长文】JavaScript数组所有API全解密和JavaScript字符串所有API全解密这两篇高质量的文章。发现没写对象API解析（估计是博主觉得简单，...

SmallBoyO 2019-08-21 12:02 评论0 收藏0
JavaScript对象详解

摘要：属性描述符升级打怪必备技能对象有自己的属性和方法，对于我们对象的属性来讲，属性还有自己的属性，又称为属性描述符。这个方法接受三个参数，第一个是指定的对象，第二个是指定的对象参数，第三个当然是要修改的属性描述符了。对象的声明有俩种：字面量通过new一个构造函数Object 两者唯一的区别就是，字面量形式，可以一次赋值多个，通过new Object就得一个一个赋值数据类型 ...

fancyLuo 2019-08-26 12:14 评论0 收藏0
属性描述对象

摘要：可枚举性属性是一个布尔值，表示目标属性是否可枚举。可配置性返回一个布尔值，决定了是否可以修改属性描述对象。其中，存值函数称为，使用属性描述对象的属性取值函数称为，使用属性描述对象的属性。 JavaScript 提供了一个内部数据结构，用来描述对象的属性，控制它的行为，比如该属性是否可写、可枚举等等。这个内部数据结构称为属性描述对象（attributes object）。每个属性都有自己...

developerworks 2019-08-23 13:51 评论0 收藏0
JS基础篇--JS中的可枚举属性与不可枚举属性以及扩展

摘要：在中，对象的属性分为可枚举和不可枚举之分，它们是由属性的值决定的。这是因为中内置的属性是不可枚举的，所以不能被访问到。此对象不可扩展且指定的属性名称不存在。返回值一个数组，其中包含对象的可枚举属性和方法的名称。在JavaScript中，对象的属性分为可枚举和不可枚举之分，它们是由属性的enumerable值决定的。可枚举性决定了这个属性能否被for…in查找遍历到。一、怎么判断属性...

dreamans 2019-08-21 11:59 评论0 收藏0