ES6 中的 Symbol

JavaScript 之 Symbol

Symbol是什么

SymbolES6中新引入的一种基本数据类型。Symbol()函数会返回 symbol 类型的值,该类型具有静态属性和静态方法。它的静态属性会暴露几个内建的成员对象;它的静态方法会暴露全局的 symbol 注册,且类似于内建对象类,但作为构造函数来说它并不完整,因为它不支持语法:new Symbol()

也就是说Symbol作为一种新的基本数据类型,我们可以使用:

let a = Symbol();

此时a便是一个Symbol类型的变量,它现在是独一无二的:

let b = Symbol();
a === b; //false

它还可以接受一个参数,我们可以给它传递一个字符串当描述,即使两个字符相同串也ok:

let symbol1 = Symbol('some');
let symbol2 = Symbol('some');
symbol1 === symbol2; //false

如果参数是对象的话,会先调用对象的toString方法来转换为字符串。
也就是说每一个Symbol创造出来的值都是不一样的。需要注意的是不能使用new的方式来创建:

let c = new Symbol(); //TypeError: Symbol is not a constructor

Symbol的使用姿势

给对象增加属性

ES5之前对象的属性名大多都是字符串,起名字是个难事,而且名字一多动不动重复了就出错了。而且有的时候我们拿过别人的代码,要给其中一个对象增加属性,我们也不知道怎么起名字不重复,这也是ES6中引入Symbol的根本原因。

let name = Symbol('name'); //加入 name 作为描述
let obj = {
    [name]: 'Baoyuan' //必须放在方括号之中
};
obj[name]; //'Baoyuan'
属性名的遍历

对象中的普通属性,我们可以使用Object.keys()for...in或者Object.getOwnPropertyNames()来进行遍历,但是他们并不能遍历出Symbol类型的属性名。请注意,它并不是私有属性。我们可以使用Object.getOwnPropertySymbols的方法来获取指定对象的Symbol属性。它会返回当前对象中所有Symbol类型的属性的Symbol值的数组:

let a = Symbol('a');
let b = Symbol('b');
let c = 'c';
let obj = {
    [a]: 'a',
    [b]: 'b',
    c: 'c'
};
let objNames = Object.getOwnPropertySymbols(obj);
console.log(objNames); // [Symbol(a), Symbol(b)]
let objName = Object.getOwnPropertyNames(obj);
console.log(objName); // ["c"]

使用Reflect.ownKeys可以遍历到所有的属性名:

let names = Reflect.ownKeys(obj);
console.log(names); // ["c", Symbol(a), Symbol(b)]
Symbol值的重复引用

有时候新建了一个Symbol值但是在其他地方我们希望再次使用,这时即使使用相同的描述符也不会产生同一个值,这时我们就需要Symbol.for():

let a = Symbol.for('hello');
let b = Symbol.for('hello');
a === b; // true

其实这两种写法都会产生新的Symbol,不过不同的是Symbol每次都产生一个新的值,而Symbol.for会先查看给定的key值是否存在,不存在了再去新建,并且还会被登记在全局环境中供搜索。我们可以使用Symbol.keyFor查看一个已登记的Symbol值的key:

Symbol.keyFor(a); // "hello"

ECMAScript 中的定义

我们先来想一下它的主要特征

  • 返回一个Symbol类型,并且是唯一的不会重复。

  • 使用new操作符初始化会报错。

  • 可以接受字符串参数作为标注,接受对象的时候调用对象的toString,即使参数相同返回的值也不同。

最后查看一下ECMAScript定义的规范。

When Symbol is called with optional argument description, the following steps are taken:

  1. If NewTarget is not undefined, throw a TypeError exception.
  2. If description is undefined, let descString be undefined.
  3. Else, let descString be ToString(description).
  4. ReturnIfAbrupt(descString).
  5. Return a new unique Symbol value whose [[Description]] value is descString.

规范中指出了当我们调用Symbol的时候有几个步骤:

  1. 如果我们使用了new,就报错。

  2. 如果没有传递参数,那么就使用undefined作为描述字.

  3. 如果传了的话就把它转换为字符串。

  4. 报错就返回。

  5. 新返回一个唯一的Symbol值,它的[[Description]]属性值为descString

你可能感兴趣的:(ES6 中的 Symbol)