JavaScript 进阶必备:掌握 Symbol 新标识符用法



个人主页:学习前端的小z

个人专栏:JavaScript 精粹

本专栏旨在分享记录每日学习的前端知识和学习笔记的归纳总结,欢迎大家在评论区交流讨论!
在这里插入图片描述



在这里插入图片描述


💯Symbol

🚧 1. 综述

在ES5中,对象的属性名均为字符串,这容易导致属性名的冲突。例如,当你使用一个他人提供的对象并希望为其添加新方法时(采用mixin模式),新方法的名字可能与现有方法产生冲突。为避免此类冲突,ES6引入了Symbol

ES6新增了一种原始数据类型Symbol,它代表独一无二的值,成为JavaScript的第七种数据类型,前六种为:undefinednull、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。

Symbol值通过Symbol函数生成,意味着对象的属性名现在有两种类型:原有的字符串类型和新增的Symbol类型。凡是属性名为Symbol类型,都是独一无二的,可确保不会与其他属性名冲突。

let s = Symbol();  
typeof s; // "symbol"

上述代码中,变量s是一个独一无二的值。typeof运算符的结果表明s是Symbol数据类型,而非字符串等其他类型。

需注意的是,Symbol函数前不能使用new命令,否则将报错。因为生成的Symbol是一个原始类型的值,而非对象。因此,Symbol值无法添加属性,它类似于字符串数据类型。

Symbol函数可接受一个字符串作为参数,用于描述Symbol实例,便于在控制台显示或转为字符串时区分。

let s1 = Symbol('apple');  
let s2 = Symbol('banana');  
  
s1; // Symbol(apple)  
s2; // Symbol(banana)  
  
s1.toString(); // "Symbol(apple)"  
s2.toString(); // "Symbol(banana)"

在上述代码中,s1和s2是两个Symbol值。添加参数后,它们就有了自己的描述,便于在输出时区分。

如果Symbol的参数是一个对象,将调用该对象的toString方法,将其转为字符串,然后生成Symbol值。

const obj = {  
  toString() {  
    return 'xyz';  
  }  
};  
const sym = Symbol(obj);  
sym; // Symbol(xyz)

需要注意的是,Symbol函数的参数只是对当前Symbol值的描述,相同参数的Symbol函数返回值是不相等的。

// 无参数情况  
let s1 = Symbol();  
let s2 = Symbol();  
  
s1 === s2; // false  
  
// 有参数情况  
let s1 = Symbol('hello');  
let s2 = Symbol('hello');  
  
s1 === s2; // false

在上述代码中,s1和s2是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  
  
if (sym) {  
  // ...  
}  
  
Number(sym); // TypeError  
sym + 2; // TypeError

🚧2 Symbol.prototype.description

🚧 2.1 深入Symbol.prototype.description

在创建 Symbol 时,我们有机会为其添加一个描述性字符串,以增强代码的可读性。

const uniqueKey = Symbol('Unique Identifier');

在上述代码中,uniqueKey 这个 Symbol 的描述就是字符串 ‘Unique Identifier’。然而,若想要直接访问这个描述,传统上我们需要将 Symbol 转换为字符串形式,这可以通过以下两种方式实现:

const uniqueKey = Symbol('Unique Identifier');  
  
String(uniqueKey); // "Symbol(Unique Identifier)"  
uniqueKey.toString(); // "Symbol(Unique Identifier)"

尽管这些方法可行,但它们返回的结果包含了 “Symbol(” 和 “)” 这样的前缀和后缀,这在某些场景下可能不是我们所期望的。幸运的是,ES2019 引入了 Symbol.prototype.description 实例属性,它允许我们直接访问 Symbol 的描述部分,无需进行任何转换。

const uniqueKey = Symbol('Unique Identifier');  
  
uniqueKey.description; // "Unique Identifier"

这一特性不仅使得代码更加简洁,也提高了代码的可读性和维护性。通过 description 属性,我们可以轻松获取 Symbol 的描述,而无需担心字符串转换带来的额外开销或格式问题。

🚧3 Symbol 作为独一无二的属性键

由于每个 Symbol 值都是独一无二的,这一特性使得它们成为对象属性名的理想选择,能够确保属性名称的唯一性,避免属性名冲突或被意外覆盖,这在多模块协作构建对象时尤为重要。

