加载中...

Proxy 和 Reflect


Proxy 概述

Proxy 用于修改某些操作的默认行为,等同于在语言层面做出修改,所以属于一种“元编程”(meta programming),即对编程语言进行编程。

Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。Proxy 这个词的原意是代理,用在这里表示由它来“代理”某些操作,可以译为“代理器”。

  1. var obj = new Proxy({}, {
  2. get: function (target, key, receiver) {
  3. console.log(`getting ${key}!`);
  4. return Reflect.get(target, key, receiver);
  5. },
  6. set: function (target, key, value, receiver) {
  7. console.log(`setting ${key}!`);
  8. return Reflect.set(target, key, value, receiver);
  9. }
  10. });

上面代码对一个空对象架设了一层拦截,重定义了属性的读取(get)和设置(set)行为。这里暂时先不解释具体的语法,只看运行结果。对设置了拦截行为的对象obj,去读写它的属性,就会得到下面的结果。

  1. obj.count = 1
  2. // setting count!
  3. ++obj.count
  4. // getting count!
  5. // setting count!
  6. // 2

上面代码说明,Proxy 实际上重载(overload)了点运算符,即用自己的定义覆盖了语言的原始定义。

ES6 原生提供 Proxy 构造函数,用来生成 Proxy 实例。

  1. var proxy = new Proxy(target, handler);

Proxy 对象的所有用法,都是上面这种形式,不同的只是handler参数的写法。其中,new Proxy()表示生成一个Proxy实例,target参数表示所要拦截的目标对象,handler参数也是一个对象,用来定制拦截行为。

下面是另一个拦截读取属性行为的例子。

  1. var proxy = new Proxy({}, {
  2. get: function(target, property) {
  3. return 35;
  4. }
  5. });
  6. proxy.time // 35
  7. proxy.name // 35
  8. proxy.title // 35

上面代码中,作为构造函数,Proxy接受两个参数。第一个参数是所要代理的目标对象(上例是一个空对象),即如果没有Proxy的介入,操作原来要访问的就是这个对象;第二个参数是一个配置对象,对于每一个被代理的操作,需要提供一个对应的处理函数,该函数将拦截对应的操作。比如,上面代码中,配置对象有一个get方法,用来拦截对目标对象属性的访问请求。get方法的两个参数分别是目标对象和所要访问的属性。可以看到,由于拦截函数总是返回35,所以访问任何属性都得到35

注意,要使得Proxy起作用,必须针对Proxy实例(上例是proxy对象)进行操作,而不是针对目标对象(上例是空对象)进行操作。

如果handler没有设置任何拦截,那就等同于直接通向原对象。

  1. var target = {};
  2. var handler = {};
  3. var proxy = new Proxy(target, handler);
  4. proxy.a = 'b';
  5. target.a // "b"

上面代码中,handler是一个空对象,没有任何拦截效果,访问handler就等同于访问target

一个技巧是将Proxy对象,设置到object.proxy属性,从而可以在object对象上调用。

  1. var object = { proxy: new Proxy(target, handler) };

Proxy 实例也可以作为其他对象的原型对象。

  1. var proxy = new Proxy({}, {
  2. get: function(target, property) {
  3. return 35;
  4. }
  5. });
  6. let obj = Object.create(proxy);
  7. obj.time // 35

上面代码中,proxy对象是obj对象的原型,obj对象本身并没有time属性,所以根据原型链,会在proxy对象上读取该属性,导致被拦截。

同一个拦截器函数,可以设置拦截多个操作。

  1. var handler = {
  2. get: function(target, name) {
  3. if (name === 'prototype') {
  4. return Object.prototype;
  5. }
  6. return 'Hello, ' + name;
  7. },
  8. apply: function(target, thisBinding, args) {
  9. return args[0];
  10. },
  11. construct: function(target, args) {
  12. return {value: args[1]};
  13. }
  14. };
  15. var fproxy = new Proxy(function(x, y) {
  16. return x + y;
  17. }, handler);
  18. fproxy(1, 2) // 1
  19. new fproxy(1,2) // {value: 2}
  20. fproxy.prototype === Object.prototype // true
  21. fproxy.foo // "Hello, foo"

下面是 Proxy 支持的拦截操作一览。

对于可以设置、但没有设置拦截的操作,则直接落在目标对象上,按照原先的方式产生结果。

(1)get(target, propKey, receiver)

拦截对象属性的读取,比如proxy.fooproxy['foo']

最后一个参数receiver是一个对象,可选,参见下面Reflect.get的部分。

(2)set(target, propKey, value, receiver)

拦截对象属性的设置,比如proxy.foo = vproxy['foo'] = v,返回一个布尔值。

(3)has(target, propKey)

拦截propKey in proxy的操作,以及对象的hasOwnProperty方法,返回一个布尔值。

(4)deleteProperty(target, propKey)

拦截delete proxy[propKey]的操作,返回一个布尔值。

(5)ownKeys(target)

拦截Object.getOwnPropertyNames(proxy)Object.getOwnPropertySymbols(proxy)Object.keys(proxy),返回一个数组。该方法返回对象所有自身的属性,而Object.keys()仅返回对象可遍历的属性。

(6)getOwnPropertyDescriptor(target, propKey)

拦截Object.getOwnPropertyDescriptor(proxy, propKey),返回属性的描述对象。

(7)defineProperty(target, propKey, propDesc)

拦截Object.defineProperty(proxy, propKey, propDesc)Object.defineProperties(proxy, propDescs),返回一个布尔值。

(8)preventExtensions(target)

拦截Object.preventExtensions(proxy),返回一个布尔值。

(9)getPrototypeOf(target)

拦截Object.getPrototypeOf(proxy),返回一个对象。

(10)isExtensible(target)

拦截Object.isExtensible(proxy),返回一个布尔值。

(11)setPrototypeOf(target, proto)

拦截Object.setPrototypeOf(proxy, proto),返回一个布尔值。

如果目标对象是函数,那么还有两种额外操作可以拦截。

(12)apply(target, object, args)

拦截 Proxy 实例作为函数调用的操作,比如proxy(...args)proxy.call(object, ...args)proxy.apply(...)

(13)construct(target, args)

拦截 Proxy 实例作为构造函数调用的操作,比如new proxy(...args)

Proxy实例的方法

下面是上面这些拦截方法的详细介绍。

get()

get方法用于拦截某个属性的读取操作。上文已经有一个例子,下面是另一个拦截读取操作的例子。

  1. var person = {
  2. name: "张三"
  3. };
  4. var proxy = new Proxy(person, {
  5. get: function(target, property) {
  6. if (property in target) {
  7. return target[property];
  8. } else {
  9. throw new ReferenceError("Property \"" + property + "\" does not exist.");
  10. }
  11. }
  12. });
  13. proxy.name // "张三"
  14. proxy.age // 抛出一个错误

上面代码表示,如果访问目标对象不存在的属性,会抛出一个错误。如果没有这个拦截函数,访问不存在的属性,只会返回undefined

get方法可以继承。

  1. let proto = new Proxy({}, {
  2. get(target, propertyKey, receiver) {
  3. console.log('GET '+propertyKey);
  4. return target[propertyKey];
  5. }
  6. });
  7. let obj = Object.create(proto);
  8. obj.xxx // "GET xxx"

上面代码中,拦截操作定义在Prototype对象上面,所以如果读取obj对象继承的属性时,拦截会生效。

下面的例子使用get拦截,实现数组读取负数的索引。

  1. function createArray(...elements) {
  2. let handler = {
  3. get(target, propKey, receiver) {
  4. let index = Number(propKey);
  5. if (index < 0) {
  6. propKey = String(target.length + index);
  7. }
  8. return Reflect.get(target, propKey, receiver);
  9. }
  10. };
  11. let target = [];
  12. target.push(...elements);
  13. return new Proxy(target, handler);
  14. }
  15. let arr = createArray('a', 'b', 'c');
  16. arr[-1] // c

上面代码中,数组的位置参数是-1,就会输出数组的倒数最后一个成员。

利用 Proxy,可以将读取属性的操作(get),转变为执行某个函数,从而实现属性的链式操作。

  1. var pipe = (function () {
  2. return function (value) {
  3. var funcStack = [];
  4. var oproxy = new Proxy({} , {
  5. get : function (pipeObject, fnName) {
  6. if (fnName === 'get') {
  7. return funcStack.reduce(function (val, fn) {
  8. return fn(val);
  9. },value);
  10. }
  11. funcStack.push(window[fnName]);
  12. return oproxy;
  13. }
  14. });
  15. return oproxy;
  16. }
  17. }());
  18. var double = n => n * 2;
  19. var pow = n => n * n;
  20. var reverseInt = n => n.toString().split("").reverse().join("") | 0;
  21. pipe(3).double.pow.reverseInt.get; // 63

上面代码设置 Proxy 以后,达到了将函数名链式使用的效果。

