一、初识
1、Symbol是es6引入的一种新的原始数据类型,表示独一无二的值。它是javascript语言的第七种数据类型,前六种是:undefined、null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
Symbol 值通过Symbol函数生成
let s = Symbol();
typeof s
//"symbol"
注意,Symbol函数前不能使用new命令,否则会报错。这是因为生成的 Symbol 是一个原始类型的值,不是对象。由于 Symbol 值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。
let sss = new Symbol()
//Uncaught TypeError: Symbol is not a constructor
2、参数
Symbol函数可以接受一个字符串作为参数,表示对 Symbol 实例的描述,但是即使参数相同所得到的值也是不同的(唯一),因此可以用来做对象的属性名,防止属性名的冲突独一无二。
let s1 = Symbol(‘foo‘);
let s2 = Symbol(‘bar‘);
s1 == s2 //false
若Symbol参数是一个对象,那么它会调用该对象的toString方法,将它转成一个字符串然后生成一个Symbol值。
const obj = {
toString() {
return ‘abc‘;
}
};
const sym = Symbol(obj);
sym // Symbol(abc)
const obj1 = {}
const sym1 = Symbol(obj1);
sym1 // Symbol([object Object])
3、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 值可以显式转为字符串
let sym = Symbol(‘My symbol‘);
String(sym) // ‘Symbol(My symbol)‘
sym.toString() // ‘Symbol(My symbol)‘
Symbol 值也可以转为布尔值,但是不能转为数值。
let sym = Symbol();
Boolean(sym) // true
!sym // false
Number(sym) // TypeError
sym + 2 // TypeError
二、应用
1、用于对象的属性名
就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。
let a = {};
a[mySymbol] = ‘Hello!‘;
// 第二种写法
let a = {
[mySymbol]: ‘Hello!‘
};
// 第三种写法
let a = {};
Object.defineProperty(a, mySymbol, { value: ‘Hello!‘ });
// 以上写法都得到同样结果
a[mySymbol] // "Hello!"
Symbol 值作为对象属性名时,不能用点运算符。因为点运算符后面总是字符串;同理,在对象的内部,使用 Symbol 值定义属性时,Symbol 值必须放在方括号之中。
const mySymbol = Symbol();
const a = {};
a.mySymbol = ‘Hello!‘;
a[mySymbol] // undefined
a[‘mySymbol‘] // "Hello!"
2、消除魔法字符串
魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码,应该尽量消除魔术字符串,改由含义清晰的变量代替。
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()
};
三、属性名的遍历
1、Symbol 作为属性名,该属性不会出现在for...in、for...of循环中,也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。
let symb = Symbol()
let obbj = {[symb]:‘aa‘,a: ‘haha‘}
JSON.stringify(obbj);
//Symbol属性没有被返回
//{"a":"haha"}
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)]
2、Reflect.ownKeys方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。
let obj = {
[Symbol(‘my_key‘)]: 1,
enum: 2,
nonEnum: 3
};
Reflect.ownKeys(obj)
// ["enum", "nonEnum", Symbol(my_key)]
//注意此数组JSON.stingify()的Symbol那一项是null
let stringifySymbol = Reflect.ownKeys(obj)
//"["enum","nonEnum",null]"
由于以 Symbol 值作为名称的属性,不会被常规方法遍历得到。我们可以利用这个特性,为对象定义一些非私有的、但又希望只用于内部的方法。
四、Symbol.for(),Symbol.keyFor()
1、我们希望重新使用同一个 Symbol 值,Symbol.for方法可以做到这一点。
let s1 = Symbol.for(‘foo‘);
let s2 = Symbol.for(‘foo‘);
s1 === s2 // true
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()写法没有登记机制,所以每次调用都会返回一个不同的值。
Symbol.keyFor方法返回一个已登记的 Symbol 类型值的key。
let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"
let s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined
上面代码中,变量s2属于未登记的 Symbol 值,所以返回undefined。
2、但是当Symbol.for()里面不传或者传空字符串的时候
let a12 = Symbol.for()
Symbol.keyFor(a12)
//"undefined"
let a13 = Symbol.for(‘‘)
Symbol.keyFor(a13)
""
其实Symbol.for()相当于Symbol.for(undefined)所以返回‘undefined‘;