JavaScript Symbol 属性使用指南

// 创建 Symbol
const id = Symbol('id'); // 'id' 是描述符（可选）
console.log(typeof id); // "symbol"

// 1. 基础创建
const sym1 = Symbol();
const sym2 = Symbol('description');
// 2. 全局注册表 (跨作用域共享)
const globalSym = Symbol.for('global.key'); // 不存在则创建
const sameSym = Symbol.for('global.key');   // 获取已存在的 Symbol
console.log(globalSym === sameSym); // true

const user = {
  name: 'Alice',
  age: 30,
  [Symbol('id')]: '123-456' // Symbol 属性
};

// 必须使用原始 Symbol 引用
const idSymbol = Symbol('id');
user[idSymbol] = '123-456';
console.log(user[idSymbol]); // "123-456"
console.log(user.idSymbol);  // undefined（错误方式）

console.log(user.hasOwnProperty(idSymbol)); // true
console.log(idSymbol in user);              // true

// 常规方法不会显示 Symbol 属性
console.log(Object.keys(user));         // ["name", "age"]
console.log(JSON.stringify(user));      // {"name":"Alice","age":30}
// 专用方法获取 Symbol 属性
const symbolProps = Object.getOwnPropertySymbols(user);
console.log(symbolProps);               // [Symbol(id)]
console.log(user[symbolProps[0]]);      // "123-456"
// 获取所有键（包括 Symbol）
const allKeys = Reflect.ownKeys(user);
console.log(allKeys); // ["name", "age", Symbol(id)]

// 创建/获取全局 Symbol
const globalSym1 = Symbol.for('app.global');
const globalSym2 = Symbol.for('app.global');
console.log(globalSym1 === globalSym2); // true
// 获取全局 Symbol 的键
console.log(Symbol.keyFor(globalSym1)); // "app.global"
const localSym = Symbol('local');
console.log(Symbol.keyFor(localSym));   // undefined

// 自定义迭代器
const myCollection = {
  items: [1, 2, 3],
  [Symbol.iterator]: function* () {
    for (let item of this.items) {
      yield item * 2;
    }
  }
};
console.log([...myCollection]); // [2, 4, 6]
// 自定义对象标识
class MyClass {
  get [Symbol.toStringTag]() {
    return 'MyCustomClass';
  }
}
console.log(new MyClass().toString()); // "[object MyCustomClass]"

// 安全扩展第三方对象
const libraryObject = { /* ... */ };
const customData = Symbol('myExtension');
libraryObject[customData] = { /* 你的数据 */ };

const Person = (() => {
  const _age = Symbol('age');
  return class Person {
    constructor(name, age) {
      this.name = name;
      this[_age] = age;
    }
    getAge() {
      return this[_age];
    }
  };
})();
const john = new Person('John', 30);
console.log(john.name);    // "John"
console.log(john.getAge()); // 30
console.log(john[_age]);    // 报错：_age 未定义

// 优于字符串常量
const LOG_LEVEL = {
  DEBUG: Symbol('DEBUG'),
  INFO: Symbol('INFO'),
  ERROR: Symbol('ERROR')
};
function log(message, level = LOG_LEVEL.INFO) {
  if (level === LOG_LEVEL.ERROR) {
    // 错误处理...
  }
}

// 自定义 instanceof 行为
class MyArray {
  static [Symbol.hasInstance](instance) {
    return Array.isArray(instance);
  }
}

console.log([] instanceof MyArray); // true

// 标记特殊对象
const READONLY_FLAG = Symbol('readonly');
function markReadonly(obj) {
  obj[READONLY_FLAG] = true;
  return new Proxy(obj, {
    set() {
      if (obj[READONLY_FLAG]) {
        throw new Error('Object is readonly');
      }
      return true;
    }
  });
}

const sym = Symbol('test');
console.log(sym + ' string'); // TypeError
console.log(Number(sym));     // TypeError

const obj = { 
  [Symbol('key')]: 'value' 
};
console.log(JSON.stringify(obj)); // {}

const obj = { [Symbol('key')]: 'value' };
const symbols = Object.getOwnPropertySymbols(obj);
console.log(obj[symbols[0]]); // "value"（仍可访问）