es6 symbol的实现方法示例
背景
es5 的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象添加新的方法(mixin 模式),新方法的名字就有可能与现有方法产生冲突。如果有一种机制,保证每个属性的名字都是独一无二的就好了,这样就从根本上防止属性名的冲突。这就是 es6 引入symbol的原因。
es6 引入了一种新的原始数据类型symbol,表示独一无二的值。它是 javascript 语言的第七种数据类型,前六种是:undefined、null、布尔值(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)"
上面代码中,s1和s2是两个 symbol 值。如果不加参数,它们在控制台的输出都是symbol(),不利于区分。有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。
如果 symbol 的参数是一个对象,就会调用该对象的tostring方法,将其转为字符串,然后才生成一个 symbol 值。
const obj = { tostring() { return 'abc'; } }; const sym = symbol(obj); sym // symbol(abc)
注意,symbol函数的参数只是表示对当前 symbol 值的描述,因此相同参数的symbol函数的返回值是不相等的。
// 没有参数的情况 let s1 = symbol(); let s2 = symbol(); s1 === s2 // false // 有参数的情况 let s1 = symbol('foo'); let s2 = symbol('foo'); s1 === s2 // false
上面代码中,s1和s2都是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
作为属性名的 symbol
由于每一个 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!"
上面代码通过方括号结构和object.defineproperty,将对象的属性名指定为一个 symbol 值。
注意,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);
上面代码中,如果s不放在方括号中,该属性的键名就是字符串s,而不是s所代表的那个 symbol 值。
采用增强的对象写法,上面代码的obj对象可以写得更简洁一些。
let obj = { [s](arg) { ... } };
symbol 类型还可以用于定义一组常量,保证这组常量的值都是不相等的。
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');
3实例:消除魔术字符串
魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码,应该尽量消除魔术字符串,改由含义清晰的变量代替。
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 }); // 魔术字符串
上面代码中,字符串triangle就是一个魔术字符串。它多次出现,与代码形成“强耦合”,不利于将来的修改和维护。
常用的消除魔术字符串的方法,就是把它写成一个变量。
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属性,这样就消除了强耦合。
如果仔细分析,可以发现shapetype.triangle等于哪个值并不重要,只要确保不会跟其他shapetype属性的值冲突即可。因此,这里就很适合改用 symbol 值。
const shapetype = { triangle: symbol() };
4属性名的遍历
symbol 作为属性名,该属性不会出现在for...in、for...of循环中,也不会被object.keys()、object.getownpropertynames()、json.stringify()返回。但是,它也不是私有属性,有一个object.getownpropertysymbols方法,可以获取指定对象的所有 symbol 属性名。
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)]
下面是另一个例子,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)]
上面代码中,使用object.getownpropertynames方法得不到symbol属性名,需要使用object.getownpropertysymbols方法。
另一个新的 api,reflect.ownkeys方法可以返回所有类型的键名,包括常规键名和 symbol 键名。
let obj = { [symbol('my_key')]: 1, enum: 2, nonenum: 3 }; reflect.ownkeys(obj) // ["enum", "nonenum", symbol(my_key)]
5 symbol.for(),symbol.keyfor()
有时,我们希望重新使用同一个 symbol 值,symbol.for方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的 symbol 值。如果有,就返回这个 symbol 值,否则就新建并返回一个以该字符串为名称的 symbol 值。
let s1 = symbol.for('foo'); let s2 = 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。
let s1 = symbol.for("foo"); symbol.keyfor(s1) // "foo" let s2 = symbol("foo"); symbol.keyfor(s2) // undefined
上面代码中,变量s2属于未登记的 symbol 值,所以返回undefined。
需要注意的是,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 值,可以在主页面得到。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。