ES6 Symbol

🌙
手机阅读
本文目录结构

概述

ES6 引入了一种新的原始数据类型 Symbol ,表示独一无二的值,最大的用法是用来定义对象的唯一属性名。

ES6 数据类型除了 Number 、 String 、 Boolean 、 Objec t、 null 和 undefined ,还新增了 Symbol 。

基本用法

Symbol 函数栈不能用 new 命令,因为 Symbol 是原始数据类型,不是对象。可以接受一个字符串作为参数,为新创建的 Symbol 提供描述,用来显示在控制台或者作为字符串的时候使用,便于区分。

  1. let sy = Symbol("KK");
  2. console.log(sy); // Symbol(KK)
  3. typeof(sy); // "symbol"
  4. // 相同参数 Symbol() 返回的值不相等
  5. let sy1 = Symbol("kk");
  6. sy === sy1; // false

使用场景

作为属性名

用法

由于每一个 Symbol 的值都是不相等的,所以 Symbol 作为对象的属性名,可以保证属性不重名。

  1. let sy = Symbol("key1");
  2. // 写法1
  3. let syObject = {};
  4. syObject[sy] = "kk";
  5. console.log(syObject); // {Symbol(key1): "kk"}
  6. // 写法2
  7. let syObject = {
  8. [sy]: "kk"
  9. };
  10. console.log(syObject); // {Symbol(key1): "kk"}
  11. // 写法3
  12. let syObject = {};
  13. Object.defineProperty(syObject, sy, {value: "kk"});
  14. console.log(syObject); // {Symbol(key1): "kk"}

Symbol 作为对象属性名时不能用.运算符,要用方括号。因为.运算符后面是字符串,所以取到的是字符串 sy 属性,而不是 Symbol 值 sy 属性。

  1. let syObject = {};
  2. syObject[sy] = "kk";
  3. syObject[sy]; // "kk"
  4. syObject.sy; // undefined

注意点

Symbol 值作为属性名时,该属性是公有属性不是私有属性,可以在类的外部访问。但是不会出现在 for…in 、 for…of 的循环中,也不会被 Object.keys() 、 Object.getOwnPropertyNames() 返回。如果要读取到一个对象的 Symbol 属性,可以通过 Object.getOwnPropertySymbols() 和 Reflect.ownKeys() 取到。

  1. let syObject = {};
  2. syObject[sy] = "kk";
  3. console.log(syObject);
  4. for (let i in syObject) {
  5. console.log(i);
  6. } // 无输出
  7. Object.keys(syObject); // []
  8. Object.getOwnPropertySymbols(syObject); // [Symbol(key1)]
  9. Reflect.ownKeys(syObject); // [Symbol(key1)]

定义常量

在 ES5 使用字符串表示常量。例如:

  1. const COLOR_RED = "red";
  2. const COLOR_YELLOW = "yellow";
  3. const COLOR_BLUE = "blue";

但是用字符串不能保证常量是独特的,这样会引起一些问题:

  1. const COLOR_RED = "red";
  2. const COLOR_YELLOW = "yellow";
  3. const COLOR_BLUE = "blue";
  4. const MY_BLUE = "blue";
  5. function ColorException(message) {
  6. this.message = message;
  7. this.name = "ColorException";
  8. }
  9. function getConstantName(color) {
  10. switch (color) {
  11. case COLOR_RED :
  12. return "COLOR_RED";
  13. case COLOR_YELLOW :
  14. return "COLOR_YELLOW ";
  15. case COLOR_BLUE:
  16. return "COLOR_BLUE";
  17. case MY_BLUE:
  18. return "MY_BLUE";
  19. default:
  20. throw new ColorException("Can't find this color");
  21. }
  22. }
  23. try {
  24. var color = "green"; // green 引发异常
  25. var colorName = getConstantName(color);
  26. } catch (e) {
  27. var colorName = "unknown";
  28. console.log(e.message, e.name); // 传递异常对象到错误处理
  29. }

但是使用 Symbol 定义常量,这样就可以保证这一组常量的值都不相等。用 Symbol 来修改上面的例子。

  1. const COLOR_RED = Symbol("red");
  2. const COLOR_YELLOW = Symbol("yellow");
  3. const COLOR_BLUE = Symbol("blue");
  4. function ColorException(message) {
  5. this.message = message;
  6. this.name = "ColorException";
  7. }
  8. function getConstantName(color) {
  9. switch (color) {
  10. case COLOR_RED :
  11. return "COLOR_RED";
  12. case COLOR_YELLOW :
  13. return "COLOR_YELLOW ";
  14. case COLOR_BLUE:
  15. return "COLOR_BLUE";
  16. default:
  17. throw new ColorException("Can't find this color");
  18. }
  19. }
  20. try {
  21. var color = "green"; // green 引发异常
  22. var colorName = getConstantName(color);
  23. } catch (e) {
  24. var colorName = "unknown";
  25. console.log(e.message, e.name); // 传递异常对象到错误处理
  26. }

Symbol 的值是唯一的,所以不会出现相同值得常量,即可以保证 switch 按照代码预想的方式执行。

Symbol.for()

Symbol.for() 类似单例模式,首先会在全局搜索被登记的 Symbol 中是否有该字符串参数作为名称的 Symbol 值,如果有即返回该 Symbol 值,若没有则新建并返回一个以该字符串参数为名称的 Symbol 值,并登记在全局环境中供搜索。

  1. let yellow = Symbol("Yellow");
  2. let yellow1 = Symbol.for("Yellow");
  3. yellow === yellow1; // false
  4. let yellow2 = Symbol.for("Yellow");
  5. yellow1 === yellow2; // true

Symbol.keyFor()

Symbol.keyFor() 返回一个已登记的 Symbol 类型值的 key ,用来检测该字符串参数作为名称的 Symbol 值是否已被登记。

  1. let yellow1 = Symbol.for("Yellow");
  2. Symbol.keyFor(yellow1); // "Yellow"

AXIHE / 精选资源

浏览全部教程

面试题

学习网站

前端培训
自己甄别

前端书籍

关于朱安邦

我叫 朱安邦,阿西河的站长,在杭州。

以前是一名平面设计师,后来开始接接触前端开发,主要研究前端技术中的JS方向。

业余时间我喜欢分享和交流自己的技术,欢迎大家关注我的 Bilibili

关注我: Github / 知乎

于2021年离开前端领域,目前重心放在研究区块链上面了

我叫朱安邦,阿西河的站长

目前在杭州从事区块链周边的开发工作,机械专业,以前从事平面设计工作。

2014年底脱产在老家自学6个月的前端技术,自学期间几乎从未出过家门,最终找到了满意的前端工作。更多>

于2021年离开前端领域,目前从事区块链方面工作了