ES6 Symbol

2020-06-11 11:35 更新

1. 概述

ES5的對象屬性名都是字符串，這容易造成屬性名的沖突。比如，你使用了一個(gè)他人提供的對象，但又想為這個(gè)對象添加新的方法（mixin 模式），新方法的名字就有可能與現(xiàn)有方法產(chǎn)生沖突。如果有一種機(jī)制，保證每個(gè)屬性的名字都是獨(dú)一無二的就好了，這樣就從根本上防止屬性名的沖突。這就是 ES6 引入 Symbol 的原因。

ES6引入了一種新的原始數(shù)據(jù)類型Symbol，表示獨(dú)一無二的值。它是 JavaScript 語言的第七種數(shù)據(jù)類型，前六種是： undefined 、 null 、布爾值（Boolean）、字符串（String）、數(shù)值（Number）、對象（Object）。

Symbol值通過Symbol 函數(shù)生成。這就是說，對象的屬性名現(xiàn)在可以有兩種類型，一種是原來就有的字符串，另一種就是新增的 Symbol 類型。凡是屬性名屬于 Symbol 類型，就都是獨(dú)一無二的，可以保證不會(huì)與其他屬性名產(chǎn)生沖突。

let s = Symbol();


typeof s
// "symbol"

上面代碼中，變量 s 就是一個(gè)獨(dú)一無二的值。 typeof 運(yùn)算符的結(jié)果，表明變量 s 是 Symbol 數(shù)據(jù)類型，而不是字符串之類的其他類型。

注意， Symbol 函數(shù)前不能使用 new 命令，否則會(huì)報(bào)錯(cuò)。這是因?yàn)樯傻?Symbol 是一個(gè)原始類型的值，不是對象。也就是說，由于 Symbol 值不是對象，所以不能添加屬性?；旧?，它是一種類似于字符串的數(shù)據(jù)類型。

Symbol 函數(shù)可以接受一個(gè)字符串作為參數(shù)，表示對 Symbol 實(shí)例的描述，主要是為了在控制臺顯示，或者轉(zhuǎn)為字符串時(shí)，比較容易區(qū)分。

let s1 = Symbol('foo');
let s2 = Symbol('bar');


s1 // Symbol(foo)
s2 // Symbol(bar)


s1.toString() // "Symbol(foo)"
s2.toString() // "Symbol(bar)"

上面代碼中， s1 和 s2 是兩個(gè) Symbol 值。如果不加參數(shù)，它們在控制臺的輸出都是 Symbol() ，不利于區(qū)分。有了參數(shù)以后，就等于為它們加上了描述，輸出的時(shí)候就能夠分清，到底是哪一個(gè)值。

如果 Symbol 的參數(shù)是一個(gè)對象，就會(huì)調(diào)用該對象的 toString 方法，將其轉(zhuǎn)為字符串，然后才生成一個(gè) Symbol 值。

const obj = {
  toString() {
    return 'abc';
  }
};
const sym = Symbol(obj);
sym // Symbol(abc)

注意， Symbol 函數(shù)的參數(shù)只是表示對當(dāng)前 Symbol 值的描述，因此相同參數(shù)的 Symbol 函數(shù)的返回值是不相等的。

// 沒有參數(shù)的情況
let s1 = Symbol();
let s2 = Symbol();


s1 === s2 // false


// 有參數(shù)的情況
let s1 = Symbol('foo');
let s2 = Symbol('foo');


s1 === s2 // false

上面代碼中， s1 和 s2 都是 Symbol 函數(shù)的返回值，而且參數(shù)相同，但是它們是不相等的。

Symbol 值不能與其他類型的值進(jìn)行運(yùn)算，會(huì)報(bào)錯(cuò)。

let sym = Symbol('My symbol');


"your symbol is " + sym
// TypeError: can't convert symbol to string
`your symbol is ${sym}`
// TypeError: can't convert symbol to string

但是，Symbol 值可以顯式轉(zhuǎn)為字符串。

let sym = Symbol('My symbol');


String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'

