Proxy

概述

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

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

上面的解释很抽象，我们通过一个🌰来展示一下它的能力：

const obj = new Proxy({}, {
    get: function (target, propKey, receiver) {
        console.log(`getting ${propKey}!`);
        return Reflect.get(target, propKey, receiver);
    },
    set: function (target, propKey, value, receiver) {
        console.log(`setting ${propKey}!`);
        return Reflect.set(target, propKey, value, receiver);
    }
})

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

obj.count = 1
// setting count!
++obj.count
// getting count!
// setting count!

上面代码说明，Proxy 实际上重载（overload）了点运算符，即用自己的定义覆盖了语言的原始定义。ES6 原生提供 Proxy 构造函数，用来生成 Proxy 实例。Proxy 对象的所有用法，都是上面这种形式，不同的只是 handler 参数的写法。其中，new Proxy()表示生成一个 Proxy 实例， target 参数表示所要拦截的目标对象， handler 参数也是一个对象，用来定制拦截行为。

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

const obj = new Proxy({}, {
    get: function (target, propKey, receiver) {
        return 35
    }
})
console.log(obj.name) // 35
console.log(obj.age)  // 35
console.log(obj.time) // 35

get方法的两个参数分别是目标对象和所要访问的属性。可以看到，由于拦截函数总是返回35，所以访问任何属性都得到35

注意，要使得 Proxy 起作用，必须针对 Proxy 实例（上例是 obj 对象）进行操作，而不是针对目标对象（上例是空对象）进行操作

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

var target = {};
var handler = {};
var proxy = new Proxy(target, handler);
proxy.a = 'b';
console.log('target.a', target.a) // b
console.log(target === proxy)     // false

上面代码中， handler 是一个空对象，没有任何拦截效果，访问 proxy 就等同于访问 target。注意：这两个对象是不同的。

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

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

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

var proxy = new Proxy({}, {
    get: function(target, propKey) {
        return 35;
    }
});
let obj = Object.create(proxy);
console.log(obj.time) // 35

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

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

var handler = {
    get: function(target, name) {
        if (name === 'prototype') {
            return Object.prototype;
        }
        return 'Hello, ' + name;
    },
    apply: function(target, thisBinding, args) {
        // console.log('target', target)
        // console.log('thisBinding', thisBinding)
        // console.log('args', args)
        return args[0];
    },
    construct: function(target, args) {
        return {value: args[1]};
    }
};
var fproxy = new Proxy(function(x, y) {
    return x + y;
}, handler);

console.log(typeof fproxy)  // function
console.log(fproxy(1, 2)) // 1 (触发了 apply)
console.log(new fproxy(1, 2)) // {value: 2} (触发了 construct)
console.log(fproxy.prototype === Object.prototype) // true
console.log(fproxy.foo === "Hello, foo") // true (触发了 get)

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

下面是 Proxy 支持的拦截操作一览，一共 13 种。

