Javascript 屬性標(biāo)志和屬性描述符

我們知道，對(duì)象可以存儲(chǔ)屬性。

到目前為止，屬性對(duì)我們來說只是一個(gè)簡(jiǎn)單的“鍵值”對(duì)。但對(duì)象屬性實(shí)際上是更靈活且更強(qiáng)大的東西。

在本章中，我們將學(xué)習(xí)其他配置選項(xiàng)，在下一章中，我們將學(xué)習(xí)如何將它們無形地轉(zhuǎn)換為 getter/setter 函數(shù)。

屬性標(biāo)志

對(duì)象屬性（properties），除 value 外，還有三個(gè)特殊的特性（attributes），也就是所謂的“標(biāo)志”：

• ?writable? — 如果為 ?true?，則值可以被修改，否則它是只可讀的。
• ?enumerable? — 如果為 ?true?，則會(huì)被在循環(huán)中列出，否則不會(huì)被列出。
• ?configurable? — 如果為 ?true?，則此屬性可以被刪除，這些特性也可以被修改，否則不可以。

我們到現(xiàn)在還沒看到它們，是因?yàn)樗鼈兺ǔ２粫?huì)出現(xiàn)。當(dāng)我們用“常用的方式”創(chuàng)建一個(gè)屬性時(shí)，它們都為 true。但我們也可以隨時(shí)更改它們。

首先，讓我們來看看如何獲得這些標(biāo)志。

Object.getOwnPropertyDescriptor 方法允許查詢有關(guān)屬性的 完整 信息。

語法是：

let descriptor = Object.getOwnPropertyDescriptor(obj, propertyName);

?obj ?

需要從中獲取信息的對(duì)象。

?propertyName ?

屬性的名稱。

返回值是一個(gè)所謂的“屬性描述符”對(duì)象：它包含值和所有的標(biāo)志。

例如：

let user = {
  name: "John"
};

let descriptor = Object.getOwnPropertyDescriptor(user, 'name');

alert( JSON.stringify(descriptor, null, 2 ) );
/* 屬性描述符：
{
  "value": "John",
  "writable": true,
  "enumerable": true,
  "configurable": true
}
*/

為了修改標(biāo)志，我們可以使用 Object.defineProperty。

語法是：

Object.defineProperty(obj, propertyName, descriptor)

?obj?，?propertyName ?

要應(yīng)用描述符的對(duì)象及其屬性。

?descriptor ?

要應(yīng)用的屬性描述符對(duì)象。

如果該屬性存在，defineProperty 會(huì)更新其標(biāo)志。否則，它會(huì)使用給定的值和標(biāo)志創(chuàng)建屬性；在這種情況下，如果沒有提供標(biāo)志，則會(huì)假定它是 false。

例如，這里創(chuàng)建了一個(gè)屬性 name，該屬性的所有標(biāo)志都為 false：

let user = {};

Object.defineProperty(user, "name", {
  value: "John"
});

let descriptor = Object.getOwnPropertyDescriptor(user, 'name');

alert( JSON.stringify(descriptor, null, 2 ) );
/*
{
  "value": "John",
  "writable": false,
  "enumerable": false,
  "configurable": false
}
 */

將它與上面的“以常用方式創(chuàng)建的” user.name 進(jìn)行比較：現(xiàn)在所有標(biāo)志都為 false。如果這不是我們想要的，那么我們最好在 descriptor 中將它們?cè)O(shè)置為 true。

現(xiàn)在讓我們通過示例來看看標(biāo)志的影響。

只讀

讓我們通過更改 writable 標(biāo)志來把 user.name 設(shè)置為只讀（user.name 不能被重新賦值）：

let user = {
  name: "John"
};

Object.defineProperty(user, "name", {
  writable: false
});

user.name = "Pete"; // Error: Cannot assign to read only property 'name'

現(xiàn)在沒有人可以改變我們 user 的 name，除非它們應(yīng)用自己的 defineProperty 來覆蓋我們的 user 的 name。

只在嚴(yán)格模式下會(huì)出現(xiàn) Errors

在非嚴(yán)格模式下，在對(duì)不可寫的屬性等進(jìn)行寫入操作時(shí)，不會(huì)出現(xiàn)錯(cuò)誤。但是操作仍然不會(huì)成功。在非嚴(yán)格模式下，違反標(biāo)志的行為（flag-violating action）只會(huì)被默默地忽略掉。

這是相同的示例，但針對(duì)的是屬性不存在的情況：

let user = { };

Object.defineProperty(user, "name", {
  value: "John",
  // 對(duì)于新屬性，我們需要明確地列出哪些是 true
  enumerable: true,
  configurable: true
});

alert(user.name); // John
user.name = "Pete"; // Error

不可枚舉

現(xiàn)在讓我們向 user 添加一個(gè)自定義的 toString。

通常，對(duì)象中內(nèi)建的 toString 是不可枚舉的，它不會(huì)顯示在 for..in 中。但是如果我們添加我們自己的 toString，那么默認(rèn)情況下它將顯示在 for..in 中，如下所示：

let user = {
  name: "John",
  toString() {
    return this.name;
  }
};

// 默認(rèn)情況下，我們的兩個(gè)屬性都會(huì)被列出：
for (let key in user) alert(key); // name, toString

