javascript基础从小白到高手系列八：Symbol 类型

本文链接：https://blog.csdn.net/wanmeijuhao/article/details/136819411

Symbol（符号）是ECMAScript 6 新增的数据类型。符号是原始值，且符号实例是唯一、不可变的。
符号的用途是确保对象属性使用唯一标识符，不会发生属性冲突的危险。
尽管听起来跟私有属性有点类似，但符号并不是为了提供私有属性的行为才增加的（尤其是因为
Object API 提供了方法，可以更方便地发现符号属性）。相反，符号就是用来创建唯一记号，进而用作非
字符串形式的对象属性。

符号的基本用法
符号需要使用Symbol()函数初始化。因为符号本身是原始类型，所以typeof 操作符对符号返回
symbol。
let sym = Symbol();
console.log(typeof sym); // symbol
调用Symbol()函数时，也可以传入一个字符串参数作为对符号的描述（description），将来可以通
过这个字符串来调试代码。但是，这个字符串参数与符号定义或标识完全无关：
let genericSymbol = Symbol();
let otherGenericSymbol = Symbol();
let fooSymbol = Symbol(‘foo’);
let otherFooSymbol = Symbol(‘foo’);
console.log(genericSymbol == otherGenericSymbol); // false
3.4 数据类型 45
8
1
2
3
4
5
14
6
7
9
10
11
13
12
console.log(fooSymbol == otherFooSymbol); // false
符号没有字面量语法，这也是它们发挥作用的关键。按照规范，你只要创建Symbol()实例并将其
用作对象的新属性，就可以保证它不会覆盖已有的对象属性，无论是符号属性还是字符串属性。
let genericSymbol = Symbol();
console.log(genericSymbol); // Symbol()
let fooSymbol = Symbol(‘foo’);
console.log(fooSymbol); // Symbol(foo);
最重要的是，Symbol()函数不能与new 关键字一起作为构造函数使用。这样做是为了避免创建符
号包装对象，像使用Boolean、String 或Number 那样，它们都支持构造函数且可用于初始化包含原
始值的包装对象：
let myBoolean = new Boolean();
console.log(typeof myBoolean); // “object”
let myString = new String();
console.log(typeof myString); // “object”
let myNumber = new Number();
console.log(typeof myNumber); // “object”
let mySymbol = new Symbol(); // TypeError: Symbol is not a constructor
如果你确实想使用符号包装对象，可以借用Object()函数：
let mySymbol = Symbol();
let myWrappedSymbol = Object(mySymbol);
console.log(typeof myWrappedSymbol); // “object”
使用全局符号注册表
如果运行时的不同部分需要共享和重用符号实例，那么可以用一个字符串作为键，在全局符号注册
表中创建并重用符号。
为此，需要使用Symbol.for()方法：
let fooGlobalSymbol = Symbol.for(‘foo’);
console.log(typeof fooGlobalSymbol); // symbol
Symbol.for()对每个字符串键都执行幂等操作。第一次使用某个字符串调用时，它会检查全局运
行时注册表，发现不存在对应的符号，于是就会生成一个新符号实例并添加到注册表中。后续使用相同
字符串的调用同样会检查注册表，发现存在与该字符串对应的符号，然后就会返回该符号实例。
let fooGlobalSymbol = Symbol.for(‘foo’); // 创建新符号
let otherFooGlobalSymbol = Symbol.for(‘foo’); // 重用已有符号
console.log(fooGlobalSymbol === otherFooGlobalSymbol); // true
即使采用相同的符号描述，在全局注册表中定义的符号跟使用Symbol()定义的符号也并不等同：
let localSymbol = Symbol(‘foo’);
let globalSymbol = Symbol.for(‘foo’);
console.log(localSymbol === globalSymbol); // false
全局注册表中的符号必须使用字符串键来创建，因此作为参数传给Symbol.for()的任何值都会被
46 第3 章语言基础
转换为字符串。此外，注册表中使用的键同时也会被用作符号描述。
let emptyGlobalSymbol = Symbol.for();
console.log(emptyGlobalSymbol); // Symbol(undefined)
还可以使用Symbol.keyFor()来查询全局注册表，这个方法接收符号，返回该全局符号对应的字
符串键。如果查询的不是全局符号，则返回undefined。
// 创建全局符号
let s = Symbol.for(‘foo’);
console.log(Symbol.keyFor(s)); // foo
// 创建普通符号
let s2 = Symbol(‘bar’);
console.log(Symbol.keyFor(s2)); // undefined
如果传给Symbol.keyFor()的不是符号，则该方法抛出TypeError：
Symbol.keyFor(123); // TypeError: 123 is not a symbol
使用符号作为属性
凡是可以使用字符串或数值作为属性的地方，都可以使用符号。这就包括了对象字面量属性和
Object.defineProperty()/Object.defineProperties()定义的属性。对象字面量只能在计算属
性语法中使用符号作为属性。
let s1 = Symbol(‘foo’),
s2 = Symbol(‘bar’),
s3 = Symbol(‘baz’),
s4 = Symbol(‘qux’);
let o = {
[s1]: ‘foo val’
};
// 这样也可以：o[s1] = ‘foo val’;
console.log(o);
// {Symbol(foo): foo val}
Object.defineProperty(o, s2, {value: ‘bar val’});
console.log(o);
// {Symbol(foo): foo val, Symbol(bar): bar val}
Object.defineProperties(o, {
[s3]: {value: ‘baz val’},
[s4]: {value: ‘qux val’}
});
console.log(o);
// {Symbol(foo): foo val, Symbol(bar): bar val,
// Symbol(baz): baz val, Symbol(qux): qux val}
类似于Object.getOwnPropertyNames()返回对象实例的常规属性数组，Object.getOwnProperty-
Symbols()返回对象实例的符号属性数组。这两个方法的返回值彼此互斥。Object.getOwnProperty-
Descriptors()会返回同时包含常规和符号属性描述符的对象。Reflect.ownKeys()会返回两种类型
的键：
3.4 数据类型 47
8
1
2
3
4
5
14
6
7
9
10
11
13
12
let s1 = Symbol(‘foo’),
s2 = Symbol(‘bar’);
let o = {
[s1]: ‘foo val’,
[s2]: ‘bar val’,
baz: ‘baz val’,
qux: ‘qux val’
};
console.log(Object.getOwnPropertySymbols(o));
// [Symbol(foo), Symbol(bar)]
console.log(Object.getOwnPropertyNames(o));
// [“baz”, “qux”]
console.log(Object.getOwnPropertyDescriptors(o));
// {baz: {…}, qux: {…}, Symbol(foo): {…}, Symbol(bar): {…}}
console.log(Reflect.ownKeys(o));
// [“baz”, “qux”, Symbol(foo), Symbol(bar)]
因为符号属性是对内存中符号的一个引用，所以直接创建并用作属性的符号不会丢失。但是，如果
没有显式地保存对这些属性的引用，那么必须遍历对象的所有符号属性才能找到相应的属性键：
let o = {
[Symbol(‘foo’)]: ‘foo val’,
[Symbol(‘bar’)]: ‘bar val’
};
console.log(o);
// {Symbol(foo): “foo val”, Symbol(bar): “bar val”}
let barSymbol = Object.getOwnPropertySymbols(o)
.find((symbol) => symbol.toString().match(/bar/));
console.log(barSymbol);
// Symbol(bar)
常用内置符号
ECMAScript 6 也引入了一批常用内置符号（well-known symbol），用于暴露语言内部行为，开发者
可以直接访问、重写或模拟这些行为。这些内置符号都以Symbol 工厂函数字符串属性的形式存在。
这些内置符号最重要的用途之一是重新定义它们，从而改变原生结构的行为。比如，我们知道
for-of 循环会在相关对象上使用Symbol.iterator 属性，那么就可以通过在自定义对象上重新定义
Symbol.iterator 的值，来改变for-of 在迭代该对象时的行为。
这些内置符号也没有什么特别之处，它们就是全局函数Symbol 的普通字符串属性，指向一个符号
的实例。所有内置符号属性都是不可写、不可枚举、不可配置的。
注意在提到ECMAScript 规范时，经常会引用符号在规范中的名称，前缀为@@。比如，
@@iterator 指的就是Symbol.iterator。
48 第3 章语言基础
Symbol.asyncIterator
根据ECMAScript 规范，这个符号作为一个属性表示“一个方法，该方法返回对象默认的AsyncIterator。
由for-await-of 语句使用”。换句话说，这个符号表示实现异步迭代器API 的函数。
for-await-of 循环会利用这个函数执行异步迭代操作。循环时，它们会调用以Symbol.asyncIterator
为键的函数，并期望这个函数会返回一个实现迭代器API 的对象。很多时候，返回的对象是实现该API
的AsyncGenerator：
class Foo {
async *Symbol.asyncIterator {}
}
let f = new Foo();
console.log(fSymbol.asyncIterator);
// AsyncGenerator {}
技术上，这个由Symbol.asyncIterator 函数生成的对象应该通过其next()方法陆续返回
Promise 实例。可以通过显式地调用next()方法返回，也可以隐式地通过异步生成器函数返回：
class Emitter {
constructor(max) {
this.max = max;
this.asyncIdx = 0;
}
async *Symbol.asyncIterator {
while(this.asyncIdx < this.max) {
yield new Promise((resolve) => resolve(this.asyncIdx++));
}
}
}
async function asyncCount() {
let emitter = new Emitter(5);
for await(const x of emitter) {
console.log(x);
}
}
asyncCount();
// 0
// 1
// 2
// 3
// 4
注意 Symbol.asyncIterator 是ES2018 规范定义的，因此只有版本非常新的浏览器
支持它。关于异步迭代和for-await-of 循环的细节，参见附录A。
Symbol.hasInstance
根据ECMAScript 规范，这个符号作为一个属性表示“一个方法，该方法决定一个构造器对象是否
3.4 数据类型 49
8
1
2
3
4
5
14
6
7
9
10
11
13
12
认可一个对象是它的实例。由instanceof 操作符使用”。instanceof 操作符可以用来确定一个对象
实例的原型链上是否有原型。instanceof 的典型使用场景如下：
function Foo() {}
let f = new Foo();
console.log(f instanceof Foo); // true
class Bar {}
let b = new Bar();
console.log(b instanceof Bar); // true
在ES6 中，instanceof 操作符会使用Symbol.hasInstance 函数来确定关系。以Symbol.
hasInstance 为键的函数会执行同样的操作，只是操作数对调了一下：
function Foo() {}
let f = new Foo();
console.log(FooSymbol.hasInstance); // true
class Bar {}
let b = new Bar();
console.log(BarSymbol.hasInstance); // true
这个属性定义在Function 的原型上，因此默认在所有函数和类上都可以调用。由于instanceof
操作符会在原型链上寻找这个属性定义，就跟在原型链上寻找其他属性一样，因此可以在继承的类上通
过静态方法重新定义这个函数：
class Bar {}
class Baz extends Bar {
static Symbol.hasInstance {
return false;
}
}
let b = new Baz();
console.log(BarSymbol.hasInstance); // true
console.log(b instanceof Bar); // true
console.log(BazSymbol.hasInstance); // false
console.log(b instanceof Baz); // false
Symbol.isConcatSpreadable
根据ECMAScript 规范，这个符号作为一个属性表示“一个布尔值，如果是true，则意味着对象应
该用Array.prototype.concat()打平其数组元素”。ES6 中的Array.prototype.concat()方法会
根据接收到的对象类型选择如何将一个类数组对象拼接成数组实例。覆盖Symbol.isConcat-
Spreadable 的值可以修改这个行为。
数组对象默认情况下会被打平到已有的数组，false 或假值会导致整个对象被追加到数组末尾。类
数组对象默认情况下会被追加到数组末尾，true 或真值会导致这个类数组对象被打平到数组实例。其
他不是类数组对象的对象在Symbol.isConcatSpreadable 被设置为true 的情况下将被忽略。
let initial = [‘foo’];
let array = [‘bar’];
console.log(array[Symbol.isConcatSpreadable]); // undefined
console.log(initial.concat(array)); // [‘foo’, ‘bar’]
array[Symbol.isConcatSpreadable] = false;
console.log(initial.concat(array)); // [‘foo’, Array(1)]
图灵社区会员 eraylee(eraylee@live.com) 专享尊重版权
50 第3 章语言基础
let arrayLikeObject = { length: 1, 0: ‘baz’ };
console.log(arrayLikeObject[Symbol.isConcatSpreadable]); // undefined
console.log(initial.concat(arrayLikeObject)); // [‘foo’, {…}]
arrayLikeObject[Symbol.isConcatSpreadable] = true;
console.log(initial.concat(arrayLikeObject)); // [‘foo’, ‘baz’]
let otherObject = new Set().add(‘qux’);
console.log(otherObject[Symbol.isConcatSpreadable]); // undefined
console.log(initial.concat(otherObject)); // [‘foo’, Set(1)]
otherObject[Symbol.isConcatSpreadable] = true;
console.log(initial.concat(otherObject)); // [‘foo’]
Symbol.iterator
根据ECMAScript 规范，这个符号作为一个属性表示“一个方法，该方法返回对象默认的迭代器。
由for-of 语句使用”。换句话说，这个符号表示实现迭代器API 的函数。
for-of 循环这样的语言结构会利用这个函数执行迭代操作。循环时，它们会调用以Symbol.iterator
为键的函数，并默认这个函数会返回一个实现迭代器API 的对象。很多时候，返回的对象是实现该API
的Generator：
class Foo {
*Symbol.iterator {}
}
let f = new Foo();
console.log(fSymbol.iterator);
// Generator {}
技术上，这个由Symbol.iterator 函数生成的对象应该通过其next()方法陆续返回值。可以通
过显式地调用next()方法返回，也可以隐式地通过生成器函数返回：
class Emitter {
constructor(max) {
this.max = max;
this.idx = 0;
}
*Symbol.iterator {
while(this.idx < this.max) {
yield this.idx++;
}
}
}
function count() {
let emitter = new Emitter(5);
for (const x of emitter) {
console.log(x);
}
}
count();
// 0
3.4 数据类型 51
8
1
2
3
4
5
14
6
7
9
10
11
13
12
// 1
// 2
// 3
// 4
注意迭代器的相关内容将在第7 章详细介绍。
Symbol.match
根据ECMAScript 规范，这个符号作为一个属性表示“一个正则表达式方法，该方法用正则表达式
去匹配字符串。由String.prototype.match()方法使用”。String.prototype.match()方法会使
用以Symbol.match 为键的函数来对正则表达式求值。正则表达式的原型上默认有这个函数的定义，
因此所有正则表达式实例默认是这个String 方法的有效参数：
console.log(RegExp.prototype[Symbol.match]);
// ƒ Symbol.match { [native code] }
console.log(‘foobar’.match(/bar/));
// [“bar”, index: 3, input: “foobar”, groups: undefined]
给这个方法传入非正则表达式值会导致该值被转换为RegExp 对象。如果想改变这种行为，让方法
直接使用参数，则可以重新定义Symbol.match 函数以取代默认对正则表达式求值的行为，从而让
match()方法使用非正则表达式实例。Symbol.match 函数接收一个参数，就是调用match()方法的
字符串实例。返回的值没有限制：
class FooMatcher {
static Symbol.match {
return target.includes(‘foo’);
}
}
console.log(‘foobar’.match(FooMatcher)); // true
console.log(‘barbaz’.match(FooMatcher)); // false
class StringMatcher {
constructor(str) {
this.str = str;
}
Symbol.match {
return target.includes(this.str);
}
}
console.log(‘foobar’.match(new StringMatcher(‘foo’))); // true
console.log(‘barbaz’.match(new StringMatcher(‘qux’))); // false
Symbol.replace
根据ECMAScript 规范，这个符号作为一个属性表示“一个正则表达式方法，该方法替换一个字符
串中匹配的子串。由String.prototype.replace()方法使用”。String.prototype.replace()
方法会使用以Symbol.replace 为键的函数来对正则表达式求值。正则表达式的原型上默认有这个函
数的定义，因此所有正则表达式实例默认是这个String 方法的有效参数：
52 第3 章语言基础
console.log(RegExp.prototype[Symbol.replace]);
// ƒ Symbol.replace { [native code] }
console.log(‘foobarbaz’.replace(/bar/, ‘qux’));
// ‘fooquxbaz’
给这个方法传入非正则表达式值会导致该值被转换为RegExp 对象。如果想改变这种行为，让方法
直接使用参数，可以重新定义Symbol.replace 函数以取代默认对正则表达式求值的行为，从而让
replace()方法使用非正则表达式实例。Symbol.replace 函数接收两个参数，即调用replace()方
法的字符串实例和替换字符串。返回的值没有限制：
class FooReplacer {
static [Symbol.replace](target, replacement) {
return target.split(‘foo’).join(replacement);
}
}
console.log(‘barfoobaz’.replace(FooReplacer, ‘qux’));
// “barquxbaz”
class StringReplacer {
constructor(str) {
this.str = str;
}
[Symbol.replace](target, replacement) {
return target.split(this.str).join(replacement);
}
}
console.log(‘barfoobaz’.replace(new StringReplacer(‘foo’), ‘qux’));
// “barquxbaz”
Symbol.search
根据ECMAScript 规范，这个符号作为一个属性表示“一个正则表达式方法，该方法返回字符串中
匹配正则表达式的索引。由String.prototype.search()方法使用”。String.prototype.search()
方法会使用以Symbol.search 为键的函数来对正则表达式求值。正则表达式的原型上默认有这个函数
的定义，因此所有正则表达式实例默认是这个String 方法的有效参数：
console.log(RegExp.prototype[Symbol.search]);
// ƒ Symbol.search { [native code] }
console.log(‘foobar’.search(/bar/));
// 3
给这个方法传入非正则表达式值会导致该值被转换为RegExp 对象。如果想改变这种行为，让方法
直接使用参数，可以重新定义Symbol.search 函数以取代默认对正则表达式求值的行为，从而让
search()方法使用非正则表达式实例。Symbol.search 函数接收一个参数，就是调用match()方法
的字符串实例。返回的值没有限制：
class FooSearcher {
static Symbol.search {
return target.indexOf(‘foo’);
}
}
3.4 数据类型 53
8
1
2
3
4
5
14
6
7
9
10
11
13
12
console.log(‘foobar’.search(FooSearcher)); // 0
console.log(‘barfoo’.search(FooSearcher)); // 3
console.log(‘barbaz’.search(FooSearcher)); // -1
class StringSearcher {
constructor(str) {
this.str = str;
}
Symbol.search {
return target.indexOf(this.str);
}
}
console.log(‘foobar’.search(new StringSearcher(‘foo’))); // 0
console.log(‘barfoo’.search(new StringSearcher(‘foo’))); // 3
console.log(‘barbaz’.search(new StringSearcher(‘qux’))); // -1
Symbol.species
根据ECMAScript 规范，这个符号作为一个属性表示“一个函数值，该函数作为创建派生对象的构
造函数”。这个属性在内置类型中最常用，用于对内置类型实例方法的返回值暴露实例化派生对象的方
法。用Symbol.species 定义静态的获取器（getter）方法，可以覆盖新创建实例的原型定义：
class Bar extends Array {}
class Baz extends Array {
static get Symbol.species {
return Array;
}
}
let bar = new Bar();
console.log(bar instanceof Array); // true
console.log(bar instanceof Bar); // true
bar = bar.concat(‘bar’);
console.log(bar instanceof Array); // true
console.log(bar instanceof Bar); // true
let baz = new Baz();
console.log(baz instanceof Array); // true
console.log(baz instanceof Baz); // true
baz = baz.concat(‘baz’);
console.log(baz instanceof Array); // true
console.log(baz instanceof Baz); // false
Symbol.split
根据ECMAScript 规范，这个符号作为一个属性表示“一个正则表达式方法，该方法在匹配正则表
达式的索引位置拆分字符串。由String.prototype.split()方法使用”。String.prototype.
split()方法会使用以Symbol.split 为键的函数来对正则表达式求值。正则表达式的原型上默认有
这个函数的定义，因此所有正则表达式实例默认是这个String 方法的有效参数：
console.log(RegExp.prototype[Symbol.split]);
// ƒ Symbol.split { [native code] }
console.log(‘foobarbaz’.split(/bar/));
// [‘foo’, ‘baz’]
图灵社区会员 eraylee(eraylee@live.com) 专享尊重版权
54 第3 章语言基础
给这个方法传入非正则表达式值会导致该值被转换为RegExp 对象。如果想改变这种行为，让方法
直接使用参数，可以重新定义Symbol.split 函数以取代默认对正则表达式求值的行为，从而让split()
方法使用非正则表达式实例。Symbol.split 函数接收一个参数，就是调用match()方法的字符串实
例。返回的值没有限制：
class FooSplitter {
static Symbol.split {
return target.split(‘foo’);
}
}
console.log(‘barfoobaz’.split(FooSplitter));
// [“bar”, “baz”]
class StringSplitter {
constructor(str) {
this.str = str;
}
Symbol.split {
return target.split(this.str);
}
}
console.log(‘barfoobaz’.split(new StringSplitter(‘foo’)));
// [“bar”, “baz”]
Symbol.toPrimitive
根据ECMAScript 规范，这个符号作为一个属性表示“一个方法，该方法将对象转换为相应的原始
值。由ToPrimitive 抽象操作使用”。很多内置操作都会尝试强制将对象转换为原始值，包括字符串、
数值和未指定的原始类型。对于一个自定义对象实例，通过在这个实例的Symbol.toPrimitive 属性
上定义一个函数可以改变默认行为。
根据提供给这个函数的参数（string、number 或default），可以控制返回的原始值：
class Foo {}
let foo = new Foo();
console.log(3 + foo); // “3[object Object]”
console.log(3 - foo); // NaN
console.log(String(foo)); // “[object Object]”
class Bar {
constructor() {
this[Symbol.toPrimitive] = function(hint) {
switch (hint) {
case ‘number’:
return 3;
case ‘string’:
return ‘string bar’;
case ‘default’:
default:
return ‘default bar’;
}
}
}
}
邮电
3.4 数据类型 55
8
1
2
3
4
5
14
6
7
9
10
11
13
12
let bar = new Bar();
console.log(3 + bar); // “3default bar”
console.log(3 - bar); // 0
console.log(String(bar)); // “string bar”
Symbol.toStringTag
根据ECMAScript 规范，这个符号作为一个属性表示“一个字符串，该字符串用于创建对象的默认
字符串描述。由内置方法Object.prototype.toString()使用”。
通过toString()方法获取对象标识时，会检索由Symbol.toStringTag 指定的实例标识符，默
认为"Object"。内置类型已经指定了这个值，但自定义类实例还需要明确定义：
let s = new Set();
console.log(s); // Set(0) {}
console.log(s.toString()); // [object Set]
console.log(s[Symbol.toStringTag]); // Set
class Foo {}
let foo = new Foo();
console.log(foo); // Foo {}
console.log(foo.toString()); // [object Object]
console.log(foo[Symbol.toStringTag]); // undefined
class Bar {
constructor() {
this[Symbol.toStringTag] = ‘Bar’;
}
}
let bar = new Bar();
console.log(bar); // Bar {}
console.log(bar.toString()); // [object Bar]
console.log(bar[Symbol.toStringTag]); // Bar
Symbol.unscopables
根据ECMAScript 规范，这个符号作为一个属性表示“一个对象，该对象所有的以及继承的属性，
都会从关联对象的with 环境绑定中排除”。设置这个符号并让其映射对应属性的键值为true，就可以
阻止该属性出现在with 环境绑定中，如下例所示：
let o = { foo: ‘bar’ };
with (o) {
console.log(foo); // bar
}
o[Symbol.unscopables] = {
foo: true
};
with (o) {
console.log(foo); // ReferenceError
}