下面的例子则是利用get拦截,实现一个生成各种DOM节点的通用函数dom

  1. const dom = new Proxy({}, {
  2. get(target, property) {
  3. return function(attrs = {}, ...children) {
  4. const el = document.createElement(property);
  5. for (let prop of Object.keys(attrs)) {
  6. el.setAttribute(prop, attrs[prop]);
  7. }
  8. for (let child of children) {
  9. if (typeof child === 'string') {
  10. child = document.createTextNode(child);
  11. }
  12. el.appendChild(child);
  13. }
  14. return el;
  15. }
  16. }
  17. });
  18. const el = dom.div({},
  19. 'Hello, my name is ',
  20. dom.a({href: '//example.com'}, 'Mark'),
  21. '. I like:',
  22. dom.ul({},
  23. dom.li({}, 'The web'),
  24. dom.li({}, 'Food'),
  25. dom.li({}, '…actually that\'s it')
  26. )
  27. );
  28. document.body.appendChild(el);

set()

set方法用来拦截某个属性的赋值操作。

假定Person对象有一个age属性,该属性应该是一个不大于200的整数,那么可以使用Proxy保证age的属性值符合要求。

  1. let validator = {
  2. set: function(obj, prop, value) {
  3. if (prop === 'age') {
  4. if (!Number.isInteger(value)) {
  5. throw new TypeError('The age is not an integer');
  6. }
  7. if (value > 200) {
  8. throw new RangeError('The age seems invalid');
  9. }
  10. }
  11. // 对于age以外的属性,直接保存
  12. obj[prop] = value;
  13. }
  14. };
  15. let person = new Proxy({}, validator);
  16. person.age = 100;
  17. person.age // 100
  18. person.age = 'young' // 报错
  19. person.age = 300 // 报错

上面代码中,由于设置了存值函数set,任何不符合要求的age属性赋值,都会抛出一个错误。利用set方法,还可以数据绑定,即每当对象发生变化时,会自动更新DOM。

有时,我们会在对象上面设置内部属性,属性名的第一个字符使用下划线开头,表示这些属性不应该被外部使用。结合getset方法,就可以做到防止这些内部属性被外部读写。

  1. var handler = {
  2. get (target, key) {
  3. invariant(key, 'get');
  4. return target[key];
  5. },
  6. set (target, key, value) {
  7. invariant(key, 'set');
  8. target[key] = value;
  9. return true;
  10. }
  11. };
  12. function invariant (key, action) {
  13. if (key[0] === '_') {
  14. throw new Error(`Invalid attempt to ${action} private "${key}" property`);
  15. }
  16. }
  17. var target = {};
  18. var proxy = new Proxy(target, handler);
  19. proxy._prop
  20. // Error: Invalid attempt to get private "_prop" property
  21. proxy._prop = 'c'
  22. // Error: Invalid attempt to set private "_prop" property

上面代码中,只要读写的属性名的第一个字符是下划线,一律抛错,从而达到禁止读写内部属性的目的。

apply()

apply方法拦截函数的调用、call和apply操作。

  1. var handler = {
  2. apply (target, ctx, args) {
  3. return Reflect.apply(...arguments);
  4. }
  5. };

apply方法可以接受三个参数,分别是目标对象、目标对象的上下文对象(this)和目标对象的参数数组。

下面是一个例子。

  1. var target = function () { return 'I am the target'; };
  2. var handler = {
  3. apply: function () {
  4. return 'I am the proxy';
  5. }
  6. };
  7. var p = new Proxy(target, handler);
  8. p()
  9. // "I am the proxy"

上面代码中,变量p是Proxy的实例,当它作为函数调用时(p()),就会被apply方法拦截,返回一个字符串。

下面是另外一个例子。

  1. var twice = {
  2. apply (target, ctx, args) {
  3. return Reflect.apply(...arguments) * 2;
  4. }
  5. };
  6. function sum (left, right) {
  7. return left + right;
  8. };
  9. var proxy = new Proxy(sum, twice);
  10. proxy(1, 2) // 6
  11. proxy.call(null, 5, 6) // 22
  12. proxy.apply(null, [7, 8]) // 30

上面代码中,每当执行proxy函数(直接调用或callapply调用),就会被apply方法拦截。

另外,直接调用Reflect.apply方法,也会被拦截。

  1. Reflect.apply(proxy, null, [9, 10]) // 38

has()

has方法用来拦截HasProperty操作,即判断对象是否具有某个属性时,这个方法会生效。典型的操作就是in运算符。

