面试官:JavaScript 原始数据类型 Symbol 有什么用?

以前提到 JavaScript 原始数据类型时,我们知道有NumberStringNullBooleanUndefined这几种。ES6 引入了新的基本数据类型SymbolBigInt。今天我们就来了解下Symbol类型。Symbol类型是为了解决属性名冲突的问题,顺带还具备模拟私有属性的功能。

简介

创建symbol变量最简单的方法是用Symbol()函数。sysmbol变量有两点比较特别:

  1. 它可以作为对象属性名。只有字符串和 symbol 类型才能用作对象属性名。
  2. 没有两个symbol 的值是相等的。
const symbol1 = Symbol();
const symbol2 = Symbol();

symbol1 === symbol2; // false

const obj = {};
obj[symbol1] = 'Hello';
obj[symbol2] = 'World';

obj[symbol1]; // 'Hello'
obj[symbol2]; // 'World'

尽管调用Symbol() 让它看起来像是对象,实际上symbol是 JavaScript 原始数据类型。把Symbol当作构造函数来用 new会报错。

const symbol1 = Symbol();

typeof symbol1; // 'symbol'
symbol1 instanceof Object; // false

// Throws "TypeError: Symbol is not a constructor"
new Symbol();

描述信息

Symbol()函数只有一个参数,字符串description。这个字符串参数的唯一作用是辅助调试,也就是它的toString()值。但是请注意,两个具有相同descriptionsymbol也是不相等的。

const symbol1 = Symbol('my symbol');
const symbol2 = Symbol('my symbol');

symbol1 === symbol2; // false
console.log(symbol1); // 'Symbol(my symbol)'

有一个全局的symbol注册中心,用Symbol.for()创建的symbol会添加到这个注册中心,并用它的 description作为索引键。也就是说,如果你用Symbol.for()创建带有相同 description的两个 symbol,它们就是相等的。

const symbol1 = Symbol.for('test');
const symbol2 = Symbol.for('test');

symbol1 === symbol2; // true
console.log(symbol1); // 'Symbol(test)'

通常来说,除非你有非常好的理由,否则不应该使用全局注册中心,因为这会造成命名冲突。

命名冲突

JavaScript 内置了一个 symbol ,那就是 ES6 中的Symbol.iterator 。拥有Symbol.iterator函数的对象被称为可迭代对象,就是说你可以在对象上使用for/of 循环

const fibonacci = {
  [Symbol.iterator]: function*() {
    let a = 1;
    let b = 1;
    let temp;

    yield b;

    while (true) {
      temp = a;
      a = a + b;
      b = temp;
      yield b;
    }
  }
};

// Prints every Fibonacci number less than 100
for (const x of fibonacci) {
  if (x >= 100) {
    break;
  }
  console.log(x);
}

为什么这里要用Symbol.iterator 而不是字符串?假设不用Symbol.iterator ,可迭代对象需要有一个字符串属性名'iterator',就像下面这个可迭代对象的类:

class MyClass {
  constructor(obj) {
    Object.assign(this, obj);
  }

  iterator() {
    const keys = Object.keys(this);
    let i = 0;
    return (function*() {
      if (i >= keys.length) {
        return;
      }
      yield keys[i++];
    })();
  }
}

MyClass 的实例是可迭代对象,可以遍历对象上面的属性。但是上面的类有个潜在的缺陷,假设有个恶意用户给 MyClass 构造函数传了一个带有iterator属性的对象:

const obj = new MyClass({ iterator: 'not a function' });

这样你在obj上使用for/of的话,JavaScript 会抛出TypeError: obj is not iterable异常。可以看出,传入对象的 iterator函数覆盖了类的 iterator属性。这有点类似原型污染的安全问题,无脑复制用户数据会对一些特殊属性,比如__proto__constructor带来问题。

这里的核心在于,symbol让对象的内部数据和用户数据井水不犯河水。由于sysmbol无法在 JSON 里表示,因此不用担心给 Express API 传入带有不合适的Symbol.iterator属性的数据。另外,对于那种混合了内置函数和用户数据的对象,比如 Mongoose model,你可以用symbol来确保用户数据不会跟内置属性冲突。

私有属性

由于任何两个symbol都是不相等的,在 JavaScript 里可以很方便地用来模拟私有属性。symbol不会出现在 Object.keys()的结果中,因此除非你明确地export 一个symbol,或者用 Object.getOwnPropertySymbols() 函数获取,否则其他代码无法访问这个属性。

function getObj() {
  const symbol = Symbol('test');
  const obj = {};
  obj[symbol] = 'test';
  return obj;
}

const obj = getObj();

Object.keys(obj); // []

// 除非有这个 symbol 的引用,否则无法访问该属性
obj[Symbol('test')]; // undefined

// 用 getOwnPropertySymbols() 依然可以拿到 symbol 的引用
const [symbol] = Object.getOwnPropertySymbols(obj);
obj[symbol]; // 'test'

还有一个原因是symbol不会出现在JSON.stringify()的结果里,确切地说是JSON.stringify()会忽略symbol属性名和属性值:

const symbol = Symbol('test');
const obj = { [symbol]: 'test', test: symbol };

JSON.stringify(obj); // "{}"

总结

Symbol 表示对象内部状态,可以很好地隔离用户数据和程序状态。有了它,我们就不再需要某些命名约定了,比如内部属性用'$'开头。下次碰到需要定义私有属性的时候,试试Symbol类型吧!


看到这个颇有气质的 logo,不来关注下吗?

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,002评论 6 509
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,777评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,341评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,085评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,110评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,868评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,528评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,422评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,938评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,067评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,199评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,877评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,540评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,079评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,192评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,514评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,190评论 2 357

推荐阅读更多精彩内容

  • 前面的话 ES5中包含5种原始类型:字符串、数字、布尔值、null和undefined。ES6引入了第6种原始类型...
    CodeMT阅读 688评论 0 1
  • ES6 引入了一种新的原始数据类型Symbol,表示独一无二的值。它是JavaScript语言的第七种数据类型,前...
    语目阅读 3,905评论 0 3
  • 概述 ES5的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象添加...
    oWSQo阅读 529评论 1 3
  • 我的天啊……3年没坐过这种车了……我也不知道说啥了……被这呼噜声吵得根本无法好好睡觉。 真的是很完美的给我们演绎了...
    maggiemiaomiao阅读 293评论 0 0
  • 忽然听到妈妈说起,邻居王阿姨被确诊为宫颈癌。吕阿姨也因心肌梗塞住院,心情甚是沉重。她们才50出头,每个人都是为生活...
    静谧A阅读 469评论 3 10