• **get(target, propKey, receiver)：**拦截对象属性的读取，比如 proxy.foo 和 proxy['foo']
• **set(target, propKey, value, receiver)：**拦截对象属性的设置，比如 proxy.foo = v 或 proxy['foo'] = v，返回一个布尔值。
• **has(target, propKey)：**拦截 propKey in proxy 的操作，返回一个布尔值。
• **deleteProperty(target, propKey)：**拦截 delete proxy[propKey] 的操作，返回一个布尔值。
• **ownKeys(target)：**拦截 Object.getOwnPropertyNames(proxy)、Object.getOwnPropertySymbols(proxy)、Object.keys(proxy)、for...in循环，返回一个数组。该方法返回目标对象所有自身的属性的属性名，而 Object.keys() 的返回结果仅包括目标对象自身的可遍历属性。
• **getOwnPropertyDescriptor(target, propKey)：**拦截 Object.getOwnPropertyDescriptor(proxy, propKey)，返回属性的描述对象。
• **defineProperty(target, propKey, propDesc)：**拦截Object.defineProperty(proxy, propKey, propDesc）、Object.defineProperties(proxy, propDescs)，返回一个布尔值。
• **preventExtensions(target)：**拦截 Object.preventExtensions(proxy)，返回一个布尔值。
• **getPrototypeOf(target)：**拦截 Object.getPrototypeOf(proxy)，返回一个对象。
• **isExtensible(target)：**拦截 Object.isExtensible(proxy)，返回一个布尔值。
• **setPrototypeOf(target, proto)：**拦截Object.setPrototypeOf(proxy, proto)，返回一个布尔值。如果目标对象是函数，那么还有两种额外操作可以拦截。
• **apply(target, object, args)：**拦截 Proxy 实例作为函数调用的操作，比如proxy(...args)、proxy.call(object, ...args)、proxy.apply(...)。
• **construct(target, args)：**拦截 Proxy 实例作为构造函数调用的操作，比如new proxy(...args)。

Proxy 实例的方法

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

1. get()

get方法用于拦截某个属性的读取操作，可以接受三个参数，依次为目标对象、属性名和 proxy 实例本身（严格地说，是操作行为所针对的对象），其中最后一个参数可选。

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

var person = { name: "张三" };
var proxy = new Proxy(person, {
    get: function(target, propKey) {
        if (propKey in target) {
            return target[propKey];
        } else {
            throw new ReferenceError("Prop name \"" + propKey + "\" does not exist.");
        }
    }
});

console.log(proxy.name) // "张三"
console.log(proxy.age) // 抛出一个错误  

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

get 方法可以继承。

let proto = new Proxy({}, {
    get(target, propertyKey, receiver) {
        console.log('GET ' + propertyKey);
        return target[propertyKey];
    }
});

let obj = Object.create(proto);
console.log(obj.foo) // "GET foo" // undefine

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

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

// 可以把多个参数存为一个数组
function createArray(...elements) {
    console.log('elements', elements)
    // elements == [...arguments]
    let handler = {
        get(target, propKey, receiver) {
            let index = Number(propKey);
            if (index < 0) {
                propKey = String(target.length + index);
            }
            return Reflect.get(target, propKey, receiver);
        }
    };

    let target = [];
    target.push(...elements);
    return new Proxy(target, handler);
}

let arr = createArray('a', 'b', 'c');
console.log(arr[-1]) // c

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

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

// Array.prototype.reduce()
const array1 = [1, 2, 3, 4];
const reducer = (accumulator, currentValue) => accumulator + currentValue;
// 1 + 2 + 3 + 4
console.log(array1.reduce(reducer));
// expected output: 10
// 5 + 1 + 2 + 3 + 4
console.log(array1.reduce(reducer, 5));
// expected output: 15

var pipe = function (value) {
    var funcStack = [];
    var oproxy = new Proxy({} , {
        get : function (pipeObject, fnName) {
            if (fnName === 'get') {
                return funcStack.reduce(function (val, fn) {
                    return fn(val);
                }, value);
            }
            funcStack.push(window[fnName]);
            return oproxy;
        }
    });
    return oproxy;
}
var double = n => n * 2;

var pow = n => n * n;
var reverseInt = n => n.toString().split("").reverse().join("") | 0;
console.log(pipe(3).double.pow.reverseInt.get); // 63
// ((3 * 2) * (3 * 2)) = 36

下面是一个get方法的第三个参数的例子，它总是指向原始的读操作所在的那个对象，一般情况下就是 Proxy 实例。

const proxy = new Proxy({}, {
    get: function(target, key, receiver) {
        return receiver;
    }
});
console.log(proxy.get === proxy)

上面代码中， proxy 对象的 getReceiver 属性是由 proxy 对象提供的，所以 receiver 指向 proxy 对象。

const proxy = new Proxy({}, {
  get: function(target, key, receiver) {
    return receiver;
  }
});

const d = Object.create(proxy);
console.log(d.a === d) // true

如果一个属性不可配置（ configurable ）且不可写（ writable ），则 Proxy 不能修改该属性，否则通过 Proxy 对象访问该属性会报错。

2. set()

set 方法用来拦截某个属性的赋值操作，可以接受四个参数，依次为目标对象、属性名、属性值和 Proxy 实例本身，其中最后一个参数可选。

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

let validator = {
    set: function (obj, prop, value) {
        if (prop == 'age') {
            if (Number.isInteger(value)) {
                throw new Error('age is not a integer')
            } else if (value <= 200) {
                obj[prop] = value
            } else {
                throw new Error('age less than 200')
            }
        }
    }
}

const per = new Proxy({}, validator)
per.age = 20
per.age = 1000
per.age = "asdasd"
console.log(per)

const handler = {
    set: function(obj, prop, value, receiver) {
        obj[prop] = receiver;
    }
};

const proxy = new Proxy({}, handler);
const myObj = {};
Object.setPrototypeOf(myObj, proxy);
// Object.getPrototypeOf
// Object.setPrototypeOf
myObj.foo = 'bar';
myObj.foo === myObj // true
console.log(myObj.__proto__) // proxy

上面代码中，设置 myObj.foo 属性的值时， myObj 并没有 foo 属性，因此引擎会到 myObj 的原型链去找 foo 属性。 myObj 的原型对象 proxy 是一个 Proxy 实例，设置它的 foo 属性会触发 set 方法。这时，第四个参数 receiver 就指向原始赋值行为所在的对象 myObj 。

注意，如果目标对象自身的某个属性不可写(writable: false) ，那么 set 方法将不起作用。

3. apply()

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

apply 方法可以接受三个参数，分别是目标对象、目标对象的上下文对象（this）和目标对象的参数数组。举个🌰：

var target = function () { return 'I am the target'; };
var handler = {
    apply: function () {
        return 'I am the proxy';
    }
};
var p = new Proxy(target, handler)
console.log(p()) // I am the proxy

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

4. has()

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

has()方法可以接受两个参数，分别是目标对象、需查询的属性名。下面的例子使用 has() 方法隐藏某些属性，不被 in 运算符发现。

var handler = {
    has (target, key) {
        if (key.startsWith('_')) {
            return false;
        }
        return key in target
    }
}
const obj = {
    _proxy: 'sda',
    foo: 'sadasd'
}
const proxy = new Proxy(obj, handler)
console.log('_proxy' in proxy) // false
console.log('foo' in proxy)  // true
console.log(Object.hasOwnProperty.call(proxy, '_proxy')) // true
console.log(proxy.hasOwnProperty('_proxy')) // true

proxy.has() 就会返回 false ，从而不会被 in 运算符发现。

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

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

4. construct()

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

construct() 方法可以接受三个参数。

• target：目标对象。
• args： 构造函数的参数数组。
• newTarget：创造实例对象时，new命令作用的构造函数（下面例子的p）。

const p = new Proxy(function () {}, {
    construct: function(target, args) {
        console.log('called: ' + args.join(', '));
        return { value: args[0] * 10 };
    }
});
(new p(1)).value

5. deleteProperty()

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

注意，目标对象自身的不可配置（configurable）的属性，不能被 deleteProperty 方法删除，否则报错。

6. defineProperty()

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

var handler = {
    defineProperty (target, key, descriptor) {
        return false;
    }
}
var target = {};
var proxy = new Proxy(target, handler);
proxy.foo = 'bar' // 不会生效
console.log(proxy.foo)

注意，如果目标对象不可扩展（non-extensible），则 defineProperty() 不能增加目标对象上不存在的属性，否则会报错。另外，如果目标对象的某个属性不可写（writable）或不可配置（configurable），则 defineProperty() 方法不得改变这两个设置。

7. getOwnPropertyDescriptor()

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

8. getPrototypeOf()

getPrototypeOf() 方法主要用来拦截获取对象原型。具体来说，拦截下面这些操作。

• Object.prototype.proto
• Object.prototype.isPrototypeOf()
• Object.getPrototypeOf()
• Reflect.getPrototypeOf()
• instanceof

var proto = {}
var p = new Proxy({}, {
    getPrototypeOf(target) {
        return proto;
    }
});
console.log(Object.getPrototypeOf(p) === proto ) // true

9. setPrototypeOf()

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

var handler = {
    setPrototypeOf (target, proto) {
        throw new Error('Changing the prototype is forbidden');
    }
};
var proto = {};
var target = function () {};
var proxy = new Proxy(target, handler);
Object.setPrototypeOf(proxy, proto);
// Error: Changing the prototype is forbidden

Proxy.revocable()

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

let target = {};
let handler = {};
let { proxy, revoke } = Proxy.revocable(target, handler);
proxy.foo = 123;
proxy.foo // 123
revoke();
proxy.foo // Uncaught TypeError: Cannot perform 'get' on a proxy that has been revoked

Proxy.revocable() 的一个使用场景是，目标对象不允许直接访问，必须通过代理访问，一旦访问结束，就收回代理权，不允许再次访问

this 问题

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

const target = {
    m: function () {
        console.log(this === proxy);
    }
};
const handler = {};
const proxy = new Proxy(target, handler);
target.m() // false
proxy.m()  // true

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

const _name = new WeakMap()
class Person {
    constructor (name) {
        _name.set(this, name)
    }
    get name() {
        return _name.get(this)
    }
}
const zhu = new Person('zzy')
console.log(zhu.name)  // zzy
const proxy = new Proxy(zhu, {})
console.log(proxy.name) // undefined

实例：Web 服务的客户端

Proxy 对象可以拦截目标对象的任意属性，这使得它很合适用来写 Web 服务的客户端。

const service = createWebService('http://example.com/data');

service.employees().then(json => {
  const employees = JSON.parse(json);
  // ···
});

function createWebService (baseUrl) {
    return new Proxy({}, {
        get (target, propKey, proxy) {
            // return () => http(`${baseUrl}/${propKey}`)
            return http(`${baseUrl}/${propKey}`)
            // return function () {
            //     return http(`${baseUrl}/${propKey}`)
            // }
        }
    })
}

同理，Proxy 也可以用来实现数据库的 ORM 层。(Object Relational Mapping) 对象关系映射