1. 程式人生 > >##ES6之Symbol

##ES6之Symbol

魔法 數據類型 world 耦合 rop value erro 寫法 number

一、初識

1、Symbol是es6引入的一種新的原始數據類型,表示獨一無二的值。它是Javascript語言的第七種數據類型,前六種是:undefined、null、布爾值(Boolean)、字符串(String)、數值(Number)、對象(Object)。

Symbol 值通過Symbol函數生成

let s = Symbol();

typeof s

//"symbol"

註意,Symbol函數前不能使用new命令,否則會報錯。這是因為生成的 Symbol 是一個原始類型的值,不是對象。由於 Symbol 值不是對象,所以不能添加屬性。基本上,它是一種類似於字符串的數據類型。


let sss = new Symbol()

//Uncaught TypeError: Symbol is not a constructor

2、參數

Symbol函數可以接受一個字符串作為參數,表示對 Symbol 實例的描述,但是即使參數相同所得到的值也是不同的(唯一),因此可以用來做對象的屬性名,防止屬性名的沖突獨一無二

let s1 = Symbol(‘foo‘);
let s2 = Symbol(‘bar‘);

s1 == s2 //false

若Symbol參數是一個對象,那麽它會調用該對象的toString方法,將它轉成一個字符串然後生成一個Symbol值。


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


const obj1 = {}
const sym1 = Symbol(obj1);
sym1 // Symbol([object Object])

3、Symbol值轉換

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

Symbol 值也可以轉為布爾值,但是不能轉為數值。

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

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

二、應用

1、用於對象的屬性名

就能保證不會出現同名的屬性。這對於一個對象由多個模塊構成的情況非常有用,能防止某一個鍵被不小心改寫或覆蓋。

let a = {};
a[mySymbol] = ‘Hello!‘;

// 第二種寫法
let a = {
  [mySymbol]: ‘Hello!‘
};

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

// 以上寫法都得到同樣結果
a[mySymbol] // "Hello!"

Symbol 值作為對象屬性名時,不能用點運算符。因為點運算符後面總是字符串;同理,在對象的內部,使用 Symbol 值定義屬性時,Symbol 值必須放在方括號之中。

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

a.mySymbol = ‘Hello!‘;
a[mySymbol] // undefined
a[‘mySymbol‘] // "Hello!"

2、消除魔法字符串

魔術字符串指的是,在代碼之中多次出現、與代碼形成強耦合的某一個具體的字符串或者數值。風格良好的代碼,應該盡量消除魔術字符串,改由含義清晰的變量代替。

const shapeType = {
  triangle: ‘Triangle‘
};

function getArea(shape, options) {
  let 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()
};

三、屬性名的遍歷

1、Symbol 作為屬性名,該屬性不會出現在for...in、for...of循環中,也不會被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回,有一個Object.getOwnPropertySymbols方法,可以獲取指定對象的所有 Symbol 屬性名。

let symb = Symbol()
let obbj = {[symb]:‘aa‘,a: ‘haha‘}
JSON.stringify(obbj);

//Symbol屬性沒有被返回
//{"a":"haha"}

Object.getOwnPropertySymbols方法返回一個數組,成員是當前對象的所有用作屬性名的 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)]

2、Reflect.ownKeys方法可以返回所有類型的鍵名,包括常規鍵名和 Symbol 鍵名。

let obj = {
  [Symbol(‘my_key‘)]: 1,
  enum: 2,
  nonEnum: 3
};

Reflect.ownKeys(obj)
//  ["enum", "nonEnum", Symbol(my_key)]
//註意此數組JSON.stingify()的Symbol那一項是null
let stringifySymbol = Reflect.ownKeys(obj)
//"["enum","nonEnum",null]"

由於以 Symbol 值作為名稱的屬性,不會被常規方法遍歷得到。我們可以利用這個特性,為對象定義一些非私有的、但又希望只用於內部的方法。

四、Symbol.for(),Symbol.keyFor()

1、我們希望重新使用同一個 Symbol 值,Symbol.for方法可以做到這一點。

let s1 = Symbol.for(‘foo‘);
let s2 = Symbol.for(‘foo‘);

s1 === s2 // true

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。

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

let s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined

上面代碼中,變量s2屬於未登記的 Symbol 值,所以返回undefined

2、但是當Symbol.for()裏面不傳或者傳空字符串的時候

let a12 = Symbol.for()
Symbol.keyFor(a12)
//"undefined"

let a13 = Symbol.for(‘‘)
Symbol.keyFor(a13)
""

其實Symbol.for()相當於Symbol.for(undefined)所以返回‘undefined‘;

##ES6之Symbol