Skip to main content

新增的 Symbol

一、什么是 Symbol​

ES6 引入了一种新的原始数据类型 Symbol，表示独一无二的值。

Symbol 值通过 Symbol 函数生成。这就是说，对象的属性名现在可以有两种类型，一种是原来就有的字符串，另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型，就都是独一无二的，可以保证不会与其他属性名产生冲突。

let a = Symbol()
let b = Symbol()

typeof a  // "symbol"
a === b   // false

二、Symbol 的作用​

1、避免属性名冲突​

Symbol 主要的作用是为对象添加独一无二的属性名，从根本上防止属性名的冲突。

let a = Symbol()
let b = Symbol()

let city = {
  [a]: 'Guangzhou',
  [b]: 'Guangzhou',
  [Symbol()]: 'Guangzhou',
  a: 'Guangzhou'
}

console.log(city)
// {a: 'Guangzhou', Symbol(): 'Guangzhou', Symbol(): 'Guangzhou', Symbol(): 'Guangzhou'}

2、做私有属性​

Symbol 更适合做私有属性，因为普通的遍历是访问不到。

let a = Symbol()
let b = Symbol()

let city = {
  [a]: 'Guangzhou',
  [b]: 'Guangzhou',
  [Symbol()]: 'Guangzhou',
  a: 'Guangzhou'
}

for (let key in city) {
  console.log(key)                // a
}
console.log(Object.keys(city))    // ['a']
console.log(JSON.stringify(city)) // {"a":"Guangzhou"}

// 使用下面的方法，可以获取到 symbol 的属性名
console.log(Object.getOwnPropertySymbols(city)) // [Symbol(), Symbol(), Symbol()]

三、Symbol 注意事项​

1、不能使用 new 命令​

Symbol 函数前不能使用 new 命令，否则会报错。这是因为生成的 Symbol 是一个原始类型的值，不是对象。也就是说，由于 Symbol 值不是对象，所以不能添加属性。基本上，它是一种类似于字符串的数据类型。

2、用参数区分 Symbol​

Symbol 函数可以接受一个字符串作为参数，表示对 Symbol 实例的描述，主要是为了在控制台显示，或者转为字符串时，比较容易区分。

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

s1 // Symbol(foo)
s2 // Symbol(bar)

s1.toString() // "Symbol(foo)"
s2.toString() // "Symbol(bar)"

上面代码中，s1 和 s2 是两个 Symbol 值。如果不加参数，它们在控制台的输出都是 Symbol()，不利于区分。有了参数以后，就等于为它们加上了描述，输出的时候就能够分清，到底是哪一个值。

注意：即时参数相同，Symbol 值也是互不相等的。

3、不能与其他类型的值进行运算​

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

4、可转为布尔值，不能转数值​

Symbol 可转为布尔值，但不能转数值。

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

if (sym) {
  // ...
}

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

5、不能用点运算符​

Symbol 值作为对象属性名时，不能用点运算符。

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

a.mySymbol = 'Hello!';

a[mySymbol]   // undefined
a['mySymbol'] // "Hello!"

上面代码中，因为点运算符后面总是字符串，所以不会读取 mySymbol 作为标识名所指代的那个值，导致 a 的属性名实际上是一个字符串，而不是一个 Symbol 值。

6、使用同一个 Symbol​

有时，我们希望重新使用同一个 Symbol 值，Symbol.for() 方法可以做到这一点。

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

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

s1 === s2 // true

上面代码中，s1 和 s2都是 Symbol 值，但是它们都是由同样参数的 Symbol.for 方法生成的，所以实际上是同一个值。

Symbol.for() 与 Symbol() 这两种写法，都会生成新的 Symbol。

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

比如，如果你调用 Symbol.for("cat") 30 次，每次都会返回同一个 Symbol 值，但是调用 Symbol("cat") 30 次，会返回 30 个不同的 Symbol 值。

四、内置的 Symbol 值​

除了定义自己使用的 Symbol 值以外，ES6 还提供了 11 个内置的 Symbol 值，指向语言内部使用的方法。

1、Symbol.hasInstance​

对象的 Symbol.hasInstance 属性，指向一个内部方法。

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

比如，foo instanceof Foo 在语言内部，实际调用的是 Foo[Symbol.hasInstance](foo)。

class MyClass {
  [Symbol.hasInstance](foo) {
    return foo instanceof Array;
  }
}

[1, 2, 3] instanceof new MyClass()

上面代码中，MyClass 是一个类，new MyClass() 会返回一个实例。该实例的 Symbol.hasInstance 方法，会在进行 instanceof 运算时自动调用，判断左侧的运算子是否为 Array 的实例。

下面是另一个例子。

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

1 instanceof Even2 instanceof Even12345 instanceof Even

2、Symbol.isConcatSpreadable​

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

let arr1 = ['c', 'd'];
['a', 'b'].concat(arr1, 'e')arr1[Symbol.isConcatSpreadable]
let arr2 = ['c', 'd'];
arr2[Symbol.isConcatSpreadable] = false;
['a', 'b'].concat(arr2, 'e')

