Symbol

概述

ES5 的對象屬性名都是字符串，這容易造成屬性名的沖突。比如，你使用了一個他人提供的對象，但又想為這個對象添加新的方法（mixin 模式），新方法的名字就有可能與現有方法產生沖突。如果有一種機制，保證每個屬性的名字都是獨一無二的就好了，這樣就從根本上防止屬性名的沖突。這就是 ES6引入Symbol 的原因。
ES6 引入了一種新的原始數據類型Symbol ，表示獨一無二的值。它是 JavaScript 語言的第七種數據類型，前六種是： undefined 、null 、布爾值（Boolean）、字符串（String）、數值（Number）、對象（Object）。
Symbol 值通過Symbol 函數生成。這就是說，對象的屬性名現在可以有兩種類型，一種是原來就有的字符串，另一種就是新增的 Symbol 類型。凡是屬性名屬于 Symbol 類型，就都是獨一無二的，可以保證不會與其他屬性名產生沖突。

let s = Symbol();
s   //Symbol()
typeof s
// "symbol"

注意， Symbol 函數前不能使用new 命令，否則會報錯。這是因為生成的 Symbol 是一個原始類型的值，不是對象。也就是說，由于 Symbol 值不是對象，所以不能添加屬性。基本上，它是一種類似于字符串的數據類型。
Symbol 函數可以接受一個字符串作為參數。

let s1 = Symbol('foo');  
let s2 = Symbol('bar');
s1 // Symbol(foo)
s2 // Symbol(bar)
s1.toString() // "Symbol(foo)"
s2.toString() // "Symbol(bar)"

如果 Symbol 的參數是一個對象，就會調用該對象的toString 方法，將其轉為字符串，然后才生成一個 Symbol 值。

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

注意， Symbol 函數的參數只是表示對當前 Symbol 值的描述，因此相同參數的Symbol 函數的返回值是不相等的。

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

Symbol 值不能與其他類型的值進行運算，會報錯。

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 值可以顯式轉為字符串

let sym = Symbol('My symbol');
String(sym) // 'Symbol(My symbol)'
sym.toString() // 'Symbol(My symbol)'

Symbol 值也可以轉為布爾值，但是不能轉為數值

let sym = Symbol();
Boolean(sym) // true
!sym // false
if (sym) {
}
Number(sym) // TypeError
sym + 2 // TypeError
作為屬性名的 Symbol

由于每一個 Symbol 值都是不相等的，這意味著 Symbol 值可以作為標識符，用于對象的屬性名，就能保證不會出現同名的屬性。

let mySymbol = Symbol();
// 第一種寫法
let a = {};
a[mySymbol] = 'Hello!';
// 第二種寫法
let a = {
[mySymbol]: 'Hello!'
};
// 第三種寫法
let a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });
// 以上寫法都得到同樣結果
a[mySymbol] // "Hello!"

上面代碼通過方括號結構和Object.defineProperty ，將對象的屬性名指定為一個 Symbol 值。
注意，Symbol 值作為對象屬性名時，不能用點運算符。

const mySymbol = Symbol();
const a = {};
a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"

上面代碼中，因為點運算符后面總是字符串，所以不會讀取mySymbol 作為標識名所指代的那個值，導致a 的屬性名實際上是一個字符串，而不是一個Symbol 值。
同理，在對象的內部，使用 Symbol 值定義屬性時，Symbol 值必須放在方括號之中。

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

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

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

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

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

還有一點需要注意，Symbol 值作為屬性名時，該屬性還是公開屬性，不是私有屬性。

實例：消除魔術字符串
function getArea(shape, options) {
let area = 0;
switch (shape) {
case 'Triangle': // 魔術字符串
area = .5 * options.width * options.height;
break;
/* ... more code ... */
}
return area;
}
getArea('Triangle', { width: 100, height: 100 }); // 魔術字符串

提取常量，便于維護。

const shapeType = {
//triangle: 'Triangle'
triangle: Symbol()
};
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 });
屬性名的遍歷

Symbol 作為屬性名，該屬性不會出現在for...in 、for...of 循環(huán)中，也不會被Object.keys() 、Object.getOwnPropertyNames() 、
JSON.stringify() 返回。但是，它也不是私有屬性，有一個Object.getOwnPropertySymbols 方法，可以獲取指定對象的所有 Symbol 屬性名。
Object.getOwnPropertySymbols 方法返回一個數組，成員是當前對象的所有用作屬性名的 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 方法與for...in 循環(huán)、Object.getOwnPropertyNames 方法進行對比的例子。

const obj = {};
let foo = Symbol("foo");
Object.defineProperty(obj, foo, {
value: "foobar",
});
for (let i in obj) {
console.log(i); // 無輸出
}
Object.getOwnPropertyNames(obj)
// []
Object.getOwnPropertySymbols(obj)
// [Symbol(foo)]

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

let obj = {
[Symbol('my_key')]: 1,
enum: 2,
nonEnum: 3
};
Reflect.ownKeys(obj)
// ["enum", "nonEnum", Symbol(my_key)]
Symbol.for()，Symbol.keyFor()

