ES6笔记 --- Reflect

概述

(1) 将 Object 对象的一些内部的方法（比如 Object.defineProperty ），放到 Reflect 对象上。

现阶段，某些方法同时在 Object 和 Reflect 对象上部署，未来的新方法将只部署在 Reflect 对象上。也就是说，从Reflect对象上可以拿到语言内部的方法。

(2) 修改某些 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
}
复制代码

(3) 让 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
复制代码

(4) 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
  }
})
复制代码

上面代码中，Proxy方法拦截target对象的属性赋值行为。它采用Reflect.set方法将值赋值给对象的属性，确保完成原有的行为，然后再部署额外的功能。

(5) 有了 Reflect 对象以后，很多操作会更易读。

// 老写法
Function.prototype.apply.call(Math.floor, undefined, [1.75]) // 1

// 新写法
Reflect.apply(Math.floor, undefined, [1.75]) // 1
复制代码

静态方法

Reflect对象一共有 13 个静态方法。

• Reflect.get(target, name, receiver)
• Reflect.set(target, name, value, receiver)
• Reflect.has(target, name)
• Reflect.deleteProperty(target, name)
• Reflect.construct(target, args)
• Reflect.getPrototypeOf(target)
• Reflect.setPrototypeOf(target, prototype)
• Reflect.apply(target, thisArg, args)
• Reflect.defineProperty(target, name, desc)
• Reflect.getOwnPropertyDescriptor(target, name)
• Reflect.isExtensible(target)
• Reflect.preventExtensions(target)
• Reflect.ownKeys(target)

上面这些方法的作用，大部分与Object对象的同名方法的作用都是相同的，而且它与Proxy对象的方法是一一对应的。下面是对它们的解释。

静态方法解析

Reflect.get(target, name, receiver)

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

const obj = {
  foo: 1,
  bar: 2,
  get baz() {
    return this.foo + this.bar;
  }
}
console.log(Reflect.get(obj, 'foo'))  // 1
console.log(Reflect.get(obj, 'bar')) // 2
console.log(Reflect.get(obj, 'baz')) // 3
复制代码

如果 name 属性部署了读取函数（getter），则读取函数的 this 绑定 receiver。

const myObject = {
  foo: 1,
  bar: 2,
  get baz() {
    return this.foo + this.bar;
  },
};

const myReceiverObject = {
  foo: 4,
  bar: 4,
};

Reflect.get(myObject, 'baz', myReceiverObject) // 8
复制代码

如果第一个参数不是对象，Reflect.get方法会报错。

Reflect.get(1, 'foo') // 报错
Reflect.get(false, 'foo') // 报错
复制代码

Reflect.set(target, name, value, receiver)

Reflect.set方法设置target对象的name属性等于value。

const myObject = {
  foo: 1,
  set bar(value) {
    return this.foo = value
  },
}

myObject.foo // 1

Reflect.set(myObject, 'foo', 2)
myObject.foo // 2

Reflect.set(myObject, 'bar', 3)
myObject.foo // 3
复制代码

如果name属性设置了赋值函数，则赋值函数的this绑定receiver。

const myObject = {
  foo: 4,
  set bar(value) {
    return this.foo = value
  },
};

const myReceiverObject = {
  foo: 0,
};

Reflect.set(myObject, 'bar', 1, myReceiverObject)
myObject.foo // 4
myReceiverObject.foo // 1
// myObject 中的 foo 属性不变，改变的是 myReceiverObject 中的 foo 属性
复制代码

注意，如果 Proxy对象和 Reflect对象联合使用，前者拦截赋值操作，后者完成赋值的默认行为，而且传入了receiver，那么Reflect.set会触发Proxy.defineProperty拦截。

let p = {
  a: 'a'
}

let handler = {
  set(target, key, value, receiver) {
    console.log('set')
    Reflect.set(target, key, value, receiver)
  },
  defineProperty(target, key, attribute) {
    console.log('defineProperty')
    Reflect.defineProperty(target, key, attribute)
  }
}

let obj = new Proxy(p, handler)
obj.a = 'A'
// set
// defineProperty
复制代码

