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 }

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。