ES6 新特性之 Symbol

概述

ES5 的对象属性名都是字符串,这在混入 (mixin) 等模式中容易造成属性名的冲突

ES6 引入了一种新的原始数据类型 Symbol,表示独一无二的值,它是 JavaScript 语言的第七种数据类型

Javascript 七种基本类型:undefined、null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)、Symbol

let s = Symbol()
typeof s // "symbol"

上面代码中,变量 s 就是一个独一无二的值,typeof 运算符的结果,表明变量 s 是 Symbol 数据类型

Symbol 函数前不能使用 new 命令,否则会报错,因为生成的 Symbol 是一个原始类型的值,不是对象

Symbol 函数可以接受一个字符串作为参数,表示对 Symbol 实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分

let s1 = Symbol('foo')
let s2 = Symbol('bar')
s1 // Symbol(foo)
s2 // Symbol(bar)
s1.toString() // "Symbol(foo)
s2.toString() // "Symbol(bar)

如果 Symbol 的参数是一个对象,就会调用该对象的 toString 方法,将其转为字符串,然后才生成一个 Symbol 值

const obj = {
  toString () {
    return 'abc'
  }
}
const sym = Symbol(obj)
sym // Symbol(abc)

Symbol 函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的 Symbol 函数的返回值是不相等的

// 没有参数的情况
let s1 = Symbol();
let s2 = Symbol();
s1 === s2 // false

// 有参数的情况
let s1 = Symbol('foo');
let s2 = Symbol('foo');
s1 === s2 // false

作为属性名的 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!"

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

示例:消灭魔术字符串

魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值

function getArea (shape, options) {
  let area = 0
  switch (shape) {
    case 'Triangle':
      area = .5 * options.width * options.height
      break
    /* ... more code ... */
  }
  return area
}

getArea('Triangle', { width: 100, height: 100 })

上面代码中,字符串 Triangle 就是一个魔术字符串,常用的消除魔术字符串的方法,就是把它写成一个变量

const shapeType = { triangle: 'Triangle' }
function getArea (shape, options) {
  let area = 0
  switch (shape) {
    case shapeType.triangle:
      area = .5 * options.width * options.height;
      break
  }
  return area
}

getArea(shapeType.triangle, { width: 100, height: 100 })

如果仔细分析,可以发现 shapeType.triangle 等于哪个值并不重要,只要确保不会跟其他 shapeType 属性的值冲突即可,这种情形就很适合改用 Symbol 值

const shapeType = { triangle: Symbol() }

Symbol.for,Symbol.keyFor

有时,我们希望重新使用同一个 Symbol 值,Symbol.for 方法可以做到这一点

let s1 = Symbol.for('foo')
let s2 = Symbol.for('foo')
s1 === s2 // true

上面代码中,s1 和 s2 都是 Symbol 值,但是它们都是同样参数的 Symbol.for 方法生成的,所以实际上是同一个值

Symbol.for 与 Symbol 这两种写法,都会生成新的 Symbol,它们的区别是,前者会被登记在全局环境中供搜索,后者不会

Symbol.for 不会每次调用就返回一个新的 Symbol 类型的值,而是会先检查给定的 key 是否已经存在,如果存在则取该值,如果不存在才会新建一个值

Symbol.for("bar") === Symbol.for("bar")
// true

Symbol("bar") === Symbol("bar")
// false

Symbol.keyFor 方法返回一个已登记的 Symbol 类型值的 key

let s1 = Symbol.for("foo")
Symbol.keyFor(s1) // "foo"

let s2 = Symbol("foo")
Symbol.keyFor(s2) // undefined

上面代码中,变量 s2 属于未登记的 Symbol 值,所以返回 undefined

本文转载自 http://es6.ruanyifeng.com/#docs/symbol 并进行整理

除特殊说明外本人博客均属原创,转载请注明出处:http://blog.johnhan.cn/blog_1038.html
鄂ICP备17018604号-1  鄂公网安备42060702000030号