上面代码中，Proxy.set 拦截里面使用了 Reflect.set， 而且传入了 receiver，导致触发 Proxy.defineProperty 拦截。这是因为 Proxy.set 的 receiver 参数总是指向当前的 Proxy实例（即上例的obj），而Reflect.set一旦传入receiver，就会将属性赋值到receiver上面（即obj），导致触发defineProperty拦截。如果Reflect.set没有传入receiver，那么就不会触发defineProperty拦截。

let p = {
  a: 'a'
};

let handler = {
  set(target, key, value, receiver) {
    console.log('set')
    Reflect.set(target, key, value)
  },
  defineProperty(target, key, attribute) {
    console.log('defineProperty')
    Reflect.defineProperty(target, key, attribute)
  }
}

let obj = new Proxy(p, handler)
obj.a = 'A'
// set
复制代码

如果第一个参数不是对象，Reflect.set会报错。

Reflect.set(1, 'foo', {}) // 报错
Reflect.set(false, 'foo', {}) // 报错
复制代码

Reflect.has(target, name)

Reflect.has方法对应name in obj里面的in运算符。

(1) Reflect.has 和 in 运算符作用一样，如果指定的属性在指定的对象或其 原型链 中，则返回 true
(2) 使用 delete 运算符删除了一个属性，则对所删除属性返回 false
(3) 将一个属性的值赋值为 undefined，而没有删除它，则仍然会返回 true

const myObject = {
  foo: 1,
};

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

// 新写法
Reflect.has(myObject, 'foo') // true
复制代码

如果Reflect.has()方法的第一个参数不是对象，会报错。

Reflect.deleteProperty(target, name)

Reflect.deleteProperty方法等同于delete obj[name]，用于删除对象的属性。

const myObj = { foo: 'bar' }

// 旧写法
delete myObj.foo

// 新写法
Reflect.deleteProperty(myObj, 'foo')
复制代码

该方法返回一个布尔值。如果删除成功，或者被删除的属性不存在，返回true；删除失败，被删除的属性依然存在，返回false。

如果Reflect.deleteProperty()方法的第一个参数不是对象，会报错。

Reflect.construct(target, args)

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

function Greeting(name) {
  this.name = name
}

// new 的写法
const instance = new Greeting('张三')

// Reflect.construct 的写法
const instance = Reflect.construct(Greeting, ['张三'])
复制代码

如果Reflect.construct()方法的第一个参数不是函数，会报错。

Reflect.getPrototypeOf(target)

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

const myObj = new FancyThing()

// 旧写法
Object.getPrototypeOf(myObj) === FancyThing.prototype // true

// 新写法
Reflect.getPrototypeOf(myObj) === FancyThing.prototype // true
复制代码

Reflect.getPrototypeOf和Object.getPrototypeOf的区别

如果参数不是对象，Object.getPrototypeOf会将这个参数转为对象，然后再运行，而Reflect.getPrototypeOf会报错

Object.getPrototypeOf(1) // Number {[[PrimitiveValue]]: 0}
Reflect.getPrototypeOf(1) // 报错
复制代码

Reflect.setPrototypeOf(target, prototype)

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

const myObj = {}

// 旧写法
Object.setPrototypeOf(myObj, Array.prototype)

// 新写法
Reflect.setPrototypeOf(myObj, Array.prototype)

myObj.length // 0
复制代码

如果无法设置目标对象的原型（比如，目标对象禁止扩展），Reflect.setPrototypeOf方法返回false

// 可扩展
Reflect.setPrototypeOf({}, null) // true

// 目标对象被冻结
Reflect.setPrototypeOf(Object.freeze({}), null) // false
复制代码

如果第一个参数不是对象，Object.setPrototypeOf会返回第一个参数，而Reflect.setPrototypeOf会报错

Object.setPrototypeOf(1, {}) // 1

Reflect.setPrototypeOf(1, {}) // TypeError: Reflect.setPrototypeOf called on non-object
复制代码

如果第一个参数是undefined或null，Object.setPrototypeOf和Reflect.setPrototypeOf都会报错

Object.setPrototypeOf(null, {}) 
// TypeError: Object.setPrototypeOf called on null or undefined