另外，Symbol 值也可以轉(zhuǎn)為布爾值，但是不能轉(zhuǎn)為數(shù)值。

let sym = Symbol();
Boolean(sym) // true
!sym  // false


if (sym) {
  // ...
}


Number(sym) // TypeError
sym + 2 // TypeError

2. Symbol.prototype.description

創(chuàng)建 Symbol 的時(shí)候，可以添加一個(gè)描述。

const sym = Symbol('foo');

上面代碼中， sym 的描述就是字符串 foo 。

但是，讀取這個(gè)描述需要將 Symbol 顯式轉(zhuǎn)為字符串，即下面的寫法。

const sym = Symbol('foo');


String(sym) // "Symbol(foo)"
sym.toString() // "Symbol(foo)"

上面的用法不是很方便。ES2019 提供了一個(gè)實(shí)例屬性 description ，直接返回 Symbol 的描述。

const sym = Symbol('foo');


sym.description // "foo"

3. 作為屬性名的 Symbol

由于每一個(gè) Symbol 值都是不相等的，這意味著 Symbol 值可以作為標(biāo)識符，用于對象的屬性名，就能保證不會(huì)出現(xiàn)同名的屬性。這對于一個(gè)對象由多個(gè)模塊構(gòu)成的情況非常有用，能防止某一個(gè)鍵被不小心改寫或覆蓋。

let mySymbol = Symbol();


// 第一種寫法
let a = {};
a[mySymbol] = 'Hello!';


// 第二種寫法
let a = {
  [mySymbol]: 'Hello!'
};


// 第三種寫法
let a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });


// 以上寫法都得到同樣結(jié)果
a[mySymbol] // "Hello!"

上面代碼通過方括號結(jié)構(gòu)和 Object.defineProperty ，將對象的屬性名指定為一個(gè) Symbol 值。

注意，Symbol 值作為對象屬性名時(shí)，不能用點(diǎn)運(yùn)算符。

const mySymbol = Symbol();
const a = {};


a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"

上面代碼中，因?yàn)辄c(diǎn)運(yùn)算符后面總是字符串，所以不會(huì)讀取 mySymbol 作為標(biāo)識名所指代的那個(gè)值，導(dǎo)致 a 的屬性名實(shí)際上是一個(gè)字符串，而不是一個(gè) Symbol 值。

同理，在對象的內(nèi)部，使用 Symbol 值定義屬性時(shí)，Symbol 值必須放在方括號之中。

let s = Symbol();


let obj = {
  [s]: function (arg) { ... }
};


obj[s](123);

上面代碼中，如果 s 不放在方括號中，該屬性的鍵名就是字符串 s ，而不是 s 所代表的那個(gè) Symbol 值。

采用增強(qiáng)的對象寫法，上面代碼的 obj 對象可以寫得更簡潔一些。

let obj = {
  [s](arg) { ... }
};

Symbol 類型還可以用于定義一組常量，保證這組常量的值都是不相等的。

const log = {};


log.levels = {
  DEBUG: Symbol('debug'),
  INFO: Symbol('info'),
  WARN: Symbol('warn')
};
console.log(log.levels.DEBUG, 'debug message');
console.log(log.levels.INFO, 'info message');

下面是另外一個(gè)例子。

const COLOR_RED    = Symbol();
const COLOR_GREEN  = Symbol();


function getComplement(color) {
  switch (color) {
    case COLOR_RED:
      return COLOR_GREEN;
    case COLOR_GREEN:
      return COLOR_RED;
    default:
      throw new Error('Undefined color');
    }
}

常量使用 Symbol 值最大的好處，就是其他任何值都不可能有相同的值了，因此可以保證上面的 switch 語句會(huì)按設(shè)計(jì)的方式工作。

還有一點(diǎn)需要注意，Symbol值作為屬性名時(shí)，該屬性還是公開屬性，不是私有屬性。

4. 實(shí)例：消除魔術(shù)字符串

