Proxy

xiaoxiao2021-02-28  136

文章编写参考 阮一峰《ECMAScript 6 入门》


1. 概述

Proxy 用于修改某些操作的默认行为,等同于在语言层面做出的修改。属于“元编程”,是对编程语言进行编程。

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

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

上面代码对空对象架设了一层代理,重新定义了属性的get和set行为。

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

上面代码说明,Proxy实际上重载了对象的点运算符,即用自己的行为覆盖了原来的行为。

ES6提供了Proxy构造函数,用于生成Proxy实例。

let proxy = new Proxy(target, handler)

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

let proxy = new Proxy({}, { get(target, property) { return 35; } }) proxy.name; // 35 proxy.time; // 35

上面代码对目标对象进行了中配置了代理,为目标对象的get方法设置了代理,使得每次对目标对象的属性进行访问时都返回35。

【如果handler没有设置任何拦截,那就等同于直接设置了一个对象】

let proxy = new Proxy({}, {}) proxy.name = 'Blue'; prompt.name; // Blue

上面代码虽然经过了Proxy代理,但是并没有代理原生对象的任何行为,所以和原生的对象没两样。

【Proxy对象也可以作为其他对象的原型对象】

let proxy = new Proxy({}, { get(target, property) { return 35; } }) let obj = Object.create(proxy); obj.age; // 35

上面代码中,proxy是obj的原型,obj对象并没有age属性,所以根据原型链,age属性会到原型中去找,从而触发了get的拦截。

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

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

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

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

(1)get(target, propKey, receiver) 拦截对象属性的读取,比如proxy.foo和proxy[‘foo’]。 最后一个参数receiver是一个对象,可选,参见下面Reflect.get的部分。

(2)set(target, propKey, value, receiver) 拦截对象属性的设置,比如proxy.foo = v或proxy[‘foo’] = v,返回一个布尔值。

(3)has(target, propKey) 拦截propKey in proxy的操作,返回一个布尔值。

(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)。


2. Proxy实例的方法

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

2.1 get( )

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

var person={ name:"Blue" } var proxy=new Proxy(person,{ get(target,prop){ if(prop in target){ return target[prop] }else{ throw new Error(`${prop} 属性不存在!`) } } }) proxy.name; //Blue proxy.age; // Uncaught Error: age 属性不存在!

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

上面说过,Proxy对象可以继承

var People = { name: "Blue" } var proxy = new Proxy(People, { get(target, prop) { if (prop in target) { return target[prop] } else { throw new Error(`${prop} 属性不存在!`) } } }) var person = Object.create(proxy); person.name; //Blue person.age; // Uncaught Error: age 属性不存在!

上面代码中person继承于proxy,所以person的拦截仍然生效。

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

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

var handler = { set(target, prop, value) { if (prop === 'Gender') { if (value == 'Man' || value == "Women") { target[prop] = value; } else { throw new Error('无效的性别值!'); } } } } var person = new Proxy({}, handler); person.Gender = 'Gay'; // Uncaught Error: 无效的性别值!

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

var handler = { get (target, key) { invariant(key, 'get'); return target[key]; }, set (target, key, value) { invariant(key, 'set'); target[key] = value; return true; } }; function invariant (key, action) { if (key[0] === '_') { throw new Error(`Invalid attempt to ${action} private "${key}" property`); } } var target = {}; var proxy = new Proxy(target, handler); proxy._prop // Error: Invalid attempt to get private "_prop" property proxy._prop = 'c' // Error: Invalid attempt to set private "_prop" property

上面代码是防止对对象私有属性的访问,下面再一个例子实现拒绝对类私有属性和方法的访问。

var Human = class { constructor() { return new Proxy(this, handler); } _callMe() { console.log('ee'); } } var Person = class extends Human { constructor(name, ...agrs) { super(name, ...agrs); this.name = name; return new Proxy(this, handler); } sayHi() { console.log('I am ', this.name); } _sayHello() { console.log('private'); } } var handler = { get(target, key) { invariant(key, 'get'); return target[key]; }, set(target, key, value) { invariant(key, 'set'); target[key] = value; return true; } }; function invariant(key, action) { if (key[0] === '_') { throw new Error(`Invalid attempt to ${action} private "${key}" property`); } } var p = new Person('Blue'); p.sayHi(); // I am Blue p._sayHello(); // Uncaught Error: Invalid attempt to get private "_sayHello" property p._callMe(); // Uncaught Error: Invalid attempt to get private "_callMe" property

