Symbol《ES6标准入门(第3版)》

Posted linxian95

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Symbol《ES6标准入门(第3版)》相关的知识,希望对你有一定的参考价值。

概述

 

1.ES5 的对象属性名都是字符串,这容易造成属性名的冲突。

如果有一种机制,保证每个属性的名字都是独一无二的就好了,这样就从根本上防止属性名的冲突,这就是 ES6 引入Symbol的原因。

 

2.ES6 引入了一种新的原始数据类型Symbol表示独一无二的值

它是 javascript 语言的第七种数据类型,前六种是:undefinednull、Boolean、String、Number、Object。

 

3.Symbol 值通过Symbol函数生成

这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的 Symbol 类型

凡是属性名属于 Symbol 类型,就都是独一无二的,可以保证不会与其他属性名产生冲突

 

let s = Symbol();

typeof s
// "symbol"

4.上面代码中,变量s就是一个独一无二的值。

typeof运算符的结果,表明变量s是 Symbol 数据类型,而不是字符串之类的其他类型。

 

5.注意,Symbol函数前不能使用new命令,否则会报错。

这是因为生成的 Symbol 是一个原始类型的值,不是对象

也就是说,由于 Symbol 值不是对象,所以不能添加属性

基本上,它是一种类似于字符串的数据类型。

 

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

 

let s1 = Symbol(‘foo‘);
let s2 = Symbol(‘bar‘);

s1 // Symbol(foo)
s2 // Symbol(bar)

s1.toString() // "Symbol(foo)"
s2.toString() // "Symbol(bar)"

7.上面代码中,s1s2是两个 Symbol 值。

如果不加参数,它们在控制台的输出都是Symbol(),不利于区分

有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。

 

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

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

 

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

s1 === s2 // false

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

s1 === s2 // false

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

 

let sym = Symbol(‘My symbol‘);

"your symbol is " + sym
// TypeError: can‘t convert symbol to string
`your symbol is ${sym}`
// TypeError: can‘t convert symbol to string

10.Symbol 值不能与其他类型的值进行运算,会报错。

 

let sym = Symbol(‘My symbol‘);

String(sym) // ‘Symbol(My symbol)‘
sym.toString() // ‘Symbol(My symbol)‘

11.但是,Symbol 值可以显式转为字符串。

 

let sym = Symbol();
Boolean(sym) // true
!sym  // false

if (sym) {
  // ...
}

Number(sym) // TypeError
sym + 2 // TypeError

12.另外,Symbol 值也可以转为布尔值,但是不能转为数值

 


 

作为属性名的Symbol

 

1.由于每一个 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!"

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

 

const mySymbol = Symbol();
const a = {};

a.mySymbol = ‘Hello!‘;
a[mySymbol] // undefined
a[‘mySymbol‘] // "Hello!"

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

上面代码中,因为点运算符后面总是字符串,所以不会读取mySymbol作为标识名所指代的那个值,导致a的属性名实际上是一个字符串,而不是一个 Symbol 值。

 

let s = Symbol();

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

obj[s](123);

4.同理,在对象的内部,使用 Symbol 值定义属性时,Symbol 值必须放在方括号之中。

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

 

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

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

 

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‘);

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

 

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‘);
    }
}

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

 

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

 


 

实例:消除魔术字符串

 

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

风格良好的代码,应该尽量消除魔术字符串,改由含义清晰的变量代替。

 

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 }); // 魔术字符串

2.上面代码中,字符串Triangle就是一个魔术字符串。

它多次出现,与代码形成“强耦合”,不利于将来的修改和维护。

 

3.常用的消除魔术字符串的方法,就是把它写成一个变量。

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 });

上面代码中,我们把Triangle写成shapeType对象的triangle属性,这样就消除了强耦合。

 

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

const shapeType = {
  triangle: Symbol()
};

上面代码中,除了将shapeType.triangle的值设为一个 Symbol,其他地方都不用修改。

 


 

属性名的遍历

 

