Symbol进修笔记

2023年3月9日 205次阅读 来源: Lessong

1.概述

ES5的对象属性名都是字符串，这轻易形成属性名的争执。ES6引入了一种新的原始数据范例Symbol，示意举世无双的值。它是JavaScript言语的第七种数据范例，前六种是：undefined、null、布尔值、字符串、数值、对象。
Symbol值经由过程Symbol函数天生。这就是说，对象的属性名如今能够有两种范例，一种是本来的字符串，另一种就是新增的Symbol范例。通常属性名属于Symbol范例，就都是举世无双的，能够保证不会与别的属性名发生争执。

let s = Symbol();
typeof s//symbol

上面代码中，变量s就是一个举世无双的值。typeof运算符的结果，表明变量s是Symbol数据范例，而不是字符串之类的别的范例。
Symbol函数能够接收一个字符串作为参数，示意对Symbol实例的形貌，主要是为了控制台显现，或许转为字符串时，比较轻易辨别。

let s1 = Symbol('foo');
let s2 = Symbol('bar');
s1//Symbol(foo);
s2//Symbol(bar);
s1.toString()//'Symbol(foo)'
s2.toString()//'Symbol(bar)'

假如Symbol的参数是一个对象，就会挪用该对象的toString要领，将其转为字符串，然后才天生一个Symbol值。

const obj = {
  toString() {
    return 'abc';
  }
};
const sym = Symbol(obj);
sym // Symbol(abc)

注重：Symbol函数的参数只是示意对当前Symbol值的形貌，因而雷同参数Symbol函数的返回值是不相等的。

// 没有参数的状况
let s1 = Symbol();
let s2 = Symbol();

s1 === s2 // false

// 有参数的状况
let s1 = Symbol('foo');
let s2 = Symbol('foo');

s1 === s2 // false

上面代码中，s1和s2都是symbol函数的返回值，而且参数雷同，然则它们是不相等的。

2.作为属性名的Symbol

由于每个Symbol值都是不雷同的，这意味着Symbol值能够作为标识符，用于对象的属性名，就可以保证不会涌现同名的属性。这关于一个对象由多个模块组成的状况异常有效，能防备某一个键被不小心改写或掩盖。

let mySymbol = Symbol();
//第一种写法
let a = {};
a[mySymbol] = 'Hello!';
//第二种写法
let a = {
    [mySymbol]:'Hello!'
};
//第三种写法
let a = {};
Object.defineProperty(a,mySymbol,{value:'Hello!'})
//以上写法都获得一样的结果
a[mySymbol]//'Hello!'

上面代码经由过程方括号构造和Object.defineProperty,将对象的属性名指定为一个Symbol值。注重：Symbol值作为对象属性名时，不能用点运算符。

const mySymbol = Symbol();
const a = {};
a.mySymbol = 'Hello!';
a[mySymbol]//undefined;
a['mySymbol']//'Hello!'

上面代码中，由于点运算符背面老是字符串，所以不会读取mySymbol作为标识名所指代的谁人值，致使a的属性名实际上是一个字符串，而不是一个Symbol值。
同理，在对象的内部，运用Symbol值定义属性时，Symbol值必需放在方括号当中。

let s = Symbol();
let obj = {
    [s]:function(arg){...}
}

上面代码中，假如s不放在方括号中，该属性的键名就是字符串s，而不是s所代表的谁人Symbol值。采纳加强的对象写法，上面代码的obj对象能够写的更简约一些。

let obj = {
    [s](arg){...}
}

Symbol范例还能够用于定义一组常量，保证这组常量的值都是不相等的。

const log = {};
log.levels = {
  DEBUG: Symbol('debug'),
  INFO: Symbol('info'),
  WARN: Symbol('warn')
}
console.log(log.levels.DEBUG, 'debug message');
console.log(log.levels.INFO, 'info message');

下面是另一个例子。

const COLOR_RED    = Symbol();
const COLOR_GREEN  = Symbol();

function getComplement(color) {
  switch (color) {
    case COLOR_RED:
      return COLOR_GREEN;
    case COLOR_GREEN:
      return COLOR_RED;
    default:
      throw new Error('Undefined color');
    }
}

常量运用 Symbol 值最大的优点，就是其他任何值都不可能有雷同的值了，因而能够保证上面的switch语句会按设想的体式格局事情。

3.实例：消弭把戏字符串