const uniqueId = Symbol('uniqueProperty');  
  
// 第一种方式  
let obj1 = {};  
obj1[uniqueId] = 'Secret Value';  
  
// 第二种方式  
let obj2 = {  
  [uniqueId]: 'Secret Value'  
};  
  
// 第三种方式  
let obj3 = {};  
Object.defineProperty(obj3, uniqueId, { value: 'Secret Value' });  
  
// 以上方式均能得到相同的结果  
console.log(obj1[uniqueId]); // "Secret Value"  
console.log(obj2[uniqueId]); // "Secret Value"  
console.log(obj3[uniqueId]); // "Secret Value"

当使用 Symbol 作为对象属性名时,重要的是要记住不能使用点运算符(.)来访问这些属性,因为点运算符后面总是被解释为字符串字面量。

const id = Symbol('property');  
const obj = {};  
  
obj.id = 'Visible to all'; // 这里的 'id' 被当作字符串处理  
console.log(obj[id]); // undefined,因为 obj[id] 并没有设置  
console.log(obj['id']); // "Visible to all"

在对象字面量内部定义属性时,若属性键为 Symbol,同样需要将其放在方括号内。

const action = Symbol('performAction');  
  
let actions = {  
  [action]: () => console.log('Action performed!')  
};  
  
actions[action](); // 输出: Action performed!

利用 ES6 的增强对象字面量语法,我们可以使上述对象定义更加简洁

let actions = {  
  [action]() {  
    console.log('Action performed!');  
  }  
};  
  
actions[action](); // 输出: Action performed!

Symbol 还可以用来定义一组互不相同的常量,这在配置对象或枚举类型中特别有用。

const config = {  
  features: {  
    [Symbol('enableLogging')]: true,  
    [Symbol('enableDebugging')]: false  
  }  
};  
  
// 注意:直接访问 Symbol 作为键的值需要通过原始 Symbol  
console.log(config.features[Symbol('enableLogging')]); // undefined,因为键是另一个新的 Symbol  
// 正确的访问方式需要保留原始 Symbol 引用  
const enableLogging = Symbol('enableLogging');  
console.log(config.features[enableLogging]); // true(如果 enableLogging 是用于定义属性的同一个 Symbol)

最后,值得注意的是,尽管使用 Symbol 作为属性名可以确保属性的唯一性,但这些属性仍然是公开的,不是私有的。若要实现真正的封装和隐藏,需要采用其他方法,如使用闭包或 WeakMap。

下面是另外一个例子。

const COLOR_RED    = Symbol();
const COLOR_GREEN  = Symbol();

function getComplement(color) {
  switch (color) {
    case COLOR_RED:
      return COLOR_GREEN;
    case COLOR_GREEN:
      return COLOR_RED;
    default:
      throw new Error('Undefined color');
    }
}

使用 Symbol 作为常量值的核心优势在于其独一无二性,确保了在整个程序范围内不会有重复的值,这为逻辑判断(如switch语句)提供了坚实的保障,使得代码的执行能够严格遵循设计预期。

然而,值得注意的是,尽管 Symbol 值被用作属性名时能够增加属性的唯一性,但这样的属性依然是公开的,并不具备 JavaScript 原生支持的私有属性特性。因此,在需要保护对象属性不被外部直接访问时,开发者需要寻找其他解决方案,如使用闭包或模块封装等技术手段。

🚧 4 实例:替换硬编码字符串

硬编码字符串指的是在代码中直接出现、且与代码逻辑紧密绑定的具体字符串或数值。良好的编程实践建议尽量避免硬编码字符串,转而使用具有明确含义的变量来替代。

function calculateArea(shape, dimensions) {  
  let area = 0;  
  
  switch (shape) {  
    case 'Rectangle': // 硬编码字符串  
      area = dimensions.width * dimensions.height;  
      break;  
    /* ... 其他代码 ... */  
  }  
  
  return area;  
}  
  

calculateArea('Rectangle', { width: 10, height: 5 }); // 硬编码字符串

在上述代码中,字符串’Rectangle’就是一个硬编码字符串。它在代码中多次出现,与逻辑紧密绑定,不利于未来的修改和维护。

