ES6入门之Symbol

117 阅读4分钟

参考文章: ECMAScript 6入门

详细的我就不说啦,阮一峰的ECMAScript 6入门写的就够详细了,下面是一些关键点总结,方便使用时温习。

基本

Symbol表示独一无二的值。可以用来避免冲突。

** 注意:** Symbol函数不能使用new命令,因为生成的Symbol是一个原始值类型的值,不是对象。(所以Symbol不能添加属性,他只是一种类似字符串的数据类型)

参数

let s = Symbol()
typeof s //symbol

是字符串,表示对Symbol实例的描述。利于区分

let s1 = Symbol('foo')

是对象,调用对象的toString方法,将返回值当做参数

let obj = {
	toString(){
    	return 'ab';
    }
}
let sym = Symbol(obj)
sym //Symbol('ab')

参数只是对Symbol的描述,因此相同参数的Symbol不相等

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

s1 === s2 //false

转换与运算

不能与其他类型运算

let sym = Symbol('My symbol');

"your symbol is " + sym
// TypeError: can't convert symbol to string

可以显示转换为字符串

let sym = Symbol('My symbol');

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

可以转换为布尔值

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

不能转换为数值

let sym = Symbol();
Number(sym) // TypeError
sym + 2 // TypeError

属性

description

获取Symbol的描述

const sym = Symbol('foo');

sym.description // "foo"

Symbol.hasInstance

指向一个内部方法。当其他对象使用instanceof运算符,判断是否为该对象的实例时,会调用这个方法。

Symbol.isConcatSpreadable

对象的Symbol.isConcatSpreadable属性等于一个布尔值,表示该对象用于Array.prototype.concat()时,是否可以展开。

Symbol.species

指向一个构造函数。创建衍生对象时,会使用该属性。

Symbol.match

指向一个函数。当执行str.match(myObject)时,如果该属性存在,会调用它,返回该方法的返回值。

Symbol.replace

指向一个方法,当该对象被String.prototype.replace方法调用时,会返回该方法的返回值。

Symbol.search

指向一个方法,当该对象被String.prototype.search方法调用时,会返回该方法的返回值。

Symbol.split

指向一个方法,当该对象被String.prototype.split方法调用时,会返回该方法的返回值。

Symbol.iterator

指向该对象的默认遍历器方法。

Symbol.toPrimitive

,指向一个方法。该对象被转为原始类型的值时,会调用这个方法,返回该对象对应的原始类型值。

Symbol.toStringTag

指向一个方法。在该对象上面调用Object.prototype.toString方法时,如果这个属性存在,它的返回值会出现在toString方法返回的字符串之中,表示对象的类型。

Symbol.unscopables

指向一个对象。该对象指定了使用with关键字时,哪些属性会被with环境排除。

方法

Symbol.for

Symbol.for()方法接受一个字符串作为参数,然后搜索有没有以该参数作为名称的 Symbol 值。如果有,就返回这个 Symbol 值,否则就新建一个以该字符串为名称的 Symbol 值,并将其注册到全局。

注意: Symbol.for()为 Symbol 值登记的名字,是全局环境的,不管有没有在全局环境运行。

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

s1 === s2 // true

ymbol.for()与Symbol()的异同

  • 同:生成新的 Symbol。
  • 异:前者会被登记在全局环境中供搜索,后者不会。Symbol.for()不会每次调用就返回一个新的 Symbol 类型的值,而是会先检查给定的key是否已经存在,如果不存在才会新建一个值。

Symbol.keyFor

Symbol.keyFor()方法返回一个已登记的 Symbol 类型值的key。未登记返回false。

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

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

使用

做属性名

避免出现同名属性,常用于一个对象由多个模块构建的情况,防止某一个键被不小心改写或覆盖。

** 注意:**Symbol做属性名时,不能用点运算符,使用方括号。Symbol 值作为属性名时,该属性还是公开属性,不是私有属性。

Symbol 作为属性名,遍历对象的时候,该属性不会出现在for...in、for...of循环中,也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。

但是,它也不是私有属性,有一个Object.getOwnPropertySymbols()方法,可以获取指定对象的所有 Symbol 属性名。该方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。

Reflect.ownKeys()方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。

let mySymbol = Symbol();

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

// 第二种写法
let a = {
  [mySymbol]: 'Hello!'
};

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

// 以上写法都得到同样结果
a[mySymbol] // "Hello!"

//做属性名
let s = Symbol();

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

obj[s](123);

定义常量

Symbol类型定义常量,可以保证这组常量的值都是不相等的

const log = {};

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');

伪私有属性

由于以 Symbol 值作为键名,不会被常规方法遍历得到。我们可以利用这个特性,为对象定义一些非私有的、但又希望只用于内部的方法。

let size = Symbol('size');

class Collection {
  constructor() {
    this[size] = 0;
  }

  add(item) {
    this[this[size]] = item;
    this[size]++;
  }

  static sizeOf(instance) {
    return instance[size];
  }
}

let x = new Collection();
Collection.sizeOf(x) // 0

x.add('foo');
Collection.sizeOf(x) // 1
//Symbol属性是一个Symbol值,所以Object.keys(x)、Object.getOwnPropertyNames(x)无法获取它,这就成了一个非私有的内部方法了
Object.keys(x) // ['0']
Object.getOwnPropertyNames(x) // ['0']
Object.getOwnPropertySymbols(x) // [Symbol(size)]

实现单例模式

单例模式指的是调用一个类,任何时候返回的都是同一个实例。