魔術(shù)字符串指的是，在代碼之中多次出現(xiàn)、與代碼形成強(qiáng)耦合的某一個(gè)具體的字符串或者數(shù)值。風(fēng)格良好的代碼，應(yīng)該盡量消除魔術(shù)字符串，改由含義清晰的變量代替。

function getArea(shape, options) {
  let area = 0;


  switch (shape) {
    case 'Triangle': // 魔術(shù)字符串
      area = .5 * options.width * options.height;
      break;
    /* ... more code ... */
  }


  return area;
}


getArea('Triangle', { width: 100, height: 100 }); // 魔術(shù)字符串

上面代碼中，字符串 Triangle 就是一個(gè)魔術(shù)字符串。它多次出現(xiàn)，與代碼形成“強(qiáng)耦合”，不利于將來的修改和維護(hù)。

常用的消除魔術(shù)字符串的方法，就是把它寫成一個(gè)變量。

const shapeType = {
  triangle: 'Triangle'
};


function getArea(shape, options) {
  let area = 0;
  switch (shape) {
    case shapeType.triangle:
      area = .5 * options.width * options.height;
      break;
  }
  return area;
}


getArea(shapeType.triangle, { width: 100, height: 100 });

上面代碼中，我們把 Triangle 寫成 shapeType 對象的 triangle 屬性，這樣就消除了強(qiáng)耦合。

如果仔細(xì)分析，可以發(fā)現(xiàn) shapeType.triangle 等于哪個(gè)值并不重要，只要確保不會(huì)跟其他 shapeType 屬性的值沖突即可。因此，這里就很適合改用 Symbol 值。

const shapeType = {
  triangle: Symbol()
};

上面代碼中，除了將 shapeType.triangle 的值設(shè)為一個(gè) Symbol，其他地方都不用修改。

5. 屬性名的遍歷

Symbol作為屬性名，遍歷對象的時(shí)候，該屬性不會(huì)出現(xiàn)在 for...in 、 for...of 循環(huán)中，也不會(huì)被 Object.keys() 、 Object.getOwnPropertyNames() 、 JSON.stringify() 返回。

但是，它也不是私有屬性，有一個(gè)Object.getOwnPropertySymbols()方法，可以獲取指定對象的所有 Symbol 屬性名。該方法返回一個(gè)數(shù)組，成員是當(dāng)前對象的所有用作屬性名的 Symbol 值。

const obj = {};
let a = Symbol('a');
let b = Symbol('b');


obj[a] = 'Hello';
obj[b] = 'World';


const objectSymbols = Object.getOwnPropertySymbols(obj);


objectSymbols
// [Symbol(a), Symbol(b)]

上面代碼是 Object.getOwnPropertySymbols() 方法的示例，可以獲取所有 Symbol 屬性名。

下面是另一個(gè)例子， Object.getOwnPropertySymbols() 方法與 for...in 循環(huán)、 Object.getOwnPropertyNames 方法進(jìn)行對比的例子。

const obj = {};
const foo = Symbol('foo');


obj[foo] = 'bar';


for (let i in obj) {
  console.log(i); // 無輸出
}


Object.getOwnPropertyNames(obj) // []
Object.getOwnPropertySymbols(obj) // [Symbol(foo)]

上面代碼中，使用 for...in 循環(huán)和 Object.getOwnPropertyNames() 方法都得不到 Symbol 鍵名，需要使用 Object.getOwnPropertySymbols() 方法。

另一個(gè)新的 API， Reflect.ownKeys() 方法可以返回所有類型的鍵名，包括常規(guī)鍵名和 Symbol 鍵名。

let obj = {
  [Symbol('my_key')]: 1,
  enum: 2,
  nonEnum: 3
};


Reflect.ownKeys(obj)
//  ["enum", "nonEnum", Symbol(my_key)]

由于以 Symbol 值作為鍵名，不會(huì)被常規(guī)方法遍歷得到。我們可以利用這個(gè)特性，為對象定義一些非私有的、但又希望只用于內(nèi)部的方法。

let size = Symbol('size');


class Collection {
  constructor() {
    this[size] = 0;
  }


  add(item) {
    this[this[size]] = item;
    this[size]++;
  }


