作为属性名的 Symbol

由于每一个 Symbol 值都是不相等的,这意味着 Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心修改或者覆盖

let mySymbol = Symbol()

// 第一种写法
let a = {}
a[mySymbol] = 'Hello!'

// 第二种写法
let a = {
  [mySymbol]: 'Hello!'
}

// 第三种写法
let a = {}
Object.defineProperty(a, mySymbol, { value: 'Hello!' })

// 以上写法都得到同样结果
a[mySymbol] // Hello

上面代码通过方括号结构和 Object.defineProperty ,将对象的属性名指定为一个 Symbol 值

注意,Symbol 值作为对象属性名时,不能用点运算符

const mySymbol = Symbol()
const a = {}

a.mySymbol = 'Hello!'
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"

上面代码中,如果 s 不放在方括号中,该属性的键名就是字符串 s ,而不是 s 所代表的那个 Symbol

采用增强的对象写法,上面代码的 obj 对象可以写得更简洁一些

let obj = {
  [s](arg) { ... }
}

Symbol 类型还可以用于定义一组常量,保证这组常量的值都是不相等的

const log = {}

log.levels = {
  DEBUG: Symbol('debug'),
  INFO: Symbol('info'),
  WARN: Symbol('warn')
}

console.log(log.levels.DEBUG, 'debug message')
console.log(log.levels.INFO, 'info message')

下面是另外一个例子

const COLOR_RED = Symbol()
const COLOR_GREEN = Symbol()

function getComplement(color) {
  switch (color) {
    case COLOR_RED:
      return COLOR_GREEN
    case COLOR_GREEN:
      return COLOR_RED
    default:
      throw new Error('Undefined color')
  }
}

常量使用 Symbol 值最大的好处,就是其他任何值都不可能有相同的值了,因此可以报告上面的 switch 语句会按设计的方式工作

还有一点需要注意,Symbol 值作为属性名时,该属性还是公开属性,不是私有属性

Last updated