上面代码中,由于类在new的时候默认会在构造函数中返回当前对象实例,也就是this,我们在默认行为的基础上做一些处理,人工干预返回的实例对象,为实例对象加上【代理】以此来实现阻止对私有方法的访问。所以在定义类属性的时候只要加前下划线即可实现类的私有化。

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

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

var handler = { apply (target, ctx, args) { return Reflect.apply(...arguments); } };

下面是一个例子。

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

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

下面是另外一个例子。

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

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

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

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

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

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

var handler = { has(target, key) { if (key[0] === '_') { return false; } return key in target; } }; var target = { _prop: 'Blue', prop: 'Crazy' }; var proxy = new Proxy(target, handler); '_prop' in proxy; // flase

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

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

var obj = { a: 10 }; Object.preventExtensions(obj); var p = new Proxy(obj, { has: function(target, prop) { return false; } }); 'a' in p // TypeError is thrown

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

var handler = { construct (target, args, newTarget) { return new target(...args); } };

下面是一个例子。

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

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

var p = new Proxy(function() {}, { construct: function(target, argumentsList) { return 1; } }); new p() // 报错

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

var handler = { deleteProperty (target, key) { invariant(key, 'delete'); return true; } }; function invariant (key, action) { if (key[0] === '_') { throw new Error(`Invalid attempt to ${action} private "${key}" property`); } } var target = { _prop: 'foo' }; var proxy = new Proxy(target, handler); delete proxy._prop // Error: Invalid attempt to delete private "_prop" property

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

【注意】目标对象自身的不可配置(configurable)的属性,不能被deleteProperty方法删除,否则报错。

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

var handler = { defineProperty (target, key, descriptor) { return false; } }; var target = {}; var proxy = new Proxy(target, handler); proxy.foo = 'bar' // TypeError: proxy defineProperty handler returned false for property '"foo"'

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

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

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

var handler = { getOwnPropertyDescriptor (target, key) { if (key[0] === '_') { return; } return Object.getOwnPropertyDescriptor(target, key); } }; var target = { _foo: 'bar', baz: 'tar' }; var proxy = new Proxy(target, handler); Object.getOwnPropertyDescriptor(proxy, 'wat') // undefined Object.getOwnPropertyDescriptor(proxy, '_foo') // undefined Object.getOwnPropertyDescriptor(proxy, 'baz') // { value: 'tar', writable: true, enumerable: true, configurable: true }

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

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

Object.prototype._proto_Object.prototype.isPrototypeOf()Object.getPrototypeOf()Reflect.getPrototypeOf()instanceof

下面是一个例子。

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

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

注意,getPrototypeOf方法的返回值必须是对象或者null,否则报错。另外,如果目标对象不可扩展(extensible), getPrototypeOf方法必须返回目标对象的原型对象。

2.10 isExtensible( ) isExtensible方法拦截Object.isExtensible操作。

var p = new Proxy({}, { isExtensible: function(target) { console.log("called"); return true; } }); Object.isExtensible(p) // "called" // true

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

【注意】该方法只能返回布尔值,否则返回值会被自动转为布尔值。

这个方法有一个强限制,它的返回值必须与目标对象的isExtensible属性保持一致,否则就会抛出错误。

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

下面是一个例子。

var p = new Proxy({}, { isExtensible: function(target) { return false; } }); Object.isExtensible(p) // 报错

2.11 ownKeys( ) ownKeys方法用来拦截对象自身属性的读取操作。具体来说,拦截以下操作。

Object.getOwnPropertyNames( )Object.getOwnPropertySymbols( )Object.keys()

下面是拦截Object.keys()的例子。