下面的例子使用has方法隐藏某些属性,不被in运算符发现。

  1. var handler = {
  2. has (target, key) {
  3. if (key[0] === '_') {
  4. return false;
  5. }
  6. return key in target;
  7. }
  8. };
  9. var target = { _prop: 'foo', prop: 'foo' };
  10. var proxy = new Proxy(target, handler);
  11. '_prop' in proxy // false

上面代码中,如果原对象的属性名的第一个字符是下划线,proxy.has就会返回false,从而不会被in运算符发现。

如果原对象不可配置或者禁止扩展,这时has拦截会报错。

  1. var obj = { a: 10 };
  2. Object.preventExtensions(obj);
  3. var p = new Proxy(obj, {
  4. has: function(target, prop) {
  5. return false;
  6. }
  7. });
  8. 'a' in p // TypeError is thrown

上面代码中,obj对象禁止扩展,结果使用has拦截就会报错。

值得注意的是,has方法拦截的是HasProperty操作,而不是HasOwnProperty操作,即has方法不判断一个属性是对象自身的属性,还是继承的属性。

另外,虽然for...in循环也用到了in运算符,但是has拦截对for...in循环不生效。

  1. let stu1 = {name: '张三', score: 59};
  2. let stu2 = {name: '李四', score: 99};
  3. let handler = {
  4. has(target, prop) {
  5. if (prop === 'score' && target[prop] < 60) {
  6. console.log(`${target.name} 不及格`);
  7. return false;
  8. }
  9. return prop in target;
  10. }
  11. }
  12. let oproxy1 = new Proxy(stu1, handler);
  13. let oproxy2 = new Proxy(stu2, handler);
  14. 'score' in oproxy1
  15. // 张三 不及格
  16. // false
  17. 'score' in oproxy2
  18. // true
  19. for (let a in oproxy1) {
  20. console.log(oproxy1[a]);
  21. }
  22. // 张三
  23. // 59
  24. for (let b in oproxy2) {
  25. console.log(oproxy2[b]);
  26. }
  27. // 李四
  28. // 99

上面代码中,has拦截只对in循环生效,对for...in循环不生效,导致不符合要求的属性没有被排除在for...in循环之外。

construct()

construct方法用于拦截new命令,下面是拦截对象的写法。

  1. var handler = {
  2. construct (target, args, newTarget) {
  3. return new target(...args);
  4. }
  5. };

construct方法可以接受两个参数。

  • target: 目标对象
  • args:构建函数的参数对象

下面是一个例子。

  1. var p = new Proxy(function() {}, {
  2. construct: function(target, args) {
  3. console.log('called: ' + args.join(', '));
  4. return { value: args[0] * 10 };
  5. }
  6. });
  7. new p(1).value
  8. // "called: 1"
  9. // 10

construct方法返回的必须是一个对象,否则会报错。

  1. var p = new Proxy(function() {}, {
  2. construct: function(target, argumentsList) {
  3. return 1;
  4. }
  5. });
  6. new p() // 报错

deleteProperty()

deleteProperty方法用于拦截delete操作,如果这个方法抛出错误或者返回false,当前属性就无法被delete命令删除。

  1. var handler = {
  2. deleteProperty (target, key) {
  3. invariant(key, 'delete');
  4. return true;
  5. }
  6. };
  7. function invariant (key, action) {
  8. if (key[0] === '_') {
  9. throw new Error(`Invalid attempt to ${action} private "${key}" property`);
  10. }
  11. }
  12. var target = { _prop: 'foo' };
  13. var proxy = new Proxy(target, handler);
  14. delete proxy._prop
  15. // Error: Invalid attempt to delete private "_prop" property

上面代码中,deleteProperty方法拦截了delete操作符,删除第一个字符为下划线的属性会报错。

defineProperty()

defineProperty方法拦截了Object.defineProperty操作。

  1. var handler = {
  2. defineProperty (target, key, descriptor) {
  3. return false;
  4. }
  5. };
  6. var target = {};
  7. var proxy = new Proxy(target, handler);
  8. proxy.foo = 'bar'
  9. // TypeError: proxy defineProperty handler returned false for property '"foo"'

上面代码中,defineProperty方法返回false,导致添加新属性会抛出错误。

getOwnPropertyDescriptor()

