【ES6脚丫系列】Symbol

摘要：它是语言的第七种数据类型，前六种是布尔值字符串数值对象。在中，根据属性名来进行判断。，是一个布尔值，表示该对象使用时，是否可以展开。等同于，指向该对象的默认遍历器方法，即该对象进行循环时，会调用这个方法，返回该对象的默认遍历器。

本文字数：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
}