为了改进这一点,我们可以将硬编码字符串替换为变量。

const shapes = {  
  rectangle: 'Rectangle'  
};  
  
function calculateArea(shape, dimensions) {  
  let area = 0;  
  switch (shape) {  
    case shapes.rectangle:  
      area = dimensions.width * dimensions.height;  
      break;  
  }  
  return area;  
}  
  
calculateArea(shapes.rectangle, { width: 10, height: 5 });

在改进后的代码中,我们将’Rectangle’定义为了shapes对象的一个属性,从而消除了硬编码。

进一步思考,shapes.rectangle的确切值并不重要,只要它能确保唯一性且不与其他shapes属性的值冲突即可。因此,使用Symbol值是一个更好的选择。

const shapes = {  
  rectangle: Symbol()  
};
在上面的代码中,我们将shapes.rectangle的值设置为了一个Symbol,而其他代码部分无需修改。

🚧 5 Symbol属性名的隐藏特性

当Symbol被用作对象的属性名时,该属性在遍历对象时不会被for…in、for…of循环以及Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()等方法返回。

然而,Symbol属性并非私有属性。Object.getOwnPropertySymbols()方法可以获取指定对象的所有用作属性名的Symbol值。

const myObject = {};  
const symA = Symbol('A');  
const symB = Symbol('B');  
  
myObject[symA] = 'Apple';  
myObject[symB] = 'Banana';  
  
const symbols = Object.getOwnPropertySymbols(myObject);  
  
symbols; // [Symbol(A), Symbol(B)]

上述代码展示了Object.getOwnPropertySymbols()方法的使用,它返回了所有Symbol属性名。

以下是一个对比Object.getOwnPropertySymbols()与for…in循环及Object.getOwnPropertyNames()方法的例子。

const myObject = {};  
const mySymbol = Symbol('mySymbol');  
  
myObject[mySymbol] = 'Value';  
  
for (let key in myObject) {  
  console.log(key); // 无输出  
}  
  
Object.getOwnPropertyNames(myObject); // []  
Object.getOwnPropertySymbols(myObject); // [Symbol(mySymbol)]

在上述代码中,for…in循环和Object.getOwnPropertyNames()方法都无法获取到Symbol键名,而Object.getOwnPropertySymbols()方法则可以。

Reflect.ownKeys()是一个新的API,它可以返回对象上所有类型的键名,包括常规键名和Symbol键名。

const myObject = {  
  [Symbol('myKey')]: 'Secret',  
  visible: 'Visible'  
};  
  
Reflect.ownKeys(myObject);  
//  ["visible", Symbol(myKey)]

由于Symbol属性名不会被常规方法遍历,我们可以利用这一特性为对象定义一些非私有的、但仅供内部使用的属性或方法。

const internalKey = Symbol('internalKey');  
  
class DataStorage {  
  constructor() {  
    this[internalKey] = {};  
  }  
  
  saveData(key, value) {  
    this[internalKey][key] = value;  
  }  
  
  getData(key) {  
    return this[internalKey][key];  
  }  
}  
  
const storage = new DataStorage();  
storage.saveData('userInfo', { name: 'Alice' });  
console.log(storage.getData('userInfo')); // { name: 'Alice' }  
  
Object.keys(storage); // []  
Object.getOwnPropertyNames(storage); // 可能包含一些继承的属性名,但不包括internalKey  
Object.getOwnPropertySymbols(storage); // [Symbol(internalKey)]

在上述代码中,DataStorage类的实例storage使用了一个Symbol属性名internalKey来存储内部数据,这使得这些数据不会通过常规方法被外部访问到。

🚧 6 Symbol的全局注册与检索

有时,我们需要跨多个代码模块或执行上下文重用同一个Symbol值。Symbol.for()方法允许我们通过传递一个字符串参数来实现这一点。如果全局注册表中已存在该字符串对应的Symbol值,则直接返回该值;否则,创建一个新的Symbol值并将其注册到全局注册表中。

let sym1 = Symbol.for('unique');  
let sym2 = Symbol.for('unique');  
  
sym1 === sym2; // true
在上述代码中,sym1和sym2都是通过Symbol.for('unique')创建的,因此它们是同一个Symbol值。

