es6 symbol的实现方法示例
背景
ES5的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象添加新的方法(mixin模式),新方法的名字就有可能与现有方法产生冲突。如果有一种机制,保证每个属性的名字都是独一无二的就好了,这样就从根本上防止属性名的冲突。这就是ES6引入Symbol的原因。
ES6引入了一种新的原始数据类型Symbol,表示独一无二的值。它是JavaScript语言的第七种数据类型,前六种是:undefined、null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
Symbol值通过Symbol函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的Symbol类型。凡是属性名属于Symbol类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
lets=Symbol(); typeofs //"symbol"
上面代码中,变量s就是一个独一无二的值。typeof运算符的结果,表明变量s是Symbol数据类型,而不是字符串之类的其他类型。
注意,Symbol函数前不能使用new命令,否则会报错。这是因为生成的Symbol是一个原始类型的值,不是对象。也就是说,由于Symbol值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。
Symbol函数可以接受一个字符串作为参数,表示对Symbol实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。
lets1=Symbol('foo'); lets2=Symbol('bar'); s1//Symbol(foo) s2//Symbol(bar) s1.toString()//"Symbol(foo)" s2.toString()//"Symbol(bar)"
上面代码中,s1和s2是两个Symbol值。如果不加参数,它们在控制台的输出都是Symbol(),不利于区分。有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。
如果Symbol的参数是一个对象,就会调用该对象的toString方法,将其转为字符串,然后才生成一个Symbol值。
constobj={ toString(){ return'abc'; } }; constsym=Symbol(obj); sym//Symbol(abc)
注意,Symbol函数的参数只是表示对当前Symbol值的描述,因此相同参数的Symbol函数的返回值是不相等的。
//没有参数的情况 lets1=Symbol(); lets2=Symbol(); s1===s2//false //有参数的情况 lets1=Symbol('foo'); lets2=Symbol('foo'); s1===s2//false
上面代码中,s1和s2都是Symbol函数的返回值,而且参数相同,但是它们是不相等的。
Symbol值不能与其他类型的值进行运算,会报错。
letsym=Symbol('Mysymbol'); "yoursymbolis"+sym //TypeError:can'tconvertsymboltostring `yoursymbolis${sym}` //TypeError:can'tconvertsymboltostring
作为属性名的Symbol
由于每一个Symbol值都是不相等的,这意味着Symbol值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。
letmySymbol=Symbol(); //第一种写法 leta={}; a[mySymbol]='Hello!'; //第二种写法 leta={ [mySymbol]:'Hello!' }; //第三种写法 leta={}; Object.defineProperty(a,mySymbol,{value:'Hello!'}); //以上写法都得到同样结果 a[mySymbol]//"Hello!"
上面代码通过方括号结构和Object.defineProperty,将对象的属性名指定为一个Symbol值。
注意,Symbol值作为对象属性名时,不能用点运算符。
constmySymbol=Symbol(); consta={}; a.mySymbol='Hello!'; a[mySymbol]//undefined a['mySymbol']//"Hello!"
上面代码中,因为点运算符后面总是字符串,所以不会读取mySymbol作为标识名所指代的那个值,导致a的属性名实际上是一个字符串,而不是一个Symbol值。
同理,在对象的内部,使用Symbol值定义属性时,Symbol值必须放在方括号之中。
lets=Symbol(); letobj={ [s]:function(arg){...} }; obj[s](123);
上面代码中,如果s不放在方括号中,该属性的键名就是字符串s,而不是s所代表的那个Symbol值。
采用增强的对象写法,上面代码的obj对象可以写得更简洁一些。
letobj={ [s](arg){...} };
Symbol类型还可以用于定义一组常量,保证这组常量的值都是不相等的。
constlog={}; log.levels={ DEBUG:Symbol('debug'), INFO:Symbol('info'), WARN:Symbol('warn') }; console.log(log.levels.DEBUG,'debugmessage'); console.log(log.levels.INFO,'infomessage');
3实例:消除魔术字符串
魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码,应该尽量消除魔术字符串,改由含义清晰的变量代替。
functiongetArea(shape,options){ letarea=0; switch(shape){ case'Triangle'://魔术字符串 area=.5*options.width*options.height; break; /*...morecode...*/ } returnarea; } getArea('Triangle',{width:100,height:100});//魔术字符串
上面代码中,字符串Triangle就是一个魔术字符串。它多次出现,与代码形成“强耦合”,不利于将来的修改和维护。
常用的消除魔术字符串的方法,就是把它写成一个变量。
constshapeType={ triangle:'Triangle' }; functiongetArea(shape,options){ letarea=0; switch(shape){ caseshapeType.triangle: area=.5*options.width*options.height; break; } returnarea; } getArea(shapeType.triangle,{width:100,height:100});
上面代码中,我们把Triangle写成shapeType对象的triangle属性,这样就消除了强耦合。
如果仔细分析,可以发现shapeType.triangle等于哪个值并不重要,只要确保不会跟其他shapeType属性的值冲突即可。因此,这里就很适合改用Symbol值。
constshapeType={ triangle:Symbol() };
4属性名的遍历
Symbol作为属性名,该属性不会出现在for...in、for...of循环中,也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有Symbol属性名。
Object.getOwnPropertySymbols方法返回一个数组,成员是当前对象的所有用作属性名的Symbol值。
constobj={}; leta=Symbol('a'); letb=Symbol('b'); obj[a]='Hello'; obj[b]='World'; constobjectSymbols=Object.getOwnPropertySymbols(obj); objectSymbols //[Symbol(a),Symbol(b)]
下面是另一个例子,Object.getOwnPropertySymbols方法与for...in循环、Object.getOwnPropertyNames方法进行对比的例子。
constobj={}; letfoo=Symbol("foo"); Object.defineProperty(obj,foo,{ value:"foobar", }); for(letiinobj){ console.log(i);//无输出 } Object.getOwnPropertyNames(obj) //[] Object.getOwnPropertySymbols(obj) //[Symbol(foo)]
上面代码中,使用Object.getOwnPropertyNames方法得不到Symbol属性名,需要使用Object.getOwnPropertySymbols方法。
另一个新的API,Reflect.ownKeys方法可以返回所有类型的键名,包括常规键名和Symbol键名。
letobj={ [Symbol('my_key')]:1, enum:2, nonEnum:3 }; Reflect.ownKeys(obj) //["enum","nonEnum",Symbol(my_key)]
5Symbol.for(),Symbol.keyFor()
有时,我们希望重新使用同一个Symbol值,Symbol.for方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值。如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值。
lets1=Symbol.for('foo'); lets2=Symbol.for('foo'); s1===s2//true
上面代码中,s1和s2都是Symbol值,但是它们都是同样参数的Symbol.for方法生成的,所以实际上是同一个值。
Symbol.for()与Symbol()这两种写法,都会生成新的Symbol。它们的区别是,前者会被登记在全局环境中供搜索,后者不会。Symbol.for()不会每次调用就返回一个新的Symbol类型的值,而是会先检查给定的key是否已经存在,如果不存在才会新建一个值。比如,如果你调用Symbol.for("cat")30次,每次都会返回同一个Symbol值,但是调用Symbol("cat")30次,会返回30个不同的Symbol值。
Symbol.keyFor方法返回一个已登记的Symbol类型值的key。
lets1=Symbol.for("foo"); Symbol.keyFor(s1)//"foo" lets2=Symbol("foo"); Symbol.keyFor(s2)//undefined
上面代码中,变量s2属于未登记的Symbol值,所以返回undefined。
需要注意的是,Symbol.for为Symbol值登记的名字,是全局环境的,可以在不同的iframe或serviceworker中取到同一个值。
iframe=document.createElement('iframe'); iframe.src=String(window.location); document.body.appendChild(iframe); iframe.contentWindow.Symbol.for('foo')===Symbol.for('foo') //true
上面代码中,iframe窗口生成的Symbol值,可以在主页面得到。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。