# 10. Symbol、Proxy、Reflect

# Symbol

ES6引入了一种新的原始数据类型Symbl,表示独一无二的值。

  • 其他6种数据类型:undefined、null、boolean、string、number、object
  • Symbol函数不能使用new命令。Symbol值通过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)"

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

s1 === s2 // false

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

s1 === s2 // false

// Symbol可以转换为Boolean值
let sym = Symbol();
Boolean(sym) // true
!sym  // false

if (sym) {
  // ...
}

# Symbol.prototype.description

let s2 = Symbol('foo')
s2.toString() // "Symbol(foo)"
s2.description // "foo"

# 作为属性名的 Symbol

let mySymbol = Symbol();

// 第一种写法
let a = {};
a[mySymbol] = 'Hello!';

// 第二种写法
let a = {
  [mySymbol]: 'Hello!'
};

// 第三种写法
let a = {};
Object.defineProperty(a, mySymbol, { value: 'Hello!' });

// 以上写法都得到同样结果
a[mySymbol] // "Hello!"

# 不能使用.运算符

注意,Symbol 值作为对象属性名时,不能用点运算符。

const mySymbol = Symbol();
const a = {};

a.mySymbol = 'Hello!';
a[mySymbol] // undefined
a['mySymbol'] // "Hello!"

//  Symbol值不能与其他类型的值运算,会报错
s2 + 'abc' // Uncaught TypeError: Cannot convert a Symbol value to a string

# 可以用于定义常量

// 示例1:
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');

// 示例2:
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');
    }
}

# 实例:消除魔术字符串

魔术字符串指的是,在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。风格良好的代码,应该尽量消除魔术字符串,改由含义清晰的变量代替。

function getArea(shape, options) {
  let area = 0;

  switch (shape) {
    case 'Triangle': // 魔术字符串
      area = .5 * options.width * options.height;
      break;
    /* ... more code ... */
  }

  return area;
}

getArea('Triangle', { width: 100, height: 100 }); // 魔术字符串


// 优化 
const shapeType = {
  triangle: Symbol()
};

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 });

# 属性名的遍历

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

let sym = Symbol('foo')
let obj = {a: 1, b:2, [sym]: 3}

Object.getOwnPropertyNames() // ["a", "b"]
Object.getOwnPropertySymbols(obj) // [Symbol(foo)]

// Reflect.ownKeys() 返回一个数组,包含对象自身的所有键名,不管键名是 Symbol 或字符串,也不管是否可枚举。
Reflect.ownKeys(obj) // ['a', 'b', Symbol(aaa)]

# Symbol.for(),Symbol.keyFor()

  • Symbol.for(value) 如果有,就返回这个 Symbol 值,否则就新建并返回一个以该字符串为名称的 Symbol 值。
  • Symbol.keyFor()方法返回一个已登记的 Symbol 类型值的key。
let s1 = Symbol.for('foo');
let s2 = Symbol.for('foo');

s1 === s2 // true

Symbol.for("bar") === Symbol.for("bar")
// true

Symbol("bar") === Symbol("bar")
// false

let s1 = Symbol.for("foo");
Symbol.keyFor(s1) // "foo"

let s2 = Symbol("foo");
Symbol.keyFor(s2) // undefined

# 内置的 Symbol 值

ES6提供了11个内置的Symbol值,指向语言内部使用的方法

# Symbol.hasInstance属性

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

// foo instanceof Foo在语言内部,实际调用的是Foo[Symbol.hasInstance](foo)。
class MyClass {
  [Symbol.hasInstance](foo) {
    return foo instanceof Array;
  }
}

[1, 2, 3] instanceof new MyClass() // true

# Symbol.iterator属性

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

const myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

[...myIterable] // [1, 2, 3]

对象进行for...of循环时,会调用Symbol.iterator方法,返回该对象的默认遍历器,详细介绍参见《Iterator 和 for...of 循环》一章。

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

let myCollection = new Collection();
myCollection[0] = 1;
myCollection[1] = 2;

for(let value of myCollection) {
  console.log(value);
}
// 1
// 2

# Proxy

Proxy(代理、委托) 与 Reflect 是 ES6 为了操作对象引入的 API 。参考: https://www.runoob.com/w3cnote/es6-reflect-proxy.html Proxy 可以对目标对象的读取、函数调用等操作进行拦截,然后进行操作处理。它不直接操作对象,而是像代理模式,通过对象的代理对象进行操作,在进行这些操作时,可以添加一些需要的额外操作。

# 拦截set和get方法

// 拦截对象的set/get方法
let target = {
    name: 'tom',
    age: 20
}
let handle = {
    get: (target, key, reciver) => {   // reciver 代表 proxy本身
        console.log(`getting ${key}`)
        return target[key]   // 等价于 return Reflect.get(target, key, receiver)
    },
    set: (target, key, value, reciver ) => {
        console.log(`settting ${key}`)
        target[key] = value // 等价于 return Reflect.set(target, key, value, receiver)
    }
}
let proxy = new Proxy(target, handle)
proxy.name
proxy.age = 12
// getting name
// settting age
// 12
// 操作未知的属性
proxy.kk = 1 // 这样会为target对象增加一个kk属性。
proxy.kkk  // undefined

var proxy = new Proxy({}, {
  get: function(target, property) {
    return 35;
  }
});

proxy.time // 35
proxy.name // 35
proxy.title // 35

# 拦截函数调用(apply)

function sub(a, b) {
    return a - b
} 
let proxy = new Proxy(sub, {
    apply: function(target, ctx, args) {
        console.log('handle apply')
        return Reflect.apply(...arguments)
    }
})
proxy(2,1)
// handle apply 
// 1

