引用:
ES6引入了一种新的原始数据类型Symbol,表示独一无二的值。它是JavaScript语言的第七种数据类型,前六种是:Undefined、Null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)
Symbol值通过Symbol
函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的Symbol类型。凡是属性名属于Symbol类型,就都是独一无二的,可以保证不会与其他属性名产生冲突
let a = Symbol();
console.log(typeof a);//symbol
//上面代码中,变量s就是一个独一无二的值。typeof运算符的结果,表明变量s是Symbol数据类型,而不是字符串之类的其他类型
注意,
Symbol
函数前不能使用
new
命令,否则会报错。这是因为生成的Symbol是一个原始类型的值,不是对象。也就是说,由于Symbol值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。
Symbol
函数可以接受一个字符串作为参数,表示对Symbol实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。
var n1 = Symbol('name');
var n2 = Symbol('scholl');
console.log(n1);//Symbol(name)
console.log(n2);//Symbol(scholl)
//两个Symbol值。如果不加参数,它们在控制台的输出都是Symbol(),不利于区分。
//有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值
//如果 Symbol 的参数是一个对象,就会调用该对象的toString方法,将其转为字符串,然后才生成一个 Symbol 值
const f = {
toString(){
return 'abc';
}
};
const o = Symbol(f);
console.log(o);//Symbol(abc)
//注意,Symbol函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的Symbol函数的返回值是不相等的
//没有参数的情况
var x1 = Symbol();
var x2 = Symbol();
console.log(x1 === x2);//false
//有参数的情况
var x3 = Symbol('foo');
var x4 = Symbol('foo');
console.log(x3 === x4);//false
//都是Symbol函数的返回值,而且参数相同,但是它们是不相等的。
Symbol值不能与其他类型的值进行运算,会报错。
var x1 = Symbol('hello');
console.log(x1 + 'andy');//Uncaught TypeError: Cannot convert a Symbol value to a string
//但是,Symbol值可以显式转为字符串。
var x2 = Symbol('hello');
console.log(String(x2));//Symbol(hello);
console.log(x2.toString());//Symbol(hello)
//另外,Symbol值也可以转为布尔值,但是不能转为数值。
var x3 = Symbol();
console.log(Boolean(x3));//true
console.log(Number(x3));//报错
1,作为属性名的symbol
由于每一个Symbol值都是不相等的,这意味着Symbol值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖
var x = Symbol();
//第一种写法
var a = {};
a[x] = 'andy';
//第二种写法
var a = {
[x]:'andy'
}
//第三种写法
var a = {};
Object.defineProperty(a,x,{value:'andy'});
//以上都会得到
a[x];//'andy'
//上面代码通过方括号结构和Object.defineProperty,将对象的属性名指定为一个Symbol值。
var x = Symbol();
var a = {};
a.x ='andy';
console.log(a[x]);//undefined
console.log(a['x']);//andy
//上面代码中,因为点运算符后面总是字符串,所以不会读取mySymbol作为标识名所指代的那个值,
//导致a的属性名实际上是一个字符串,而不是一个Symbol值
同理,在对象的内部,使用Symbol值定义属性时,Symbol值必须放在方括号之中。
let s = Symbol();
let obj = {
[s]: function (arg) {
return arg;
}
};
console.log(obj[s](1));//1
//上面代码中,如果s不放在方括号中,该属性的键名就是字符串s,而不是s所代表的那个Symbol值
//Symbol类型还可以用于定义一组常量,保证这组常量的值都是不相等的。
const levels = {
NAME:Symbol('name'),
AGE:Symbol('age')
};
console.log(levels.NAME,'name mes');//Symbol(name) "name mes"
2,属性的遍历
for...in
、for...of
循环中,也不会被Object.keys()
、Object.getOwnPropertyNames()
、JSON.stringify()
返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols
方法,可以获取指定对象的所有 Symbol 属性名。Object.getOwnPropertySymbols
方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。var obj = {};
var x = Symbol('x');
var y = Symbol('y');
obj[x] = 'hello';
obj[y] = 'andy';
var oSymbols = Object.getOwnPropertySymbols(obj);
console.log(oSymbols);//[Symbol(x), Symbol(y)]
另一个新的API,Reflect.ownKeys
方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。
3,Symbol.for(),Symbol.keyFor()
有时,我们希望重新使用同一个Symbol值,Symbol.for
方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值。如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值
var x = Symbol.for('name');
var y = Symbol.for('name');
console.log(x===y);//true
//都是 Symbol 值,但是它们都是同样参数的Symbol.for方法生成的,所以实际上是同一个值
//Symbol.for()与Symbol()这两种写法,都会生成新的Symbol。
//它们的区别是,前者会被登记在全局环境中供搜索,后者不会。
//Symbol.for()不会每次调用就返回一个新的 Symbol 类型的值,而是会先检查给定的key是否已经存在,如果不存在才会新建一个值。
//比如,如果你调用Symbol.for("cat")30次,每次都会返回同一个 Symbol 值,但是调用Symbol("cat")30次,会返回30个不同的Symbol值
console.log(Symbol.for('age') === Symbol.for('age'));//true
console.log(Symbol('ages') === Symbol('ages'));//false
//由于Symbol()写法没有登记机制,所以每次调用都会返回一个不同的值
//Symbol.keyFor方法返回一个已登记的 Symbol 类型值的key。
var x1 = Symbol.for('school');
console.log(Symbol.keyFor(x1));//school
var x2 = Symbol('schools');
console.log(Symbol.keyFor(x2));//undefiend
//上面代码中,变量x2属于未登记的Symbol值,所以返回undefined
//需要注意的是,Symbol.for为Symbol值登记的名字,是全局环境的,可以在不同的 iframe 或 service worker 中取到同一个值
4,实例:singleton模式
Singleton模式指的是调用一个类,任何时候返回的都是同一个实例。
对于Node来说,模块文件可以看成是一个类。怎么保证每次执行这个模块文件,返回的都是同一个实例呢?
//很容易想到,可以把实例放到顶层对象global
//index.js
function A() {
this.foo = 'hello';
}
if (!global._foo) {
global._foo = new A();
}
module.exports = global._foo;
//加载index.js
var a = require('./index');
console.log(a.foo);
//上面代码中,变量a任何时候加载的都是A的同一个实例。
//但是,这里有一个问题,全局变量global._foo是可写的,任何文件都可以修改。
var a = require('./index');
global._foo = 123;
//上面的代码,会使得别的脚本加载mod.js都失真。
//为了防止这种情况出现,我们就可以使用Symbol。
//index.js
const FOO_KEY = Symbol.for('foo');
function A(){
this.foo = 'hello';
}
if(!global[FOO_KEY]){
global[FOO_KEY] = new A();
}
module.exports = global[FOO_KEY];
//上面代码中,可以保证global[FOO_KEY]不会被无意间覆盖,但还是可以被改写。
var a = require('./index');
global[Symbol.for('foo')] = 123;
//如果键名使用Symbol方法生成,那么外部将无法引用这个值,当然也就无法改写。
const FOO_KEY = Symbol('foo');
//上面代码将导致其他脚本都无法引用FOO_KEY。但这样也有一个问题,就是如果多次执行这个脚本,每次得到的FOO_KEY都是不一样的。
//虽然Node会将脚本的执行结果缓存,一般情况下,不会多次执行同一个脚本,但是用户可以手动清除缓存,所以也不是完全可靠。