const shapeType = {
    triangle:'Triangle'
};
function getArea(shape,options){
    let area = 0;
    switch(shape){
        case shapeType.triangle:
            area = .5*options.width*options.height;
            break;
    }
    return area;
}
getArea(shapeType.triangle,{width:100,height:100})

上面代码中，我们把Triangle写成shapeType对象的triangle属性，如许就消弭了强耦合。
假如仔细分析，能够发明shapeType.triangle即是哪一个值并不主要，只需确保不会跟别的shapeType属性的值争执即可。因而这里就很合适改用Symbol值。

const shapeType = {
    traingle:Symbol();
}

属性名的遍历

Symbol作为属性域名，该属性不会涌现for…in、for…of轮回中，也不会被Object.keys()、Object.getOwnPropertyNames()、JSON.stringify()返回。然则，它也不是私有属性，有一个Object.getOwnPropertySymbols要领，能够猎取指定对象的一切Symbol属性名。
Object.getOwnPropertySymbols要领返回一个数组，成员是当前对象的一切效作属性名的Symbol值。

const obj = {};
let a = Symbol('a');
let b = Symbol('b');

obj[a] = 'Hello';
obj[b] = 'World';

const objectSymbols = Object.getOwnPropertySymbols(obj);

objectSymbols
// [Symbol(a), Symbol(b)]

下面是另一个例子，Object.getOwnPropertySymbols要领与for….in轮回、Object.getOwnPropertyNames要领举行对照的例子。

const obj = {};

let foo = Symbol("foo");

Object.defineProperty(obj, foo, {
  value: "foobar",
});

for (let i in obj) {
  console.log(i); // 无输出
}

Object.getOwnPropertyNames(obj)
// []

Object.getOwnPropertySymbols(obj)
// [Symbol(foo)]

上面代码中，运用Object.getOwnPropertyNames要领得不到Symbol属性名，须要运用Object.getOwnPropertySymbols要领。
另一个新的API，Reflect.ownKeys要领能够返回一切另范例的键名，包含通例键名和Symbol键名。

let obj ={
    [Symbol('my_key')]:1,
    enum:2,
    nonEnum:3
};
Reflect.ownKeys(obj);
//  ["enum", "nonEnum", Symbol(my_key)]

由于以Symbol值作为称号的属性，不会被通例要领遍历获得。我们能够应用这个特征，为对象定义一些非私有的、但又愿望只用于内部的要领。

let size = Symbol('size');
class Collection{
    constructor(){
        this[size] = 0;
    }cat
    add(item){
        this[this[size]] = item;
        this[size]++;
    }
    static sizeOf(instance){
        return instance[size]
    }
}
let x = new Collection();
Collection.sizeOf(x)//0;
x.add('foo');
Collection.sizeOf(x)//1;
Object.keys(x)//['0'];
Object.getOwnPropertyNames(x)//['0'];
Object,getOwnPropertySymbols(x)//[Symbol(size)];

上面代码中，对象x的size属性是一个Symbol值，所以Object.keys(x)、Obejct.getOwnPropertyNames(x)都没法猎取它。这就形成了一种非私有的内部要领的结果。

5Symbol.for(),Symbol.keyFor()

偶然，我们愿望从新运用一个Symbol值，Symbol.for要领能够做到这一点。它接收一个字符串作为参数，然后搜刮有无以该参数作为称号的Symbol值。假如有，就返回这个Symbol值，不然就新建并返回一个以该字符串为称号的Symbol值。

let s1 = Symbol.for('foo');
let s2 = Symbol.for('foo');
s1===s2//true

上面代码中，s1和s2都是Symbol值，然则它们都是一样参数的Symbol.for要领天生的，所以实际上是同一个值。
Symbol.for()与Symbol()这两种写法，都邑天生新的Symbol。它们的区别是，前者会被登记在全局环境中供搜刮，后者不会。Symbol.for()不会每次挪用就返回一个新的Symbol范例的值，而是会先搜检给定的key是不是已存在，假如不存在才会新建一个值。比方，假如你挪用Symbol.for(‘cat’)30次，每次都邑返回同一个Symbol值，然则挪用Symbol(‘cat’)30次，会返回30个差别的Symbol值。

Symbol.for('bar') === Symbol.for('bar')//true
Symbol('bar') === Symbol('bar')//false
    原文作者：Lessong
    原文地址: https://segmentfault.com/a/1190000017970868
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