摘要：它是語言的第七種數據類型，前六種是布爾值字符串數值對象。在中，根據屬性名來進行判斷。，是一個布爾值，表示該對象使用時，是否可以展開。等同于，指向該對象的默認遍歷器方法，即該對象進行循環時，會調用這個方法，返回該對象的默認遍歷器。

本文字數：3000+，閱讀時間6分鐘。

如果有理解不到位的地方，歡迎大家糾錯。如果覺得還可以，希望大家可以點個贊。 謝謝大家。

目錄

一、Symbol是什么？

二、Symbol和對象的關系

三、實例：消除魔術字符串

四、Symbol和遍歷

五、Symbol.for()，Symbol.keyFor()

六、Symbol內置屬性（多種）

【01】[Symbol.hasInstance]

【02】Symbol.isConcatSpreadable

【03】Symbol.species

【04】Symbol.match

【05】Symbol.replace

【06】Symbol.search

【07】Symbol.split

【08】Symbol.iterator

【09】Symbol.toPrimitive

【10】[Symbol.toStringTag]:"str"

【11】Symbol.unscopables

Symbol是新的原始類型，不是對象。表示獨一無二的值。

它是JavaScript語言的第七種數據類型，前六種是：Undefined、Null、布爾值（Boolean）、字符串（String）、數值（Number）、對象（Object）。

使用typeof會返回“symbol"

typeof Symbol();//“symbol”

【02】語法：

Symbol值通過Symbol函數生成。

Symbol函數前不能使用new命令，否則會報錯。

寫法1：

let sym = Symbol();

var s1 = Symbol("foo");

Symbol函數可以接受一個字符串作為參數，表示對Symbol實例的描述。
相同參數的Symbol函數的返回值是不相等的。
作用：便于區分

在控制臺顯示。否則輸出都是Symbol()。

轉為字符串時。

寫法2：

let sym = Symbol.for("abc");

【03】Symbol用途：

可以防止對象的屬性名沖突。

ES5的對象屬性名都是字符串，容易造成屬性名的沖突。

當使用別人提供的對象時，你可能由于對這個對象的不熟悉，而操作屬性名沖突（比如在添加屬性名時）。

對象的屬性名現在可以有兩種類型：

一種是字符串。

一種是Symbol類型。

【04】symbol創建后就不可變更。

【05】Symbol值不是對象，所以不能添加屬性（在嚴格模式下嘗試設置屬性會得到TypeError的錯誤）。

【06】Symbol值不能被自動轉換為字符串，可以顯式轉為字符串。拼接symbol與字符串會報錯：TypeError錯誤。

通過String(symbolEle)或symbolEle.toString()可以顯式地將symbol轉換為一個字符串。

例子：

var 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

例子：

var sym = Symbol("My symbol");
String(sym) // "Symbol(My symbol)"
sym.toString() // "Symbol(My symbol)"

【07】Symbol值可以轉為布爾值。

寫法：

var sym = Symbol();
Boolean(sym) // true
!sym  // false
if (sym) { // ...
}

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

【09】不能轉為數值。不能用Number(Symbol變量)進行轉換。不能symbol變量和數值進行運算，比如加減等。

例子：

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

【10】對不兼容的瀏覽器，使用一個polyfill，例如core.js。

【01】把Symbol作為對象的屬性名，可以防止屬性名被改寫或覆蓋。

寫法：

【02】以對象+“.”+Symbol變量賦值時，這等于給對象填加普通的字符串屬性，而不是Symbol。

因為點運算符后接字符串。所以不會找變量所對應的值，而是把變量名作為字符串。

var a ={},mySymbol =Symbol()
a.mySymbol = "zyx456";//這時等于給對象加普通的字符串屬性名。

例子：

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

a.mySymbol = "Hello!";
a[mySymbol] // undefined
a["mySymbol"] // "Hello!"
console.log(a);//{ mySymbol: "Hello!" }

【03】在對象的{}內部，Symbol必須放在方括號之中。

否則，就只是代表該字符串屬性名。

【04】Symbol類型可以作為屬性值。用于定義一組常量，保證這組常量的值都是不相等的。

例子：

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");}}

【05】Symbol值作為屬性名時，是公開屬性，不是私有屬性。

例子：

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

采用增強的對象寫法，上面代碼的obj對象可以寫得更簡潔一些。(zyx456：就是簡化的對象寫法。省略function關鍵字)

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

01，魔術字符串指的是：

zyx456：指的是函數中的判斷條件（字符串或數值），應該修改為可變化的變量，作為函數參數輸入。

否則，一旦判斷條件改變了，就得再次修改該函數，不利于維護。

可以把變量存放在一個對象里。變量名作為屬性名，Symbol()作為它的屬性值。
我們實際需要使用的是屬性名，屬性值并不重要，可以用Symbol作為屬性值來保證唯一性。
在switch中，根據case 屬性名 來進行判斷。

這里說的是判斷條件是什么并不重要，重要是能根據這個條件判斷就可以了。看下面的例子就清楚了。

例子:

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

    switch (shape) {
        case "Triangle": // 魔術字符串
            area = .5 * options.width * options.height;
            break;/* ... more code ... */
    }
    return area;
}
getArea("Triangle", {width: 100, height: 100}); // 魔術字符串

修改為：

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

因此，這里就很適合改用Symbol值。

const shapeType = {
  triangle: Symbol()};

【01】Symbol作為屬性名時：

不會出現在for...in、for...of循環中。

不會被Object.keys()、Object.getOwnPropertyNames()返回

