ES6学习笔记九|Symbol

1. 概述

  • ES6引入了一种新的原始数据类型Symbol,表示独一无二的值。它是JavaScript语言的第七种数据类型,前六种是undefined,Null,布尔值(Boolean),字符串(String),数值(Number),对象(Object)。
  • Symbol值通过Symbol函数生成。凡是属性名属于Symbol类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。
let s = Symbol();
typeof s;   //"Symbol"

注意:Symbol函数前不能使用new命令,会报错。
原因:生成的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函数返回值不相等。

  • Symbol值不能与其他类型的值进行运算,会报错。
  • Symbol值可以显式转为字符串。也可以转为布尔值,但是不能转为数值。
var sym = Symbol('Me');
"you" + sym    //TypeError
String(sym)   //'Symbol(Me)'
sym.toString  //'Symbol(Me)'

var s = Symbol();
Boolean(s)  //true
!s   //false

2. 作为属性名的Symbol

  • Symbol值可以作为标识符,用于对象的属性名,可以保证不出现同名属性。
var s = Symbol();
//第一种写法
var a = {};
a[s] = 'Hello';
//第二种写法
var a = {
    [s]: 'Hello'
}
//第三种写法
var a = {};
Object.defindProperty(a,s,{value:'Hello'});
//以上结果相同
a[s]  //"Hello"

注意:
Symbol值作为对象属性名时,不能用点运算符。
对象内部,使用Symbol值定义属性时,Symbol值必须放在方括号之中。

  • Symbol类型还可以用于定义一组常量,保证这组常量的值都是不相等的。
  • Symbol值作为属性名时,该属性是公开属性,不是私有属性。

3. 实例:消除魔术字符串

魔术字符串指在代码中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。

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'
};
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 });

shapeType.triangle等于哪个值并不重要,只要确保不会跟其他shapeType属性的值冲突即可。因此,这里适合改用Symbol值。

const shapeType = { 
   triangle: Symbol()
};

4. 属性名的遍历

  • Symbol作为属性名,该属性不会出现在for...in、for...of循环中也不会被Object.keys()
    、Object.getOwnPropertyNames()返回。但是,它也不是私有属性,有一个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);
objectSymbols// [Symbol(a), Symbol(b)]
  • 使用Object.getOwnPropertyNames方法得不到Symbol属性名,需要使用Object.getOwnPropertySymbols方法。

  • Reflect.ownKeys方法可以返回所有类型的键名,包括常规键名和Symbol键名。

let obj = { 
    [Symbol('my_key')]: 1, 
    enum: 2, 
    nonEnum: 3
};
Reflect.ownKeys(obj)
// [Symbol(my_key), 'enum', 'nonEnum']

5. Symbol.for(),Symbol.keyFor()

  • Symbol.for方法接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值。如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值。
var s1 = Symbol.for('foo');
var s2 = Symbol.for('foo');
s1 === s2 // true

Symbol.for('foo') ===Symbol.for('foo'); //false
  • Symbol.keyFor方法返回一个已登记的Symbol类型值的key。
var s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"
var s2 = Symbol("foo");//未登记
Symbol.keyFor(s2) // undefined

注意:Symbol.fo为Symbol值登记的名字,是全局环境的,可以在不同的iframe或service worker中取到同一个值。

6. 模块的Singleton模式

  • Singleton模式指的是调用一个类,任何时候返回的都是同一个实例。
  • 把实例放到顶层对象global。
// mod.js
function A() { 
    this.foo = 'hello';
}
if (!global._foo) { 
    global._foo = new A();
}
module.exports = global._foo;

然后加载上面的mod.js

var a = require('./mod.js');
console.log(a.foo);

上面代码中,变量a任何时候加载的都是A的同一个实例。
但时全局变量global._foo是可写的,任何文件都可以修改。

var a = require('./mod.js');
global._foo = 123;

上面的代码会使别的脚本加载mod.js都失真。
为防止这种情况,使用Symbol

// 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];

上面代码中,可以保证global[FOO_KEY]
不会被无意间覆盖,但还是可以被改写。

var a = require('./mod.js');
global[Symbol.for('foo')] = 123;