# 拦截hasProperty(has)

// 拦截hasProperty操作
let exam = new Proxy({name: 'tom'}, {
    has: function(target, key) {
        console.log('handler has')
        return key in target
    }
})
'name' in exam
// handler has
// true

# 拦截new命令(construct)

class T {
    constructor(name) {
        this.name = name
    }
}
let proxy2 = new Proxy(T, {
    construct: function (target, args, newTarget) {
        console.log('handle construct')
        return Reflect.construct(target, args, newTarget)
    }
})
new proxy2('tom')
// handle construct
// T {name: "tom"}

这里只介绍部分拦截,更多细节,请参考:http://es6.ruanyifeng.com/#docs/proxy

# Reflect

Reflect对象与Proxy对象一样,也是 ES6 为了操作对象而提供的新 API。Reflect对象的设计目的有这样几个:

  • 将Object对象的一些明显属于语言内部的方法(比如Object.defineProperty),放到Reflect对象上。
  • 修改某些Object方法的返回结果,让其变得更合理。比如,Object.defineProperty(obj, name, desc)在无法定义属性时,会抛出一个错误,而Reflect.defineProperty(obj, name, desc)则会返回false。
// 老写法
try {
  Object.defineProperty(target, property, attributes);
  // success
} catch (e) {
  // failure
}

// 新写法
if (Reflect.defineProperty(target, property, attributes)) {
  // success
} else {
  // failure
}
  • 让Object操作都变成函数行为。某些Object操作是命令式,比如name in obj和delete obj[name],而Reflect.has(obj, name)和Reflect.deleteProperty(obj, name)让它们变成了函数行为。
// 老写法
'assign' in Object // true

// 新写法
Reflect.has(Object, 'assign') // true
  • Reflect对象的方法与Proxy对象的方法一一对应,只要是Proxy对象的方法,就能在Reflect对象上找到对应的方法。这就让Proxy对象可以方便地调用对应的Reflect方法,完成默认行为,作为修改行为的基础。也就是说,不管Proxy怎么修改默认行为,你总可以在Reflect上获取默认行为。
Proxy(target, {
  set: function(target, name, value, receiver) {
    var success = Reflect.set(target, name, value, receiver);
    if (success) {
      console.log('property ' + name + ' on ' + target + ' set to ' + value);
    }
    return success;
  }
});

# 静态方法

Reflect对象一共有 13 个静态方法。这些方法的作用,大部分与Object对象的同名方法的作用都是相同的,而且它与Proxy对象的方法是一一对应的。

  • Reflect.apply(target, thisArg, args) Reflect.apply方法等同于Function.prototype.apply.call(func, thisArg, args),用于绑定this对象后执行给定函数。 一般来说,如果要绑定一个函数的this对象,可以这样写fn.apply(obj, args),但是如果函数定义了自己的apply方法,就只能写成Function.prototype.apply.call(fn, obj, args),采用Reflect对象可以简化这种操作。

  • Reflect.construct(target, args) Reflect.construct方法等同于new target(...args),这提供了一种不使用new,来调用构造函数的方法。

  • Reflect.get(target, name, receiver) Reflect.get方法查找并返回target对象的name属性,如果没有该属性,则返回undefined。

  • Reflect.set(target, name, value, receiver) Reflect.set方法设置target对象的name属性等于value。

  • Reflect.defineProperty(target, name, desc) Reflect.defineProperty方法基本等同于Object.defineProperty,用来为对象定义属性。未来,后者会被逐渐废除,请从现在开始就使用Reflect.defineProperty代替它。

  • Reflect.deleteProperty(target, name) Reflect.deleteProperty方法等同于delete obj[name],用于删除对象的属性。

  • Reflect.has(target, name) Reflect.has方法对应name in obj里面的in运算符。

var myObject = {
  foo: 1,
};

// 旧写法
'foo' in myObject // true

// 新写法
Reflect.has(myObject, 'foo') // true
  • Reflect.ownKeys(target) Reflect.ownKeys方法用于返回对象的所有属性,基本等同于Object.getOwnPropertyNames与Object.getOwnPropertySymbols之和。
var myObject = {
  foo: 1,
  bar: 2,
  [Symbol.for('baz')]: 3,
  [Symbol.for('bing')]: 4,};
// 旧写法
Object.getOwnPropertyNames(myObject)
// ['foo', 'bar']
Object.getOwnPropertySymbols(myObject)
//[Symbol(baz), Symbol(bing)]
// 新写法
Reflect.ownKeys(myObject)
// ['foo', 'bar', Symbol(baz), Symbol(bing)]
  • Reflect.isExtensible(target) Reflect.isExtensible方法对应Object.isExtensible,返回一个布尔值,表示当前对象是否可扩展。

  • Reflect.preventExtensions(target) Reflect.preventExtensions对应Object.preventExtensions方法,用于让一个对象变为不可扩展。它返回一个布尔值,表示是否操作成功。

  • Reflect.getOwnPropertyDescriptor(target, name) Reflect.getOwnPropertyDescriptor基本等同于Object.getOwnPropertyDescriptor,用于得到指定属性的描述对象,将来会替代掉后者。

  • Reflect.getPrototypeOf(target) Reflect.getPrototypeOf方法用于读取对象的__proto__属性,对应Object.getPrototypeOf(obj)。

  • Reflect.setPrototypeOf(target, prototype) Reflect.setPrototypeOf方法用于设置目标对象的原型(prototype),对应Object.setPrototypeOf(obj, newProto)方法。它返回一个布尔值,表示是否设置成功。

上次更新: 2020/11/8 下午4:18:47