  static sizeOf(instance) {
    return instance[size];
  }
}


let x = new Collection();
Collection.sizeOf(x) // 0


x.add('foo');
Collection.sizeOf(x) // 1


Object.keys(x) // ['0']
Object.getOwnPropertyNames(x) // ['0']
Object.getOwnPropertySymbols(x) // [Symbol(size)]

上面代碼中，對象 x 的 size 屬性是一個(gè) Symbol 值，所以 Object.keys(x) 、 Object.getOwnPropertyNames(x) 都無法獲取它。這就造成了一種非私有的內(nèi)部方法的效果。

6. Symbol.for()，Symbol.keyFor()

有時(shí)，我們希望重新使用同一個(gè) Symbol 值，Symbol.for()方法可以做到這一點(diǎn)。它接受一個(gè)字符串作為參數(shù)，然后搜索有沒有以該參數(shù)作為名稱的 Symbol 值。如果有，就返回這個(gè) Symbol 值，否則就新建一個(gè)以該字符串為名稱的 Symbol 值，并將其注冊到全局。

let s1 = Symbol.for('foo');
let s2 = Symbol.for('foo');


s1 === s2 // true

上面代碼中， s1 和 s2 都是 Symbol 值，但是它們都是由同樣參數(shù)的 Symbol.for 方法生成的，所以實(shí)際上是同一個(gè)值。

Symbol.for()與Symbol()這兩種寫法，都會(huì)生成新的 Symbol。它們的區(qū)別是，前者會(huì)被登記在全局環(huán)境中供搜索，后者不會(huì)。 Symbol.for() 不會(huì)每次調(diào)用就返回一個(gè)新的 Symbol 類型的值，而是會(huì)先檢查給定的 key 是否已經(jīng)存在，如果不存在才會(huì)新建一個(gè)值。比如，如果你調(diào)用 Symbol.for("cat") 30 次，每次都會(huì)返回同一個(gè) Symbol 值，但是調(diào)用 Symbol("cat") 30 次，會(huì)返回 30 個(gè)不同的 Symbol 值。

Symbol.for("bar") === Symbol.for("bar")
// true


Symbol("bar") === Symbol("bar")
// false

上面代碼中，由于 Symbol() 寫法沒有登記機(jī)制，所以每次調(diào)用都會(huì)返回一個(gè)不同的值。

Symbol.keyFor() 方法返回一個(gè)已登記的 Symbol 類型值的 key 。

let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"


let s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined

上面代碼中，變量 s2 屬于未登記的 Symbol 值，所以返回 undefined 。

注意， Symbol.for() 為 Symbol 值登記的名字，是全局環(huán)境的，不管有沒有在全局環(huán)境運(yùn)行。

function foo() {
  return Symbol.for('bar');
}


const x = foo();
const y = Symbol.for('bar');
console.log(x === y); // true

上面代碼中， Symbol.for('bar') 是函數(shù)內(nèi)部運(yùn)行的，但是生成的 Symbol 值是登記在全局環(huán)境的。所以，第二次運(yùn)行 Symbol.for('bar') 可以取到這個(gè) Symbol 值。

Symbol.for() 的這個(gè)全局登記特性，可以用在不同的 iframe 或 service worker 中取到同一個(gè)值。

iframe = document.createElement('iframe');
iframe.src = String(window.location);
document.body.appendChild(iframe);


iframe.contentWindow.Symbol.for('foo') === Symbol.for('foo')
// true

上面代碼中，iframe 窗口生成的 Symbol 值，可以在主頁面得到。

7. 實(shí)例：模塊的 Singleton 模式

Singleton模式指的是調(diào)用一個(gè)類，任何時(shí)候返回的都是同一個(gè)實(shí)例。

對于 Node 來說，模塊文件可以看成是一個(gè)類。怎么保證每次執(zhí)行這個(gè)模塊文件，返回的都是同一個(gè)實(shí)例呢？

很容易想到，可以把實(shí)例放到頂層對象 global 。

// mod.js
function A() {
  this.foo = 'hello';
}


