ES6 Symbol函数

绝地灬酷狼 2021-09-15 06:06 347阅读 0赞

# 一.Symbol #

## 1.什么是Symbol？ ##

它是 JavaScript 语言的第七种数据类型，前六种是：undefined、null、布尔值（Boolean）、字符串（String）、数值（Number）、对象（Object）。

let s = Symbol(); typeof s // "symbol" 上面代码中，变量s就是一个独一无二的值。typeof运算符的结果，表明变量s是 Symbol 数据类型，而不是字符串之类的其他类型。

## 2.为什么引入？ ##

用它来产生一个独一无二的值。凡是属性名属于 Symbol 类型，就都是独一无二的

## 3.注意 ##

①Symbol函数前不能使用new命令，否则会报错

因为生成的 Symbol 是一个原始类型的值，不是对象.所以不能添加属性

②Symbol函数可以接受一个字符串作为参数

表示对Symbol实例的描述，主要是为了在控制台显示，或者转为字符串时，比较容易区分。

let s1 = Symbol('foo'); let s2 = Symbol('bar'); s1 // Symbol() s2 // Symbol() s1.toString() // "Symbol(foo)" s2.toString() // "Symbol(bar)" 上面代码中，如果不加参数输出都是Symbol()，不利于区分。有了参数以后，就等于为它们加上了描述，输出的时候就能够分清，到底是哪一个值。

③如果 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函数的返回值，而且参数相同，但是它们是不相等的。

⑤Symbol 值不能与其他类型的值进行运算，会报错

let sym = Symbol('My symbol'); "your symbol is " + sym // TypeError: can't convert symbol to string `your symbol is ${sym}` // TypeError: can't convert symbol to string 但是，Symbol 值可以显式转为字符串。 let sym = Symbol('My symbol'); String(sym) // 'Symbol(My symbol)' sym.toString() // 'Symbol(My symbol)' 另外，Symbol 值也可以转为布尔值，但是不能转为数值。 let sym = Symbol(); Boolean(sym) // true !sym // false if (sym) { // ... } Number(sym) // TypeError sym + 2 // TypeError

二.作为属性名的Symbol

1.写法

2.注意

①Symbol 值作为对象属性名时，不能用点运算符

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

上面代码中，因为点运算符后面总是字符串，所以不会读取mySymbol作为标识名所指代的那个值，导致a的属性名实际上是一个字符串，而不是一个 Symbol 值。

②Symbol 值必须放在方括号之中

let s = Symbol();
    
    let obj = {
      [s]: function (arg) { ... }
    };
    
    obj[s](123);
    上面代码中，如果s不放在方括号中，该属性的键名就是字符串s，而不是s所代表的那个 Symbol 值。

③采用增强的对象写法，

上面代码的obj对象可以写得更简洁一些。let obj = \{  \[s\](arg) \{ ... \}\};

④Symbol 值作为属性名时，该属性还是公开属性，不是私有属性。

三.属性名遍历  获取Symbol属性的方法

Symbol 作为属性名，该属性不会出现在`for...in`、`for...of`循环中，也不会被`Object.keys()`、`Object.getOwnPropertyNames()`、`JSON.stringify()`返回。但是，它也不是私有属性，有一个`Object.getOwnPropertySymbols`方法，可以获取指定对象的所有 Symbol 属性名。

1.Object.getOwnPropertySymbols方法返回一个数组，成员是当前对象的所有用作属性名的 Symbol 值。

const obj = {};
    		let a = Symbol('a');
    		let b = Symbol('b');
    
    		obj[a] = 'Hello';
    		obj[b] = 'World';
    
    		const objectSymbols = Object.getOwnPropertySymbols(obj);
    
    		console.log(objectSymbols)//输出 [Symbol(a), Symbol(b)]

2.Object.getOwnPropertySymbols方法与for...in循环、Object.getOwnPropertyNames方法进行对比的例子。

上面代码中，使用Object.getOwnPropertyNames方法得不到Symbol属性名，需要使用Object.getOwnPropertySymbols方法。

3.Reflect.ownKeys方法可以返回所有类型的键名，包括常规键名和 Symbol 键名。

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

4.非私有的内部方法（为对象定义一些非私有的、但又希望只用于内部的方法）

et size = Symbol('size');
    class Collection {
      constructor() {
        this[size] = 0;
      }
    
      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)、Object.getOwnPropertyNames(x)都无法获取它。这就造成了一种非私有的内部方法的效果。

四.Symbol.for()，Symbol.keyFor()

1.Symbol.for()重新使用同一个 Symbol 值

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

`Symbol.for()`与`Symbol()`这两种写法，都会生成新的 Symbol。它们的区别是，前者会被登记在全局环境中供搜索，后者不会。

2.Symbol.keyFor方法返回一个已登记的 Symbol 类型值的key

let s1 = Symbol.for("foo");
    Symbol.keyFor(s1) // "foo"
    
    let s2 = Symbol("foo");
    Symbol.keyFor(s2) // undefined
    上面代码中，变量s2属于未登记的 Symbol 值，所以返回undefined。

五.ES6开放11个内部方法的操作

![20180417140059867][]

请参考：[ECMAScript 6 入门][ECMAScript 6]

下面简单理解下

1.Symbol.hasInstance 执行instanceof 调用的方法

对象的Symbol.hasInstance属性，指向一个内部方法。当其他对象使用instanceof运算符，判断是否为该对象的实例时，会调用这个方法。

class MyClass {
      [Symbol.hasInstance](foo) {
        return foo instanceof Array;
      }
    }
    [1, 2, 3] instanceof new MyClass() // true

2.Symbol.isConcatSpreadable顾名思义concat是否可以展开

var arr1 = [1,2,3,4];
    var arr2 = ['a','b','c','d'];
    arr1.concat(arr2)  //[1, 2, 3, 4, "a", "b", "c", "d"]
    
    arr2[Symbol.isConcatSpreadable] = false;
    arr1.concat(arr2) // [1, 2, 3, 4, Array(4)]

3.Symbol.species属性，指向一个构造函数。创建衍生对象时，会使用该属性

4.Symbol.match,replace,serch,split方法

5.Symbol.iterator属性，指向该对象的默认遍历器方法

[20180417140059867]: /images/20210813/881d295ea47249e7802292098d718d11.png
[ECMAScript 6]: http://es6.ruanyifeng.com/#docs/symbol