JavaScript Symbol toStringTag 属性

在 JavaScript 中，Symbol toStringTag 属性是一种用于定制对象的默认字符串描述的内建 Symbol 属性。它允许开发者定义一个定制的 [[Class]] 属性标签，使其在内部方法 Object.prototype.toString() 被调用时能够提供更有意义的对象描述。

Symbol toStringTag 属性是一个可读且可写的属性，它的默认值是 Symbol.toStringTag。可以通过修改这个属性值来改变对象的默认 toString() 行为。

使用方法

创建一个 Symbol toStringTag 属性有两种方式：

1. 使用内置的 Symbol.toStringTag 属性

const obj = {};
console.log(obj.toString());  // [object Object]

obj[Symbol.toStringTag] = 'CustomObject';
console.log(obj.toString());  // [object CustomObject]

在上面的例子中，我们创建了一个空对象 obj，并打印了默认的 toString() 结果 [object Object]。然后我们使用 Symbol.toStringTag 属性将 obj 的标签修改为 'CustomObject'，再次调用 toString() 方法时，结果就从 [object Object] 变成了 [object CustomObject]。

2. 使用内置 Symbol.species 属性

class CustomArray extends Array {
  get [Symbol.toStringTag]() {
    return 'CustomArray';
  }
}

const arr = new CustomArray();
console.log(arr.toString());  // [object CustomArray]

在上面的例子中，我们定义了一个自定义的数组类 CustomArray，继承自内建的 Array 类。通过重写 CustomArray 的 get 方法来修改 Symbol.toStringTag 属性的值，从而定制了数组实例的描述。调用 arr 的 toString() 方法时，结果为 [object CustomArray]。

应用场景

Symbol toStringTag 属性的使用场景有很多，以下是其中几个常见的应用：

1. 定制对象的默认字符串描述

class CustomPerson {
  constructor(name) {
    this.name = name;
  }
  get [Symbol.toStringTag]() {
    return 'CustomPerson';
  }
}

const person = new CustomPerson('John');
console.log(person.toString());  // [object CustomPerson]

在上面的例子中，我们创建了一个自定义的 Person 类，通过重写 Symbol.toStringTag 属性来定制 person 对象的默认字符串描述。调用 person 的 toString() 方法时，结果为 [object CustomPerson]。

2. 判断数据类型

function getType(obj) {
  return Object.prototype.toString.call(obj).slice(8,-1);
}

const num = 42;
console.log(getType(num));  // Number

const arr = [];
console.log(getType(arr));  // Array

const regex = /hello/;
console.log(getType(regex));  // RegExp

在上面的例子中，我们定义了一个 getType 函数来判断传入对象的类型。通过调用 Object.prototype.toString() 方法，并使用 slice() 方法截取结果的一部分，我们可以获取对象的类型。而这个类型信息正是由 Symbol toStringTag 属性提供的。

总结

Symbol toStringTag 属性是 JavaScript 中一个非常有用的内建 Symbol 属性。它允许开发者定义对象的默认字符串描述，并且可以方便地定制化 toString() 方法的行为。在实际开发中，该属性常用于定制对象的描述符、判断数据类型等场景。通过灵活运用 Symbol toStringTag 属性，开发者可以提供更清晰、更有意义的对象描述。