从零认识 Symbol：3 分钟搞懂 ES6 新类型

原创已于 2025-11-19 09:56:14 修改 · 700 阅读

20 ·

CC 4.0 BY-SA版权

文章标签：

#es6 #前端 #ecmascript

于 2025-11-19 09:17:09 首次发布

前端同时被 2 个专栏收录

38 篇文章

订阅专栏

ES6

18 篇文章

订阅专栏

在 JavaScript 中，Symbol 是 ES6 引入的原始数据类型（与 String、Number、Boolean、null、undefined 并列），核心作用是生成唯一且不可变的标识符，解决对象属性名冲突、实现私有属性等场景。

一、核心特性（决定其作用的基础）

唯一性：即使传入相同的描述符，两个 Symbol 实例也不相等（描述符仅用于调试，不影响唯一性）。
不可变性：Symbol 生成后无法修改，也无法被隐式转换为字符串 / 数字（避免意外操作）。
隐式不枚举：Symbol 作为对象属性名时，不会被 for...in、Object.keys()、JSON.stringify() 遍历到（但可通过 Object.getOwnPropertySymbols() 获取）。

二、主要作用及场景

1. 避免对象属性名冲突

这是 Symbol 最核心的作用。当多个模块 / 代码片段需要给同一个对象添加属性时，普通字符串属性名容易重复覆盖，而 Symbol 天然唯一，不会冲突。

示例：

// 模块 A 定义的 Symbol 属性
const sym1 = Symbol('user');
const obj = {
  [sym1]: '模块A的用户数据' // Symbol 作为属性名需用 [] 包裹
};

// 模块 B 定义相同描述符的 Symbol
const sym2 = Symbol('user');
obj[sym2] = '模块B的用户数据'; // 不会覆盖 sym1 的属性

console.log(obj[sym1]); // "模块A的用户数据"
console.log(obj[sym2]); // "模块B的用户数据"
console.log(sym1 === sym2); // false（即使描述符相同，实例也不相等）

2. 实现对象 “私有属性”（弱私有）

JavaScript 没有原生的私有属性语法（ES11 新增 # 私有字段，但兼容性和灵活性有限），Symbol 可通过 “隐式不枚举” 特性模拟私有属性 —— 外部无法通过常规遍历获取，只能通过持有 Symbol 实例访问。

示例：

// 模块内部定义 Symbol（外部无法访问该 Symbol 实例）
const _privateProp = Symbol('private');

class MyClass {
  constructor() {
    this[_privateProp] = '私有数据'; // 私有属性
  }

  getPrivate() {
    return this[_privateProp]; // 仅内部方法可访问
  }
}

const instance = new MyClass();
console.log(instance.getPrivate()); // "私有数据"

// 外部无法通过常规方式获取：
console.log(instance[_privateProp]); // undefined（外部没有 _privateProp 引用）
console.log(Object.keys(instance)); // []（不枚举 Symbol 属性）
console.log(JSON.stringify(instance)); // "{}"（不序列化 Symbol 属性）

⚠️ 注意：这是 “弱私有”—— 外部仍可通过 Object.getOwnPropertySymbols(instance) 获取所有 Symbol 属性并访问，但这种方式属于非常规操作，可视为 “约定俗成的私有”。

3. 定义常量（避免魔法字符串）

当需要定义一组 “互不相等” 的常量（如状态码、枚举值）时，Symbol 比字符串更安全（避免字符串拼写错误导致的 bug）。

示例：

// 用 Symbol 定义状态常量（天然唯一，不会冲突）
const STATUS_PENDING = Symbol('pending');
const STATUS_RESOLVED = Symbol('resolved');
const STATUS_REJECTED = Symbol('rejected');

function handleStatus(status) {
  switch (status) {
    case STATUS_PENDING:
      console.log('等待中');
      break;
    case STATUS_RESOLVED:
      console.log('成功');
      break;
    case STATUS_REJECTED:
      console.log('失败');
      break;
  }
}

handleStatus(STATUS_RESOLVED); // "成功"
// 不会因误写字符串（如 'resolve'）导致逻辑错误

4. 扩展原生对象（无冲突）

有时需要给数组、对象等原生类型添加自定义方法，用 Symbol 作为方法名可避免覆盖原生方法或其他库的扩展方法。

示例：

// 给数组添加自定义遍历方法，用 Symbol 命名避免冲突
const myForEach = Symbol('myForEach');
Array.prototype[myForEach] = function (callback) {
  for (let i = 0; i < this.length; i++) {
    callback(this[i], i, this);
  }
};

const arr = [1, 2, 3];
arr[myForEach]((item) => console.log(item)); // 1 2 3

// 不会影响原生 forEach 或其他方法
arr.forEach((item) => console.log(item * 2)); // 2 4 6

5. 作为对象的 “元数据” 标识

Symbol 可用于存储对象的元数据（如类型标识、配置信息），不会污染常规属性，也不会被序列化。

示例：

// 定义元数据 Symbol
const TYPE_SYMBOL = Symbol('type');

// 给对象添加类型元数据
const user = {
  name: '张三',
  [TYPE_SYMBOL]: 'user'
};

const post = {
  title: '文章',
  [TYPE_SYMBOL]: 'post'
};

// 通过 Symbol 判断对象类型
function getType(obj) {
  return obj[TYPE_SYMBOL];
}

console.log(getType(user)); // "user"
console.log(getType(post)); // "post"

三、关键 API

Symbol([description])：创建 Symbol 实例（描述符可选，仅用于 console.log 调试）。
Symbol.for(key)：全局 Symbol 注册表 —— 如果存在 key 对应的 Symbol，则返回它；否则创建并注册（解决 Symbol 跨模块共享问题）。
javascript
```
const symA = Symbol.for('globalKey');
const symB = Symbol.for('globalKey');
console.log(symA === symB); // true（同一全局 Symbol）
```
Symbol.keyFor(sym)：获取全局注册表中 Symbol 对应的 key（非全局 Symbol 返回 undefined）。
javascript
```
const sym = Symbol.for('globalKey');
console.log(Symbol.keyFor(sym)); // "globalKey"
```
Object.getOwnPropertySymbols(obj)：获取对象所有 Symbol 类型的属性名（返回数组）。
Reflect.ownKeys(obj)：获取对象所有属性名（包括 Symbol 和字符串，不包含继承属性）。

四、注意事项

Symbol 不能使用 new 关键字（会报错），直接调用 Symbol() 即可。

Symbol 无法被隐式转换为字符串 / 数字（String(sym) 或 sym.toString() 可显式转换为描述符字符串）：

const sym = Symbol('test');
console.log(sym + ''); // 报错（Cannot convert a Symbol value to a string）
console.log(String(sym)); // "Symbol(test)"（显式转换允许）