【ES6腳丫系列】Symbol

時間 2021-02-18

標籤 git github segmentfault 數組瀏覽器 app ecmascript 函數 this spa 欄目 Git 简体版

原文原文鏈接

【ES6腳丫系列】git

【ES6腳丫系列】Symbolgithub

若是有理解不到位的地方，歡迎你們糾錯。若是以爲還能夠，但願你們能夠點個贊。謝謝你們。segmentfault

目錄數組

1、Symbol是什麼？瀏覽器

2、Symbol和對象的關係app

3、實例：消除魔術字符串ecmascript

4、Symbol和遍歷函數

5、Symbol.for()，Symbol.keyFor()this

6、Symbol內置屬性（多種）spa

【01】[Symbol.hasInstance]

【02】Symbol.isConcatSpreadable

【03】Symbol.species

【04】Symbol.match

【05】Symbol.replace

【06】Symbol.search

【07】Symbol.split

【08】Symbol.iterator

【09】Symbol.toPrimitive

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

【11】Symbol.unscopables

1、Symbol是什麼？

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

它是JavaScript語言的第七種數據類型，前六種是：Undefined、Null、布爾值（Boolean）、字符串（String）、數值（Number）、對象（Object）。

使用typeof會返回「symbol"

typeof Symbol();//「symbol」

【02】語法：

Symbol值經過Symbol函數生成。

Symbol函數前不能使用new命令，不然會報錯。

寫法1：

let sym = Symbol();

var s1 = Symbol('foo');

Symbol函數能夠接受一個字符串做爲參數，表示對Symbol實例的描述。
相同參數的Symbol函數的返回值是不相等的。

做用：便於區分

- 在控制檯顯示。不然輸出都是Symbol()。
- 轉爲字符串時。

寫法2：

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

【03】Symbol用途：

能夠防止對象的屬性名衝突。

ES5的對象屬性名都是字符串，容易形成屬性名的衝突。

當使用別人提供的對象時，你可能因爲對這個對象的不熟悉，而操做屬性名衝突（好比在添加屬性名時）。

對象的屬性名如今能夠有兩種類型：

一種是字符串。
一種是Symbol類型。

【04】symbol建立後就不可變動。

【05】Symbol值不是對象，因此不能添加屬性（在嚴格模式下嘗試設置屬性會獲得TypeError的錯誤）。

【06】Symbol值不能被自動轉換爲字符串，能夠顯式轉爲字符串。拼接symbol與字符串會報錯：TypeError錯誤。

經過String(symbolEle)或symbolEle.toString()能夠顯式地將symbol轉換爲一個字符串。

例子：

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值能夠轉爲布爾值。

寫法：

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

【08】Symbol值不能與其餘類型的值進行運算，會報錯。

【09】不能轉爲數值。不能用Number(Symbol變量)進行轉換。不能symbol變量和數值進行運算，好比加減等。

例子：

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

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

2、Symbol和對象的關係

【01】把Symbol做爲對象的屬性名，能夠防止屬性名被改寫或覆蓋。

寫法：

【02】以對象+「.」+Symbol變量賦值時，這等於給對象填加普通的字符串屬性，而不是Symbol。

由於點運算符後接字符串。因此不會找變量所對應的值，而是把變量名做爲字符串。

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】在對象的{}內部，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);

採用加強的對象寫法，上面代碼的obj對象能夠寫得更簡潔一些。(吃碼小妖：就是簡化的對象寫法。省略function關鍵字)

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

3、實例：消除魔術字符串

01，魔術字符串指的是：

吃碼小妖：指的是函數中的判斷條件（字符串或數值），應該修改成可變化的變量，做爲函數參數輸入。

不然，一旦判斷條件改變了，就得再次修改該函數，不利於維護。

能夠把變量存放在一個對象裏。變量名做爲屬性名，Symbol()做爲它的屬性值。
咱們實際須要使用的是屬性名，屬性值並不重要，能夠用Symbol做爲屬性值來保證惟一性。

在switch中，根據case 屬性名來進行判斷。

