详解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 相关文章推荐
更正确的asp冒泡排序
May 24 Javascript
javascript 事件绑定问题
Jan 01 Javascript
jquery获得下拉框值的代码
Aug 13 Javascript
深入理解JavaScript系列(16) 闭包(Closures)
Apr 12 Javascript
onclick与listeners的执行先后问题详细解剖
Jan 07 Javascript
js识别不同浏览器基于userAgent做判断
Jul 29 Javascript
Angularjs 自定义服务的三种方式(推荐)
Aug 02 Javascript
如何在vue中使用ts的示例代码
Feb 28 Javascript
实例讲解JS中pop使用方法
Jan 27 Javascript
JS为什么说async/await是generator的语法糖详解
Jul 11 Javascript
vue-openlayers实现地图坐标弹框效果
Sep 24 Javascript
JavaScript实现前端网页版倒计时
Mar 24 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
php empty函数 使用说明
2009/08/10 PHP
在yii中新增一个用户验证的方法详解
2013/06/20 PHP
php文件上传的简单实例
2013/10/19 PHP
PHP魔术方法__GET、__SET使用实例
2014/11/25 PHP
php使用APC实现实时上传进度条功能
2015/10/26 PHP
PDO操作MySQL的基础教程(推荐)
2017/08/18 PHP
PHP通过文件保存和更新信息的方法分析
2019/09/12 PHP
Extjs EditorGridPanel中ComboBox列的显示问题
2011/07/04 Javascript
JQuery扩展插件Validate 2通过参数设置验证规则
2011/09/05 Javascript
上传的js验证(图片/文件的扩展名)
2013/04/25 Javascript
JS求平均值的小例子
2013/11/29 Javascript
javascript获取flash版本号的方法
2014/11/20 Javascript
js实现图片点击左右轮播
2015/07/08 Javascript
JQuery EasyUI Layout 在from布局自适应窗口大小的实现方法
2016/05/28 Javascript
JavaScript每天必学之事件
2016/09/18 Javascript
Bootstrap开发中Tab标签页切换图表显示问题的解决方法
2018/07/13 Javascript
JS实现可切换图片的幻灯切换效果示例
2019/05/24 Javascript
vue-以文件流-blob-的形式-下载-导出文件操作
2020/08/07 Javascript
python计算书页码的统计数字问题实例
2014/09/26 Python
python 内置函数filter
2017/06/01 Python
python 接口_从协议到抽象基类详解
2017/08/24 Python
python中requests使用代理proxies方法介绍
2017/10/25 Python
Python获取当前公网ip并自动断开宽带连接实例代码
2018/01/12 Python
Python实现常见的回文字符串算法
2018/11/14 Python
python GUI库图形界面开发之PyQt5表单布局控件QFormLayout详细使用方法与实例
2020/03/06 Python
彻底解决Python包下载慢问题
2020/11/15 Python
CSS3实现银灰色动画效果的导航菜单代码
2015/09/01 HTML / CSS
德国亚洲食品网上商店:asiafoodland.de
2019/12/28 全球购物
网上卖盒饭创业计划书
2014/01/26 职场文书
办公室综合文员岗位职责范本
2014/02/13 职场文书
顶碗少年教学反思
2014/02/21 职场文书
创业融资计划书
2014/04/25 职场文书
党员四风问题个人对照检查材料
2014/10/26 职场文书
群众路线教育实践活动方案
2014/10/31 职场文书
java设计模式--建造者模式详解
2021/07/21 Java/Android
python之PySide2安装使用及QT Designer UI设计案例教程
2021/07/26 Python