getOwnPropertyDescriptor方法拦截Object.getOwnPropertyDescriptor,返回一个属性描述对象或者undefined

  1. var handler = {
  2. getOwnPropertyDescriptor (target, key) {
  3. if (key[0] === '_') {
  4. return;
  5. }
  6. return Object.getOwnPropertyDescriptor(target, key);
  7. }
  8. };
  9. var target = { _foo: 'bar', baz: 'tar' };
  10. var proxy = new Proxy(target, handler);
  11. Object.getOwnPropertyDescriptor(proxy, 'wat')
  12. // undefined
  13. Object.getOwnPropertyDescriptor(proxy, '_foo')
  14. // undefined
  15. Object.getOwnPropertyDescriptor(proxy, 'baz')
  16. // { value: 'tar', writable: true, enumerable: true, configurable: true }

上面代码中,handler.getOwnPropertyDescriptor方法对于第一个字符为下划线的属性名会返回undefined

getPrototypeOf()

getPrototypeOf方法主要用来拦截Object.getPrototypeOf()运算符,以及其他一些操作。

  • Object.prototype.__proto__
  • Object.prototype.isPrototypeOf()
  • Object.getPrototypeOf()
  • Reflect.getPrototypeOf()
  • instanceof运算符

下面是一个例子。

  1. var proto = {};
  2. var p = new Proxy({}, {
  3. getPrototypeOf(target) {
  4. return proto;
  5. }
  6. });
  7. Object.getPrototypeOf(p) === proto // true

上面代码中,getPrototypeOf方法拦截Object.getPrototypeOf(),返回proto对象。

isExtensible()

isExtensible方法拦截Object.isExtensible操作。

  1. var p = new Proxy({}, {
  2. isExtensible: function(target) {
  3. console.log("called");
  4. return true;
  5. }
  6. });
  7. Object.isExtensible(p)
  8. // "called"
  9. // true

上面代码设置了isExtensible方法,在调用Object.isExtensible时会输出called

这个方法有一个强限制,如果不能满足下面的条件,就会抛出错误。

  1. Object.isExtensible(proxy) === Object.isExtensible(target)

下面是一个例子。

  1. var p = new Proxy({}, {
  2. isExtensible: function(target) {
  3. return false;
  4. }
  5. });
  6. Object.isExtensible(p) // 报错

ownKeys()

ownKeys方法用来拦截Object.keys()操作。

  1. let target = {};
  2. let handler = {
  3. ownKeys(target) {
  4. return ['hello', 'world'];
  5. }
  6. };
  7. let proxy = new Proxy(target, handler);
  8. Object.keys(proxy)
  9. // [ 'hello', 'world' ]

上面代码拦截了对于target对象的Object.keys()操作,返回预先设定的数组。

下面的例子是拦截第一个字符为下划线的属性名。

  1. let target = {
  2. _bar: 'foo',
  3. _prop: 'bar',
  4. prop: 'baz'
  5. };
  6. let handler = {
  7. ownKeys (target) {
  8. return Reflect.ownKeys(target).filter(key => key[0] !== '_');
  9. }
  10. };
  11. let proxy = new Proxy(target, handler);
  12. for (let key of Object.keys(proxy)) {
  13. console.log(target[key]);
  14. }
  15. // "baz"

preventExtensions()

preventExtensions方法拦截Object.preventExtensions()。该方法必须返回一个布尔值。

这个方法有一个限制,只有当Object.isExtensible(proxy)false(即不可扩展)时,proxy.preventExtensions才能返回true,否则会报错。

  1. var p = new Proxy({}, {
  2. preventExtensions: function(target) {
  3. return true;
  4. }
  5. });
  6. Object.preventExtensions(p) // 报错

上面代码中,proxy.preventExtensions方法返回true,但这时Object.isExtensible(proxy)会返回true,因此报错。

为了防止出现这个问题,通常要在proxy.preventExtensions方法里面,调用一次Object.preventExtensions

  1. var p = new Proxy({}, {
  2. preventExtensions: function(target) {
  3. console.log("called");
  4. Object.preventExtensions(target);
  5. return true;
  6. }
  7. });
  8. Object.preventExtensions(p)
  9. // "called"
  10. // true

setPrototypeOf()

setPrototypeOf方法主要用来拦截Object.setPrototypeOf方法。

下面是一个例子。

  1. var handler = {
  2. setPrototypeOf (target, proto) {
  3. throw new Error('Changing the prototype is forbidden');
  4. }
  5. };
  6. var proto = {};
  7. var target = function () {};
  8. var proxy = new Proxy(target, handler);
  9. proxy.setPrototypeOf(proxy, proto);
  10. // Error: Changing the prototype is forbidden

上面代码中,只要修改target的原型对象,就会报错。

Proxy.revocable()

Proxy.revocable方法返回一个可取消的Proxy实例。

  1. let target = {};
  2. let handler = {};
  3. let {proxy, revoke} = Proxy.revocable(target, handler);
  4. proxy.foo = 123;
  5. proxy.foo // 123
  6. revoke();
  7. proxy.foo // TypeError: Revoked

