JavaScript ES(6-11)全版本语法 (七):Symbol

215 阅读4分钟

前提概要

上一篇编写的是ES6中的Class,链接:juejin.cn/post/700724… ,这次写的是ES6中Symbol的基本语法和应用场景,可能不是很全。如有不对的或者不准确的地方,欢迎大家提出😄,我也积极修改。下边开始正文:

src=http___nimg.ws.126.net__url=http%3A%2F%2Fdingyue.ws.126.net%2F2021%2F0523%2F11474b04j00qtjmv9000tc000hg00d5c.jpg&thumbnail=650x2147483647&quality=80&type=jpg&refer=http___nimg.ws.126.jpg

ES6 引入了一种新的原始数据类型 Symbol ,表示独一无二的值。它是 JavaScript 语言的第七种数据类型,前六种是:undefined、null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。

Symbol 值通过Symbol函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。

声明方式

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

通过上述代码可知,变量s就是一个独一无二的值。typeof的结果说明s是 Symbol 数据类型。

let s1 = Symbol()
let s2 = Symbol()
console.log(s1) // Symbol()
console.log(s2) // Symbol()
console.log(s1 === s2) // false

通过上述代码可知,即使都是通过Symbol()声明变量,但是变量还是不相等,也证明了Symbol的独一无二。

注意:

Symbol函数前不能使用new命令,否则会报错。这是因为生成的 Symbol 是一个原始类型的值,不是对象。也就是说,由于 Symbol 值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。

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

let s1 = Symbol('foo')
let s2 = Symbol('foo')
console.log(s1) // Symbol(foo)
console.log(s2) // Symbol(foo)
console.log(s1.description) // foo
console.log(s2.description) // foo
console.log(s1 === s2) // false

当Symbol的参数为一个对象的时候,Symbol会自动调用对象的toString()方法,将其转换为字符串,再生成一个Symbol的值,把字符串作为Symbol的描述

const obj = {
  name: 'xs',
  toString () {
    return this.name
  }
}
let s = Symbol(obj)
console.log(s) // Symbol(xs)

上述代码中如果把toString()方法删掉,再次运行console.log(s),可得Symbol([object Object]),原因是obj对象内部没有写toString()方法,我们就无法获取 s 的 description。

Symbol.for()

Symbol.for() 接受一个字符串作为参数,然后会全局搜索有没有以该参数作为名称的 Symbol 值。如果有,就返回这个 Symbol 值,否则就新建一个以该字符串为名称的 Symbol 值,并将其注册到全局。

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

注意:

Symbol.for()与Symbol()这两种写法,都会生成新的 Symbol。它们的区别是,前者会被登记在全局环境中供搜索,后者不会。Symbol.for()不会每次调用就返回一个新的 Symbol 类型的值,而是会先全局检查给定的key是否已经存在,如果不存在才会新建一个值。并且Symbol.for()一定是声明在全局环境当中,不会管当前是否是在全局环境当中。

Symbol.keyFor()

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

const s1 = Symbol('foo')
console.log(Symbol.keyFor(s1)) // undefined

const s2 = Symbol.for('foo')
console.log(Symbol.keyFor(s2)) // foo

应用场景

1、作为属性名

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

需求:在一个班级中,可能会有同学名字相同的情况,使用对象来描述学生信息的时候,如果直接使用学生姓名作为key会有有问题。

const students = {
    小明: {
        address: 'xxx',
        age: '12'
    },
    小红: {
        address: 'yyy',
        age: '11'
    },
    小明: {
        address: 'zzz',
        age: '13'
    },
}
console.log(students)
运行结果:
  小红: {address'yyy', age: '11'}
  小明: {address'zzz', age: '13'}

如果使用Symbol,同名的学生信息就不会被覆盖:

const stu1 = Symbol('小明')
const stu2 = Symbol('小明')
const students = {
    [stu1]: {
        address: 'xxx',
        age: '12'
    },
    小红: {
        address: 'yyy',
        age: '11'
    },
    [stu2]: {
        address: 'zzz',
        age: '13'
    },
}
console.log(students)
console.log(students[stu1]) // {address: 'xxx', age: '12'}
console.log(students[stu2]) // {address: 'zzz', age: '13'}
运行结果:
  小红: {address'yyy', age: '11'}
  Symbol(小明): {address'xxx', age: '12'}
  Symbol(小明): {address'zzz', age: '13'}

2、属性的遍历

const sym = Symbol('like')
class User {
  constructor(name) {
    this.name = name
    this[sym] = ' like guitar'
  }
  getName() {
    return this.name + this[sym]
  }
}
const user = new User('xs')
console.log(user.getName()) // xs like guitar
// for...in 只能遍历出普通属性
for (let key in user) {
  console.log(key) // name
}
// Object.keys() 只能遍历出普通属性
for (let key of Object.keys(user)) {
  console.log(key) // name
}
// Object.getOwnPropertySymbols() 只能遍历出Symbol属性
for (let key of Object.getOwnPropertySymbols(user)) {
  console.log(key) // Symbol(like)
}
// Reflect.ownKeys() 既有普通属性也有Symbol属性
for (let key of Reflect.ownKeys(user)) {
  console.log(key) // name Symbol(like)
}

3、消除魔术字符串

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

function getArea(shape) {
    let area = 0
    switch (shape) {
        case 'Triangle':
            area = 1
            break
        case 'Circle':
            area = 2
            break
    }
    return area
}
console.log(getArea('Triangle')) // 1

上面代码中,字符串Triangle和Circle就是魔术字符串。它多次出现,与代码形成“强耦合”,不利于将来的修改和维护。

使用Symbol就可以很好的解决这个问题:

const shapeType = {
    triangle: Symbol(),
    circle: Symbol()
}
function getArea(shape) {
    let area = 0
    switch (shape) {
        case shapeType.triangle:
            area = 1
            break
        case shapeType.circle:
            area = 2
            break
    }
    return area
}
console.log(getArea(shapeType.triangle)) // 1