dekuchen

2018-07-03 21:43

ES6 Symbol实战

本文作者:IMWeb dekuchen 原文出处:IMWeb社区 未经同意,禁止转载

ES6 的Symbol到底有什么作用呢? 这篇文章为你揭晓。

20180514152627526982883.jpg

ES6 Symbol实战

前言

我们先来看看ES6 Symbol是什么

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

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

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

let s = Symbol();

typeof s
// "symbol"

上面代码中,变量s就是一个独一无二的值。typeof运算符的结果,表明变量s是 Symbol 数据类型,而不是字符串之类的其他类型。

注意,Symbol函数前不能使用new命令,否则会报错。这是因为生成的 Symbol 是一个原始类型的值,不是对象。也就是说,由于 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函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的Symbol函数的返回值是不相等的。

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

 s1 === s2 // false

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

 s1 === s2 // false

2. 作为属性名的 Symbol

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

 let mySymbol = Symbol();

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

 // 第二种写法
 let a = {
   [mySymbol]: 'Hello!'
     //调用symbol的时候要加[]
 };

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

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

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

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

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

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

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

 let s = Symbol();

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

 obj[s](123);

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

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

3. 属性名的遍历

Symbol 作为属性名,该属性不会出现在for...infor...of循环中,也不会被Object.keys()Object.getOwnPropertyNames()JSON.stringify()返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。

4. 模拟私有方法

由于以 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)]

我的总结

常规用法

  1. Symbol作为函数不能使用new
  2. Symbol不参与运算
  3. Symbol可以显式转换成字符串
  4. Symbol可以转换成bool但是不能转换成数字。

作为类的属性名Key

  1. 做对象或者类的属性名时,只能放在方括号中[]
  2. 消除魔术字符串
  3. Symbol 作为属性名,该属性不会出现在for...infor...of循环中,也不会被Object.keys()Object.getOwnPropertyNames()JSON.stringify()返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。
  4. 不会被for in,for of,Object.keys(),Object.getOwnPropertyNames(),JSON.stringify()返回,所以很适合模拟类方法中的私有方法,但是可以被Object.getOwnPropertySymbols访问,所以不是绝对安全的私有方法。
  5. 配合ES6的类使用最佳。
let size = Symbol('size');
let render = Symbol('render');
class Collection {
    constructor(){
        this[size] = 0; //模拟私有属性
    }

    //模拟私有方法
    [render](opt){
        console.log('render siyou');
    }

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

    test(){
        console.log('test');
        this[render]();
    }

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

let x = new Collection();
Collection.sizeOf(x);
// x[render]();
x.add('foo');
Collection.sizeOf(x);
// x.test();
console.log(Object.keys(x));
console.log(Object.getOwnPropertyNames(x));
console.log(Object.getOwnPropertySymbols(x));
console.log(Object.getOwnPropertyNames(x.__proto__));
console.log(Object.getOwnPropertySymbols(x.__proto__));
0条评论

    您需要 注册 一个IMWeb账号或者 才能进行评论。