详解ES6 Symbol 的用途


Posted in Javascript onOctober 14, 2018

Symbol 唯一的用途就是标识对象属性,表明对象支持的功能。 相比于字符属性名,Symbol 的区别在于唯一,可避免名字冲突。 这样 Symbol 就给出了唯一标识类型信息的一种方式,从这个角度看有点类似 C++ 的 Traits。

解决了什么问题

在 JavaScript 中要判断一个对象支持的功能,常常需要做一些 Duck Test。 比如经常需要判断一个对象是否可以按照数组的方式去迭代,这类对象称为 Array-like。 lodash 中是这样判断的:

function isArrayLike(value) {
  return value != null && isLength(value.length) && !isFunction(value);
}

在 ES6 中提出一个 @@iterator 方法,所有支持迭代的对象(比如 Array、Map、Set)都要实现。 @@iterator 方法的属性键为 Symbol.iterator 而非字符串。 这样只要对象定义有 Symbol.iterator 属性就可以用 for ... of 进行迭代。 比如:

if (Symbol.iterator in arr) {
  for(let n of arr) console.log(n)
}

其他用例

上述例子中 Symbol 标识了这个对象是可迭代的(Iterables),是一个典型的 Symbol 用例。 详情可以参考 ES6 迭代器 一文。 此外利用 Symbol 还可以做很多其他事情,例如:

常量枚举

JavaScript 没有枚举类型,常量概念也通常用字符串或数字表示。例如:

const COLOR_GREEN = 1
const COLOR_RED = 2

function isSafe(trafficLight) {
  if (trafficLight === COLOR_RED) return false
  if (trafficLight === COLOR_GREEN) return true
  throw new Error(`invalid trafficLight: ${trafficLight}`)
}
  • 我们需要认真地排列这些常量的值。如果不小心有两个值重复会很难调试,就像 #define false true 引起的问题一样。
  • 取值可能重复。如果有另一处定义了 BUSY = 1 并不小心把 BUSY 传入,干脆 isSafe(1),理想的枚举概念应该抛出异常,但上述代码无法检测。

Symbol 给出了解决方案:

const COLOR_GREEN = Symbol('green')
const COLOR_RED = Symbol('red')

即使字符串写错或重复也不重要,因为每次调用 Symbol() 都会给出独一无二的值。 这样就可以确保所有 isSafe() 调用都传入这两个 Symbol 之一。

私有属性

由于没有访问限制,JavaScript 曾经有一个惯例:私有属性以下划线起始来命名。 这样不仅无法隐藏这些名字,而且会搞坏代码风格。 可以利用 Symbol 来隐藏这些私有属性:

let speak = Symbol('speak')
class Person {
  [speak]() {
    console.log('harttle')
  }
}

如下几种访问都获取不到 speak 属性:

let p = new Person()

Object.keys(p)           // []
Object.getOwnPropertyNames(p)    // []
for(let key in p) console.log(key) // <empty>

但 Symbol 只能隐藏这些函数,并不能阻止未授权访问。 仍然可以通过 Object.getOwnPerpertySymbols(), Reflect.ownKeys(p) 来枚举到 speak 属性。

新的基本类型

Symbol 是新的基本类型,从此 JavaScript 有 7 种类型:

  • Number
  • Boolean
  • String
  • undefined
  • null
  • Symbol
  • Object

转换为字符串

Symbol 支持 symbol.toString() 方法以及 String(symbol), 但不能通过 + 转换为字符串,也不能直接用于模板字符串输出。 后两种情况都会产生 TypeError,是为了避免把它当做字符串属性名来使用。

转换为数字

不可转换为数字。Number(symbol) 或四则运算都会产生 TypeError。

转换为布尔

Boolean(symbol) 和取非运算都 OK。这是为了方便判断是否包含属性。

包裹对象

Symbol 是基本类型,但不能用 new Symbol(sym) 来包裹成对象,需要使用 Object(sym)。 除了判等不成立外,包裹对象的使用与原基本类型几乎相同:

let sym = Symbol('author')
let obj = {
  [sym]: 'harttle'
}
let wrapped = Object(sym)
wrapped instanceof Symbol  // true,真的是true!!!
obj[sym]          // 'harttle'
obj[wrapped]        // 'harttle'

常见的 Symbol

文章最前面的例子提到的 Symbol.iterator 是一个内置 Symbol。除此之外常见的内置 Symbol 还有:

Symbol.match

Symbol.match 在 String.prototype.match() 中用于获取 RegExp 对象的匹配方法。 我们来改写一下 Symbol.match 标识的方法,

观察 String.prototype.match() 的表现, 下面的例子来自 MDN:

// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/@@match
class RegExp1 extends RegExp {
 [Symbol.match](str) {
  var result = RegExp.prototype[Symbol.match].call(this, str);
  return result ? 'VALID' : 'INVALID';
 }
}

console.log('2012-07-02'.match(new RegExp1('([0-9]+)-([0-9]+)-([0-9]+)')));
// expected output: "VALID"
Symbol.toPrimitive

在对象进行运算时经常会变成 "[object Object]", 这是对象转换为字符串(基本数据类型)的默认行为,定义在 Object.prototype.toString。 比如这个对象:

var count = {
  value: 3
};
count + 2   // "[object Object]2"

这个对象也在表示一个数字,怎么让它可以参加四则运算呢? 给它加一个 Symbol.toPrimitive 属性,来改变它转换为基本类型的行为:

count[Symbol.toPrimitive] = function () {
  return this.value
};
count + 2   // 5

更多内置 Symbol 请参考 MDN 文档: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol#Well-known_symbols