這裏說的是判斷條件是什麼並不重要，重要是能根據這個條件判斷就能夠了。看下面的例子就清楚了。

例子:

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}); // 魔術字符串

修改成：

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

4、Symbol和遍歷

【01】Symbol做爲屬性名時：

不會出如今for...in、for...of循環中。

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

【02】Object.getOwnPropertySymbols()。

返回一個數組，成員是對象的全部做爲屬性名的Symbol值，不包括屬性值。

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

【03】Reflect.ownKeys()能夠返回全部類型的鍵名，包括常規鍵名和Symbol鍵名。

返回的是一個數組，其中Symbol爲Symbol(stringEle)。其餘爲字符串形式。

【04】能夠用Symbol()爲對象定義一些非私有的、但又但願只用於內部的方法。

例子：

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

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

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

0一、接受一個字符串做爲參數。
0二、而後在全局做用域中搜索是否有以該參數做爲名稱的Symbol值。

若是有，就返回這個Symbol值（2個Symbol變量全等）。

不然就新建並返回一個以該字符串爲名稱的Symbol值。

0三、用途：重複使用同一個Symbol值。

0四、能夠在不一樣的iframe或service worker中取到同一個值。

0五、經過Symbol.for()建立的symbol會保存在Symbol註冊表中。

0六、Symbol.for()與Symbol()

前者：會全局搜索是否有存在。後者不會。

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

參數是Symbol變量。用於判斷Symbol變量的描述字符串是否已登記。

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

若是未登記，返回undefined。
若是是第一次登記，返回已登記的Symbol 類型值的字符串str。

若是是已經登記過的同一個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

6、Symbol內置屬性（多種）

【01】[Symbol.hasInstance]

01，指向一個內部方法。

Constructor[Symbol.hasInstace](){}

對象使用instanceof運算符時，會調用這個方法，判斷該對象是否爲某個構造函數的實例。

好比，foo instanceof Foo在語言內部，實際調用的是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()時，是否能夠展開。

若是設置爲false：

arr[Symbol.isConcatSpreadable] = false;

那麼，在arr1.concat(arr)中，將以總體的方式插入arr1中。造成多維數組。

02，數組的Symbol.isConcatSpreadable屬性默認爲true，表示能夠展開。

03，類數組的對象也能夠展開，但它的Symbol.isConcatSpreadable屬性默認爲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是可擴展的，類A2是不可擴展的，因此使用concat時有不同的結果。

【03】Symbol.species

指向一個方法。

對象做爲構造函數創造實例時，會調用這個方法。

即若是this.constructor[Symbol.species]存在，就會使用這個屬性做爲構造函數，來創造新的實例對象。

Symbol.species屬性默認的讀取器以下。

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

語言內部的替換：

【04】Symbol.match

01，指向一個方法。當執行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

【05】Symbol.replace

指向一個方法。

當該對象被String.prototype.replace方法調用時，會返回該方法的返回值。

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

【06】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

【07】Symbol.split

指向一個方法，當該對象被String.prototype.split方法調用時，會返回該方法的返回值。

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

【08】Symbol.iterator

01，指向該對象的默認遍歷器方法，即該對象進行for...of循環時，會調用這個方法，返回該對象的默認遍歷器。（指向一個函數）

02，吃碼小妖，是一個指針。能夠做爲屬性同樣的使用。指向遍歷器方法。

1,2,3

03，能夠像函數調用同樣。

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

指向一個方法。

該對象被轉爲原始類型的值時，會調用這個方法，返回該對象對應的原始類型值。

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'

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

指向一個方法。

在該對象上面調用Object.prototype.toString方法時，若是這個屬性存在，它的返回值會出如今toString方法返回的字符串之中，表示對象的類型。

在對象中設置這個屬性[Symbol.toStringTag]爲任意字符串XXX，那麼，這個對象調用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新增內置對象的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

（吃碼小妖：僅放置，由於嚴格模式不能用with）

指向一個對象。

該對象指定了使用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
}

相關標籤/搜索

每日一句

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