if (!global._foo) {
  global._foo = new A();
}


module.exports = global._foo;

然后，加載上面的 mod.js 。

const a = require('./mod.js');
console.log(a.foo);

上面代碼中，變量 a 任何時(shí)候加載的都是 A 的同一個(gè)實(shí)例。

但是，這里有一個(gè)問題，全局變量 global._foo 是可寫的，任何文件都可以修改。

global._foo = { foo: 'world' };


const a = require('./mod.js');
console.log(a.foo);

上面的代碼，會(huì)使得加載 mod.js 的腳本都失真。

為了防止這種情況出現(xiàn)，我們就可以使用 Symbol。

// mod.js
const FOO_KEY = Symbol.for('foo');


function A() {
  this.foo = 'hello';
}


if (!global[FOO_KEY]) {
  global[FOO_KEY] = new A();
}


module.exports = global[FOO_KEY];

上面代碼中，可以保證 global[FOO_KEY] 不會(huì)被無意間覆蓋，但還是可以被改寫。

global[Symbol.for('foo')] = { foo: 'world' };


const a = require('./mod.js');

如果鍵名使用 Symbol 方法生成，那么外部將無法引用這個(gè)值，當(dāng)然也就無法改寫。

// mod.js
const FOO_KEY = Symbol('foo');


// 后面代碼相同 ……

上面代碼將導(dǎo)致其他腳本都無法引用 FOO_KEY 。但這樣也有一個(gè)問題，就是如果多次執(zhí)行這個(gè)腳本，每次得到的 FOO_KEY 都是不一樣的。雖然 Node 會(huì)將腳本的執(zhí)行結(jié)果緩存，一般情況下，不會(huì)多次執(zhí)行同一個(gè)腳本，但是用戶可以手動(dòng)清除緩存，所以也不是絕對可靠。

8. 內(nèi)置的 Symbol 值

除了定義自己使用的 Symbol 值以外，ES6 還提供了11個(gè)內(nèi)置的 Symbol 值，指向語言內(nèi)部使用的方法。

Symbol.hasInstance

對象的Symbol.hasInstance屬性，指向一個(gè)內(nèi)部方法。當(dāng)其他對象使用 instanceof運(yùn)算符，判斷是否為該對象的實(shí)例時(shí)，會(huì)調(diào)用這個(gè)方法。比如， foo instanceof Foo 在語言內(nèi)部，實(shí)際調(diào)用的是 FooSymbol.hasInstance 。

class MyClass {
  [Symbol.hasInstance](foo) {
    return foo instanceof Array;
  }
}


[1, 2, 3] instanceof new MyClass() // true

上面代碼中， MyClass 是一個(gè)類， new MyClass() 會(huì)返回一個(gè)實(shí)例。該實(shí)例的 Symbol.hasInstance 方法，會(huì)在進(jìn)行 instanceof 運(yùn)算時(shí)自動(dòng)調(diào)用，判斷左側(cè)的運(yùn)算子是否為 Array 的實(shí)例。

下面是另一個(gè)例子。

