ES6的原始資料型別Symbol
-
概述
保證每個屬性的名字都是獨一無二就從根本上防止屬性名的衝突。ES6 引入了一種新的原始資料型別Symbol，表示獨一無二的值。它是 JavaScript 語言的第七種資料型別，前六種是：undefined、null、布林值（Boolean）、字串（String）、數值（Number）、物件（Object）
Symbol 值通過Symbol函式生成。這就是說，物件的屬性名現在可以有兩種型別，一種是原來就有的字串，另一種就是新增的 Symbol 型別。凡是屬性名屬於 Symbol 型別，就都是獨一無二的，可以保證不會與其他屬性名產生衝突。
let s = Symbol(); console.log(typeof s) // "symbol" //上面程式碼中，變數s就是一個獨一無二的值。typeof運算子的結果，表明變數s是 Symbol 資料型別，而不是字串之類的其他型別。
Symbol函式前不能使用new命令，否則會報錯。這是因為生成的 Symbol 是一個原始型別的值，不是物件。也就是說，由於 Symbol 值不是物件，所以不能新增屬性。基本上，它是一種類似於字串的資料型別。
Symbol函式可以接受一個字串作為引數，表示對 Symbol 例項的描述，主要是為了在控制檯顯示，或者轉為字串時，比較容易區分。
如果 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 值不能與其他型別的值進行運算，會報錯。但Symbol 值可以顯式轉為字串。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 //顯示轉為字串 String(sym) // 'Symbol(My symbol)' sym.toString() // 'Symbol(My symbol)' // 轉為布林值，但不能轉為數值 let sym = Symbol(); Boolean(sym) // true !sym // false if (sym) { // ... } Number(sym) // TypeError sym + 2 // TypeError
- 作為屬性名的Symbol
由於每一個 Symbol 值都是不相等的，這意味著 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);
//如果s不放在方括號中，該屬性的鍵名就是字串s，而不是s所代表的那個 Symbol 值。
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');
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語句會按設計的方式工作。
還有一點需要注意，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 }); // 魔術字串
上面程式碼中，字串Triangle就是一個魔術字串。它多次出現，與程式碼形成“強耦合”，不利於將來的修改和維護。
常用的消除魔術字串的方法，就是把它寫成一個變數。
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屬性，這樣就消除了強耦合。
如果仔細分析，可以發現shapeType.triangle等於哪個值並不重要，只要確保不會跟其他shapeType屬性的值衝突即可。因此，這裡就很適合改用 Symbol 值。
const shapeType = {
triangle: Symbol()
};
//除了將shapeType.triangle的值設為一個 Symbol，其他地方都不用修改。
-
屬性名的遍歷
Symbol 作為屬性名，該屬性不會出現在for…in、for…of迴圈中，也不會被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但是，它也不是私有屬性，有一個Object.getOwnPropertySymbols方法，可以獲取指定物件的所有 Symbol 屬性名。Object.getOwnPropertySymbols方法返回一個數組，成員是當前物件的所有用作屬性名的 Symbol 值。
Reflect.ownKeys方法可以返回所有型別的鍵名，包括常規鍵名和 Symbol 鍵名。
由於以 Symbol 值作為名稱的屬性，不會被常規方法遍歷得到。我們可以利用這個特性，為物件定義一些非私有的、但又希望只用於內部的方法。
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屬性是一個 Symbol 值，所以Object.keys(x)、Object.getOwnPropertyNames(x)都無法獲取它。這就造成了一種非私有的內部方法的效果。
- Symbol.for()，Symbol.keyFor()
Symbol.for方法可以重新使用同一個 Symbol 值。它接受一個字串作為引數，然後搜尋有沒有以該引數作為名稱的 Symbol 值。如果有，就返回這個 Symbol 值，否則就新建並返回一個以該字串為名稱的 Symbol 值。
let s1 = Symbol.for('foo');
let s2 = Symbol.for('foo');
s1 === s2 // true s1和s2都是 Symbol 值，但是它們都是同樣引數的Symbol.for方法生成的，所以實際上是同一個值
Symbol.for()與Symbol()這兩種寫法，都會生成新的 Symbol。它們的區別是，前者會被登記在全域性環境中供搜尋，後者不會。Symbol.for()不會每次呼叫就返回一個新的 Symbol 型別的值，而是會先檢查給定的key是否已經存在，如果不存在才會新建一個值。比如，如果你呼叫Symbol.for(“cat”)30 次，每次都會返回同一個 Symbol 值，但是呼叫Symbol(“cat”)30 次，會返回 30 個不同的 Symbol 值。
Symbol.keyFor方法返回一個已登記的 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 值登記的名字，是全域性環境的，可以在不同的 iframe 或 service worker 中取到同一個值。
iframe = document.createElement('iframe');
iframe.src = String(window.location);
document.body.appendChild(iframe);
iframe.contentWindow.Symbol.for('foo') === Symbol.for('foo')
// true iframe 視窗生成的 Symbol 值，可以在主頁面得到。
- 例項：模組的 Singleton 模式
Singleton 模式指的是呼叫一個類，任何時候返回的都是同一個例項。
對於 Node 來說，模組檔案可以看成是一個類。可以把例項放到頂層物件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任何時候載入的都是A的同一個例項。
//全域性變數global._foo是可寫的，任何檔案都可以修改
global._foo = { foo: 'world' };
const a = require('./mod.js');
console.log(a.foo);
//會使得載入mod.js的指令碼都失真。
//為了防止這種情況出現，我們就可以使用 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]不會被無意間覆蓋，但還是可以被改寫。
global[Symbol.for('foo')] = { foo: 'world' };
const a = require('./mod.js');
//如果鍵名使用Symbol方法生成，那麼外部將無法引用這個值，當然也就無法改寫。
// mod.js
const FOO_KEY = Symbol('foo');
// 後面程式碼相同 ……
//上面程式碼將導致其他指令碼都無法引用FOO_KEY。但這樣也有一個問題，就是如果多次執行這個指令碼，每次得到的FOO_KEY都是不一樣的。雖然 Node 會將指令碼的執行結果快取，一般情況下，不會多次執行同一個指令碼，但是使用者可以手動清除快取，所以也不是絕對可靠。
-
內建的 Symbol 值
除了定義自己使用的 Symbol 值以外，ES6 還提供了 11 個內建的 Symbol 值，指向語言內部使用的方法。（1）物件的Symbol.hasInstance屬性，指向一個內部方法。當其他物件使用instanceof運算子，判斷是否為該物件的例項時，會呼叫這個方法。比如，foo instanceof Foo在語言內部，實際呼叫的是FooSymbol.hasInstance。
（2）物件的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.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時有不一樣的結果。
//注意，Symbol.isConcatSpreadable的位置差異，A1是定義在例項上，A2是定義在類本身，效果相同。
（3）物件的Symbol.species屬性，指向一個建構函式。建立衍生物件時，會使用該屬性。
（4）物件的Symbol.match屬性，指向一個函式。當執行str.match(myObject)時，如果該屬性存在，會呼叫它，返回該方法的返回值。
（5）物件的Symbol.replace屬性，指向一個方法，當該物件被String.prototype.replace方法呼叫時，會返回該方法的返回值。
（6）物件的Symbol.search屬性，指向一個方法，當該物件被String.prototype.search方法呼叫時，會返回該方法的返回值。
（7）物件的Symbol.split屬性，指向一個方法，當該物件被String.prototype.split方法呼叫時，會返回該方法的返回值。
（8）物件的Symbol.iterator屬性，指向該物件的預設遍歷器方法
（9）物件的Symbol.toPrimitive屬性，指向一個方法。該物件被轉為原始型別的值時，會呼叫這個方法，返回該物件對應的原始型別值。
Symbol.toPrimitive被呼叫時，會接受一個字串引數，表示當前運算的模式，一共有三種模式。
Number：該場合需要轉成數值
String：該場合需要轉成字串
Default：該場合可以轉成數值，也可以轉成字串
（10）物件的Symbol.toStringTag屬性，指向一個方法。在該物件上面呼叫Object.prototype.toString方法時，如果這個屬性存在，它的返回值會出現在toString方法返回的字串之中，表示物件的型別。也就是說，這個屬性可以用來定製[object Object]或[object Array]中object後面的那個字串。
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’
（11）物件的Symbol.unscopables屬性，指向一個物件。該物件指定了使用with關鍵字時，哪些屬性會被with環境排除。