ES6-12.Symbol

Posted 2022-12-17 lyralee

Symbol是ES6新增的原始类型数据，引入的初衷是为了对象可以有永不重复的属性名。

所以属性名可以是字符串外，还可以是Symbol值；

const a = Symbol("a")；
const obj = ;
obj[a] = "Hello"

1.用法:

const a = Symbol([descName])

1) 直接调用方法，因为是原始值，切忌使用new，因为会生成一个对象。

2) Symbol不会进行自动类型转换，但是可以手动转为String和Boolean;不能转为Number;

3) 方法的参数是Symbol值描述。可以通过原型链上的Symbol.prototype.description访问

const a = Symbol("a");
a.description; // "a"

描述只是为了调试区分，Symbol每次运行都生成一个新的值，即使描述一样，值也不一样。

Symbol(‘foo‘) === Symbol(‘foo‘); // false

2. Symbol注册

Symbol.for(description)用于Symbol值全局环境（可跨iframe和service worker）注册；一部分功能和Symbol()重合；

Symbol.keyFor(变量名)用于获取已经注册过的变量的描述；

const sym = Symbol.for("foo"); // 如果未注册过就注册后返回；注册过就直接返回
Symbol.keyFor(sym); // "foo"
Symbol.for("foo") === Symbol.for("foo"); // true

 3. 单例模式导出内容作为全局变量

nodeJS的通过require(‘./mod.js)引入下面的文件。

require的机制是，先判断是否有缓存结果，因为Node会将脚本的执行结果缓存。

如果有缓存，直接取出结果。如果没有，去新建实例。

// mod.js
const FOO_KEY = Symbol.for(‘foo‘); 
// 不能用Symbol(),因为如果用户清空缓存，每次结果都不一样，global也无意义
function A() 
    this.foo = ‘hello‘;

// 将结果挂在全局对象上，避免多次实例化，因为用户可能清空缓存
if (!global[FOO_KEY])  
    global[FOO_KEY] = new A();

module.exports = global[FOO_KEY]; // 避免外部修改全局变量

4.内置函数

js提供了很多原生方法。这些原生方法的调用实际是调用的Symbol函数。

可以说，如果我们只要手动给原本不支持的对象添加这些Symbol函数，就可以让它支持这些原生方法。

Symbol.变量名 = Symbol(Symbol.变量名)

1. 构造函数内置函数

1）[Symbol.hasInstance]()---实例方法

对应 instanceof 方法

obj instanceof Fun 
// 实际是直接调用
Fun[Symbol.hasInstance](obj)

2. 数组内置函数

1）[Symbol.isConcatSreadable]---属性

对应数组的concat函数; String类型也适用该方法。

var arr1 =[1,2];var arr2= [3,4];
arr1.concat(arr2);  // [1,2,3,4]
// 实际是参数内部的属性Symbol.isConcatSpreadable === undefined
// 当这个属性为undefined/true时，都会展开
// 如果是false,不展开
arr2[Symbol.isConcatSpreadable] = false;
arr1.concat(arr2); // [1,2,[3,4]]

2)static [Symbol.species]() --- 静态属性

对应数组的可以获得衍生数组的方法，如map, filter等方法。

这些方法的本质是，重新调用构造函数的[Symbol.species]属性返回的新的构造函数。

默认返回构造函数本身。

class MyArray extends Array;
var a = new MyArray([1,2]);
var b = a.map(i => i*2);// 默认使用MyArray的构造函数
b instanceof MyArray; // true
b instanceof Array; // true
/**********如果修改静态属性*******/
class MyArray extends Array
    static get [Symbol.species]()  return Array  // 修改衍生对象的构造函数
;
var a = new MyArray([1,2]);
var b = a.map(i => i*2);
b instanceof MyArray; // false
b instanceof Array; // true

3. 字符串对象的内置函数

1）[Symbol.match]() -- 实例方法

str.match(string/RegExp) //返回匹配的数组，数组有index和input两个属性
// 实际对应
str[Symbol.match](str)/RegExp[Symbol.match](str)

2）[Symbol.search]() ---实例方法

str.search(string/RegExp) //返回匹配的位置
// 实际对应
str[Symbol.search](str)/RegExp[Symbol.search](str)

3)[Symbol.replace]() ---实例方法

String.prototype.replace(searchValue, replaceValue)
// 等同于
searchValue[Symbol.replace](this, replaceValue)

4）[Symbol.split]() --- 实例方法

String.prototype.split(separator, limit)
// 等同于
separator[Symbol.split](this, limit)

4. 可遍历对象

所有可遍历对象进行遍历时都是调用的[Symbol.iterator]() ；

[Symbol.iterator]() --- 实例Generator方法

class Collection 
  *[Symbol.iterator]() 
    let i = 0;
    while(this[i] !== undefined) 
      yield this[i];
      ++i;
    
  

5. 数据类型转换

js在运行中，经常会通过运算符，将数据自动转为原始数据

[Symbol.toPrimitive]()

var obj = ;
5 + obj; //"5[object Object]"
// 实际调用的是
obj[Symbol.toPrimitive](根据运算符决定的类型)；

6. 对象内置函数

1）[Symbol.toStringTag] --- 属性

对应Object.prototype.toString()方法

var a = ;
var type = a.toString();
// 相当于
var type = a[Symbol.toStringTag];

2)[Symbol.unscopables] ---属性

指定不能使用With的属性

// 有 unscopables 时
class MyClass 
  foo()  return 1; 
  get [Symbol.unscopables]() 
    return  foo: true ; // 设置为true表示不能被with访问，再向上级作用域查找
  


var foo = function ()  return 2; ;

with (MyClass.prototype) 
  foo(); // 2