圖片.png

【ES6腳丫系列】Symbol

如果有理解不到位的地方稻据，歡迎大家糾錯艾猜。如果覺得還可以，希望大家可以點個贊捻悯。 謝謝大家匆赃。

我寫的是自己的體會。

目錄

一今缚、Symbol是什么算柳？

二、Symbol和對象的關(guān)系

三姓言、實例：消除魔術(shù)字符串

四瞬项、Symbol和遍歷

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

六囱淋、Symbol內(nèi)置屬性（多種）

• Symbol.hasInstance

• Symbol.isConcatSpreadable

• Symbol.species

• Symbol.match

• Symbol.replace

• Symbol.search

• Symbol.split

• Symbol.iterator

• Symbol.toPrimitive

• [Symbol.toStringTag]:"str"

• Symbol.unscopables

一猪杭、Symbol是什么？

Symbol是新的原始類型绎橘，不是對象胁孙。表示獨一無二的值。

它是JavaScript語言的第七種數(shù)據(jù)類型称鳞，前六種是：Undefined涮较、Null、布爾值（Boolean）冈止、字符串（String）狂票、數(shù)值（Number）、對象（Object）熙暴。

使用typeof會返回“symbol"

typeof Symbol();//“symbol”

img

【02】語法：

Symbol值通過Symbol函數(shù)生成闺属。

Symbol函數(shù)前不能使用new命令，否則會報錯周霉。

寫法1：

let sym = Symbol();

var s1 = Symbol('foo');

Symbol函數(shù)可以接受一個字符串作為參數(shù)掂器，表示對Symbol實例的描述。

相同參數(shù)的Symbol函數(shù)的返回值是不相等的俱箱。

作用：便于區(qū)分

• 在控制臺顯示国瓮。否則輸出都是Symbol()。
• 轉(zhuǎn)為字符串時狞谱。

寫法2：

let sym = Symbol.for("abc");

【03】Symbol用途：

• 可以防止對象的屬性名沖突乃摹。

ES5的對象屬性名都是字符串，容易造成屬性名的沖突跟衅。

當(dāng)使用別人提供的對象時孵睬，你可能由于對這個對象的不熟悉，而操作屬性名沖突（比如在添加屬性名時）伶跷。

對象的屬性名現(xiàn)在可以有兩種類型：

• 一種是字符串掰读。
• 一種是Symbol類型。

【04】symbol創(chuàng)建后就不可變更撩穿。

【05】Symbol值不是對象磷支，所以不能添加屬性（在嚴(yán)格模式下嘗試設(shè)置屬性會得到TypeError的錯誤）。

【06】Symbol值不能被自動轉(zhuǎn)換為字符串食寡，可以顯式轉(zhuǎn)為字符串。拼接symbol與字符串會報錯：TypeError錯誤廓潜。

通過String(symbolEle)或symbolEle.toString()可以顯式地將symbol轉(zhuǎn)換為一個字符串抵皱。

例子：

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值可以轉(zhuǎn)為布爾值善榛。

寫法：

var sym = Symbol();
Boolean(sym) // true
!sym  // false
if (sym) { // ...
}

【08】Symbol值不能與其他類型的值進(jìn)行運(yùn)算，會報錯呻畸。

【09】不能轉(zhuǎn)為數(shù)值移盆。不能用Number(Symbol變量)進(jìn)行轉(zhuǎn)換。不能symbol變量和數(shù)值進(jìn)行運(yùn)算伤为，比如加減等咒循。

例子：

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

【10】對不兼容的瀏覽器，使用一個polyfill绞愚，例如core.js叙甸。

二、Symbol和對象的關(guān)系

【01】把Symbol作為對象的屬性名位衩，可以防止屬性名被改寫或覆蓋裆蒸。

寫法：

【02】以對象+“.”+Symbol變量賦值時，這等于給對象填加普通的字符串屬性糖驴，而不是Symbol僚祷。

因為點運(yùn)算符后接字符串。所以不會找變量所對應(yīng)的值贮缕，而是把變量名作為字符串辙谜。

var a ={},mySymbol =Symbol()
a.mySymbol = "吃碼小妖";//這時等于給對象加普通的字符串屬性名。

例子：

var mySymbol = Symbol();var a = {};

a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"
console.log(a);//{ mySymbol: 'Hello!' }

【03】在對象的{}內(nèi)部感昼，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);