如果键名使用Symbol方法生成,那么外部将无法引用这个值,当然也就无法改写。

javascript
// mod.js
const FOO_KEY = Symbol('foo');

// 后面代码相同 ……

上面代码将导致其他脚本都无法引用FOO_KEY
。但这样也有一个问题,就是如果多次执行这个脚本,每次得到的FOO_KEY都是不一样的。虽然Node会将脚本的执行结果缓存,一般情况下,不会多次执行同一个脚本,但是用户可以手动清除缓存,所以也不是完全可靠。
以上???

7. 内置的Symbol值

ES6提供11个内置的Symbol值,指向语言内部使用的方法。

  • Symbol.hasInstance
  • 对象的Symbol.hasInstance
    属性,指向一个内部方法。当其他对象使用instanceof运算符,判断是否为该对象的实例时,会调用这个方法。比如,foo instanceof Foo
    在语言内部,实际调用的是Foo[Symbol.hasInstance](foo)。
  • Symbol.isConcatSpreadable
  • 对象的Symbol.isConcatSpreadable
    属性等于一个布尔值,表示该对象使用Array.prototype.concat()时,是否可以展开。
let arr1 = ['c', 'd'];
['a', 'b'].concat(arr1, 'e') // ['a', 'b', 'c', 'd', 'e']
arr1[Symbol.isConcatSpreadable] // undefined

let arr2 = ['c', 'd'];
arr2[Symbol.isConcatSpreadable] = false;
['a', 'b'].concat(arr2, 'e') // ['a', 'b', ['c','d'], 'e']
  • Symbol.species
  • 对象的Symbol.species属性,指向一个方法。该对象作为构造函数创造实例时,会调用这个方法。即如果this.constructor[Symbol.species]
    存在,就会使用这个属性作为构造函数,来创造新的实例对象。
  • Symbol.match
  • 对象的Symbol.match属性,指向一个函数。当执行str.match(myObject)时,如果该属性存在,会调用它,返回该方法的返回值。
  • Symbol.replace
  • 对象的Symbol.replace属性,指向一个方法,当该对象被String.prototype.replace方法调用时,会返回该方法的返回值
String.prototype.replace(searchValue, replaceValue)
// 等同于
searchValue[Symbol.replace](this, replaceValue)
  • Symbol.search
  • 对象的Symbol.search属性,指向一个方法,当该对象被String.prototype.search方法调用时,会返回该方法的返回值。
  • Symbol.split
  • 对象的Symbol.split属性,指向一个方法,当该对象被String.prototype.split方法调用时,会返回该方法的返回值。
String.prototype.split(separator, limit)
// 等同于
separator[Symbol.split](this, limit)
  • Symbol.iterator
  • 对象的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();
     }
   }
};

2 * obj // 246
3 + obj // '3default'
obj == 'default' // true
String(obj) // 'str'
  • Symbol.toStringTag
  • 对象的Symbol.toStringTag属性,指向一个方法。在该对象上面调用Object.prototype.toString
    方法时,如果这个属性存在,它的返回值会出现在toString方法返回的字符串之中,表示对象的类型。也就是说,这个属性可以用来定制[object Object]或[object Array]中object后面的那个字符串。
  • Symbol.unscopables
  • 对象的Symbol.unscopables属性,指向一个对象。该对象指定了使用with关键字时,哪些属性会被with环境排除。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,099评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,473评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,229评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,570评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,427评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,335评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,737评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,392评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,693评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,730评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,512评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,349评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,750评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,017评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,290评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,706评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,904评论 2 335

推荐阅读更多精彩内容

  • 1.属性的简洁表示法 允许直接写入变量和函数 上面代码表明,ES6 允许在对象之中,直接写变量。这时,属性名为变量...
    雨飞飞雨阅读 1,126评论 0 3
  • 1.概述 ES5的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象...
    赵然228阅读 798评论 2 10
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,511评论 18 139
  • 1.深夜闲谈,列夫托尔斯泰欲言又止∶“我们到陌生城市,还不是凭几个建筑物的尖顶来识别的么,后日离开了,记得起的也就...
    凛无礫阅读 406评论 2 1