上面代码说明，数组的默认行为是可以展开，Symbol.isConcatSpreadable 默认等于 undefined。该属性等于 true 时，也有展开的效果。

类似数组的对象正好相反，默认不展开。它的 Symbol.isConcatSpreadable 属性设为 true，才可以展开。

let obj = {length: 2, 0: 'c', 1: 'd'};
['a', 'b'].concat(obj, 'e')
obj[Symbol.isConcatSpreadable] = true;
['a', 'b'].concat(obj, 'e')

Symbol.isConcatSpreadable 属性也可以定义在类里面。

class A1 extends Array {
  constructor(args) {
    super(args);
    this[Symbol.isConcatSpreadable] = true;
  }
}
class A2 extends Array {
  constructor(args) {
    super(args);
  }
  get [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)

上面代码中，类 A1 是可展开的，类 A2 是不可展开的，所以使用 concat 时有不一样的结果。

注意，Symbol.isConcatSpreadable 的位置差异，A1 是定义在实例上，A2 是定义在类本身，效果相同。

3、Symbol.species​

对象的 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 MyArrayc instanceof MyArray

上面代码中，子类 MyArray 继承了父类 Array，a 是 MyArray 的实例，b 和 c 是 a 的衍生对象。你可能会认为，b 和 c 都是调用数组方法生成的，所以应该是数组（Array的实例），但实际上它们也是 MyArray 的实例。

Symbol.species 属性就是为了解决这个问题而提供的。现在，我们可以为 MyArray 设置 Symbol.species 属性。

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

上面代码中，由于定义了 Symbol.species 属性，创建衍生对象时就会使用这个属性返回的函数，作为构造函数。这个例子也说明，定义 Symbol.species 属性要采用 get 取值器。默认的 Symbol.species 属性等同于下面的写法。

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

现在，再来看前面的例子。

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

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

b instanceof MyArrayb instanceof Array

上面代码中，a.map(x => x) 生成的衍生对象，就不是 MyArray 的实例，而直接就是 Array 的实例。

再看一个例子。

class T1 extends Promise {
}

class T2 extends Promise {
  static get [Symbol.species]() {
    return Promise;
  }
}

new T1(r => r()).then(v => v) instanceof T1new T2(r => r()).then(v => v) instanceof T2

上面代码中，T2 定义了 Symbol.species 属性，T1 没有。结果就导致了创建衍生对象时（then方法），T1 调用的是自身的构造方法，而 T2 调用的是 Promise 的构造方法。

总之，Symbol.species 的作用在于，实例对象在运行过程中，需要再次调用自身的构造函数时，会调用该属性指定的构造函数。它主要的用途是，有些类库是在基类的基础上修改的，那么子类使用继承的方法时，作者可能希望返回基类的实例，而不是子类的实例。

4、Symbol.match​

对象的 Symbol.match 属性，指向一个函数。当执行 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())

5、Symbol.replace​

对象的 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')

Symbol.replace 方法会收到两个参数，第一个参数是 replace 方法正在作用的对象，上面例子是 Hello，第二个参数是替换后的值，上面例子是 World。

6、Symbol.search​

对象的 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'))

7、Symbol.split​

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

String.prototype.split(separator, limit)separator[Symbol.split](this, limit)

下面是一个例子。

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'))
'foobar'.split(new MySplitter('bar'))
'foobar'.split(new MySplitter('baz'))

上面方法使用 Symbol.split 方法，重新定义了字符串对象的 split 方法的行为，

8、Symbol.iterator​

对象的 Symbol.iterator 属性，指向该对象的默认遍历器方法。

const myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

[...myIterable]

对象进行 for...of 循环时，会调用 Symbol.iterator 方法，返回该对象的默认遍历器。

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

9、Symbol.toPrimitive​

对象的 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 * obj3 + objobj == 'default'String(obj)

10、Symbol.toStringTag​

对象的 Symbol.toStringTag 属性，指向一个方法。在该对象上面调用 Object.prototype.toString 方法时，如果这个属性存在，它的返回值会出现在 toString 方法返回的字符串之中，表示对象的类型。也就是说，这个属性可以用来定制 [object Object] 或 [object Array] 中 object 后面的那个字符串。

({[Symbol.toStringTag]: 'Foo'}.toString())class Collection {
  get [Symbol.toStringTag]() {
    return 'xxx';
  }
}
let x = new Collection();
Object.prototype.toString.call(x)

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​

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

Array.prototype[Symbol.unscopables]
Object.keys(Array.prototype[Symbol.unscopables])

上面代码说明，数组有 7 个属性，会被 with 命令排除。

class MyClass {
  foo() { return 1; }
}

var foo = function () { return 2; };

with (MyClass.prototype) {
  foo();}
class MyClass {
  foo() { return 1; }
  get [Symbol.unscopables]() {
    return { foo: true };
  }
}

var foo = function () { return 2; };

with (MyClass.prototype) {
  foo();}

上面代码通过指定 Symbol.unscopables 属性，使得 with 语法块不会在当前作用域寻找 foo 属性，即 foo 将指向外层作用域的变量。