class Even {
  static [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
}


// 等同于
const Even = {
  [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
};


1 instanceof Even // false
2 instanceof Even // true
12345 instanceof Even // false

Symbol.isConcatSpreadable

對象的 Symbol.isConcatSpreadable屬性等于一個(gè)布爾值，表示該對象用于 Array.prototype.concat()時(shí)，是否可以展開。

let arr1 = ['c', 'd'];
['a', 'b'].concat(arr1, 'e') // ['a', 'b', 'c', 'd', 'e']
arr1[Symbol.isConcatSpreadable] // undefined


let arr2 = ['c', 'd'];
arr2[Symbol.isConcatSpreadable] = false;
['a', 'b'].concat(arr2, 'e') // ['a', 'b', ['c','d'], 'e']

上面代碼說明，數(shù)組的默認(rèn)行為是可以展開， Symbol.isConcatSpreadable 默認(rèn)等于 undefined 。該屬性等于 true 時(shí)，也有展開的效果。

類似數(shù)組的對象正好相反，默認(rèn)不展開。它的 Symbol.isConcatSpreadable 屬性設(shè)為 true ，才可以展開。

let obj = {length: 2, 0: 'c', 1: 'd'};
['a', 'b'].concat(obj, 'e') // ['a', 'b', obj, 'e']


obj[Symbol.isConcatSpreadable] = true;
['a', 'b'].concat(obj, 'e') // ['a', 'b', 'c', 'd', 'e']

Symbol.isConcatSpreadable 屬性也可以定義在類里面。

class A1 extends Array {
  constructor(args) {
    super(args);
    this[Symbol.isConcatSpreadable] = true;
  }
}
class A2 extends Array {
  constructor(args) {
    super(args);
  }
  get [Symbol.isConcatSpreadable] () {
    return false;
  }
}
let a1 = new A1();
a1[0] = 3;
a1[1] = 4;
let a2 = new A2();
a2[0] = 5;
a2[1] = 6;
[1, 2].concat(a1).concat(a2)
// [1, 2, 3, 4, [5, 6]]

上面代碼中，類 A1 是可展開的，類 A2 是不可展開的，所以使用 concat 時(shí)有不一樣的結(jié)果。

注意， Symbol.isConcatSpreadable 的位置差異， A1 是定義在實(shí)例上， A2 是定義在類本身，效果相同。

Symbol.species

對象的Symbol.species 屬性，指向一個(gè)構(gòu)造函數(shù)。創(chuàng)建衍生對象時(shí)，會(huì)使用該屬性。

class MyArray extends Array {
}


const a = new MyArray(1, 2, 3);
const b = a.map(x => x);
const c = a.filter(x => x > 1);


b instanceof MyArray // true
c instanceof MyArray // true

上面代碼中，子類 MyArray 繼承了父類 Array ， a 是 MyArray 的實(shí)例， b 和 c 是 a 的衍生對象。你可能會(huì)認(rèn)為， b 和 c 都是調(diào)用數(shù)組方法生成的，所以應(yīng)該是數(shù)組（ Array 的實(shí)例），但實(shí)際上它們也是 MyArray 的實(shí)例。

Symbol.species 屬性就是為了解決這個(gè)問題而提供的?，F(xiàn)在，我們可以為 MyArray 設(shè)置 Symbol.species 屬性。

class MyArray extends Array {
  static get [Symbol.species]() { return Array; }
}

上面代碼中，由于定義了 Symbol.species 屬性，創(chuàng)建衍生對象時(shí)就會(huì)使用這個(gè)屬性返回的函數(shù)，作為構(gòu)造函數(shù)。這個(gè)例子也說明，定義 Symbol.species 屬性要采用 get 取值器。默認(rèn)的 Symbol.species 屬性等同于下面的寫法。

static get [Symbol.species]() {
  return this;
}

現(xiàn)在，再來看前面的例子。

class MyArray extends Array {
  static get [Symbol.species]() { return Array; }
}


const a = new MyArray();
const b = a.map(x => x);


b instanceof MyArray // false
b instanceof Array // true

上面代碼中， a.map(x => x) 生成的衍生對象，就不是 MyArray 的實(shí)例，而直接就是 Array 的實(shí)例。

再看一個(gè)例子。

class T1 extends Promise {
}


class T2 extends Promise {
  static get [Symbol.species]() {
    return Promise;
  }
}


new T1(r => r()).then(v => v) instanceof T1 // true
new T2(r => r()).then(v => v) instanceof T2 // false

上面代碼中， T2 定義了 Symbol.species 屬性， T1 沒有。結(jié)果就導(dǎo)致了創(chuàng)建衍生對象時(shí)（ then 方法）， T1 調(diào)用的是自身的構(gòu)造方法，而 T2 調(diào)用的是 Promise 的構(gòu)造方法。

總之， Symbol.species 的作用在于，實(shí)例對象在運(yùn)行過程中，需要再次調(diào)用自身的構(gòu)造函數(shù)時(shí)，會(huì)調(diào)用該屬性指定的構(gòu)造函數(shù)。它主要的用途是，有些類庫是在基類的基礎(chǔ)上修改的，那么子類使用繼承的方法時(shí)，作者可能希望返回基類的實(shí)例，而不是子類的實(shí)例。

Symbol.match

對象的 Symbol.match屬性，指向一個(gè)函數(shù)。當(dāng)執(zhí)行str.match(myObject) 時(shí)，如果該屬性存在，會(huì)調(diào)用它，返回該方法的返回值。

String.prototype.match(regexp)
// 等同于
regexp[Symbol.match](this)


class MyMatcher {
  [Symbol.match](string) {
    return 'hello world'.indexOf(string);
  }
}


'e'.match(new MyMatcher()) // 1

Symbol.replace

對象的Symbol.replace屬性，指向一個(gè)方法，當(dāng)該對象被String.prototype.replace方法調(diào)用時(shí)，會(huì)返回該方法的返回值。

String.prototype.replace(searchValue, replaceValue)
// 等同于
searchValue[Symbol.replace](this, replaceValue)

下面是一個(gè)例子。

const x = {};
x[Symbol.replace] = (...s) => console.log(s);


'Hello'.replace(x, 'World') // ["Hello", "World"]

Symbol.replace 方法會(huì)收到兩個(gè)參數(shù)，第一個(gè)參數(shù)是 replace 方法正在作用的對象，上面例子是 Hello ，第二個(gè)參數(shù)是替換后的值，上面例子是 World 。

Symbol.search

對象的 Symbol.search 屬性，指向一個(gè)方法，當(dāng)該對象被 String.prototype.search 方法調(diào)用時(shí)，會(huì)返回該方法的返回值。

String.prototype.search(regexp)
// 等同于
regexp[Symbol.search](this)


class MySearch {
  constructor(value) {
    this.value = value;
  }
  [Symbol.search](string) {
    return string.indexOf(this.value);
  }
}
'foobar'.search(new MySearch('foo')) // 0

Symbol.split

對象的Symbol.split 屬性，指向一個(gè)方法，當(dāng)該對象被String.prototype.split方法調(diào)用時(shí)，會(huì)返回該方法的返回值。

String.prototype.split(separator, limit)
// 等同于
separator[Symbol.split](this, limit)

下面是一個(gè)例子。

class MySplitter {
  constructor(value) {
    this.value = value;
  }
  [Symbol.split](string) {
    let index = string.indexOf(this.value);
    if (index === -1) {
      return string;
    }
    return [
      string.substr(0, index),
      string.substr(index + this.value.length)
    ];
  }
}


'foobar'.split(new MySplitter('foo'))
// ['', 'bar']


'foobar'.split(new MySplitter('bar'))
// ['foo', '']


'foobar'.split(new MySplitter('baz'))
// 'foobar'

上面方法使用 Symbol.split 方法，重新定義了字符串對象的 split 方法的行為，

Symbol.iterator

對象的Symbol.iterator屬性，指向該對象的默認(rèn)遍歷器方法。

const myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};


[...myIterable] // [1, 2, 3]

對象進(jìn)行for...of循環(huán)時(shí)，會(huì)調(diào)用Symbol.iterator方法，返回該對象的默認(rèn)遍歷器，詳細(xì)介紹參見《Iterator 和 for...of 循環(huán)》一章。

class Collection {
  *[Symbol.iterator]() {
    let i = 0;
    while(this[i] !== undefined) {
      yield this[i];
      ++i;
    }
  }
}


let myCollection = new Collection();
myCollection[0] = 1;
myCollection[1] = 2;


for(let value of myCollection) {
  console.log(value);
}
// 1
// 2

Symbol.toPrimitive

對象的Symbol.toPrimitive 屬性，指向一個(gè)方法。該對象被轉(zhuǎn)為原始類型的值時(shí)，會(huì)調(diào)用這個(gè)方法，返回該對象對應(yīng)的原始類型值。

Symbol.toPrimitive 被調(diào)用時(shí)，會(huì)接受一個(gè)字符串參數(shù)，表示當(dāng)前運(yùn)算的模式，一共有三種模式。

