JavaScriptES6之独一无二的Symbol

目录

作为属性名的Symbol

实例：消除魔术字符串

Symbol类型属性名的遍历

Symbol.for() Symbol.keyFor()

---

Symbol是一个原始数据类型，表示独一无二的值，也就是说Symbol类型的值只要创建就是唯一的。它是JavaScript语言的第七种数据类型，前六种：undefined、null、Boolean、String、number、Object。

Symbol值通过Symbol函数生成。这就是说，对象的属性名现在有两种类型，一种是原来就有的字符串，另一种就是新增的Symbol类型。

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

let s = Symbol("a");
console.log(s); //Symbol(a)
console.log(typeof s);      //symbol

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

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

let s1 = Symbol("foo");
let s2 = Symbol("bar");
console.log(s1);        //Symbol(foo)
console.log(s2);        //Symbol(bar)
console.log(s1.toString());     //"Symbol(foo)"
console.log(s2.toString());     //"Symbol(bar)"

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

const obj = {
     name : "abc",
     toString() {
         return "abc";
     }
 }
let s = Symbol(obj);
console.log(s);  //Symbol(abc)

注意，Symbol函数的参数只是表示对当前Symbol值的描述，因此相同参数的Symbol函数的返回值也是不相同的，这就表示了Symbol类型的值是独一无二的。

//有参数的情况下
let s1 = Symbol("foo");
let s2 = Symbol("foo");
console.log(Object.is(s1,s2));  //false
//无参数的情况下
let s1 = Symbol();
let s2 = Symbol();
console.log(Object.is(s1,s2));      //false

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

let sym = Symbol("my symbol");
console.log('your symbol is' + sym);        //error     cannot convert a Symbol value to a string
console.log(`your symbol is ${sym}`);           //error     cannot convert a Symbol value to a string

Symbol值可以显示的转换为字符串，布尔值，但是不能转换为数值。

let sym = Symbol("my symbol");
console.log(String(sym));               //Symbol(my symbol)
console.log(sym.toString());        //Symbol(my symbol)
console.log('your symbol is ' + String(sym));           //your symbol is Symbol(my symbol)
console.log(`your symbol is ${sym.toString()}`);        //your symbol is Symbol(my symbol)

let sym = Symbol();
console.log(Boolean(sym));      //true
console.log( !sym);         //false
if(sym){                //true
     console.log(true);
}
console.log(Number(sym));           //error     cannot convert a Symbol value to a number
console.log(2 + sym);                    //error     cannot convert a Symbol value to a number

作为属性名的Symbol

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

let mySymbol = Symbol();
//第一种写法
let a = {};
a[mySymbol] = "Hello";
console.log(a[mySymbol]);    //Hello
//第二种写法
let a = {
     [mySymbol] : "Hello w",
}
console.log(a[mySymbol]);    //Hello w
//第三种写法
let a = {};
Object.defineProperty(a,mySymbol,{
     value : "Hello World",
     configurable : true,
     enumerable : true,
     writable : true,
})
console.log(a[mySymbol]);       //Hello World

注意：Symbol值作为对象的属性的时候，只能用表达式进行读写，不能用点运算符。否则就不是一个Symbol类型的值。因为点运算符后面吗总是字符串，所以不会读取mySymbol作为标识名所指代的那个值，导致a的属性名实际上是一个字符串，而不是一个对象。

const mySymbol = Symbol();
const a = {};
a.mySymbol = "Hello";
console.log(a.mySymbol);        //Hello
console.log(a[mySymbol]);       //undefined
console.log(a['mySymbol']); //Hello

在对象内部，使用Symbol值定义属性时，Symbol值必须放在方括号之中。如果不放在方括号中，该属性的键名就是字符串，而不是s所表示的那个Symbol值。

let s = Symbol();
let obj = {
     [s] (...args) {
         console.log(args);
     }
}
obj[s](1,2,3);      //[1,2,3]
console.log(obj.s);     //undefined

Symbol类型还可以用于定义一组常量，保证这组常量的值都是不相等的。常量使用Symbol值最大的好处，就是其他任何值都不可能有相同的值了，因此可以保证上面的switch语句会按设计的方式工作。

const COLOR_RED = Symbol("red");
const COLOR_GREEN = Symbol("green");
const getComplement = (color) => {
     switch(color){
        case COLOR_RED :
                 return COLOR_RED;
        case COLOR_GREEN :
                 return COLOR_GREEN;
        default :
                 throw new Error("undefined color");
     }
}
console.log(getComplement(COLOR_RED));      //Symbol(red)
console.log(getComplement(COLOR_GREEN));        //Symbol(green)

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

实例：消除魔术字符串

 魔术字符串指的是，在代码之中多次出现，与代码形成强耦合的某一具体的字符串或者数值。风格良好的代码，应该尽量消除魔术字符串，改由含义清晰的变量代替。