Proxy.revocable方法返回一个对象,该对象的proxy属性是Proxy实例,revoke属性是一个函数,可以取消Proxy实例。上面代码中,当执行revoke函数之后,再访问Proxy实例,就会抛出一个错误。

this 问题

虽然 Proxy 可以代理针对目标对象的访问,但它不是目标对象的透明代理,即不做任何拦截的情况下,也无法保证与目标对象的行为一致。主要原因就是在 Proxy 代理的情况下,目标对象内部的this关键字会指向 Proxy 代理。

  1. const target = {
  2. m: function () {
  3. console.log(this === proxy);
  4. }
  5. };
  6. const handler = {};
  7. const proxy = new Proxy(target, handler);
  8. target.m() // false
  9. proxy.m() // true

上面代码中,一旦proxy代理target.m,后者内部的this就是指向proxy,而不是target

下面是一个例子,由于this指向的变化,导致 Proxy 无法代理目标对象。

  1. const _name = new WeakMap();
  2. class Person {
  3. constructor(name) {
  4. _name.set(this, name);
  5. }
  6. get name() {
  7. return _name.get(this);
  8. }
  9. }
  10. const jane = new Person('Jane');
  11. jane.name // 'Jane'
  12. const proxy = new Proxy(jane, {});
  13. proxy.name // undefined

上面代码中,目标对象janename属性,实际保存在外部WeakMap对象_name上面,通过this键区分。由于通过proxy.name访问时,this指向proxy,导致无法取到值,所以返回undefined

此外,有些原生对象的内部属性,只有通过正确的this才能拿到,所以 Proxy 也无法代理这些原生对象的属性。

  1. const target = new Date();
  2. const handler = {};
  3. const proxy = new Proxy(target, handler);
  4. proxy.getDate();
  5. // TypeError: this is not a Date object.

上面代码中,getDate方法只能在Date对象实例上面拿到,如果this不是Date对象实例就会报错。这时,this绑定原始对象,就可以解决这个问题。

  1. const target = new Date('2015-01-01');
  2. const handler = {
  3. get(target, prop) {
  4. if (prop === 'getDate') {
  5. return target.getDate.bind(target);
  6. }
  7. return Reflect.get(target, prop);
  8. }
  9. };
  10. const proxy = new Proxy(target, handler);
  11. proxy.getDate() // 1

Reflect概述

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

(1) 将Object对象的一些明显属于语言内部的方法(比如Object.defineProperty),放到Reflect对象上。现阶段,某些方法同时在ObjectReflect对象上部署,未来的新方法将只部署在Reflect对象上。也就是说,从Reflect对象上可以拿到语言内部的方法。

(2) 修改某些Object方法的返回结果,让其变得更合理。比如,Object.defineProperty(obj, name, desc)在无法定义属性时,会抛出一个错误,而Reflect.defineProperty(obj, name, desc)则会返回false

  1. // 老写法
  2. try {
  3. Object.defineProperty(target, property, attributes);
  4. // success
  5. } catch (e) {
  6. // failure
  7. }
  8. // 新写法
  9. if (Reflect.defineProperty(target, property, attributes)) {
  10. // success
  11. } else {
  12. // failure
  13. }

(3) 让Object操作都变成函数行为。某些Object操作是命令式,比如name in objdelete obj[name],而Reflect.has(obj, name)Reflect.deleteProperty(obj, name)让它们变成了函数行为。

  1. // 老写法
  2. 'assign' in Object // true
  3. // 新写法
  4. Reflect.has(Object, 'assign') // true

(4)Reflect对象的方法与Proxy对象的方法一一对应,只要是Proxy对象的方法,就能在Reflect对象上找到对应的方法。这就让Proxy对象可以方便地调用对应的Reflect方法,完成默认行为,作为修改行为的基础。也就是说,不管Proxy怎么修改默认行为,你总可以在Reflect上获取默认行为。

  1. Proxy(target, {
  2. set: function(target, name, value, receiver) {
  3. var success = Reflect.set(target,name, value, receiver);
  4. if (success) {
  5. log('property ' + name + ' on ' + target + ' set to ' + value);
  6. }
  7. return success;
  8. }
  9. });

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

