es6学习笔记-Symbol_v1.0
基本抄了一次内容,有很多只是知道其然并不知其所以然,不过也算是加深了一次印象,另外每段代码我都有手动执行过.
ES6引入了一种新的原始数据类型Symbol,表示独一无二的值。
它是JavaScript语言的第七种数据类型,前六种是:Undefined、Null、布尔值(Boolean)、字符串(String)、数值(Number)、对象(Object)。
ES5的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象添加新的方法(mixin模式),新方法的名字就有可能与现有方法产生冲突。为了防止冲突,这就是ES6引入Symbol的原因。
Symbol值通过Symbol函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的Symbol类型。凡是属性名属于Symbol类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
let s = Symbol();typeof s// "symbol"
Symbol函数可以接受一个字符串作为参数,表示对Symbol实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。
var s1 = Symbol('foo');var s2 = Symbol('bar');s1 // Symbol(foo)s2 // Symbol(bar)s1.toString() // "Symbol(foo)"s2.toString() // "Symbol(bar)"
Symbol值不能与其他类型的值进行运算(可以转为布尔值,但不能运算)
Symbol值作为对象属性名时,不能用点运算符。
作为属性名的Symbol
var mySymbol = Symbol();// 第一种写法var a = {};a[mySymbol] = 'Hello!';// 第二种写法var a = {//在对象内部必须要使用方括号包裹Symbol属性 [mySymbol]: 'Hello!'};// 第三种写法var a = {};//Object.defineProperty(obj, prop(需定义或修改的属性的名字), descriptor(将被定义或修改的属性的描述符))Object.defineProperty(a, mySymbol, { value: 'Hello!' });// 以上写法都得到同样结果a[mySymbol] // "Hello!"
增强对象写法
let s = Symbol();let obj = {//跟下面一样 [s]: function (arg) { ... }//用方括号};obj[s](123);//--------------------------let obj = { //这是增强对象写法 [s](arg) { ... }};
跟常量配合使用
主要是为了保证常量不会相同
log.levels = { DEBUG: Symbol('debug'),//这里就是 INFO: Symbol('info'), WARN: Symbol('warn')};log(log.levels.DEBUG, 'debug message');log(log.levels.INFO, 'info message');//--------------------------const COLOR_RED = Symbol(); //比较巧妙的设置为一个唯一的常量const COLOR_GREEN = Symbol();function getComplement(color) { switch (color) { case COLOR_RED: return COLOR_GREEN; case COLOR_GREEN: return COLOR_RED; default: throw new Error('Undefined color'); }}
实例:消除魔术字符串
魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码,应该尽量消除魔术字符串,该由含义清晰的变量代替。
function getArea(shape, options) { var area = 0; switch (shape) { case 'Triangle': // 魔术字符串 area = .5 * options.width * options.height; break; /* ... more code ... */ } return area;}getArea('Triangle', { width: 100, height: 100 }); // 魔术字符串
改成这样
var shapeType = { triangle: 'Triangle'//这样消除了强耦合};//更直接的方式使用Symbol保持唯一const shapeType = { triangle: Symbol()};//-------------------------function getArea(shape, options) { var area = 0; switch (shape) { case shapeType.triangle: area = .5 * options.width * options.height; break; } return area;}getArea(shapeType.triangle, { width: 100, height: 100 });
属性名的遍历
Symbol 作为属性名,该属性不会出现在for...in、for...of循环中,也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。
Object.getOwnPropertySymbols方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。
var obj = {};var a = Symbol('a');var b = Symbol('b');obj[a] = 'Hello';obj[b] = 'World';var objectSymbols = Object.getOwnPropertySymbols(obj);console.log(objectSymbols)// 返回[Symbol(a), Symbol(b)]for (var i in obj) {//并不能使用这个方法获取Symbol console.log(i); // 无输出}console.log(Object.getOwnPropertyNames(obj))//并不能使用这个方法获取Symbol// 返回[]
Reflect.ownKeys
Reflect.ownKeys方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。
let obj = { [Symbol('my_key')]: 1, enum: 2, nonEnum: 3};console.log(Reflect.ownKeys(obj))// 返回 ["enum", "nonEnum", Symbol(my_key)]
Symbol.for()
Symbol.for方法,它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值。如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值。
var s1 = Symbol.for('foo');var s2 = Symbol.for('foo');console.log(s1 === s2) // trueconsole.log(Symbol.for("bar") === Symbol.for("bar"))// trueconsole.log(Symbol("bar") === Symbol("bar"))// false
Symbol.for()与Symbol()这两种写法,都会生成新的Symbol。它们的区别是,前者会被登记在全局环境中供搜索,后者不会。Symbol.for()不会每次调用就返回一个新的 Symbol 类型的值,而是会先检查给定的key是否已经存在,如果不存在才会新建一个值。
实例:模块的 Singleton 模式
Singleton模式指的是调用一个类,任何时候返回的都是同一个实例。
对于Node来说,模块文件可以看成是一个类。怎么保证每次执行这个模块文件,返回的都是同一个实例呢?
把实例放到顶层对象global
// mod.jsfunction A() { this.foo = 'hello';}if (!global._foo) { global._foo = new A();}module.exports = global._foo;
变量a任何时候加载的都是A的同一个实例。
var a = require('./mod.js');console.log(a.foo);
但是,这里有一个问题,全局变量global._foo是可写的,任何文件都可以修改。
var a = require('./mod.js');global._foo = 123;//修改了全局变量global._foo
上面的代码,会使得别的脚本加载mod.js都失真。
为了防止这种情况出现,我们就可以使用Symbol。
// mod.jsconst FOO_KEY = Symbol.for('foo'); //Symbol.for生成是为了有些时候可以重新使用这个Symbol值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('./mod.js');global[Symbol.for('foo')] = 123;
如果键名使用Symbol方法生成,那么外部将无法引用这个值,当然也就无法改写。
// mod.jsconst FOO_KEY = Symbol('foo');//保证每次都是唯一,因为Symbol生成// 后面代码相同 ……
上面代码将导致其他脚本都无法引用FOO_KEY。但这样也有一个问题,就是如果多次执行这个脚本,每次得到的FOO_KEY都是不一样的。虽然Node会将脚本的执行结果缓存,一般情况下,不会多次执行同一个脚本,但是用户可以手动清除缓存,所以也不是完全可靠。
内置的Symbol值
Symbol.hasInstance
对象的Symbol.hasInstance属性,指向一个内部方法。当其他对象使用instanceof运算符,判断是否为该对象的实例时,会调用这个方法。比如,foo instanceof Foo在语言内部,实际调用的是Foo[Symbol.hasInstance](foo)
。
class MyClass { [Symbol.hasInstance](foo) {//instanceof指向了这个内部方法 return foo instanceof Array; }}//调用了instanceofconsole.log([1, 2, 3] instanceof new MyClass()) //返回 true
Symbol.isConcatSpreadable
对象的Symbol.isConcatSpreadable属性等于一个布尔值,表示该对象使用Array.prototype.concat()时,是否可以展开。
数组的默认行为是可以展开
let arr1 = ['c', 'd'];console.log(['a', 'b'].concat(arr1, 'e')) // ['a', 'b', 'c', 'd', 'e']console.log(arr1[Symbol.isConcatSpreadable]) // undefinedlet arr2 = ['c', 'd'];arr2[Symbol.isConcatSpreadable] = false;console.log(arr2[Symbol.isConcatSpreadable]);//返回falseconsole.log(['a', 'b'].concat(arr2, 'e')) // ['a', 'b', ['c','d'], 'e']
Symbol.species
对象的Symbol.species属性,指向当前对象的构造函数。创造实例时,默认会调用这个方法,即使用这个属性返回的函数当作构造函数,来创造新的实例对象。
class MyArray extends Array { // 覆盖父类 Array 的构造函数 //所以他是由当前类MyArray创建的 static get [Symbol.species]() { return this; }//静态方法并且要用get来获取Symbol.species属性}var a = new MyArray(1,2,3);var mapped = a.map(x => x * x);//虽然是由MyArray来创建的,但是因为他也是集成自Array,所以都是trueconsole.log(mapped instanceof MyArray) // trueconsole.log(mapped instanceof Array) // true
//如果改成了返回Array的话,那么结果的是Array为true static get [Symbol.species]() { return Array; }
Symbol.match
对象的Symbol.match属性,指向一个函数。当执行str.match(myObject)时,如果该属性存在,会调用它,返回该方法的返回值。
String.prototype.match(regexp)// 等同于regexp[Symbol.match](this)
class MyMatcher { [Symbol.match](string) { return 'hello world'.indexOf(string); }}'e'.match(new MyMatcher()) // 1(从0开始计算第一位,1是第二位)
Symbol.replace
对象的Symbol.replace属性,指向一个方法,当该对象被String.prototype.replace方法调用时,会返回该方法的返回值。
String.prototype.replace(searchValue, replaceValue)// 等同于searchValue[Symbol.replace](this, replaceValue)下面是一个例子。
const obj = {};obj[Symbol.replace] = (...s) => console.log(s);'Hello'.replace(obj, 'World') // ["Hello", "World"]
Symbol.replace方法会收到两个参数,第一个参数是replace方法正在作用的对象,上面例子是Hello,第二个参数是替换后的值,上面例子是World。
Symbol.search
对象的Symbol.search属性,指向一个方法,当该对象被String.prototype.search方法调用时,会返回该方法的返回值。
String.prototype.search(regexp)// 等同于regexp[Symbol.search](this)
class MySearch { constructor(value) { this.value = value; } [Symbol.search](string) { return string.indexOf(this.value); }}console.log('foobar'.search(new MySearch('foo'))) // 0
Symbol.split
对象的Symbol.split属性,指向一个方法,当该对象被String.prototype.split方法调用时,会返回该方法的返回值。
String.prototype.split(separator, limit)// 等同于separator[Symbol.split](this, limit)
class MySplitter { constructor(value) { this.value = value; } [Symbol.split](string) { var index = string.indexOf(this.value); if (index === -1) { return string; } return [ string.substr(0, index), string.substr(index + this.value.length) ]; }}console.log('foobar'.split(new MySplitter('foo')))// ['', 'bar']console.log('foobar'.split(new MySplitter('bar')))// ['foo', '']console.log('foobar'.split(new MySplitter('baz')))// 'foobar'
上面方法使用Symbol.split方法,重新定义了字符串对象的split方法的行为
Symbol.iterator
对象的Symbol.iterator属性,指向该对象的默认遍历器方法。
var myIterable = {};myIterable[Symbol.iterator] = function* () { yield 1; yield 2; yield 3;};[...myIterable] // [1, 2, 3]
对象进行for...of循环时,会调用Symbol.iterator方法,返回该对象的默认遍历器,
Symbol.toPrimitive
对象的Symbol.toPrimitive属性,指向一个方法。该对象被转为原始类型的值时,会调用这个方法,返回该对象对应的原始类型值。
Symbol.toPrimitive被调用时,会接受一个字符串参数,表示当前运算的模式,一共有三种模式。
Number:该场合需要转成数值
String:该场合需要转成字符串Default:该场合可以转成数值,也可以转成字符串let obj = { [Symbol.toPrimitive](hint) { switch (hint) { case 'number': return 123; case 'string': return 'str'; case 'default': return 'default'; default: throw new Error(); } }};console.log(2 * obj) // 246console.log(3 + obj) // '3default'console.log(obj == 'default') // trueconsole.log(String(obj)) // 'str'
Symbol.toStringTag
对象的Symbol.toStringTag属性,指向一个方法。在该对象上面调用Object.prototype.toString方法时,如果这个属性存在,它的返回值会出现在toString方法返回的字符串之中,表示对象的类型。也就是说,这个属性可以用来定制[object Object]或[object Array]中object后面的那个字符串。
// 例一console.log(({[Symbol.toStringTag]: 'Foo'}.toString()))// "[object Foo]"// 例二class Collection { get [Symbol.toStringTag]() { return 'xxx'; }}var x = new Collection();console.log(Object.prototype.toString.call(x)) // "[object xxx]"
ES6新增内置对象的Symbol.toStringTag属性值如下。
JSON[Symbol.toStringTag]:'JSON'Math[Symbol.toStringTag]:'Math'Module对象M[Symbol.toStringTag]:'Module'ArrayBuffer.prototype[Symbol.toStringTag]:'ArrayBuffer'DataView.prototype[Symbol.toStringTag]:'DataView'Map.prototype[Symbol.toStringTag]:'Map'Promise.prototype[Symbol.toStringTag]:'Promise'Set.prototype[Symbol.toStringTag]:'Set'%TypedArray%.prototype[Symbol.toStringTag]:'Uint8Array'等WeakMap.prototype[Symbol.toStringTag]:'WeakMap'WeakSet.prototype[Symbol.toStringTag]:'WeakSet'%MapIteratorPrototype%[Symbol.toStringTag]:'Map Iterator'%SetIteratorPrototype%[Symbol.toStringTag]:'Set Iterator'%StringIteratorPrototype%[Symbol.toStringTag]:'String Iterator'Symbol.prototype[Symbol.toStringTag]:'Symbol'Generator.prototype[Symbol.toStringTag]:'Generator'GeneratorFunction.prototype[Symbol.toStringTag]:'GeneratorFunction'
参考引用: