详解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 hasOwnProperty 方法 &amp; in 关键字
Nov 26 Javascript
javascript 必知必会之closure
Sep 21 Javascript
jQuery中trigger()方法用法实例
Jan 19 Javascript
jquery ztree异步搜索(搜叶子)实践
Feb 25 Javascript
node.js文件上传处理示例
Oct 27 Javascript
ajax的分页查询示例(不刷新页面)
Jan 11 Javascript
详解基于angular路由的requireJs按需加载js
Jan 20 Javascript
微信小程序 图片宽高自适应详解
May 11 Javascript
解决webpack打包速度慢的解决办法汇总
Jul 06 Javascript
jQuery DOM节点的遍历方法小结
Aug 15 jQuery
代码详解Vuejs响应式原理
Dec 20 Javascript
微信小程序APP的生命周期及页面的生命周期
Apr 19 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
4种Windows系统下Laravel框架的开发环境安装及部署方法详解
2020/04/06 PHP
jQuery 各种浏览器下获得日期区别
2008/12/22 Javascript
WEB页子窗口(showModalDialog和showModelessDialog)使用说明
2009/10/25 Javascript
关于js日期转化为毫秒数“节省20%的效率和和节省9个字符“问题
2012/03/01 Javascript
Javascript实现关联数据(Linked Data)查询及注意细节
2013/02/22 Javascript
IE的fireEvent方法概述及应用
2013/02/22 Javascript
解决extjs grid 不随窗口大小自适应的改变问题
2014/01/26 Javascript
JavaScript实现模仿桌面窗口的方法
2015/07/18 Javascript
text-align:justify实现文本两端对齐 兼容IE
2015/08/19 Javascript
JavaScript事件 &quot;事件对象&quot;的注意要点
2016/01/14 Javascript
分享jQuery插件的学习笔记
2016/01/14 Javascript
你所未知的3种Node.js代码优化方式
2016/02/25 Javascript
json格式的javascript对象用法分析
2016/07/04 Javascript
jQuery 获取遍历获取table中每一个tr中的第一个td的方法
2016/10/05 Javascript
微信小程序录音与播放录音功能
2017/12/25 Javascript
vue vuex vue-rouert后台项目——权限路由(适合初学)
2017/12/29 Javascript
js实现前面自动补全位数的方法
2018/10/10 Javascript
Vue使用localStorage存储数据的方法
2019/05/27 Javascript
简述Vue中容易被忽视的知识点
2019/12/09 Javascript
Vue scoped及deep使用方法解析
2020/08/01 Javascript
微信小程序实现页面左右滑动
2020/11/16 Javascript
Vue项目打包部署到apache服务器的方法步骤
2021/02/01 Vue.js
Python控制多进程与多线程并发数总结
2016/10/26 Python
Python元组操作实例分析【创建、赋值、更新、删除等】
2017/07/24 Python
详解Python核心编程中的浅拷贝与深拷贝
2018/01/07 Python
python实现简单遗传算法
2018/03/19 Python
Python PyAutoGUI模块控制鼠标和键盘实现自动化任务详解
2018/09/04 Python
详解Python中的format格式化函数的使用方法
2019/11/20 Python
python爬虫实例之获取动漫截图
2020/05/31 Python
意大利独特而优质的家居用品:Fazzini
2018/12/05 全球购物
对于没有初始化的变量的初始值可以作怎样的假定
2014/10/12 面试题
EJB发布WEB服务一般步骤
2012/10/31 面试题
专科应届生求职信
2013/11/24 职场文书
“四风”查摆问题自我剖析材料
2014/09/27 职场文书
2016教师六五普法学习心得体会
2016/01/21 职场文书
关于springboot 配置date字段返回时间戳的问题
2021/07/25 Java/Android