跨 Realm 使用

JavaScript Realm 是指当前代码片段运行的上下文,包括全局变量,比如 Array, Date 这些全局函数。 在打开新标签页、 加载 iframe 或加载 Worker 进程时,都会产生多个 JavaScript Realm。 跨 Realm 通信时这些全局变量是不同的,例如从 iframe 中传递给数组 arr 给父窗口, 父窗口中收到的 arr instanceof Array 为 false,因为它的原型是 iframe 中的那个 Array。

但是一个对象在 iframe 中可以迭代(Iterable),那么在父窗口中也应当能被迭代。 这就要求 Symbol 可以跨 Realm,当然 Symbol.iterator 可以。 如果你定义的 Symbol 也需要跨 Realm,请使用 Symbol Registry API:

// 在 Symbol Registry 中注册一个跨 Realm Symbol
let sym = Symbol.for('foo')
// 获取 Symbol 的键值字符串
Symbol.keyFor(sym)   // 'foo'

内置的跨 Realm Symbol 其实不在 Symbol Registry 中:

Symbol.keyFor(Symbol.iterator)  // undefined

总结

以上所述是小编给大家介绍的ES6 Symbol 的用途,希望对大家有所帮助,如果大家有任何疑问欢迎给我留言,小编会及时回复大家的!

Javascript 相关文章推荐
javascript自启动函数的问题探讨
Oct 05 Javascript
使用jQuery和PHP实现类似360功能开关效果
Feb 12 Javascript
SyntaxHighlighter 3.0.83使用笔记
Jan 26 Javascript
jquery带下拉菜单和焦点图代码分享
Aug 24 Javascript
在html中引入外部js文件,并调用带参函数的方法
Oct 31 Javascript
微信小程序中做用户登录与登录态维护的实现详解
May 17 Javascript
vue component组件使用方法详解
Jul 14 Javascript
AngularJs点击状态值改变背景色的实例
Dec 18 Javascript
Webpack中雪碧图插件使用详解
May 25 Javascript
微信小程序使用 vant Dialog组件的正确方式
Feb 21 Javascript
vue 自定义组件的写法与用法详解
Mar 04 Javascript
使用PDF.js渲染canvas实现预览pdf的效果示例
Apr 17 Javascript
javascript实现文本框标签验证的实例代码
Oct 14 #Javascript
Vue+webpack项目配置便于维护的目录结构教程详解
Oct 14 #Javascript
单页面vue引入百度统计的使用方法示例详解
Oct 13 #Javascript
详解解决Vue相同路由参数不同不会刷新的问题
Oct 12 #Javascript
详解webpack loader和plugin编写
Oct 12 #Javascript
深入理解Angularjs 脏值检测
Oct 12 #Javascript
vue中render函数的使用详解
Oct 12 #Javascript
You might like
ASP和PHP都是可以删除自身的
2007/04/09 PHP
PHP日期处理函数 整型日期格式
2011/01/12 PHP
PHP判断远程图片或文件是否存在的实现代码
2014/02/20 PHP
推荐几款用 Sublime Text 开发 Laravel 所用到的插件
2014/10/30 PHP
PHP版微信第三方实现一键登录及获取用户信息的方法
2016/10/14 PHP
php微信公众号开发之图片回复
2018/10/20 PHP
JS 的应用开发初探(mootools)
2009/12/19 Javascript
jQuery 打造动态下滑菜单实现说明
2010/04/15 Javascript
defer属性导致引用JQuery的页面报“浏览器无法打开网站xxx,操作被中止”错误的解决方法
2010/04/27 Javascript
JavaScript实现表格排序方法
2013/06/14 Javascript
Jquery中LigerUi的弹出编辑框(实现方法)
2013/07/09 Javascript
浅析JavaScript中的typeof运算符
2013/11/30 Javascript
解析JavaScript中点号“.”的多义性
2013/12/02 Javascript
jQuery ajax调用WCF服务实例
2014/07/16 Javascript
浅谈javascript中createElement事件
2014/12/05 Javascript
javascript制作网页图片上实现下雨效果
2015/02/26 Javascript
JavaScript实现找质数代码分享
2015/03/24 Javascript
JavaScript中通过提示框跳转页面的方法
2016/02/14 Javascript
Node.js中使用jQuery的做法
2016/08/17 Javascript
Vue2.0 UI框架ElementUI使用方法详解
2017/04/14 Javascript
JS代码实现电脑配置检测功能
2018/03/21 Javascript
webstorm添加*.vue文件支持
2018/05/08 Javascript
使用vue-infinite-scroll实现无限滚动效果
2018/06/22 Javascript
Js中使用正则表达式验证输入是否有特殊字符
2018/09/07 Javascript
vue文件运行的方法教学
2019/02/12 Javascript
JS中箭头函数与this的写法和理解
2021/01/14 Javascript
[02:17]2016国际邀请赛中国区预选赛VG战队领队采访
2016/06/26 DOTA
python在每个字符后添加空格的实例
2018/05/07 Python
python 快速把超大txt文件转存为csv的实例
2018/10/26 Python
Python设计模式之外观模式实例详解
2019/01/17 Python
opencv之为图像添加边界的方法示例
2019/12/26 Python
Python第三方包PrettyTable安装及用法解析
2020/07/08 Python
蛋白质世界:Protein World
2017/11/23 全球购物
编写一子程序,将一链表倒序,即使链表表尾变表头,表头变表尾
2016/02/10 面试题
班主任工作实习计划
2015/01/16 职场文书
小学运动会前导词
2015/07/20 职场文书