let target = { a: 1, b: 2, c: 3 }; let handler = { ownKeys(target) { return ['a']; } }; let proxy = new Proxy(target, handler); Object.keys(proxy) // [ 'a' ]

上面代码拦截了对于target对象的Object.keys()操作,只返回a、b、c三个属性之中的a属性。

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

let target = { _bar: 'foo', _prop: 'bar', prop: 'baz' }; let handler = { ownKeys (target) { return Reflect.ownKeys(target).filter(key => key[0] !== '_'); } }; let proxy = new Proxy(target, handler); for (let key of Object.keys(proxy)) { console.log(target[key]); } // "baz"

【注意】使用Object.keys方法时,有三类属性会被ownKeys方法自动过滤,不会返回。

目标对象上不存在的属性属性名为 Symbol 值不可遍历(enumerable)的属性 let target = { a: 1, b: 2, c: 3, [Symbol.for('secret')]: '4', }; Object.defineProperty(target, 'key', { enumerable: false, configurable: true, writable: true, value: 'static' }); let handler = { ownKeys(target) { return ['a', 'd', Symbol.for('secret'), 'key']; } }; let proxy = new Proxy(target, handler); Object.keys(proxy) // ['a']

上面代码中,ownKeys方法之中,显式返回不存在的属性(d)、Symbol 值(Symbol.for(‘secret’))、不可遍历的属性(key),结果都被自动过滤掉。

ownKeys方法还可以拦截Object.getOwnPropertyNames()。

var p = new Proxy({}, { ownKeys: function(target) { return ['a', 'b', 'c']; } }); Object.getOwnPropertyNames(p) // [ 'a', 'b', 'c' ]

ownKeys方法返回的数组成员,只能是字符串或 Symbol 值。如果有其他类型的值,或者返回的根本不是数组,就会报错。

var obj = {}; var p = new Proxy(obj, { ownKeys: function(target) { return [123, true, undefined, null, {}, []]; } }); Object.getOwnPropertyNames(p) // Uncaught TypeError: 123 is not a valid property name

上面代码中,ownKeys方法虽然返回一个数组,但是每一个数组成员都不是字符串或 Symbol 值,因此就报错了。

如果目标对象自身包含不可配置的属性,则该属性必须被ownKeys方法返回,否则报错

var obj = {}; Object.defineProperty(obj, 'a', { configurable: false, enumerable: true, value: 10 } ); var p = new Proxy(obj, { ownKeys: function(target) { return ['b']; } }); Object.getOwnPropertyNames(p) // Uncaught TypeError: 'ownKeys' on proxy: trap result did not include 'a'

上面代码中,obj对象的a属性是不可配置的,这时ownKeys方法返回的数组之中,必须包含a,否则会报错。

另外,如果目标对象是不可扩展的(non-extensition),这时ownKeys方法返回的数组之中,必须包含原对象的所有属性,且不能包含多余的属性,否则报错。

var obj = { a: 1 }; Object.preventExtensions(obj); var p = new Proxy(obj, { ownKeys: function(target) { return ['a', 'b']; } }); Object.getOwnPropertyNames(p) // Uncaught TypeError: 'ownKeys' on proxy: trap returned extra keys but proxy target is non-extensible

上面代码中,Obj对象是不可扩展的,这时ownKeys方法返回的数组之中,包含了obj对象的多余属性b,所以导致了报错。

2.12 preventExtensions( ) preventExtensions方法拦截Object.preventExtensions()。该方法必须返回一个布尔值,否则会被自动转为布尔值。

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

var p = new Proxy({}, { preventExtensions: function(target) { return true; } }); Object.preventExtensions(p) // 报错

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

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

var p = new Proxy({}, { preventExtensions: function(target) { console.log('called'); Object.preventExtensions(target); return true; } }); Object.preventExtensions(p) // "called" // true

2.13 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

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

注意,该方法只能返回布尔值,否则会被自动转为布尔值。另外,如果目标对象不可扩展(extensible),setPrototypeOf方法不得改变目标对象的原型。


3. 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 // TypeError: Revoked

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

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

转载请注明原文地址: https://www.6miu.com/read-30282.html

最新回复(0)