1.Symbol 作为属性名,该属性不会出现在for...infor...of循环中,也不会被Object.keys()Object.getOwnPropertyNames()JSON.stringify()返回。

但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。

 

2.Object.getOwnPropertySymbols方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值

const obj = {};
let a = Symbol(‘a‘);
let b = Symbol(‘b‘);

obj[a] = ‘Hello‘;
obj[b] = ‘World‘;

const objectSymbols = Object.getOwnPropertySymbols(obj);

objectSymbols
// [Symbol(a), Symbol(b)]

 

3.下面是另一个例子,Object.getOwnPropertySymbols方法与for...in循环、Object.getOwnPropertyNames方法进行对比的例子。

const obj = {};

let foo = Symbol("foo");

Object.defineProperty(obj, foo, {
  value: "foobar",
});

for (let i in obj) {
  console.log(i); // 无输出
}

Object.getOwnPropertyNames(obj)
// []

Object.getOwnPropertySymbols(obj)
// [Symbol(foo)]

 

4.另一个新的 API,Reflect.ownKeys方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。

let obj = {
  [Symbol(‘my_key‘)]: 1,
  enum: 2,
  nonEnum: 3
};

Reflect.ownKeys(obj)
//  ["enum", "nonEnum", Symbol(my_key)]

 

5.由于以 Symbol 值作为名称的属性,不会被常规方法遍历得到。

我们可以利用这个特性,为对象定义一些非私有的、但又希望只用于内部的方法

let size = Symbol(‘size‘);

class Collection {
  constructor() {
    this[size] = 0;
  }

  add(item) {
    this[this[size]] = item;
    this[size]++;
  }

  static sizeOf(instance) {
    return instance[size];
  }
}

let x = new Collection();
Collection.sizeOf(x) // 0

x.add(‘foo‘);
Collection.sizeOf(x) // 1

Object.keys(x) // [‘0‘]
Object.getOwnPropertyNames(x) // [‘0‘]
Object.getOwnPropertySymbols(x) // [Symbol(size)]

上面代码中,对象xsize属性是一个 Symbol 值,所以Object.keys(x)Object.getOwnPropertyNames(x)都无法获取它。

这就造成了一种非私有的内部方法的效果。

 


 

Symbol.for()、Symbol.keyFor()

 

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

它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的 Symbol 值。

如果有,就返回这个 Symbol 值,否则就新建并返回一个以该字符串为名称(这里的名称应该是为key吧?)的 Symbol 值。

 

let s1 = Symbol.for(‘foo‘);
let s2 = Symbol.for(‘foo‘);

s1 === s2 // true

2.上面代码中,s1s2都是 Symbol 值,但是它们都是同样参数的Symbol.for方法生成的,所以实际上是同一个值。(同一个Symbol值,放在了不同的变量里)

 

3.Symbol.for()Symbol()这两种写法,都会生成新的 Symbol

它们的区别是,前者会被登记在全局环境中供搜索,后者不会。

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

比如,如果你调用Symbol.for("cat")30 次,每次都会返回同一个 Symbol 值,但是调用Symbol("cat")30 次,会返回 30 个不同的 Symbol 值

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

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

上面代码中,由于Symbol()写法没有登记机制,所以每次调用都会返回一个不同的值。

 

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

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

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

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

 

5.需要注意的是,Symbol.for为 Symbol 值登记的名字,是全局环境的,可以在不同的 iframe 或 service worker 中取到同一个值。

iframe = document.createElement(‘iframe‘);
iframe.src = String(window.location);
document.body.appendChild(iframe);

iframe.contentWindow.Symbol.for(‘foo‘) === Symbol.for(‘foo‘)
// true

上面代码中,iframe 窗口生成的 Symbol 值,可以在主页面得到。

 


 

实例:模块的Singleton模式

 

1.Singleton 模式指的是调用一个类,任何时候返回的都是同一个实例

对于 Node 来说,模块文件可以看成是一个类。怎么保证每次执行这个模块文件,返回的都是同一个实例呢?

