ES6之symbol
date
Jun 13, 2018
slug
dcqsqtcq
status
Published
tags
JavaScript
summary
type
Post
ES6 引入了一种新的原始数据类型 Symbol，表示独一无二的值。它是 JavaScript 语言的第七种数据类型，前六种是：undefined、null、布尔值（Boolean）、字符串（String）、数值（Number）、对象（Object）。凡是属性名属于 Symbol 类型，就都是独一无二的，可以保证不会与其他属性名产生冲突。
Symbol 值通过 Symbol 函数生成。这就是说，对象的属性名现在可以有两种类型，一种是原来就有的字符串，另一种就是新增的 Symbol 类型。注意，Symbol 函数前不能使用 new 命令，否则会报错。这是因为生成的 Symbol 是一个原始类型的值，不是对象。也就是说，由于 Symbol 值不是对象，所以不能添加属性。基本上，它是一种类似于字符串的数据类型。
Symbol 函数可以接受一个字符串作为参数，表示对 Symbol 实例的描述，主要是为了在控制台显示，或者转为字符串时，比较容易区分。如果 Symbol 的参数是一个对象，就会调用该对象的 toString 方法，将其转为字符串，然后才生成一个 Symbol 值。
let s = Symbol();typeof s// "symbol"let s1 = Symbol('foo');let s2 = Symbol('bar');s1 // Symbol(foo)s2 // Symbol(bar)s1.toString() // "Symbol(foo)"s2.toString() // "Symbol(bar)"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 // falseSymbol 值不能与其他类型的值进行运算，会报错。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 stringlet sym = Symbol();Boolean(sym) // true!sym // falseif (sym) { // ...}Number(sym) // TypeErrorsym + 2 // TypeErrorES2019 提供了一个实例属性 description，直接返回 Symbol 的描述。
const sym = Symbol('foo');sym.description // "foo"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 });仔细分析，可以发现 shapeType.triangle 等于哪个值并不重要，只要确保不会跟其他 shapeType 属性的值冲突即可。因此，这里就很适合改用 Symbol 值。下面代码中，除了将 shapeType.triangle 的值设为一个 Symbol，其他地方都不用修改。
const shapeType = { triangle: Symbol()};属性名的遍历
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)]另一个新的 API，Reflect.ownKeys()方法可以返回所有类型的键名，包括常规键名和 Symbol 键名。
let obj = { [Symbol('my_key')]: 1, enum: 2, nonEnum: 3};Reflect.ownKeys(obj)// ["enum", "nonEnum", Symbol(my_key)]由于以 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) // 0x.add('foo');Collection.sizeOf(x) // 1Object.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 值，Symbol.for()方法可以做到这一点。它接受一个字符串作为参数，然后搜索有没有以该参数作为名称的 Symbol 值。如果有，就返回这个 Symbol 值，否则就新建一个以该字符串为名称的 Symbol 值，并将其注册到全局。
let s1 = Symbol.for('foo');let s2 = Symbol.for('foo');s1 === s2 // trueSymbol.for()与 Symbol()这两种写法，都会生成新的 Symbol。它们的区别是，前者会被登记在全局环境中供搜索，后者不会。Symbol.for()不会每次调用就返回一个新的 Symbol 类型的值，而是会先检查给定的 key 是否已经存在，如果不存在才会新建一个值。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 值登记的名字，是全局环境的，不管有没有在全局环境运行。Symbol.for()的这个全局登记特性，可以用在不同的 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实例：模块的 Singleton 模式
Singleton 模式指的是调用一个类，任何时候返回的都是同一个实例。对于 Node 来说，模块文件可以看成是一个类。怎么保证每次执行这个模块文件，返回的都是同一个实例呢？
很容易想到，可以把实例放到顶层对象 global。但是，这里有一个问题，全局变量 global.xxx 是可写的，任何文件都可以修改。为了防止这种情况出现，我们就可以使用 Symbol。
// mod.jsconst FOO_KEY = Symbol.for('foo');function A() { this.foo = 'hello';}if (!global[FOO_KEY]) { global[FOO_KEY] = new A();}module.exports = global[FOO_KEY];// a.jsglobal[Symbol.for('foo')] = { foo: 'world' };const a = require('./mod.js');上面代码中，可以保证 global[FOO_KEY]不会被无意间覆盖，但还是可以被改写。如果键名使用 Symbol 方法生成，那么外部将无法引用这个值，当然也就无法改写。
// mod.jsconst FOO_KEY = Symbol('foo');// 后面代码相同 ……上面代码将导致其他脚本都无法引用 FOO_KEY。但这样也有一个问题，就是如果多次执行这个脚本，每次得到的 FOO_KEY 都是不一样的。所以也不是绝对可靠。
内置的 Symbol 值
下面提到的属性，可以看做 C++中运算符的重载，即通过 class 方式（继承原数据类型），添加 Symbol 方式对内置属性进行改写，以支持自定义。所以之前 ES6 中对象的扩展里，很多地方都提到排除 Symbol 值。
Symbol.hasInstance
对象的 Symbol.hasInstance 属性，指向一个内部方法。当其他对象使用 instanceof 运算符，判断是否为该对象的实例时，会调用这个方法。比如，foo instanceof Foo 在语言内部，实际调用的是 FooSymbol.hasInstance。
class Even { static [Symbol.hasInstance](obj) { return Number(obj) % 2 === 0; }}// 等同于const Even = { [Symbol.hasInstance](obj) { return Number(obj) % 2 === 0; }};1 instanceof Even // false2 instanceof Even // true12345 instanceof Even // falseSymbol.isConcatSpreadable
对象的 Symbol.isConcatSpreadable 属性等于一个布尔值，表示该对象用于 Array.prototype.concat()时，是否可以展开。
- 数组的 Symbol.isConcatSpreadable 默认等于 undefined，默认行为是可以展开。该属性设为 true 时，也有展开的效果。
- 类似数组的对象正好相反，默认不展开。它的 Symbol.isConcatSpreadable 属性设为 true，才可以展开。
// 数组let arr1 = ['c', 'd'];['a', 'b'].concat(arr1, 'e') // ['a', 'b', 'c', 'd', 'e']arr1[Symbol.isConcatSpreadable] // undefinedlet 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 { 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]]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 // truec instanceof MyArray // true上面代码中，子类 MyArray 继承了父类 Array，a 是 MyArray 的实例，b 和 c 是 a 的衍生对象。你可能会认为，b 和 c 都是调用数组方法生成的，所以应该是数组（Array 的实例），但实际上它们也是 MyArray 的实例。Symbol.species 属性就是为了解决这个问题而提供的。
class MyArray extends Array { static get [Symbol.species]() { return Array; }}const a = new MyArray();const b = a.map(x => x);b instanceof MyArray // falseb instanceof Array // true再来看一个例子
class T1 extends Promise {}class T2 extends Promise { static get [Symbol.species]() { return Promise; }}new T1(r => r()).then(v => v) instanceof T1 // truenew T2(r => r()).then(v => v) instanceof T2 // false总之，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()) // 1Symbol.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')) // 0Symbol.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 属性，指向该对象的默认遍历器方法。对象进行 for…of 循环时，会调用 Symbol.iterator 方法，返回该对象的默认遍历器，详细介绍参见《Iterator 和 for…of 循环》一章。
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 // 2463 + obj // '3default'obj == 'default' // trueString(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 属性值如下。
- JSONSymbol.toStringTag：‘JSON’
- MathSymbol.toStringTag：‘Math’
- Module 对象 MSymbol.toStringTag：‘Module’
- ArrayBuffer.prototypeSymbol.toStringTag：‘ArrayBuffer’
- DataView.prototypeSymbol.toStringTag：‘DataView’
- Map.prototypeSymbol.toStringTag：‘Map’
- Promise.prototypeSymbol.toStringTag：‘Promise’
- Set.prototypeSymbol.toStringTag：‘Set’
- %TypedArray%.prototypeSymbol.toStringTag：’Uint8Array’等
- WeakMap.prototypeSymbol.toStringTag：‘WeakMap’
- WeakSet.prototypeSymbol.toStringTag：‘WeakSet’
- %MapIteratorPrototype%Symbol.toStringTag：‘Map Iterator’
- %SetIteratorPrototype%Symbol.toStringTag：‘Set Iterator’
- %StringIteratorPrototype%Symbol.toStringTag：‘String Iterator’
- Symbol.prototypeSymbol.toStringTag：‘Symbol’
- Generator.prototypeSymbol.toStringTag：‘Generator’
- GeneratorFunction.prototypeSymbol.toStringTag：‘GeneratorFunction’
Symbol.unscopables
对象的 Symbol.unscopables 属性，指向一个对象。该对象指定了使用 with 关键字时，哪些属性会被 with 环境排除。