下面是另一个例子。

  1. var loggedObj = new Proxy(obj, {
  2. get(target, name) {
  3. console.log('get', target, name);
  4. return Reflect.get(target, name);
  5. },
  6. deleteProperty(target, name) {
  7. console.log('delete' + name);
  8. return Reflect.deleteProperty(target, name);
  9. },
  10. has(target, name) {
  11. console.log('has' + name);
  12. return Reflect.has(target, name);
  13. }
  14. });

上面代码中,每一个Proxy对象的拦截操作(getdeletehas),内部都调用对应的Reflect方法,保证原生行为能够正常执行。添加的工作,就是将每一个操作输出一行日志。

有了Reflect对象以后,很多操作会更易读。

  1. // 老写法
  2. Function.prototype.apply.call(Math.floor, undefined, [1.75]) // 1
  3. // 新写法
  4. Reflect.apply(Math.floor, undefined, [1.75]) // 1

Reflect对象的方法

Reflect对象的方法清单如下,共13个。

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

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

(1)Reflect.get(target, name, receiver)

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

  1. var myObject = {
  2. foo: 1,
  3. bar: 2,
  4. get baz() {
  5. return this.foo + this.bar;
  6. },
  7. }
  8. Reflect.get(myObject, 'foo') // 1
  9. Reflect.get(myObject, 'bar') // 2
  10. Reflect.get(myObject, 'baz') // 3

如果name属性部署了读取函数(getter),则读取函数的this绑定receiver

  1. var myObject = {
  2. foo: 1,
  3. bar: 2,
  4. get baz() {
  5. return this.foo + this.bar;
  6. },
  7. };
  8. var myReceiverObject = {
  9. foo: 4,
  10. bar: 4,
  11. };
  12. Reflect.get(myObject, 'baz', myReceiverObject) // 8

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

  1. Reflect.get(1, 'foo') // 报错
  2. Reflect.get(false, 'foo') // 报错

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

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

  1. var myObject = {
  2. foo: 1,
  3. set bar(value) {
  4. return this.foo = value;
  5. },
  6. }
  7. myObject.foo // 1
  8. Reflect.set(myObject, 'foo', 2);
  9. myObject.foo // 2
  10. Reflect.set(myObject, 'bar', 3)
  11. myObject.foo // 3

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

  1. var myObject = {
  2. foo: 4,
  3. set bar(value) {
  4. return this.foo = value;
  5. },
  6. };
  7. var myReceiverObject = {
  8. foo: 0,
  9. };
  10. Reflect.set(myObject, 'bar', 1, myReceiverObject);
  11. myObject.foo // 4
  12. myReceiverObject.foo // 1

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

  1. Reflect.set(1, 'foo', {}) // 报错
  2. Reflect.set(false, 'foo', {}) // 报错

(3)Reflect.has(obj, name)

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

  1. var myObject = {
  2. foo: 1,
  3. };
  4. // 旧写法
  5. 'foo' in myObject // true
  6. // 新写法
  7. Reflect.has(myObject, 'foo') // true

如果第一个参数不是对象,Reflect.hasin运算符都会报错。

(4)Reflect.deleteProperty(obj, name)

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

  1. const myObj = { foo: 'bar' };
  2. // 旧写法
  3. delete myObj.foo;
  4. // 新写法
  5. Reflect.deleteProperty(myObj, 'foo');

(5)Reflect.construct(target, args)

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

  1. function Greeting(name) {
  2. this.name = name;
  3. }
  4. // new 的写法
  5. const instance = new Greeting('张三');
  6. // Reflect.construct 的写法
  7. const instance = Reflect.construct(Greeting, '张三');

(6)Reflect.getPrototypeOf(obj)

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

  1. const myObj = new FancyThing();
  2. // 旧写法
  3. Object.getPrototypeOf(myObj) === FancyThing.prototype;
  4. // 新写法
  5. Reflect.getPrototypeOf(myObj) === FancyThing.prototype;

Reflect.getPrototypeOfObject.getPrototypeOf的一个区别是,如果第一个参数不是对象(包括nullundefined),Object.getPrototypeOf会将这个参数转为对象,然后再运行,而Reflect.getPrototypeOf会报错。

  1. Object.getPrototypeOf(1) // undefined
  2. Reflect.getPrototypeOf(1) // 报错

(7)Reflect.setPrototypeOf(obj, newProto)

Reflect.setPrototypeOf方法用于设置对象的__proto__属性,对应Object.setPrototypeOf(obj, newProto)

  1. const myObj = new FancyThing();
  2. // 旧写法
  3. Object.setPrototypeOf(myObj, OtherThing.prototype);
  4. // 新写法
  5. Reflect.setPrototypeOf(myObj, OtherThing.prototype);

