ES6 新增数据类型 Symbol

1.概述

在ES5之前数据类型只有六种是： undefined ,Object, null,Number,String,boolean

ES6 新引用了一种类型 Symbol 作用: 表示独一无二的值。

Symbol 值通过Symeol函数生成的。现在对象的属性名现在可以有两种类型，一种原来就有的字符串，另一种就是新增的Symbol

类型

lets1=Symbol('foo');

lets2=Symbol('bar');

s1// Symbol(foo)

s2// Symbol(bar)

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

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

上面代码中，s1和s2是两个 Symbol 值。如果不加参数，它们在控制台的输出都是Symbol()，不利于区分。有了参数以后，就等于为它们加上了描述，输出的时候就能够分清，到底是哪一个值。

如果 Symbol 的参数是一个对象，就会调用该对象的toString方法，将其转为字符串，然后才生成一个 Symbol 值。

constobj={

toString() {

return'abc';

}

};

constsym=Symbol(obj);

sym// Symbol(abc)

这里有参没参都是不会相等（全等）的因为 Symnol值是唯一的

// 没有参数的情况

lets1=Symbol();

lets2=Symbol();

s1===s2// false

// 有参数的情况

lets1=Symbol('foo');

lets2=Symbol('foo');

s1===s2// false

Symbol 值不能与其他类型的值进行运算，会报错。

letsym=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 值可以显式转为字符串。

letsym=Symbol('My symbol');

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

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

另外，Symbol 值也可以转为布尔值，但是不能转为数值

letsym=Symbol();

Boolean(sym)// true

!sym// false

if(sym) {

// ...

}

Number(sym)// TypeError

sym+2// TypeError

2.Symbol.prototype.description（描述）

创建 Symbol 的时候，可以添加一个描述

constsym=Symbol('foo');

但是，读取这个描述需要将 Symbol 显式转为字符串，即下面的写法。

constsym=Symbol('foo');

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

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

上面的用法不是很方便。ES2019提供了一个实例属性description，直接返回 Symbol 的描述。

const sym = Symbol('foo');

sym.description // "foo"

3.作为属性名的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 值。

let s = Symbol();

let obj = {

[s]: function (arg) { ... }

};

obj[s](123);

上面代码中，如果s不放在方括号中，该属性的键名就是字符串s，而不是s所代表的那个 Symbol 值。

4.消除魔术字符串

魔术字符串指的是，在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码，应该尽量消除魔术字符串，改由含义清晰的变量代替

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'

};

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，其他地方都不用修改

5.属性名的遍历

Symbol 作为属性名，遍历对象的时候，该属性不会出现在for...in、for...of循环中，也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。

但是，它也不是私有属性，有一个Object.getOwnPropertySymbols()方法，可以获取指定对象的所有 Symbol 属性名。该方法返回一个数组，成员是当前对象的所有用作属性名的 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 属性名

6.Symbol.for(),Symbol.keyFor()

有时，我们希望重新使用同一个 Symbol 值，Symbol.for()方法可以做到这一点。它接受一个字符串作为参数，然后搜索有没有以该参数作为名称的 Symbol 值。如果有，就返回这个 Symbol 值，否则就新建一个以该字符串为名称的 Symbol 值，并将其注册到全局

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

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

s1 === s2 // true

上面代码中，s1和s2都是 Symbol 值，但是它们都是由同样参数的Symbol.for方法生成的，所以实际上是同一个值。

7.模块的Singleton模式

Singleton 模式指的是调用一个类，任何时候返回的都是同一个实例

对于 Node 来说，模块文件可以看成是一个类。怎么保证每次执行这个模块文件，返回的都是同一个实例呢？

// 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方法生成，那么外部将无法引用这个值，当然也就无法改写。

8.内置的Symbol值

Symbol.hasInstance

对象的Symbol.hasInstance属性，指向一个内部方法。当其他对象使用instanceof运算符，判断是否为该对象的实例时，会调用这个方法。比如，foo instanceof Foo在语言内部，实际调用的是Foo[Symbol.hasInstance](foo)。

class MyClass {

[Symbol.hasInstance](foo) {

return foo instanceof Array;

}

}

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

上面代码中，MyClass是一个类，new MyClass()会返回一个实例。该实例的Symbol.hasInstance方法，会在进行instanceof运算时自动调用，判断左侧的运算子是否为Array的实例。

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属性等于一个布尔值，表示该对象用于

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是定义在类本身，效果相同。

Symbol.species

对象的Symbol.species属性，指向一个构造函数。创建衍生对象时，会使用该属性。

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的实例，b和c是a的衍生对象。你可能会认为，b和c都是调用数组方法生成的，所以应该是数组（Array的实例），但实际上它们也是MyArray的实例。

Symbol.species属性就是为了解决这个问题而提供的。现在，我们可以为MyArray设置Symbol.species属性。

class MyArray extends Array {

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

}

上面代码中，由于定义了Symbol.species属性，创建衍生对象时就会使用这个属性返回的函数，作为构造函数。这个例子也说明，定义Symbol.species属性要采用get取值器。默认的Symbol.species属性等同于下面的写法。

static get [Symbol.species]() {

return this;

}

现在，再来看前面的例子

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的实例，而直接就是Array的实例。

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没有。结果就导致了创建衍生对象时（then方法），T1调用的是自身的构造方法，而T2调用的是Promise的构造方法。

总之，Symbol.species的作用在于，实例对象在运行过程中，需要再次调用自身的构造函数时，会调用该属性指定的构造函数。它主要的用途是，有些类库是在基类的基础上修改的，那么子类使用继承的方法时，作者可能希望返回基类的实例，而不是子类的实例

Symbol.match

对象的Symbol.match属性，指向一个函数。当执行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'))

上面方法使用Symbol.split方法，重新定义了字符串对象的split方法的行为，

Symbol.iterator

上面方法使用Symbol.split方法，重新定义了字符串对象的split方法的行为，

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环境排除。

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将指向外层作用域的变量。

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 211,884评论 6赞 492
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,347评论 3赞 385
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 157,435评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,509评论 1赞 284
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 65,611评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 49,837评论 1赞 290
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 38,987评论 3赞 408
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,730评论 0赞 267
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,194评论 1赞 303
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,525评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,664评论 1赞 340
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,334评论 4赞 330
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 39,944评论 3赞 313
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,764评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 31,997评论 1赞 266
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,389评论 2赞 360
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,554评论 2赞 349