ES6学习笔记（九）

时间 2019-11-09

原文原文链接

一、概述

ES5的对象属性名都是字符串，这容易形成属性名的冲突。好比，你使用了一个他人提供的对象，但又想为这个对象添加新的方法（mixin模式），新方法的名字就有可能与现有方法产生冲突。若是有一种机制，保证每一个属性的名字都是独一无二的就行了，这样就从根本上防止属性名的冲突。这就是ES6引入Symbol的缘由。javascript

ES6引入了一种新的原始数据类型Symbol，表示独一无二的值。它是JavaScript语言的第七种数据类型，前六种是：Undefined、Null、布尔值（Boolean）、字符串（String）、数值（Number）、对象（Object）。java

Symbol值经过Symbol函数生成。这就是说，对象的属性名如今能够有两种类型，一种是原来就有的字符串，另外一种就是新增的Symbol类型。凡是属性名属于Symbol类型，就都是独一无二的，能够保证不会与其余属性名产生冲突。数组

let s = Symbol();

typeof s
// "symbol"

上面代码中，变量s就是一个独一无二的值。typeof运算符的结果，代表变量s是Symbol数据类型，而不是字符串之类的其余类型。缓存

注意，Symbol函数前不能使用new命令，不然会报错。这是由于生成的Symbol是一个原始类型的值，不是对象。也就是说，因为Symbol值不是对象，因此不能添加属性。基本上，它是一种相似于字符串的数据类型。app

Symbol函数能够接受一个字符串做为参数，表示对Symbol实例的描述，主要是为了在控制台显示，或者转为字符串时，比较容易区分。函数

var s1 = Symbol('foo');
var s2 = Symbol('bar');

s1 // Symbol(foo)
s2 // Symbol(bar)

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

上面代码中，s1和s2是两个Symbol值。若是不加参数，它们在控制台的输出都是Symbol()，不利于区分。有了参数之后，就等于为它们加上了描述，输出的时候就可以分清，究竟是哪个值。ui

注意，Symbol函数的参数只是表示对当前Symbol值的描述，所以相同参数的Symbol函数的返回值是不相等的。this

// 没有参数的状况
var s1 = Symbol();
var s2 = Symbol();

s1 === s2 // false

// 有参数的状况
var s1 = Symbol("foo");
var s2 = Symbol("foo");

s1 === s2 // false

上面代码中，s1和s2都是Symbol函数的返回值，并且参数相同，可是它们是不相等的。spa

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

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

可是，Symbol值能够显式转为字符串。

var sym = Symbol('My symbol');

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

另外，Symbol值也能够转为布尔值，可是不能转为数值。

var sym = Symbol();
Boolean(sym) // true
!sym  // false

if (sym) {
  // ...
}

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

二、做为属性名的Symbol

因为每个Symbol值都是不相等的，这意味着Symbol值能够做为标识符，用于对象的属性名，就能保证不会出现同名的属性。这对于一个对象由多个模块构成的状况很是有用，能防止某一个键被不当心改写或覆盖。

var mySymbol = Symbol();

// 第一种写法
var a = {};
a[mySymbol] = 'Hello!';

// 第二种写法
var a = {
  [mySymbol]: 'Hello!'
};

// 第三种写法
var a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });

// 以上写法都获得一样结果
a[mySymbol] // "Hello!"

上面代码经过方括号结构和Object.defineProperty，将对象的属性名指定为一个Symbol值。

注意，Symbol值做为对象属性名时，不能用点运算符。

var mySymbol = Symbol();
var 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值。

采用加强的对象写法，上面代码的obj对象能够写得更简洁一些。

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

Symbol类型还能够用于定义一组常量，保证这组常量的值都是不相等的。

log.levels = {
  DEBUG: Symbol('debug'),
  INFO: Symbol('info'),
  WARN: Symbol('warn')
};
log(log.levels.DEBUG, 'debug message');
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) { var area = 0; switch (shape) { case 'Triangle': // 魔术字符串 area = .5 * options.width * options.height; break; /* ... more code ... */ } return area; } getArea('Triangle', { width: 100, height: 100 }); // 魔术字符串

上面代码中，字符串“Triangle”就是一个魔术字符串。它屡次出现，与代码造成“强耦合”，不利于未来的修改和维护。

经常使用的消除魔术字符串的方法，就是把它写成一个变量。

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

上面代码中，咱们把“Triangle”写成shapeType对象的triangle属性，这样就消除了强耦合。

若是仔细分析，能够发现shapeType.triangle等于哪一个值并不重要，只要确保不会跟其余shapeType属性的值冲突便可。所以，这里就很适合改用Symbol值。

const shapeType = { triangle: Symbol() };

上面代码中，除了将shapeType.triangle的值设为一个Symbol，其余地方都不用修改。

四、属性名的遍历

Symbol做为属性名，该属性不会出如今for...in、for...of循环中，也不会被Object.keys()、Object.getOwnPropertyNames()返回。可是，它也不是私有属性，有一个Object.getOwnPropertySymbols方法，能够获取指定对象的全部Symbol属性名。

Object.getOwnPropertySymbols方法返回一个数组，成员是当前对象的全部用做属性名的Symbol值。

var obj = {}; var a = Symbol('a'); var b = Symbol('b'); obj[a] = 'Hello'; obj[b] = 'World'; var objectSymbols = Object.getOwnPropertySymbols(obj); objectSymbols // [Symbol(a), Symbol(b)]

下面是另外一个例子，Object.getOwnPropertySymbols方法与for...in循环、Object.getOwnPropertyNames方法进行对比的例子。

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)]

