Proxy
- ES6-Proxy
Proxy
用于修改某些操做的默认行为,等同于在语言层面作出修改,因此属于一种“元编程”(meta programming
),即对编程语言进行编程。能够理解成,在目标对象以前架设一层“拦截”,外界对该对象的访问,都必须先经过这层拦截,所以提供了一种机制,能够对外界的访问进行过滤和改写。
使用方式
- 将
Proxy
对象,设置到object.proxy
属性,从而能够在object
对象上调用。
const object = { proxy: new Proxy(target, handler) };
复制代码
- 使用
Proxy
对象
const proxy = new Proxy({}, {
get: function(target, propKey) {
return 'detanx';
}
});
obj.name // 'detanx'
复制代码
拦截操做
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)
。
get()
- 拦截某个属性的读取操做,能够接受三个参数,依次为目标对象、属性名和 proxy 实例自己(严格地说,是操做行为所针对的对象),其中最后一个参数可选。
const proxy = new Proxy({}, {
get(target, propertyKey [, receiver]) {
return target[propertyKey];
}
});
复制代码
- 若是一个属性不可配置(
configurable
)且不可写(writable
),则 Proxy
不能修改该属性,不然经过 Proxy
对象访问该属性会报错。
const target = Object.defineProperties({}, {
foo: {
value: 123,
writable: false,
configurable: false
},
});
const handler = {
get(target, propKey) {
return 'abc';
}
};
const proxy = new Proxy(target, handler);
proxy.foo
// TypeError: Invariant check failed
复制代码
set()
set
方法用来拦截某个属性的赋值操做,能够接受四个参数,依次为目标对象、属性名、属性值和 Proxy
实例自己,其中最后一个参数可选。
let prxyo = new Proxy({}, {
set(target, propertyKey, value [, receiver]) {
return target[propertyKey];
}
});
复制代码
- 若是目标对象自身的某个属性,不可写(
configurable
)且不可写(writable
),那么set
方法将不起做用。
const obj = {};
Object.defineProperty(obj, 'foo', {
value: 'bar',
writable: false,
});
const handler = {
set: function(obj, prop, value, receiver) {
obj[prop] = 'baz';
}
};
const proxy = new Proxy(obj, handler);
proxy.foo = 'baz';
proxy.foo // "bar"
复制代码
- 严格模式下,
set
代理若是没有返回true
,就会报错。
'use strict';
const handler = {
set: function(obj, prop, value, receiver) {
obj[prop] = receiver;
// 不管有没有下面这一行,都会报错
return false;
}
};
const proxy = new Proxy({}, handler);
proxy.foo = 'bar';
// TypeError: 'set' on proxy: trap returned falsish for property 'foo'
复制代码
apply()
apply
方法拦截函数的调用、call
和apply
操做。
apply
方法能够接受三个参数,分别是目标对象、目标对象的上下文对象(this
)和目标对象的参数数组。
const proxy = new Proxy( {}, {
apply (target, ctx, args) {
return Reflect.apply(...arguments);
}
});
复制代码
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
复制代码
- 直接调用
Reflect.apply
方法,也会被拦截。
Reflect.apply(proxy, null, [9, 10]) // 38
复制代码
has()
has
方法用来拦截HasProperty
操做(注意不是HasOwnProperty
,即has
方法不判断一个属性是对象自身的属性,仍是继承的属性。),即判断对象是否具备某个属性时,这个方法会生效。典型的操做就是in
运算符。能够接受两个参数,分别是目标对象、需查询的属性名。
- 用于隐藏某些属性
// 隐藏_开头的属性
var handler = {
has (target, key) {
if (key[0] === '_') {
return false;
}
return key in target;
}
};
var target = { _prop: 'foo', prop: 'foo' };
var proxy = new Proxy(target, handler);
'_prop' in proxy // false
复制代码
let stu1 = {name: '张三', score: 59};
let stu2 = {name: '李四', score: 99};
let handler = {
has(target, prop) {
if (prop === 'score' && target[prop] < 60) {
console.log(`${target.name} 不及格`);
return false;
}
return prop in target;
}
}
let oproxy1 = new Proxy(stu1, handler);
let oproxy2 = new Proxy(stu2, handler);
'score' in oproxy1
// 张三 不及格
// false
'score' in oproxy2
// true
for (let a in oproxy1) {
console.log(oproxy1[a]);
}
// 张三
// 59
for (let b in oproxy2) {
console.log(oproxy2[b]);
}
// 李四
// 99
复制代码
construct()
construct
方法用于拦截new命令,下面是拦截对象的写法。能够接受三个参数:目标对象、构造函数的参数对象、创造实例对象时,new
命令做用的构造函数。construct
方法返回的必须是一个对象,不然会报错。
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
var p = new Proxy(function() {}, {
construct: function(target, argumentsList) {
return 1;
}
});
new p() // 报错
// Uncaught TypeError: 'construct' on proxy: trap returned non-object ('1')
复制代码
deleteProperty()
deleteProperty
方法用于拦截delete
操做,若是这个方法抛出错误或者返回false
,当前属性就没法被delete
命令删除。目标对象自身的不可配置(configurable
)的属性,不能被deleteProperty
方法删除,不然报错。
var handler = {
deleteProperty (target, key) {
delete target[key];
return true;
}
};
var target = { prop: 'foo' };
var proxy = new Proxy(target, handler);
delete proxy._prop
复制代码
defineProperty()
defineProperty()
方法拦截了Object.defineProperty()
操做。若是目标对象不可扩展(non-extensible
),则defineProperty()
不能增长目标对象上不存在的属性,不然会报错。另外,若是目标对象的某个属性不可写(writable
)或不可配置(configurable
),则defineProperty()
方法不得改变这两个设置。
var handler = {
defineProperty (target, key, descriptor) {
return false;
}
};
var target = {};
var proxy = new Proxy(target, handler);
proxy.foo = 'bar' // 不会生效
复制代码
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 }
复制代码
getPrototypeOf()
- 方法主要用来拦截获取对象原型,返回值必须是对象或者
null
,不然报错。
- 若是目标对象不可扩展(
non-extensible
), 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
复制代码
isExtensible()、preventExtensions()和setPrototypeOf()
- 相同点
- 这三个方法只能返回布尔值,不然会被自动转为布尔值。
- 不一样点
isExtensible()
方法有一个强限制,它的返回值必须与目标对象的isExtensible
属性保持一致,不然就会抛出错误。
var p = new Proxy({}, {
isExtensible: function(target) {
console.log("called");
return true;
}
});
Object.isExtensible(p)
// "called"
// true
// 报错
var p = new Proxy({}, {
isExtensible: function(target) {
return false;
}
});
Object.isExtensible(p)
// Uncaught TypeError: 'isExtensible' on proxy: trap result does not reflect extensibility of proxy target (which is 'true')
复制代码
preventExtensions()
方法有一个限制,只有目标对象不可扩展时(即Object.isExtensible(proxy)
为false
),proxy.preventExtensions
才能返回true
,不然会报错。为了防止出现这个问题,一般要在proxy.preventExtensions()
方法里面,调用一次Object.preventExtensions()
。
var proxy = new Proxy({}, {
preventExtensions: function(target) {
return true;
}
});
Object.preventExtensions(proxy)
// Uncaught TypeError: 'preventExtensions' on proxy: trap returned truish but the proxy target is extensible
// 纠正后
var proxy = new Proxy({}, {
preventExtensions: function(target) {
console.log('called');
Object.preventExtensions(target);
return true;
}
});
Object.preventExtensions(proxy)
// "called"
// Proxy {}
复制代码
setPrototypeOf()
若是目标对象不可扩展(non-extensible
),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
复制代码
ownKeys()
ownKeys()
方法用来拦截对象自身属性的读取操做。具体来讲,拦截如下操做。
Object.getOwnPropertyNames()
Object.getOwnPropertySymbols()
Object.keys()
for...in
循环
- 使用
Object.keys()
方法时,有三类属性会被ownKeys()
方法自动过滤,不会返回。目标对象上不存在的属性、属性名为 Symbol
值、不可遍历(enumerable
)的属性。
- 使用限制(很重要)
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()
方法返回,不然报错。
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'
复制代码
- 目标对象是不可扩展的(
non-extensible
),这时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
复制代码
Proxy.revocable()
Proxy.revocable()
方法返回一个对象,该对象的proxy
属性是Proxy实例,revoke
属性是一个函数,能够取消Proxy
实例。
let target = {};
let handler = {};
let {proxy, revoke} = Proxy.revocable(target, handler);
proxy.foo = 123;
proxy.foo // 123
revoke();
proxy.foo // TypeError: Revoked
复制代码
- 当执行
revoke
函数以后,再访问Proxy
实例,就会抛出一个错误。
Proxy.revocable()
的一个使用场景是,目标对象不容许直接访问,必须经过代理访问,一旦访问结束,就收回代理权,不容许再次访问。
this
问题
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 jane = new Person('Jane');
jane.name // 'Jane'
const proxy = new Proxy(jane, {});
proxy.name // undefined
=> // 增长get拦截
const proxy = new Proxy(jane, {
get(target, prop) {
console.log('prop', prop)
if (prop === 'name') {
return target.name
}
return Reflect.get(target, prop);
}
});
proxy.name // Jane
复制代码
- 有些原生对象的内部属性,只有经过正确的
this
才能拿到,因此 Proxy
也没法代理这些原生对象的属性。这时,this
绑定原始对象,就能够解决这个问题。
const target = new Date();
const handler = {};
const proxy = new Proxy(target, handler);
proxy.getDate();
// TypeError: this is not a Date object.
// 在get中绑定this
const target = new Date('2015-01-01');
const handler = {
get(target, prop) {
if (prop === 'getDate') {
return target.getDate.bind(target);
}
return Reflect.get(target, prop);
}
};
const proxy = new Proxy(target, handler);
proxy.getDate() //
复制代码
vue3使用Proxy替换defineProperty
- Object.defineProperty
Object.defineProperty
没法监控到数组下标的变化,致使直接经过数组的下标给数组设置值,不能实时响应。通过vue内部处理后可使用如下几种方法来监听数组push()
、pop()
、shift()
、unshift()
、splice()
、sort()
、reverse()
,因为只针对了以上八种方法进行了hack
处理,因此其余数组的属性也是检测不到的,仍是具备必定的局限性。
Object.defineProperty
只能劫持对象的属性,所以咱们须要对每一个对象的每一个属性进行遍历。
- Proxy
- 能够劫持整个对象,并返回一个新对象。
- 有
13
种劫持操做。
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
对象的拦截操做(get、delete、has、...
),内部都调用对应的Reflect
方法。