Symbol.for()与直接使用Symbol()的区别在于前者会将Symbol值注册到全局环境中,而后者每次调用都会创建一个新的Symbol值。

javascript
Symbol.for('example') === Symbol.for('example'); // true  
Symbol('example') === Symbol('example'); // false
Symbol.keyFor()方法用于检索已注册的Symbol值的字符串键。

javascript
let registeredSym = Symbol.for('registered');  
Symbol.keyFor(registeredSym); // 'registered'  
  
let unregisteredSym = Symbol('unregistered');  
Symbol.keyFor(unregisteredSym); // undefined

在上述代码中,unregisteredSym是一个未注册的Symbol值,因此Symbol.keyFor(unregisteredSym)返回undefined。
值得注意的是,Symbol.for()注册的全局Symbol值在任何执行上下文中都是可用的,包括不同的iframe或service worker。

function createGlobalSymbol() {  
  return Symbol.for('globalSymbol');  
}  
  
const sym1 = createGlobalSymbol();  
const sym2 = Symbol.for('globalSymbol');  
  
console.log(sym1 === sym2); // true  
  
// 在iframe中  
const iframe = document.createElement('iframe');  
iframe.src = String(window.location);  
document.body.appendChild(iframe);  
  
iframe.onload = function() {  
  console.log(iframe.contentWindow.Symbol.for('globalSymbol') === sym1); // true  
};

上述代码展示了如何在主页面和iframe之间共享通过Symbol.for()注册的全局Symbol值。】

将【】中的markdown文本中的代码块插入如下格式
javascript
代码块放在中间

🚧 7 内置的 Symbol 值

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

🔱 7.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() // true

上面代码中,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 Even // false
2 instanceof Even // true
12345 instanceof Even // false

🔱7.2 Symbol.isConcatSpreadable

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

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

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

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

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

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

obj[Symbol.isConcatSpreadable] = true;
['a', 'b'].concat(obj, 'e') // ['a', 'b', 'c', 'd', '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)
// [1, 2, 3, 4, [5, 6]]

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

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

🔱7.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 MyArray // true
c instanceof MyArray // true

上面代码中,子类MyArray继承了父类ArrayaMyArray的实例,bca的衍生对象。你可能会认为,bc都是调用数组方法生成的,所以应该是数组(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 MyArray // false
b instanceof Array // true

上面代码中,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 T1 // true
new T2(r => r()).then(v => v) instanceof T2 // false

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

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

🔱7.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()) // 1

🔱7.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') // ["Hello", "World"]

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

🔱7.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')) // 0

🔱7.7 掌握 Symbol.split:自定义字符串分割逻辑

在JavaScript中,对象的Symbol.split属性指向一个特殊的方法。当该对象作为分隔符被传递给String.prototype.split方法时,Symbol.split方法会被调用,并返回split方法的处理结果。

具体来说,以下两种调用方式是等效的:

String.prototype.split(separator, limit);  
// 等同于  
separator[Symbol.split](this, limit);

下面是一个示例,展示了如何使用Symbol.split方法来自定义字符串的分割逻辑:

class CustomSplitter {  
  constructor(delimiter) {  
    this.delimiter = delimiter;  
  }  
    
  [Symbol.split](string, limit) {  
    let index = string.indexOf(this.delimiter);  
    if (index === -1) {  
      // 如果找不到分隔符,则返回整个字符串  
      return [string];  
    }  
    // 否则,根据分隔符将字符串分割成两部分  
    let part1 = string.substring(0, index);  
    let part2 = string.substring(index + this.delimiter.length);  
    return [part1, part2];  
  }  
}  
  
// 使用自定义的分隔符对象进行字符串分割  
'foobar'.split(new CustomSplitter('foo')); // 输出:['', 'bar']  
'foobar'.split(new CustomSplitter('bar')); // 输出:['foo', '']  
'foobar'.split(new CustomSplitter('baz')); // 输出:['foobar'],因为找不到分隔符

在这个示例中,我们定义了一个CustomSplitter类,它包含了一个Symbol.split方法。这个方法接受一个字符串和一个可选的限制参数,然后根据自定义的分隔符来分割字符串。通过这种方式,我们可以灵活地控制字符串的分割逻辑,使其更加符合我们的需求。