如果我們不喜歡它，那么我們可以設(shè)置 enumerable:false。之后它就不會(huì)出現(xiàn)在 for..in 循環(huán)中了，就像內(nèi)建的 toString 一樣：

let user = {
  name: "John",
  toString() {
    return this.name;
  }
};

Object.defineProperty(user, "toString", {
  enumerable: false
});

// 現(xiàn)在我們的 toString 消失了：
for (let key in user) alert(key); // name

不可枚舉的屬性也會(huì)被 Object.keys 排除：

alert(Object.keys(user)); // name

不可配置

不可配置標(biāo)志（configurable:false）有時(shí)會(huì)預(yù)設(shè)在內(nèi)建對(duì)象和屬性中。

不可配置的屬性不能被刪除，它的特性（attribute）不能被修改。

例如，Math.PI 是只讀的、不可枚舉和不可配置的：

let descriptor = Object.getOwnPropertyDescriptor(Math, 'PI');

alert( JSON.stringify(descriptor, null, 2 ) );
/*
{
  "value": 3.141592653589793,
  "writable": false,
  "enumerable": false,
  "configurable": false
}
*/

因此，開發(fā)人員無法修改 Math.PI 的值或覆蓋它。

Math.PI = 3; // Error，因?yàn)槠?writable: false

// 刪除 Math.PI 也不會(huì)起作用

我們也無法將 Math.PI 改為 writable：

// Error，因?yàn)?configurable: false
Object.defineProperty(Math, "PI", { writable: true });

我們對(duì) Math.PI 什么也做不了。

使屬性變成不可配置是一條單行道。我們無法通過 defineProperty 再把它改回來。

請(qǐng)注意：configurable: false 防止更改和刪除屬性標(biāo)志，但是允許更改對(duì)象的值。

這里的 user.name 是不可配置的，但是我們?nèi)匀豢梢愿乃?，因?yàn)樗强蓪懙模?

let user = {
  name: "John"
};

Object.defineProperty(user, "name", {
  configurable: false
});

user.name = "Pete"; // 正常工作
delete user.name; // Error

現(xiàn)在，我們將 user.name 設(shè)置為一個(gè)“永不可改”的常量，就像內(nèi)建的 Math.PI：

let user = {
  name: "John"
};

Object.defineProperty(user, "name", {
  writable: false,
  configurable: false
});

// 不能修改 user.name 或它的標(biāo)志
// 下面的所有操作都不起作用：
user.name = "Pete";
delete user.name;
Object.defineProperty(user, "name", { value: "Pete" });

唯一可行的特性更改：writable true → false

對(duì)于更改標(biāo)志，有一個(gè)小例外。

對(duì)于不可配置的屬性，我們可以將 writable: true 更改為 false，從而防止其值被修改（以添加另一層保護(hù)）。但無法反向行之。

Object.defineProperties

有一個(gè)方法 Object.defineProperties(obj, descriptors)，允許一次定義多個(gè)屬性。

語法是：

Object.defineProperties(obj, {
  prop1: descriptor1,
  prop2: descriptor2
  // ...
});

例如：

Object.defineProperties(user, {
  name: { value: "John", writable: false },
  surname: { value: "Smith", writable: false },
  // ...
});

所以，我們可以一次性設(shè)置多個(gè)屬性。

Object.getOwnPropertyDescriptors

要一次獲取所有屬性描述符，我們可以使用 Object.getOwnPropertyDescriptors(obj) 方法。

它與 Object.defineProperties 一起可以用作克隆對(duì)象的“標(biāo)志感知”方式：

let clone = Object.defineProperties({}, Object.getOwnPropertyDescriptors(obj));

通常，當(dāng)我們克隆一個(gè)對(duì)象時(shí)，我們使用賦值的方式來復(fù)制屬性，像這樣：

for (let key in user) {
  clone[key] = user[key]
}

……但是，這并不能復(fù)制標(biāo)志。所以如果我們想要一個(gè)“更好”的克隆，那么 Object.defineProperties 是首選。

另一個(gè)區(qū)別是 for..in 會(huì)忽略 symbol 類型的和不可枚舉的屬性，但是 Object.getOwnPropertyDescriptors 返回包含 symbol 類型的和不可枚舉的屬性在內(nèi)的 所有 屬性描述符。

設(shè)定一個(gè)全局的密封對(duì)象

屬性描述符在單個(gè)屬性的級(jí)別上工作。

還有一些限制訪問 整個(gè) 對(duì)象的方法：

Object.preventExtensions(obj)

禁止向?qū)ο筇砑有聦傩浴?

Object.seal(obj)

禁止添加/刪除屬性。為所有現(xiàn)有的屬性設(shè)置 ?configurable: false?。

Object.freeze(obj)

禁止添加/刪除/更改屬性。為所有現(xiàn)有的屬性設(shè)置 ?configurable: false, writable: false?。

還有針對(duì)它們的測(cè)試：

Object.isExtensible(obj)

如果添加屬性被禁止，則返回 ?false?，否則返回 ?true?。

Object.isSealed(obj)

如果添加/刪除屬性被禁止，并且所有現(xiàn)有的屬性都具有 ?configurable: false?則返回 ?true?。

Object.isFrozen(obj)

如果添加/刪除/更改屬性被禁止，并且所有當(dāng)前屬性都是 ?configurable: false, writable: false?，則返回 ?true?。

這些方法在實(shí)際中很少使用。