Reflect.setPrototypeOf(null, {}) 
// TypeError: Reflect.setPrototypeOf called on non-object
复制代码

Reflect.apply(target, thisArg, args)

• 参数
  • target：要执行的函数
  • thisArg：this 指向
  • 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对象可以简化这种操作。

const ages = [11, 33, 12, 54, 18, 96]

// 旧写法
const youngest = Math.min.apply(Math, ages)
const oldest = Math.max.apply(Math, ages)
const type = Object.prototype.toString.call(youngest)

// 新写法
const youngest = Reflect.apply(Math.min, Math, ages)
const oldest = Reflect.apply(Math.max, Math, ages)
const type = Reflect.apply(Object.prototype.toString, youngest, [])
复制代码

Reflect.defineProperty(target, name, desc)

Reflect.defineProperty方法基本等同于Object.defineProperty，用来为对象定义属性。

未来，Object.defineProperty会被逐渐废除，请从现在开始就使用Reflect.defineProperty代替它

function MyDate() {
 // ...
}

// 旧写法
Object.defineProperty(MyDate, 'now', {
  value: () => Date.now()
})

// 新写法
Reflect.defineProperty(MyDate, 'now', {
  value: () => Date.now()
})
复制代码

如果Reflect.defineProperty的第一个参数不是对象，就会抛出错误，比如Reflect.defineProperty(1, 'foo')

这个方法可以与Proxy.defineProperty配合使用

const p = new Proxy({}, {
  defineProperty(target, prop, descriptor) {
    console.log(descriptor)
    return Reflect.defineProperty(target, prop, descriptor)
  }
})

p.foo = 'bar'
// {value: "bar", writable: true, enumerable: true, configurable: true}

p.foo // "bar"
复制代码

上面代码中，Proxy.defineProperty对属性赋值设置了拦截，然后使用Reflect.defineProperty完成了赋值

Reflect.getOwnPropertyDescriptor(target, name)

Reflect.getOwnPropertyDescriptor基本等同于Object.getOwnPropertyDescriptor，用于得到指定属性的描述对象，将来会替代掉Object.getOwnPropertyDescriptor

const myObject = {}
Object.defineProperty(myObject, 'hidden', {
  value: true,
  enumerable: false,
})

// 旧写法
const theDescriptor = Object.getOwnPropertyDescriptor(myObject, 'hidden')

// 新写法
const theDescriptor = Reflect.getOwnPropertyDescriptor(myObject, 'hidden')
复制代码

Reflect.getOwnPropertyDescriptor和Object.getOwnPropertyDescriptor的区别

如果第一个参数不是对象，Object.getOwnPropertyDescriptor(1, 'foo')不报错，返回undefined，而Reflect.getOwnPropertyDescriptor(1, 'foo')会抛出错误，表示参数非法

Reflect.isExtensible(target)

Reflect.isExtensible方法对应Object.isExtensible，返回一个布尔值，表示当前对象是否可扩展

const myObject = {}

// 旧写法
Object.isExtensible(myObject) // true

// 新写法
Reflect.isExtensible(myObject) // true
复制代码

如果参数不是对象，Object.isExtensible会返回false，因为非对象本来就是不可扩展的，而Reflect.isExtensible会报错

Object.isExtensible(1) // false
Reflect.isExtensible(1) // 报错
复制代码

Reflect.preventExtensions(target)

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

const myObject = {}

// 旧写法
Object.preventExtensions(myObject) // Object {}

// 新写法
Reflect.preventExtensions(myObject) // true
复制代码

如果参数不是对象，Object.preventExtensions在 ES5 环境报错，在 ES6 环境返回传入的参数，而Reflect.preventExtensions会报错

// ES5 环境
Object.preventExtensions(1) // 报错

// ES6 环境
Object.preventExtensions(1) // 1

// 新写法
Reflect.preventExtensions(1) // 报错
复制代码

Reflect.ownKeys(target)

Reflect.ownKeys方法用于返回对象的所有属性，基本等同于Object.getOwnPropertyNames与Object.getOwnPropertySymbols之和

不会返回原型链上的属性

const 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.ownKeys()方法的第一个参数不是对象，会报错