🔱7.8 Symbol.iterator

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

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

[...myIterable] // [1, 2, 3]

对象进行for...of循环时,会调用Symbol.iterator方法,返回该对象的默认遍历器,详细介绍参见《Iterator 和 for…of 循环》一章。

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);
}
// 1
// 2

🔱7.9 深入理解 Symbol.toPrimitive 方法

对象的 Symbol.toPrimitive 属性指向一个特定的方法,该方法在对象需要被转换为原始类型值时被调用,并返回相应的原始类型值。

Symbol.toPrimitive 方法在被调用时会接收一个字符串参数,该参数表示当前运算所需的模式,具体有三种模式可选:

  • Number:表示需要将对象转换为数值类型。
  • String:表示需要将对象转换为字符串类型。
  • Default:表示对象可以根据情况转换为数值或字符串类型。

以下是一个示例代码,展示了 Symbol.toPrimitive 方法的使用:

let obj = {  
  [Symbol.toPrimitive](hint) {  
    switch (hint) {  
      case 'number':  
        return 123; // 当需要数值时,返回123  
      case 'string':  
        return 'str'; // 当需要字符串时,返回'str'  
      case 'default':  
        return 'default'; // 当无特定需求时,返回'default'  
      default:  
        throw new Error(); // 对于未知的模式,抛出错误  
    }  
  }  
};  
  
console.log(2 * obj); // 输出:246,因为对象被转换为了数值123  
console.log(3 + obj); // 输出:'3default',因为对象在默认模式下被转换为了字符串'default'  
console.log(obj == 'default'); // 输出:true,因为对象在默认模式下的原始值就是'default'  
console.log(String(obj)); // 输出:'str',因为对象被明确转换为了字符串'str'

在这个示例中,通过定义 Symbol.toPrimitive 方法,我们控制了对象在不同情况下转换为原始类型值的行为。

🔱7.10 Symbol.toStringTag

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

// 例一
({[Symbol.toStringTag]: 'Foo'}.toString())
// "[object Foo]"

// 例二
class Collection {
  get [Symbol.toStringTag]() {
    return 'xxx';
  }
}
let x = new Collection();
Object.prototype.toString.call(x) // "[object xxx]"

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’

🔱7.11 探索 Symbol.unscopables 属性

对象的 Symbol.unscopables 属性是一个指向对象的指针,该对象用于定义在使用 with 语句时,哪些属性应该被排除在 with 环境之外。

// 查看 Array.prototype 上的 Symbol.unscopables 属性  
Array.prototype[Symbol.unscopables]  
// 输出:  
// {  
//   copyWithin: true,  
//   entries: true,  
//   fill: true,  
//   find: true,  
//   findIndex: true,  
//   includes: true,  
//   keys: true  
// }  
  
// 获取并列出所有被排除的属性名  
Object.keys(Array.prototype[Symbol.unscopables])  
// 输出:['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'includes', 'keys']

上述代码展示了数组有7个属性,这些属性在使用 with 语句时会被排除。

// 未使用 Symbol.unscopables 时  
class MyClass {  
  foo() { return 1; }  
}  
  
var foo = function () { return 2; };  
  
with (MyClass.prototype) {  
  foo(); // 输出:1,调用的是 MyClass.prototype 上的 foo 方法  
}  
  
// 使用了 Symbol.unscopables 时  
class MyClass {  
  foo() { return 1; }  
  get [Symbol.unscopables]() {  
    return { foo: true };  
  }  
}  
  
var foo = function () { return 2; };  
  
with (MyClass.prototype) {  
  foo(); // 输出:2,调用的是外部作用域中的 foo 函数  
}

在上述代码中,通过为 MyClass 类定义 Symbol.unscopables 属性,我们指定了在使用 with 语句时,foo 属性应该被排除在当前作用域之外,因此 foo 会指向外部作用域中的同名变量或函数。


在这里插入图片描述


JavaScript: https://developer.mozilla.org/en-US/docs/Web/JavaScript


  • 266
    点赞
  • 160
    收藏
    觉得还不错? 一键收藏
  • 158
    评论
评论 158
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值