【02】Object.getOwnPropertySymbols()。

返回一個數組，成員是對象的所有作為屬性名的Symbol值，不包括屬性值。

例如：[Symbol(a),Symbol(b)]

【03】Reflect.ownKeys()可以返回所有類型的鍵名，包括常規鍵名和Symbol鍵名。

返回的是一個數組，其中Symbol為Symbol(stringEle)。其他為字符串形式。

【04】可以用Symbol()為對象定義一些非私有的、但又希望只用于內部的方法。

例子：

var obj = {};
var a = Symbol("a");
var b = Symbol.for("b");

obj[a] = "Hello";
obj[b] = "World";
var objectSymbols = Object.getOwnPropertySymbols(obj);

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

例子：

var obj = {};
var foo = Symbol("foo");

Object.defineProperty(obj, foo, {value: "foobar",});
for (var i in obj) {
  console.log(i); // 無輸出
}

Object.getOwnPropertyNames(obj)// []

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

例子：

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

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

例子：

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

    add(item) {
        this[this[size]] = item;              
  //size是Symbol，this[size]是構造器中第一次賦值是的0.
            //this[this[size]]=item;
            //就是累次給Collection添加Collection[0]=item;
        this[size]++;
    }

    static sizeOf(instance) {
        return instance[size];
    }
}
var 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)]

【01】Symbol.for("字符串")

01、接受一個字符串作為參數。
02、然后在全局作用域中搜索是否有以該參數作為名稱的Symbol值。
如果有，就返回這個Symbol值（2個Symbol變量全等）。
否則就新建并返回一個以該字符串為名稱的Symbol值。
03、用途：重復使用同一個Symbol值。
04、可以在不同的iframe或service worker中取到同一個值。
05、通過Symbol.for()創建的symbol會保存在Symbol注冊表中。
06、Symbol.for()與Symbol()
前者：會全局搜索是否有存在。后者不會。

【02】Symbol.keyFor(Symbol.for(字符串Str));

參數是Symbol變量。用于判斷Symbol變量的描述字符串是否已登記。

使用Symbol.for(string);會登記str。

如果未登記，返回undefined。
如果是第一次登記，返回已登記的Symbol 類型值的字符串str。
如果是已經登記過的同一個Symbol變量，返回undefined。

Symbol.keyFor(Symbol.for("foo"));

例子：

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

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

let s3 = Symbol();
console.log(Symbol.keyFor(s3));//undefined

【】

var s1 = Symbol.for("foo");var s2 = Symbol.for("foo");

s1 === s2 // true

例子：

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

例子：

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

iframe.contentWindow.Symbol.for("foo") === Symbol.for("foo");// true

01，指向一個內部方法。

Constructor[Symbol.hasInstace](){}

對象使用instanceof運算符時，會調用這個方法，判斷該對象是否為某個構造函數的實例。

比如，foo instanceof Foo在語言內部，實際調用的是FooSymbol.hasInstance。

class MyClass {
    [Symbol.hasInstance](foo) {
        return foo instanceof Array;
    }
}
var o = new MyClass();
o instanceof Array // false

01，是一個布爾值，表示該對象使用Array.prototype.concat()時，是否可以展開。

如果設置為false：

arr[Symbol.isConcatSpreadable] = false;

那么，在arr1.concat(arr)中，將以整體的方式插入arr1中。形成多維數組。

02，數組的Symbol.isConcatSpreadable屬性默認為true，表示可以展開。

03，類數組的對象也可以展開，但它的Symbol.isConcatSpreadable屬性默認為false，必須手動打開。

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

例子：

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 {[Symbol.isConcatSpreadable]() {return true;}}
class A2 extends Array {[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時有不一樣的結果。

指向一個方法。

對象作為構造函數創造實例時，會調用這個方法。

即如果this.constructor[Symbol.species]存在，就會使用這個屬性作為構造函數，來創造新的實例對象。

Symbol.species屬性默認的讀取器如下。

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

語言內部的替換：

01，指向一個方法。當執行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

指向一個方法。

當該對象被String.prototype.replace方法調用時，會返回該方法的返回值。

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

指向一個方法。

當該對象被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

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

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

01，指向該對象的默認遍歷器方法，即該對象進行for...of循環時，會調用這個方法，返回該對象的默認遍歷器。（指向一個函數）

02，zyx456，是一個指針。可以作為屬性一樣的使用。指向遍歷器方法。

1,2,3

03，可以像函數調用一樣。

let arr = ["a", "b", "c"];
let iter = arr[Symbol.iterator]();

zyx456：iter就是遍歷器對象了。

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被調用時，會接受一個字符串參數，表示當前運算的模式，一共有三種模式。

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"

指向一個方法。

在該對象上面調用Object.prototype.toString方法時，如果這個屬性存在，它的返回值會出現在toString方法返回的字符串之中，表示對象的類型。

在對象中設置這個屬性[Symbol.toStringTag]為任意字符串XXX，那么，這個對象調用toString()會輸出為"[object XXX]"。

也就是說，這個屬性可以用來定制“[object Object]"或"[object Array]"中object后面的那個字符串。

console.log({[Symbol.toStringTag]: "Foo"}.toString())// "[object Foo]"

class Collection {get [Symbol.toStringTag]() {return "xxx";}}
var 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"

（zyx456：僅放置，因為嚴格模式不能用with）

指向一個對象。

該對象指定了使用with關鍵字時，哪些屬性會被with環境排除。

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

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

上面代碼說明，數組有6個屬性，會被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
}