内置对象 - Symbol 对象 - 符号类型的创建与使用

前端 - Javascript 《内置对象 - Symbol 对象 - 符号类型的创建与使用》

一、引言

在 JavaScript 的数据类型大家庭中，ES6 引入了一种全新的原始数据类型——Symbol。它就像是一个神秘的“隐形标记”，为开发者提供了独特且不可变的值，在很多场景下发挥着重要作用。接下来，我们就一起揭开Symbol对象的神秘面纱，探索符号类型的创建与使用。

二、Symbol 的基本概念

Symbol是一种原始数据类型，表示独一无二的值。这意味着即使你创建两个看起来一模一样的Symbol，它们也是不相等的。与其他原始数据类型（如Number、String、Boolean等）不同，Symbol的主要特点就是其唯一性。

三、Symbol 的创建

在 JavaScript 中，创建Symbol非常简单，使用Symbol()函数即可。这个函数可以接受一个可选的字符串参数，用于描述这个Symbol，主要是为了方便调试和识别。

1. 创建无描述的 Symbol

const sym1 = Symbol();
const sym2 = Symbol();
console.log(sym1 === sym2); // false

在这个例子中，我们创建了两个Symbol，尽管它们没有描述信息，但它们是不相等的，这体现了Symbol的唯一性。

2. 创建带描述的 Symbol

const sym3 = Symbol('description');
const sym4 = Symbol('description');
console.log(sym3 === sym4); // false
console.log(sym3.toString()); // "Symbol(description)"

这里我们为Symbol添加了描述信息，虽然sym3和sym4的描述相同，但它们仍然是不相等的。同时，我们可以通过toString()方法将Symbol转换为字符串，方便查看其描述。

3. 使用 Symbol.for() 创建全局 Symbol

Symbol.for()方法可以创建或检索全局Symbol注册表中的Symbol。如果指定的键已经存在于全局注册表中，则返回该Symbol；否则，创建一个新的Symbol并将其存储在全局注册表中。

const globalSym1 = Symbol.for('global');
const globalSym2 = Symbol.for('global');
console.log(globalSym1 === globalSym2); // true

在这个例子中，Symbol.for('global')第一次调用时会创建一个新的全局Symbol，第二次调用时会返回之前创建的同一个Symbol，因此globalSym1和globalSym2是相等的。

4. 使用 Symbol.keyFor() 获取全局 Symbol 的键

Symbol.keyFor()方法可以用来获取全局Symbol的键。

const globalSym = Symbol.for('myGlobalSymbol');
const key = Symbol.keyFor(globalSym);
console.log(key); // "myGlobalSymbol"

四、Symbol 的使用场景

1. 作为对象属性名

Symbol可以作为对象的属性名，这样可以避免属性名冲突。因为Symbol是独一无二的，不会与其他属性名重复。

const nameSymbol = Symbol('name');
const person = {
    [nameSymbol]: 'John',
    age: 30
};
console.log(person[nameSymbol]); // "John"

在这个例子中，我们使用Symbol作为person对象的属性名，这样即使其他代码也使用了name作为属性名，也不会与我们的nameSymbol冲突。

2. 模拟私有属性

由于Symbol作为属性名时，不会被for...in、Object.keys()、JSON.stringify()等方法遍历到，因此可以用来模拟对象的私有属性。

const privateKey = Symbol('private');
class MyClass {
    constructor() {
        this[privateKey] = 'This is a private value';
    }
    getPrivateValue() {
        return this[privateKey];
    }
}
const obj = new MyClass();
console.log(obj.getPrivateValue()); // "This is a private value"
for (let key in obj) {
    console.log(key); // 不会输出 privateKey
}

在这个例子中，privateKey作为MyClass的私有属性，外部代码无法通过常规的遍历方法访问到它。

3. 定义常量

使用Symbol定义常量可以确保常量的唯一性，避免常量名冲突。

const COLOR_RED = Symbol('red');
const COLOR_GREEN = Symbol('green');
const COLOR_BLUE = Symbol('blue');
function getColorName(color) {
    switch (color) {
        case COLOR_RED:
            return 'Red';
        case COLOR_GREEN:
            return 'Green';
        case COLOR_BLUE:
            return 'Blue';
        default:
            return 'Unknown';
    }
}
console.log(getColorName(COLOR_RED)); // "Red"

在这个例子中，我们使用Symbol定义了三个颜色常量，确保它们的唯一性，避免了常量名冲突的问题。

五、总结

方法/特性	描述
`Symbol()`	创建一个唯一的`Symbol`，可接受一个可选的描述字符串
`Symbol.for(key)`	创建或检索全局`Symbol`注册表中的`Symbol`
`Symbol.keyFor(sym)`	获取全局`Symbol`的键
作为对象属性名	避免属性名冲突
模拟私有属性	不被常规遍历方法访问
定义常量	确保常量的唯一性

Symbol作为 JavaScript 中的一种新的数据类型，为我们提供了很多有用的功能和特性。通过合理使用Symbol，我们可以编写出更加健壮、安全的代码。希望本文能帮助你更好地理解和使用Symbol对象。

.bat程序教程	python入门基础教程	Pandas教程	Pygame教程
Django3.2.9教程	Flask1.1.1教程	python3.X - 区块链教程	Java教程
Spring教程	C#教程	PHP教程	R教程
Node.js教程	mysql数据库教程	Redis数据库教程	MongoDB数据库教程
RabbitMQ教程	Lua教程	FindBI教程	HTML5教程
CSS教程	Javascript教程	jQuery教程	微信小程序教程
微信小游戏教程	Vue.js教程	服务器教程	TensorFlow教程
PyTorch教程	Unity教程	Objective-C教程	Android教程
AppleScript教程	Mac - SHELL教程	算法教程	Python教程
数据库教程	运维工具教程	Nginx教程	Docker教程