JavaScript:Symbol

Symbol(符号)是ECMAScript 6新增的数据类型。符号是原始值,且符号实例是唯一、不可变的。符号的用途是确保对象属性使用唯一标识符,不会发生属性冲突的危险。

Symbol用于防止属性名冲突而产生的,比如向第三方对象中添加属性时。

Symbol 的值是唯一的,独一无二的不会重复的

基础知识

Symbol

let hd = Symbol();
let edu = Symbol();
console.log(hd); //symbol
console.log(hd == edu); //false

Symbol 不可以添加属性

let hd = Symbol();
hd.name = "木易";
console.log(hd.name);

描述参数

可传入字符串用于描述Symbol,方便在控制台分辨Symbol

let hd = Symbol("is name");
let edu = Symbol("这是一个测试");

console.log(hd); //Symbol(is name)
console.log(edu.toString()); //Symbol(这是一个测试)

传入相同参数Symbol也是独立唯一的,因为参数只是描述而已,但使用 Symbol.for则不会

let hd = Symbol("木易");
let edu = Symbol("木易");
console.log(hd == edu); //false

使用description可以获取传入的描述参数

let hd = Symbol("木易");
console.log(hd.description); //木易

Symbol.for

根据描述获取Symbol,如果不存在则新建一个Symbol

  • 使用Symbol.for会在系统中将Symbol登记
  • 使用Symbol则不会登记
let hd = Symbol.for("木易");
let edu = Symbol.for("木易");
console.log(hd == edu); //true

Symbol.keyFor

Symbol.keyFor 根据使用Symbol.for登记的Symbol返回描述,如果找不到返回undefined 。

let hd = Symbol.for("木易");
console.log(Symbol.keyFor(hd)); //木易

let edu = Symbol("houdunren");
console.log(Symbol.keyFor(edu)); //undefined

对象属性

Symbol 是独一无二的所以可以保证对象属性的唯一。

  • Symbol 声明和访问使用 [](变量)形式操作
  • 也不能使用 . 语法因为 .语法是操作字符串属性的。

下面写法是错误的,会将symbol 当成字符串symbol处理

let symbol = Symbol("木易");
let obj = {
  symbol: "boreas"
};
console.log(obj);

正确写法是以[] 变量形式声明和访问

let symbol = Symbol("木易");
let obj = {
  [symbol]: "object"
};
console.log(obj[symbol]); //object

实例操作

缓存操作

使用Symbol可以解决在保存数据时由于名称相同造成的耦合覆盖问题。

class Cache {
  static data = {};
  static set(name, value) {
    this.data[name] = value;
  }
  static get(name) {
    return this.data[name];
  }
}

let user = {
  name: "木易",
  key: Symbol("缓存")
};

let cart = {
  name: "购物车",
  key: Symbol("购物车")
};

Cache.set(user.key, user);
Cache.set(cart.key, cart);
console.log(Cache.get(user.key));

遍历属性

Symbol 不能使用 for/infor/of 遍历操作

let symbol = Symbol("木易");
let obj = {
  name: "boreas",
  [symbol]: "object"
};

for (const key in obj) {
  console.log(key); //name
}

for (const key of Object.keys(obj)) {
  console.log(key); //name
}

可以使用 Object.getOwnPropertySymbols 获取所有Symbol属性

...
for (const key of Object.getOwnPropertySymbols(obj)) {
  console.log(key);
}

也可以使用 Reflect.ownKeys(obj) 获取所有属性包括Symbol

...
for (const key of Reflect.ownKeys(obj)) {
  console.log(key);
}
...

如果对象属性不想被遍历,可以使用Symbol保护

const site = Symbol("网站名称");
class User {
  constructor(name) {
    this[site] = "木易";
    this.name = name;
  }
  getName() {
    return `${this[site]}-${this.name}`;
  }
}
const hd = new User("XJ大叔");
console.log(hd.getName());
for (const key in hd) {
  console.log(key);
}