const getArea = (shape,options) => {            
     let area = 0;
     switch(shape){
         case "Triangle" : //魔术字符串
             area = .5 * options.width * options.height;
             break;
     }
     return area;
}
console.log(getArea("Triangle",{width : 100, height : 100}));
//上面代码中，字符串Triangle就是一个魔术字符串。它多次出现，与代码形成了强耦合，不利于将来的修改和维护。

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

const shapeType = {
    triangle : "Triangle",
};
const getArea = (shape,options) => {
     let area = 0;
     switch(shape){
         case shapeType.triangle :
             area = .5 * options.width * options.height;
             break;
     }
     return area;
}
console.log(getArea(shapeType.triangle,{width : 100 , height : 100 ,}));
//上面代码中，我们把Triangle写成shapeType对象的triangle属性，这样就消除了强耦合。

如果仔细分析，可以发现shapeType.triangle等于哪个值不重要，只要确保不会跟其他shapeType属性的值冲突即可。因此这里很适合改用Symbol值。下面是用高阶函数写的一种方法。

const shapeType = {
     triangle : "Triangle",
}
const areaAll = (type) => (shape,options) => {
     let area = 0;
     switch (shape){
         case type : 
             area = .5 * options.width * options.height;
             break;
     }
     return area;
}
const getArea = areaAll(shapeType.triangle);
console.log(getArea(shapeType.triangle,{width : 100 , height : 100 ,}))

Symbol类型属性名的遍历

Symbol作为属性名，这个属性不会出现在foo...in、for...of循环中，也不会被，Object.keys()。Object.getOwnPropertyNames(),JSON.stringify返回。在之前的笔记中有提到可以被Reflect.ownKeys方法遍历到，当然也有遍历Symbol自己的属性的方法。Object.getOwnPropertySymbols方法，可以获得指定对象的所有Symbol属性。

该方法返回一个数组，成员是当前对象的所有用作属性名的Symbol值。

let syB = Symbol("b");
let syA = Symbol("a");
const obj = {
     [syB] : "Hello b",
     [syA] : "Hello a",
}
const objSymbols = Object.getOwnPropertySymbols(obj);
console.log(objSymbols);        //[symbol(b),symbol(a)]

Object.getOwnPropertySymbols方法与for...in循环，Object.getOwnPropertyNames方法进行对比的例子。

const obj = {};
let foo = Symbol("foo");
Object.defineProperty(obj,foo,{
     value : "foobar",
});
for(let prop in obj){
     console.log(prop);          //无输出
}
console.log(Object.getOwnPropertyNames(obj));       //[]
console.log(Object.getOwnPropertySymbols(obj));     //[Symbol(foo)]

上面说Reflect.ownKeys方法也可以遍历到。这个方法返回所有的键名，包括常规键名和Symbol键名。

let obj = {
     [Symbol("my_key")] : 1,
     enum : 2,
     nonEnum : 3,
};
console.log(Reflect.ownKeys(obj));      //["enum" , "nonEnum" , "Symbol(my_key)"]

 由于以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();
console.log(Collection.sizeOf(x))       //0
x.add("foo");
console.log(Collection.sizeOf(x));      //1
console.log(Object.keys(x));        //["0"]
console.log(Object.getOwnPropertyNames(x));     //["0"]
console.log(Object.getOwnPropertySymbols(x));   //[Symbol(size)]

 上面代码中，对象x的size属性是一个Symbol值，所以Object.keys(x),Object.getOwnPropertyNames(x)都无法获取它，这就造成了一种非私有的内部方法的效果。

Symbol.for() Symbol.keyFor()

使用Symbol，有时候我们希望使用同一个Symbol值，Symbol.for方法可以做到这一点，它接受一个字符串参数，然后搜索有没有以该参数为名称的Symbol值。如果有就返回这个Symbol值，否侧就新建并返回以该字符串为名称的Symbol值。

let s1 = Symbol.for("foo");
let s2 = Symbol.for("foo");
let s3 = Symbol("foo");
console.log(Object.is(s2,s3));  //false
console.log(Object.is(s1,s2));  //true

Symbol.for()与Symbol()的区别

这两种方法都会生成新的Symbol。但是，前者在生成新的Symbol值的时候会被登记到全局环境中供Symbol.for方法搜索，Symbol.for()不会每次调用就返回一个新的 Symbol 类型的值，而是会先检查给定的key是否已经存在，如果不存在才会新建一个值。

console.log(Symbol.for("bar") === Symbol.for("bar"));       //true
console.log(Symbol("bar1") === Symbol("bar1"));             //true

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

let s1 = Symbol.for("foo"); //已登记
let s2 = Symbol("bar");         //未登记
console.log(Symbol.keyFor(s1));     //"foo"
console.log(Symbol.keyFor(s2));     //undefined

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

let iframe = document.createElement("iframe");
// iframe.src = String(window.location);  //同域
iframe.src = "https://www.baidu.com";   //跨域
document.body.appendChild(iframe);
console.log(iframe.contentWindow.Symbol.for("foo") === Symbol.for("foo"));   //true

主页传送门