JS 中的 Symbol

wopen發表於2019-03-06
JSSymbol

Symbol 是 ES6 新加入的資料型別，是一種原始資料型別。該型別的性質在於這個型別的值可以用來建立匿名的物件屬性。該資料型別通常被用作一個物件屬性的鍵值——當你想讓它是私有的時候。物件的屬性名現在可以有兩種型別，一種是字串，另一種就是 Symbol 型別。

Symbol 值通過Symbol函式生成，它是獨一無二的，可以保證不會與其他屬性名產生衝突。

let s1 = Symbol();
// Symbol 函式前不能使用 new 命令，否則會報錯
// 因為生成的 Symbol 是一個原始型別的值，不是物件

let s2 = Symbol();

typeof s
// "symbol"

s1 === s2 // false
// Symbol 是獨一無二的
複製程式碼

列印 Symbol 型別都顯示為 Symbol，這不好區分，這時就可以給它傳遞一個引數，來區分 Symbol。

const obj = {
  toString() {
    return 'abc';
  }
};
const sym = Symbol(obj);
sym // Symbol(abc)

let s1 = Symbol('foo');
let s2 = Symbol('foo');

s1 === s2 // false
複製程式碼

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 string
複製程式碼

Symbol 值可以顯式轉為字串和布林值，但是不能轉為數值。

let sym = Symbol('My symbol');

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

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

Number(sym) // TypeError
sym + 2 // TypeError
複製程式碼

作為屬性名

Symbol 值可以作為屬性名，一般用來實現私有屬性。

let mySymbol = Symbol();
let s = Symbol();

// 第一種寫法
let a = {};
a[mySymbol] = 'Hello!';

// 第二種寫法
let a = {
  [mySymbol]: 'Hello!',
  [s] (arg) { }
};

// 第三種寫法
let a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });

// 以上寫法都得到同樣結果
a[mySymbol] // "Hello!"
複製程式碼

遍歷屬性名

Symbol 作為屬性名，該屬性不會出現在for...in、for...of迴圈中，也不會被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。

但是，Object.getOwnPropertySymbols方法，可以獲取指定物件的所有 Symbol 屬性名，Reflect.ownKeys方法可以返回所有型別的鍵名，包括常規鍵名和 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)]

複製程式碼

Symbol 的靜態方法

Symbol 一共有兩個靜態方法Symbol.for(key)和Symbol.keyFor(sym)。

for

Symbol.for(key)方法會根據給定的鍵key，來從執行時的symbol登錄檔中找到對應的 symbol，如果找到了，則返回它，否則，新建一個與該鍵關聯的symbol，並放入全域性symbol 登錄檔中。

Symbol.for("foo"); // 建立一個 symbol 並放入 symbol 登錄檔中，鍵為 "foo"
Symbol.for("foo"); // 從 symbol 登錄檔中讀取鍵為"foo"的 symbol


Symbol.for("bar") === Symbol.for("bar"); // true，證明了上面說的
Symbol("bar") === Symbol("bar"); // false，Symbol() 函式每次都會返回新的一個 symbol


var sym = Symbol.for("mario");
sym.toString(); 
// "Symbol(mario)"，mario 既是該 symbol 在 symbol 登錄檔中的鍵名，又是該 symbol 自身的描述字串
複製程式碼

keyFor

Symbol.keyFor(sym)方法用來獲取symbol登錄檔中與某個symbol關聯的鍵。

// 建立一個 symbol 並放入 Symbol 登錄檔，key 為 "foo"
var globalSym = Symbol.for("foo"); 
Symbol.keyFor(globalSym); // "foo"

// 建立一個 symbol，但不放入 symbol 登錄檔中
var localSym = Symbol(); 
Symbol.keyFor(localSym); // undefined，所以是找不到 key 的

// well-known symbol 們並不在 symbol 登錄檔中
Symbol.keyFor(Symbol.iterator) // undefined

let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"

let s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined
// Symbol()寫法沒有登記機制，所以每次呼叫都會返回一個不同的值
複製程式碼

內建的 Symbol 值 （Well-known symbols）

ES6 提供了 12 個內建的 Symbol 值，指向語言內部使用的方法。

迭代 symbols

Symbol.iterator

指向該物件的預設遍歷器方法。

Symbol.asyncIterator

指向該物件的預設非同步遍歷器方法。

正規表示式 symbols

Symbol.match

指向一個函式。String.prototype.match()方法執行時如果該屬性存在，會呼叫此函式，返回該方法的返回值。

String.prototype.match(regexp)
// 等同於
regexp[Symbol.match](this)

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

'e'.match(new MyMatcher()) // 1

"/bar/".startsWith(/bar/); 

// Throws TypeError, 因為 /bar/ 是一個正規表示式
// 且 Symbol.match 沒有修改。

var re = /foo/;
re[Symbol.match] = false;
"/foo/".startsWith(re); // true
"/baz/".endsWith(re);   // false

// 如果將 Symbol.match 置為 false，
// 使用 match 屬性的表示式檢查會認為該物件不是正規表示式物件
複製程式碼

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.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

指向一個方法，當該物件被String.prototype.split方法呼叫時，會返回該方法的返回值。

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'
複製程式碼

其他 symbols

Symbol.hasInstance

指向一個內部方法。當其他物件使用instanceof運算子，判斷是否為該物件的例項時，會呼叫這個方法。

class Even {
  static [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
}

// 等同於
const Even = {
  [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
};

1 instanceof Even // false
2 instanceof Even // true
12345 instanceof Even // false
複製程式碼

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

// ----------

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.unscopables

指向一個物件。該物件指定了使用with關鍵字時，哪些屬性會被with環境排除。

Array.prototype[Symbol.unscopables]
// {
//   copyWithin: true,
//   entries: true,
//   fill: true,
//   find: true,
//   findIndex: true,
//   includes: true,
//   keys: true
// }

// 陣列有 7 個屬性，會被with命令排除
複製程式碼

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 // true
c instanceof MyArray // true
// b 和 c 是 a 的衍生物件

// ---------

class MyArray extends Array {
  static get [Symbol.species]() { return Array; }
}

const a = new MyArray();
const b = a.map(x => x);

b instanceof MyArray // false
b instanceof Array // true
複製程式碼

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

指向一個方法。在該物件上面呼叫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 內建物件屬性值：

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 原型

Symbol 一共有 4 個原型方法。

Symbol.prototype.toSource()

返回代表該物件原始碼的字串。該方法通常由JavaScript內部呼叫。

對於內建Symbol物件, toSource 返回以下字串，表明原始碼不可見：

`
function Symbol() {
   [native code]
}
`
複製程式碼

對於Symbol例項, toSource 返回代表原始碼的字串。

"Symbol()"
複製程式碼

Symbol.prototype.toString()

返回當前 symbol 物件的字串表示。

Symbol.prototype.valueOf()

返回當前 symbol 物件所包含的 symbol 原始值。

Symbol.prototype[@@toPrimitive]

可將 Symbol 物件轉換為原始值。返回該原始值為指定的 Symbol 物件。

Symbol()[Symbol.toPrimitive](hint);

一般不需要自己呼叫 JS 會自動地呼叫該方法。

Symbol 靜態屬性

除了prototype屬性，Symbol 還有一個length屬性，值為0。

相關文章