  • Number：該場合需要轉(zhuǎn)成數(shù)值
  • String：該場合需要轉(zhuǎn)成字符串
  • Default：該場合可以轉(zhuǎn)成數(shù)值，也可以轉(zhuǎn)成字符串

let obj = {
  [Symbol.toPrimitive](hint) {
    switch (hint) {
      case 'number':
        return 123;
      case 'string':
        return 'str';
      case 'default':
        return 'default';
      default:
        throw new Error();
     }
   }
};


2 * obj // 246
3 + obj // '3default'
obj == 'default' // true
String(obj) // 'str'

Symbol.toStringTag

對象的Symbol.toStringTag屬性，指向一個(gè)方法。在該對象上面調(diào)用 Object.prototype.toString方法時(shí)，如果這個(gè)屬性存在，它的返回值會(huì)出現(xiàn)在 toString 方法返回的字符串之中，表示對象的類型。也就是說，這個(gè)屬性可以用來定制 [object Object] 或 [object Array] 中 object 后面的那個(gè)字符串。

// 例一
({[Symbol.toStringTag]: 'Foo'}.toString())
// "[object Foo]"


// 例二
class Collection {
  get [Symbol.toStringTag]() {
    return 'xxx';
  }
}
let x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"

ES6 新增內(nèi)置對象的 Symbol.toStringTag 屬性值如下。