采用增強(qiáng)的對象寫法号醉，上面代碼的obj對象可以寫得更簡潔一些。(吃碼小妖：就是簡化的對象寫法辛块。省略function關(guān)鍵字)

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

三畔派、實例：消除魔術(shù)字符串

01，魔術(shù)字符串指的是：

吃碼小妖：指的是函數(shù)中的判斷條件（字符串或數(shù)值）润绵，應(yīng)該修改為可變化的變量线椰，作為函數(shù)參數(shù)輸入。

否則尘盼，一旦判斷條件改變了憨愉，就得再次修改該函數(shù)烦绳，不利于維護(hù)。

可以把變量存放在一個對象里配紫。變量名作為屬性名径密，Symbol()作為它的屬性值。

我們實際需要使用的是屬性名躺孝，屬性值并不重要享扔，可以用Symbol作為屬性值來保證唯一性。

在switch中植袍，根據(jù)case 屬性名 來進(jìn)行判斷惧眠。

這里說的是判斷條件是什么并不重要，重要是能根據(jù)這個條件判斷就可以了奋单★笔裕看下面的例子就清楚了。

例子:

function getArea(shape, options) {
    var area = 0;

    switch (shape) {
        case 'Triangle': // 魔術(shù)字符串
            area = .5 * options.width * options.height;
            break;/* ... more code ... */
    }
    return area;
}
getArea('Triangle', {width: 100, height: 100}); // 魔術(shù)字符串

修改為：

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

四、Symbol和遍歷

【01】Symbol作為屬性名時：

不會出現(xiàn)在for...in贷笛、for...of循環(huán)中应又。

不會被Object.keys()、Object.getOwnPropertyNames()返回

【02】Object.getOwnPropertySymbols()乏苦。

返回一個數(shù)組株扛，成員是對象的所有作為屬性名的Symbol值，不包括屬性值汇荐。

例如：[Symbol(a),Symbol(b)]

【03】Reflect.ownKeys()可以返回所有類型的鍵名洞就，包括常規(guī)鍵名和Symbol鍵名。

返回的是一個數(shù)組掀淘，其中Symbol為Symbol(stringEle)旬蟋。其他為字符串形式。

【04】可以用Symbol()為對象定義一些非私有的革娄、但又希望只用于內(nèi)部的方法倾贰。

例子：

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]是構(gòu)造器中第一次賦值是的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)]

五拦惋、Symbol.for()匆浙，Symbol.keyFor()

【01】Symbol.for('字符串')

01、接受一個字符串作為參數(shù)厕妖。
02首尼、然后在全局作用域中搜索是否有以該參數(shù)作為名稱的Symbol值。

如果有，就返回這個Symbol值（2個Symbol變量全等）饰恕。
否則就新建并返回一個以該字符串為名稱的Symbol值挠羔。

03井仰、用途：重復(fù)使用同一個Symbol值埋嵌。

04、可以在不同的iframe或service worker中取到同一個值俱恶。

05雹嗦、通過Symbol.for()創(chuàng)建的symbol會保存在Symbol注冊表中。

06合是、Symbol.for()與Symbol()
前者：會全局搜索是否有存在了罪。后者不會。

【02】Symbol.keyFor(Symbol.for(字符串Str));

參數(shù)是Symbol變量聪全。用于判斷Symbol變量的描述字符串是否已登記泊藕。

使用Symbol.for(string);會登記str。

如果未登記难礼，返回undefined娃圆。

如果是第一次登記，返回已登記的Symbol 類型值的字符串str蛾茉。
如果是已經(jīng)登記過的同一個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

六谦炬、Symbol內(nèi)置屬性（多種）

【01】[Symbol.hasInstance]

01悦屏，指向一個內(nèi)部方法。

ConstructorSymbol.hasInstace{}

對象使用instanceof運(yùn)算符時键思，會調(diào)用這個方法础爬，判斷該對象是否為某個構(gòu)造函數(shù)的實例。

比如吼鳞，foo instanceof Foo在語言內(nèi)部看蚜，實際調(diào)用的是FooSymbol.hasInstance。

class MyClass {
    [Symbol.hasInstance](foo) {
        return foo instanceof Array;
    }
}
var o = new MyClass();
o instanceof Array // false

【02】Symbol.isConcatSpreadable

01赖条，是一個布爾值失乾，表示該對象使用Array.prototype.concat()時，是否可以展開纬乍。

