ES6 引入了一种新的原始数据类型Symbol,表示独一无二的值。它是 JavaScript 语言的第七种数据类型,前六种是:undefined、null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
Symbol 值通过Symbol函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
let s = Symbol();
console.log(typeof s);//symbol
注意,Symbol函数前不能使用new命令,否则会报错。这是因为生成的 Symbol 是一个原始类型的值,不是对象。也就是说,由于 Symbol 值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。
Symbol函数可以接受一个字符串作为参数,表示对 Symbol 实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。
let s1 = Symbol('one');
let s2 = Symbol('two');
console.log(s1); // Symbol(one)
console.log(s2); // Symbol(two)
console.log(s1.toString()); // 'Symbol(one)'
console.log(s2.toString()); // 'Symbol(two)'
如果 Symbol 的参数是一个对象,就会调用该对象的toString方法,将其转为字符串,然后才生成一个 Symbol 值。
const obj = {
toString() {
return 'abc'
}
}
const s = Symbol(obj);
console.log(s); // Symbol(abc)
作为属性名的Symbol
由于每一个 Symbol 值都是不相等的,这意味着 Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。
let mySymbol = Symbol();
// 第一种写法
let a1 = {};
a1[mySymbol] = 'Hello!';
// 第二种写法
let a2 = {
[mySymbol]: 'Hello!'
};
// 第三种写法
let a3 = {};
Object.defineProperty(a3, mySymbol, { value: 'Hello!' });
// 以上写法都得到同样结果
console.log(a1[mySymbol]) // "Hello!"
console.log(a2[mySymbol]) // "Hello!"
console.log(a3[mySymbol]) // "Hello!"
注意,Symbol 值作为对象属性名时,不能用点运算符。
所以再对象内部,使用Symbol值定义属性时,Symbol值必须放在方括号之中
let s = Symbol();
let obj = {
[s]: function(arg) {
console.log(arg);
}
}
obj[s](10);//10
-
采用增强的对象语法,上面的obj对象可以写的更简洁一些
let obj = { [s](arg) { console.log(arg) } }
属性名的遍历
Symbol作为属性名,该属性不会出现在for...in、for...of循环中,也不会被Object.keys()、Object.getOwnPropertyName()、JSON.stringify()返回,但是它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有Symbol属性名。
const obj = {};
let a = Symbol('a');
let b = Symbol('b');
obj[a] = 'Hello';
obj[b] = 'Mr';
const objectSymbol = Object.getOwnPropertySymbols(obj);
console.log(objectSymbol);//[Symbol(a), Symbol(b)]
另一个新的API,Reflect.ownKeys方法可以返回所有类型的键名,包括常规键名和Symbol键名。
let obj = {
[Symbol('my_key')]: 1,
two: 2,
three: 3
};
console.log(Reflect.ownKeys(obj));//["two", "three", 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)]
Symbol.for(),Symbol.keyFor()
有时候,我们希望使用同一个Symbol值,Symbol.for方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值,如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值。
let s1 = Symbol.for('identical');
let s2 = Symbol.for('identical');
console.log(Object.is(s1, s2));//true
Symbol.for()与Symbol()这两种写法,都会生成新的Symbol。它们的区别是,前者会被登记在全局环境中供搜索,后者不会。Symbol.for()不会每次调用就返回一个新的Symbol值,而是先会检查给定的key是否已存在,如果不存在才会新建一个值。
let s1 = Symbol.for('text');
console.log(Symbol.keyFor(s1));//text
let s2 = Symbol('text');
console.log(Symbol.keyFor(s2));//undefined
上面代码中,变量s2属于未登记的Symbol值,所以返回undefined
注意:Symbol.for为Symbol值登记的名字是全局的,可以在不同的iframe或service worker中取到同一个值
实例:模块的Singleton模式
Singleton模式指的是调用一个类,任何时候返回的都是同一个实例
//mod.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];
上面代码中,使用Symbol后,可以保证global[FOO_KEY]不会被无意间覆盖,但还可以被改写
global[Symbol.for('foo')] = { foo: 'world' }
const a = require('./mod.js')
网友评论