  • JSON[Symbol.toStringTag] ：'JSON'
  • Math[Symbol.toStringTag] ：'Math'
  • Module 對象 M[Symbol.toStringTag] ：'Module'
  • ArrayBuffer.prototype[Symbol.toStringTag] ：'ArrayBuffer'
  • DataView.prototype[Symbol.toStringTag] ：'DataView'
  • Map.prototype[Symbol.toStringTag] ：'Map'
  • Promise.prototype[Symbol.toStringTag] ：'Promise'
  • Set.prototype[Symbol.toStringTag] ：'Set'
  • %TypedArray%.prototype[Symbol.toStringTag] ：'Uint8Array'等
  • WeakMap.prototype[Symbol.toStringTag] ：'WeakMap'
  • WeakSet.prototype[Symbol.toStringTag] ：'WeakSet'
  • %MapIteratorPrototype%[Symbol.toStringTag] ：'Map Iterator'
  • %SetIteratorPrototype%[Symbol.toStringTag] ：'Set Iterator'
  • %StringIteratorPrototype%[Symbol.toStringTag] ：'String Iterator'
  • Symbol.prototype[Symbol.toStringTag] ：'Symbol'
  • Generator.prototype[Symbol.toStringTag] ：'Generator'
  • GeneratorFunction.prototype[Symbol.toStringTag] ：'GeneratorFunction'

Symbol.unscopables

對象的Symbol.unscopables 屬性，指向一個(gè)對象。該對象指定了使用 with關(guān)鍵字時(shí)，哪些屬性會(huì)被 with 環(huán)境排除。

Array.prototype[Symbol.unscopables]
// {
//   copyWithin: true,
//   entries: true,
//   fill: true,
//   find: true,
//   findIndex: true,
//   includes: true,
//   keys: true
// }


Object.keys(Array.prototype[Symbol.unscopables])
// ['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'includes', 'keys']

上面代碼說明，數(shù)組有 7 個(gè)屬性，會(huì)被 with 命令排除。

// 沒有 unscopables 時(shí)
class MyClass {
  foo() { return 1; }
}


var foo = function () { return 2; };


with (MyClass.prototype) {
  foo(); // 1
}


// 有 unscopables 時(shí)
class MyClass {
  foo() { return 1; }
  get [Symbol.unscopables]() {
    return { foo: true };
  }
}


var foo = function () { return 2; };


with (MyClass.prototype) {
  foo(); // 2
}

上面代碼通過指定Symbol.unscopables屬性，使得 with 語法塊不會(huì)在當(dāng)前作用域?qū)ふ?foo 屬性，即 foo 將指向外層作用域的變量。

以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號