面试题：JavaScript 公认符号之 Symbol 在元编程中的应用场景

Question

在 JavaScript 元编程的语境下，阐述 Symbol 类型的独特应用场景。请利用 Symbol 创建一个可迭代对象，实现自定义的迭代逻辑，并且说明 Symbol 在防止属性名冲突、定义对象内部方法等方面如何提升代码的健壮性和可维护性，以及与其他传统方式相比的优势。

Answer 1

Symbol 类型的独特应用场景

1. 唯一标识：Symbol 类型创建的 symbol 值是唯一的，可用于为对象添加独一无二的属性，避免属性名冲突。在大型项目中，不同模块可能为对象添加属性，使用 Symbol 可防止属性名重复导致的意外覆盖。
2. 隐藏属性：由于 symbol 作为属性名不能通过常规的 for...in 循环或 Object.keys() 遍历到，可用于定义对象内部的、不希望外部直接访问的属性，实现一定程度的数据封装。
3. 元编程：在元编程中，Symbol 有特殊用途，例如定义对象的可迭代性、自定义类型转换等。

创建可迭代对象并实现自定义迭代逻辑

const myIterable = {
    [Symbol.iterator]() {
        let index = 0;
        const data = [1, 2, 3, 4, 5];
        return {
            next() {
                if (index < data.length) {
                    return { value: data[index++], done: false };
                } else {
                    return { done: true };
                }
            }
        };
    }
};

for (const value of myIterable) {
    console.log(value);
}

在上述代码中，通过在对象上定义 Symbol.iterator 方法，使该对象成为可迭代对象。Symbol.iterator 方法返回一个具有 next() 方法的迭代器对象，next() 方法定义了每次迭代返回的值和是否迭代结束的状态。

在防止属性名冲突方面提升代码健壮性和可维护性

1. 传统方式的问题：使用字符串作为属性名时，很容易在不同部分的代码中出现相同的属性名，导致属性值被意外覆盖。例如：

const obj1 = { prop: 'value1' };
const obj2 = { prop: 'value2' };
// 假设在某个地方合并这两个对象，prop 属性会被覆盖

2. Symbol 的优势：使用 Symbol 作为属性名可避免这种冲突。

const sym = Symbol('prop');
const obj1 = { [sym]: 'value1' };
const obj2 = { [Symbol('prop')]: 'value2' };
// 这里即使看起来属性名描述一样，但实际是不同的 symbol，不会冲突

这样，在代码维护过程中，无需担心不同模块间因属性名相同而引发的错误。

在定义对象内部方法方面提升代码健壮性和可维护性

1. 传统方式的问题：传统上通过字符串定义对象方法，这些方法容易被外部代码直接访问和修改，破坏对象的封装性和内部逻辑。例如：

const obj = {
    _privateMethod() {
        console.log('This is a private method');
    }
};
// 外部代码可以通过 obj._privateMethod() 调用，破坏封装

2. Symbol 的优势：使用 Symbol 定义内部方法，可隐藏这些方法，外部代码无法轻易访问。

const privateMethodSymbol = Symbol('privateMethod');
const obj = {
    [privateMethodSymbol]() {
        console.log('This is a truly private method');
    },
    publicMethod() {
        this[privateMethodSymbol]();
    }
};
// 外部代码无法直接通过 symbol 访问，只能通过公开方法间接调用，增强了封装性和代码健壮性

在维护代码时，不会担心内部方法被外部错误调用或修改，提高了代码的可维护性。