上面代码中，使用Object.getOwnPropertyNames方法得不到Symbol属性名，须要使用Object.getOwnPropertySymbols方法。

另外一个新的API，Reflect.ownKeys方法能够返回全部类型的键名，包括常规键名和Symbol键名。

let obj = { [Symbol('my_key')]: 1, enum: 2, nonEnum: 3 }; Reflect.ownKeys(obj) // [Symbol(my_key), 'enum', 'nonEnum']

因为以Symbol值做为名称的属性，不会被常规方法遍历获得。咱们能够利用这个特性，为对象定义一些非私有的、但又但愿只用于内部的方法。

var size = Symbol('size'); class Collection { constructor() { this[size] = 0; } add(item) { this[this[size]] = 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)]

上面代码中，对象x的size属性是一个Symbol值，因此Object.keys(x)、Object.getOwnPropertyNames(x)都没法获取它。这就形成了一种非私有的内部方法的效果。

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

有时，咱们但愿从新使用同一个Symbol值，Symbol.for方法能够作到这一点。它接受一个字符串做为参数，而后搜索有没有以该参数做为名称的Symbol值。若是有，就返回这个Symbol值，不然就新建并返回一个以该字符串为名称的Symbol值。

var s1 = Symbol.for('foo'); var 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.for("bar") === Symbol.for("bar") // true Symbol("bar") === Symbol("bar") // false

上面代码中，因为Symbol()写法没有登记机制，因此每次调用都会返回一个不一样的值。

Symbol.keyFor方法返回一个已登记的Symbol类型值的key。

var s1 = Symbol.for("foo"); Symbol.keyFor(s1) // "foo" var 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。

var a = require('./mod.js'); console.log(a.foo);

上面代码中，变量a任什么时候候加载的都是A的同一个实例。

可是，这里有一个问题，全局变量global._foo是可写的，任何文件均可以修改。

var a = require('./mod.js'); global._foo = 123;

上面的代码，会使得别的脚本加载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]不会被无心间覆盖，但仍是能够被改写。

var a = require('./mod.js'); global[Symbol.for('foo')] = 123;

若是键名使用Symbol方法生成，那么外部将没法引用这个值，固然也就没法改写。

```javascript // mod.js const FOO_KEY = Symbol('foo');  // 后面代码相同 ……

上面代码将致使其余脚本都没法引用FOO_KEY。但这样也有一个问题，就是若是屡次执行这个脚本，每次获得的FOO_KEY都是不同的。虽然Node会将脚本的执行结果缓存，通常状况下，不会屡次执行同一个脚本，可是用户能够手动清除缓存，因此也不是彻底可靠。

七、内置的Symbol值

除了定义本身使用的Symbol值之外，ES6还提供了11个内置的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; } } 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属性等于true或undefined，都有这个效果。

相似数组的对象也能够展开，但它的Symbol.isConcatSpreadable属性默认为false，必须手动打开。

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); this[Symbol.isConcatSpreadable] = 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.species

对象的Symbol.species属性，指向一个方法。该对象做为构造函数创造实例时，会调用这个方法。即若是this.constructor[Symbol.species]存在，就会使用这个属性做为构造函数，来创造新的实例对象。

Symbol.species属性默认的读取器以下。

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

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)

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)

Symbol.iterator

对象的Symbol.iterator属性，指向该对象的默认遍历器方法。

var myIterable = {}; myIterable[Symbol.iterator] = function* () { yield 1; yield 2; yield 3; }; [...myIterable] // [1, 2, 3]

对象进行for...of循环时，会调用Symbol.iterator方法，返回该对象的默认遍历器，详细介绍参见《Iterator和for...of循环》一章。

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

对象的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'; } } 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'

Symbol.unscopables

对象的Symbol.unscopables属性，指向一个对象。该对象指定了使用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 }