如果第一个参数不是对象,Reflect.setPrototypeOfObject.setPrototypeOf都会报错。

  1. Object.setPrototypeOf(1) // 报错
  2. Reflect.setPrototypeOf(1) // 报错

(8)Reflect.apply(func, 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对象可以简化这种操作。

  1. const ages = [11, 33, 12, 54, 18, 96];
  2. // 旧写法
  3. const youngest = Math.min.apply(Math, ages);
  4. const oldest = Math.max.apply(Math, ages);
  5. const type = Object.prototype.toString.call(youngest);
  6. // 新写法
  7. const youngest = Reflect.apply(Math.min, Math, ages);
  8. const oldest = Reflect.apply(Math.max, Math, ages);
  9. const type = Reflect.apply(Object.prototype.toString, youngest);

(9)Reflect.defineProperty(target, propertyKey, attributes)

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

  1. function MyDate() {
  2. /*…*/
  3. }
  4. // 旧写法
  5. Object.defineProperty(MyDate, 'now', {
  6. value: () => new Date.now()
  7. });
  8. // 新写法
  9. Reflect.defineProperty(MyDate, 'now', {
  10. value: () => new Date.now()
  11. });

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

(10)Reflect.getOwnPropertyDescriptor(target, propertyKey)

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

  1. var myObject = {};
  2. Object.defineProperty(myObject, 'hidden', {
  3. value: true,
  4. enumerable: false,
  5. });
  6. // 旧写法
  7. var theDescriptor = Object.getOwnPropertyDescriptor(myObject, 'hidden');
  8. // 新写法
  9. var theDescriptor = Reflect.getOwnPropertyDescriptor(myObject, 'hidden');

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

(11)Reflect.isExtensible (target)

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

  1. const myObject = {};
  2. // 旧写法
  3. Object.isExtensible(myObject) // true
  4. // 新写法
  5. Reflect.isExtensible(myObject) // true

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

  1. Object.isExtensible(1) // false
  2. Reflect.isExtensible(1) // 报错

(12)Reflect.preventExtensions(target)

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

  1. var myObject = {};
  2. // 旧写法
  3. Object.isExtensible(myObject) // true
  4. // 新写法
  5. Reflect.preventExtensions(myObject) // true

如果参数不是对象,Object.isExtensible在 ES5 环境报错,在 ES6 环境返回这个参数,而Reflect.preventExtensions会报错。

  1. // ES5
  2. Object.preventExtensions(1) // 报错
  3. // ES6
  4. Object.preventExtensions(1) // 1
  5. // 新写法
  6. Reflect.preventExtensions(1) // 报错

(13)Reflect.ownKeys (target)

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

  1. var myObject = {
  2. foo: 1,
  3. bar: 2,
  4. [Symbol.for('baz')]: 3,
  5. [Symbol.for('bing')]: 4,
  6. };
  7. // 旧写法
  8. Object.getOwnPropertyNames(myObject)
  9. // ['foo', 'bar']
  10. Object.getOwnPropertySymbols(myObject)
  11. //[Symbol.for('baz'), Symbol.for('bing')]
  12. // 新写法
  13. Reflect.ownKeys(myObject)
  14. // ['foo', 'bar', Symbol.for('baz'), Symbol.for('bing')]

实例:使用 Proxy 实现观察者模式

观察者模式(Observer mode)指的是函数自动观察数据对象,一旦对象有变化,函数就会自动执行。

  1. const person = observable({
  2. name: '张三',
  3. age: 20
  4. });
  5. function print() {
  6. console.log(`${person.name}, ${person.age}`)
  7. }
  8. observe(print);
  9. person.name = '李四';
  10. // 输出
  11. // 李四, 20

上面代码中,数据对象person是观察目标,函数print是观察者。一旦数据对象发生变化,print就会自动执行。

下面,使用 Proxy 写一个观察者模式的最简单实现,即实现observableobserve这两个函数。思路是observable函数返回一个原始对象的 Proxy 代理,拦截赋值操作,触发充当观察者的各个函数。

  1. const queuedObservers = new Set();
  2. const observe = fn => queuedObservers.add(fn);
  3. const observable = obj => new Proxy(obj, {set});
  4. function set(target, key, value, receiver) {
  5. const result = Reflect.set(target, key, value, receiver);
  6. queuedObservers.forEach(observer => observer());
  7. return result;
  8. }

上面代码中,先定义了一个Set集合,所有观察者函数都放进这个集合。然后,observable函数返回原始对象的代理,拦截赋值操作。拦截函数set之中,会自动执行所有观察者。


还没有评论.