如果設(shè)置為false：

arr[Symbol.isConcatSpreadable] = false;

那么碱茁，在arr1.concat(arr)中，將以整體的方式插入arr1中仿贬。形成多維數(shù)組纽竣。

02，數(shù)組的Symbol.isConcatSpreadable屬性默認(rèn)為true，表示可以展開蜓氨。

03聋袋，類數(shù)組的對象也可以展開，但它的Symbol.isConcatSpreadable屬性默認(rèn)為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是可擴(kuò)展的，類A2是不可擴(kuò)展的顷霹，所以使用concat時有不一樣的結(jié)果咪惠。

【03】Symbol.species

指向一個方法。

對象作為構(gòu)造函數(shù)創(chuàng)造實例時淋淀，會調(diào)用這個方法遥昧。

即如果this.constructor[Symbol.species]存在，就會使用這個屬性作為構(gòu)造函數(shù)朵纷，來創(chuàng)造新的實例對象炭臭。

Symbol.species屬性默認(rèn)的讀取器如下。

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

語言內(nèi)部的替換：

【04】Symbol.match

01柴罐，指向一個方法徽缚。當(dāng)執(zhí)行str.match(myObject)時，如果該屬性存在革屠，會調(diào)用它凿试，返回該方法的返回值。String.prototype.match(regexp) // 等同于

regexp[Symbol.match](this)

class MyMatcher {    [Symbol.match](string) {    
    return 'hello world'.indexOf(string);    }}
'e'.match(new MyMatcher()) // 1

【05】Symbol.replace

指向一個方法似芝。

當(dāng)該對象被String.prototype.replace方法調(diào)用時那婉，會返回該方法的返回值。

String.prototype.replace(searchValue, replaceValue)
// 等同于
searchValue[Symbol.replace](this, replaceValue)

【06】Symbol.search

指向一個方法党瓮。

當(dāng)該對象被String.prototype.search方法調(diào)用時详炬，會返回該方法的返回值。

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

【07】Symbol.split

指向一個方法寞奸，當(dāng)該對象被String.prototype.split方法調(diào)用時呛谜，會返回該方法的返回值。

String.prototype.split(separator, limit)
// 等同于
separator[Symbol.split](this, limit)

【08】Symbol.iterator

01枪萄，指向該對象的默認(rèn)遍歷器方法隐岛，即該對象進(jìn)行for...of循環(huán)時，會調(diào)用這個方法瓷翻，返回該對象的默認(rèn)遍歷器聚凹。（指向一個函數(shù)）

02割坠，吃碼小妖，是一個指針妒牙”撕撸可以作為屬性一樣的使用。指向遍歷器方法湘今。

[1,2,3][Symbol.iterator]

03敢朱，可以像函數(shù)調(diào)用一樣。

let arr = ['a', 'b', 'c'];
let iter = arr[Symbol.iterator]();

吃碼小妖：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

【09】Symbol.toPrimitive

指向一個方法蔫饰。

該對象被轉(zhuǎn)為原始類型的值時，會調(diào)用這個方法愉豺，返回該對象對應(yīng)的原始類型值。

Symbol.toPrimitive被調(diào)用時茫因，會接受一個字符串參數(shù)蚪拦，表示當(dāng)前運(yùn)算的模式，一共有三種模式冻押。

• Number：該場合需要轉(zhuǎn)成數(shù)值

• String：該場合需要轉(zhuǎn)成字符串

• Default：該場合可以轉(zhuǎn)成數(shù)值驰贷，也可以轉(zhuǎn)成字符串

  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'

【10】[Symbol.toStringTag]:"str"

指向一個方法。

在該對象上面調(diào)用Object.prototype.toString方法時洛巢，如果這個屬性存在括袒，它的返回值會出現(xiàn)在toString方法返回的字符串之中，表示對象的類型稿茉。

在對象中設(shè)置這個屬性[Symbol.toStringTag]為任意字符串XXX锹锰，那么，這個對象調(diào)用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新增內(nèi)置對象的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'

【11】Symbol.unscopables

（吃碼小妖：僅放置痢士，因為嚴(yán)格模式不能用with）

指向一個對象。

該對象指定了使用with關(guān)鍵字時茂装，哪些屬性會被with環(huán)境排除怠蹂。

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

上面代碼說明，數(shù)組有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
}