属性名的遍历

Symbol 作为属性名,遍历对象的时候,该属性不会出现在for...infor...of循环中,也不会被Object.keys()Object.getOwnPropertyNames()JSON.stringify()返回。

但是,它也不是私有属性,有一个Object.getOwnPropertySymbols()方法,可以获取指定对象的所有 Symbol 属性名。该方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。

  1. const obj = {};
  2. let a = Symbol('a');
  3. let b = Symbol('b');
  4. obj[a] = 'Hello';
  5. obj[b] = 'World';
  6. const objectSymbols = Object.getOwnPropertySymbols(obj);
  7. objectSymbols
  8. // [Symbol(a), Symbol(b)]

上面代码是Object.getOwnPropertySymbols()方法的示例,可以获取所有 Symbol 属性名。

下面是另一个例子,Object.getOwnPropertySymbols()方法与for...in循环、Object.getOwnPropertyNames方法进行对比的例子。

  1. const obj = {};
  2. const foo = Symbol('foo');
  3. obj[foo] = 'bar';
  4. for (let i in obj) {
  5. console.log(i); // 无输出
  6. }
  7. Object.getOwnPropertyNames(obj) // []
  8. Object.getOwnPropertySymbols(obj) // [Symbol(foo)]

上面代码中,使用for...in循环和Object.getOwnPropertyNames()方法都得不到 Symbol 键名,需要使用Object.getOwnPropertySymbols()方法。

另一个新的 API,Reflect.ownKeys()方法可以返回所有类型的键名,包括常规键名和 Symbol 键名。

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

由于以 Symbol 值作为键名,不会被常规方法遍历得到。我们可以利用这个特性,为对象定义一些非私有的、但又希望只用于内部的方法。

  1. let size = Symbol('size');
  2. class Collection {
  3. constructor() {
  4. this[size] = 0;
  5. }
  6. add(item) {
  7. this[this[size]] = item;
  8. this[size]++;
  9. }
  10. static sizeOf(instance) {
  11. return instance[size];
  12. }
  13. }
  14. let x = new Collection();
  15. Collection.sizeOf(x) // 0
  16. x.add('foo');
  17. Collection.sizeOf(x) // 1
  18. Object.keys(x) // ['0']
  19. Object.getOwnPropertyNames(x) // ['0']
  20. Object.getOwnPropertySymbols(x) // [Symbol(size)]

上面代码中,对象xsize属性是一个 Symbol 值,所以Object.keys(x)Object.getOwnPropertyNames(x)都无法获取它。这就造成了一种非私有的内部方法的效果。