很容易想到,可以把实例放到顶层对象global

 

// mod.js
function A() {
  this.foo = ‘hello‘;
}

if (!global._foo) {
  global._foo = new A();
}

module.exports = global._foo;
const a = require(‘./mod.js‘);
console.log(a.foo);

2.上面代码中,变量a任何时候加载的都是A的同一个实例。

但是,这里有一个问题,全局变量global._foo是可写的,任何文件都可以修改。

 

// mod.js
const FOO_KEY = Symbol.for(‘foo‘);

function A() {
  this.foo = ‘hello‘;
}

if (!global[FOO_KEY]) {
  global[FOO_KEY] = new A();
}

module.exports = global[FOO_KEY];
global[Symbol.for(‘foo‘)] = { foo: ‘world‘ };

const a = require(‘./mod.js‘);

3.为了防止这种情况出现,我们就可以使用 Symbol。

上面代码中,可以保证global[FOO_KEY]不会被无意间覆盖,但还是可以被改写。

如果键名使用Symbol方法生成,那么外部将无法引用这个值,当然也就无法改写。

 

// mod.js
const FOO_KEY = Symbol(‘foo‘);

// 后面代码相同 ……

4.上面代码将导致其他脚本都无法引用FOO_KEY

但这样也有一个问题,就是如果多次执行这个脚本,每次得到的FOO_KEY都是不一样的。

虽然 Node 会将脚本的执行结果缓存,一般情况下,不会多次执行同一个脚本,但是用户可以手动清除缓存,所以也不是绝对可靠。

 


 

内置的Symbol值

 

1.除了定义自己使用的 Symbol 值以外,ES6 还提供了 11 个内置的 Symbol 值,指向语言内部使用的方法。

 

Symbol.hasInstance

 

1.对象的Symbol.hasInstance属性,指向一个内部方法。

当其他对象使用instanceof运算符,判断是否为该对象的实例时,会调用这个方法。

比如,foo instanceof Foo在语言内部,实际调用的是Foo[Symbol.hasInstance](foo)

class MyClass {
  [Symbol.hasInstance](foo) {
    return foo instanceof Array;
  }
}

[1, 2, 3] instanceof new MyClass() // true

上面代码中,MyClass是一个类,new MyClass()会返回一个实例。

该实例的Symbol.hasInstance方法,会在进行instanceof运算时自动调用,判断左侧的运算子是否为Array的实例。

 

2.下面是另一个例子。

class Even {
  static [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
}

// 等同于
const Even = {
  [Symbol.hasInstance](obj) {
    return Number(obj) % 2 === 0;
  }
};

1 instanceof Even // false
2 instanceof Even // true
12345 instanceof Even // false

 


 

Symbol.toPrimitive

 

1.对象的Symbol.toPrimitive属性,指向一个方法。该对象被转为原始类型的值时,会调用这个方法,返回该对象对应的原始类型值。

 

2.Symbol.toPrimitive被调用时,会接受一个字符串参数,表示当前运算的模式,一共有三种模式。

  • Number:该场合需要转成数值
  • String:该场合需要转成字符串
  • Default:该场合可以转成数值,也可以转成字符串
let obj = {
  [Symbol.toPrimitive](hint) {
    switch (hint) {
      case ‘number‘:
        return 123;
      case ‘string‘:
        return ‘str‘;
      case ‘default‘:
        return ‘default‘;
      default:
        throw new Error();
     }
   }
};

2 * obj // 246
3 + obj // ‘3default‘
obj == ‘default‘ // true
String(obj) // ‘str‘

 

以上是关于Symbol《ES6标准入门(第3版)》的主要内容,如果未能解决你的问题,请参考以下文章

重读 ES6 标准入门(第3版)

对象的新增方法《ES6标准入门(第3版)》

对象的新增方法《ES6标准入门(第3版)》

ES6入门九:Symbol元编程

ES6 之 解构赋值

ES6 从入门到精通 # 09:Symbol 类型