有時，我們希望重新使用同一個 Symbol 值， Symbol.for 方法可以做到這一點。它接受一個字符串作為參數，然后搜索有沒有以該參數作為名稱的Symbol 值。如果有，就返回這個 Symbol 值，否則就新建并返回一個以該字符串為名稱的 Symbol 值。

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

Symbol.for() 與Symbol() 這兩種寫法，都會生成新的 Symbol。
區(qū)別：前者會被登記在全局環(huán)境中供搜索，后者不會。
Symbol.for() 不會每次調用就返回一個新的 Symbol 類型的值，而是會先檢查給定的key 是否已經存在，如果不存在才會新建一個值。

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

上面代碼中，由于Symbol() 寫法沒有登記機制，所以每次調用都會返回一個不同的值。
Symbol.keyFor 方法返回一個已登記的 Symbol 類型值的key 。

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

需要注意的是， Symbol.for 為 Symbol 值登記的名字，是全局環(huán)境的。

Symbol.for() 只會得到一個相同的值，可以在全局環(huán)境中搜索。
Symbol() 每次都會創(chuàng)建一個新的值。
Symbol.keyFor() 只對Symbol.for()的值有效，即在全局環(huán)境中有的值。

內置的 Symbol 值

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

Symbol.hasInstance

對象的Symbol.hasInstance 屬性，指向一個內部方法。當其他對象使用instanceof 運算符，判斷是否為該對象的實例時，會調用這個方法。比如， foo instanceof Foo 在語言內部，實際調用的是FooSymbol.hasInstance 。

class MyClass {
[Symbol.hasInstance](foo) {
return foo instanceof Array;
}
}
[1, 2, 3] instanceof new MyClass() // true
Symbol.isConcatSpreadable

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

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']

上面代碼說明，數組的默認行為是可以展開， Symbol.isConcatSpreadable 默認等于undefined 。該屬性等于true 時，也有展開的效果。
類似數組的對象正好相反，默認不展開。它的Symbol.isConcatSpreadable 屬性設為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.species

對象的Symbol.species 屬性，指向當前對象的構造函數。創(chuàng)造實例時，默認會調用這個方法，即使用這個屬性返回的函數當作構造函數，來創(chuàng)造新的實例對象。

定義Symbol.species 屬性要采用get讀取器。
class MyArray extends Array {
// 覆蓋父類 Array 的構造函數
static get [Symbol.species]() { return Array; }
}
let a = new MyArray(1,2,3);
let mapped = a.map(x => x * x);
mapped instanceof MyArray // false
mapped instanceof Array // true

上面代碼中，由于構造函數被替換成了Array 。所以， mapped 對象不是MyArray 的實例，而是Array 的實例。

Symbol.match

對象的Symbol.match 屬性，指向一個函數。當執(zhí)行str.match(myObject) 時，如果該屬性存在，會調用它，返回該方法的返回值。

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 屬性，指向一個方法，當該對象被String.prototype.replace 方法調用時，會返回該方法的返回值。

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

下面是一個例子。

const x = {};
x[Symbol.replace] = (...s) => console.log(s);
'Hello'.replace(x, 'World') // ["Hello", "World"]

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

Symbol.search

對象的Symbol.search 屬性，指向一個方法，當該對象被String.prototype.search 方法調用時，會返回該方法的返回值。

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 屬性，指向一個方法，當該對象被String.prototype.split 方法調用時，會返回該方法的返回值。

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

下面是一個例子。

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.iterator

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

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

對象的Symbol.toPrimitive 屬性，指向一個方法。該對象被轉為原始類型的值時，會調用這個方法，返回該對象對應的原始類型值。
Symbol.toPrimitive 被調用時，會接受一個字符串參數，表示當前運算的模式，一共有三種模式。

  • Number：該場合需要轉成數值
  • String：該場合需要轉成字符串
  • Default：該場合可以轉成數值，也可以轉成字符串
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 屬性，指向一個方法。在該對象上面調用Object.prototype.toString 方法時，如果這個屬性存在，它的返回值會出現在toString 方法返回的字符串之中，表示對象的類型。也就是說，這個屬性可以用來定制[object Object] 或[object Array] 中object 后面的那個字符串。

// 例一
({[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 新增內置對象的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 屬性，指向一個對象。該對象指定了使用with 關鍵字時，哪些屬性會被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']

上面代碼說明，數組有 7 個屬性，會被with 命令排除。

// 沒有 unscopables 時
class MyClass {
foo() { return 1; }
}
var foo = function () { return 2; };
with (MyClass.prototype) {
foo(); // 1
}
// 有 unscopables 時
class MyClass {
foo() { return 1; }
get [Symbol.unscopables]() {
return { foo: true };
}
}
var foo = function () { return 2; };
with (MyClass.prototype) {
foo(); // 2
}

上面代碼通過指定Symbol.unscopables 屬性，使得with 語法塊不會在當前作用域尋找foo 屬性，即foo 將指向外層作用域的變量。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容