博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
ECMAScript学习笔记-Proxy
阅读量:2489 次
发布时间:2019-05-11

本文共 12900 字,大约阅读时间需要 43 分钟。

一、概念

Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。
ES6 原生提供 Proxy 构造函数,用来生成 Proxy 实例。
Proxy 对象的所有用法,都是上面这种形式,不同的只是handler参数的写法。其中,new Proxy()表示生成一个Proxy实例,target参数表示所要拦截的目标对象,handler参数也是一个对象,用来定制拦截行为。

var proxy = new Proxy({}, {  get: function(target, property) {
return 35; }});proxy.time // 35proxy.name // 35proxy.title // 35

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

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

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

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

var proxy = new Proxy({}, {  get: function(target, property) {
return 35; }});let obj = Object.create(proxy);obj.time // 35//proxy对象是obj对象的原型,obj对象本身并没有time属性,所以根据原型链,会在proxy对象上读取该属性,导致被拦截。

二、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),返回一个数组。该方法返回目标对象所有自身的属性的属性名,而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(…)。

1.get方法用于拦截某个属性的读取操作,可以接受三个参数,依次为目标对象、属性名和 proxy 实例本身(即this关键字指向的那个对象),其中最后一个参数可选。

var person = {  name: "张三"};var proxy = new Proxy(person, {  get: function(target, property) {
if (property in target) { return target[property]; } else { throw new ReferenceError("Property \"" + property + "\" does not exist."); } }});proxy.name // "张三"proxy.age // 抛出一个错误

get方法的第三个参数receiver,总是为当前的 Proxy 实例。

const proxy = new Proxy({}, {  get: function(target, property, receiver) {
return receiver; }});proxy.getReceiver === proxy // true

如果一个属性不可配置(configurable)和不可写(writable),则该属性不能被代理,通过 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

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

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

let validator = {  set: function(obj, prop, value) {
if (prop === 'age') { if (!Number.isInteger(value)) { throw new TypeError('The age is not an integer'); } if (value > 200) { throw new RangeError('The age seems invalid'); } } // 对于满足条件的 age 属性以及其他属性,直接保存 obj[prop] = value; }};let person = new Proxy({}, validator);person.age = 100;person.age // 100person.age = 'young' // 报错person.age = 300 // 报错

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

const 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`); }}const target = {};const proxy = new Proxy(target, handler);proxy._prop// Error: Invalid attempt to get private "_prop" propertyproxy._prop = 'c'// Error: Invalid attempt to set private "_prop" property

set方法的第四个参数receiver,总是返回this关键字所指向的那个对象,即proxy实例本身。

const handler = {  set: function(obj, prop, value, receiver) {
obj[prop] = receiver; }};const proxy = new Proxy({}, handler);proxy.foo = 'bar';proxy.foo === proxy // true

如果目标对象自身的某个属性,不可写也不可配置,那么set不得改变这个属性的值,只能返回同样的值,否则报错。

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) // 6proxy.call(null, 5, 6) // 22proxy.apply(null, [7, 8]) // 30//每当执行proxy函数(直接调用或call和apply调用),就会被apply方法拦截。

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

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

4.has()

has方法用来拦截HasProperty操作,即判断对象是否具有某个属性时,这个方法会生效。典型的操作就是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//上面代码中,如果原对象的属性名的第一个字符是下划线,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//上面代码中,obj对象禁止扩展,结果使用has拦截就会报错。也就是说,如果某个属性不可配置(或者目标对象不可扩展),则has方法就不得“隐藏”(即返回false)目标对象的该属性。

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

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

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// truefor (let a in oproxy1) {  console.log(oproxy1[a]);}// 张三// 59for (let b in oproxy2) {  console.log(oproxy2[b]);}// 李四// 99

5.construct()

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

var handler = {  construct (target, args, newTarget) {    return new target(...args);  }};//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() // 报错

6.deleteProperty()

deleteProperty方法用于拦截delete操作,如果这个方法抛出错误或者返回false,当前属性就无法被delete命令删除
下面代码中,deleteProperty方法拦截了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

7.defineProperty()

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,导致添加新属性会抛出错误。

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')// undefinedObject.getOwnPropertyDescriptor(proxy, '_foo')// undefinedObject.getOwnPropertyDescriptor(proxy, 'baz')// { value: 'tar', writable: true, enumerable: true, configurable: true }

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

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(proxy) === Object.isExtensible(target)
var p = new Proxy({}, {  isExtensible: function(target) {
return false; }});Object.isExtensible(p) // 报错

11.ownKeys()

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

  • Object.getOwnPropertyNames()
  • Object.getOwnPropertySymbols()
  • 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' ]

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

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方法返回,否则报错。

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-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

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方法里面,调用一次Object.preventExtensions。

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

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

三、Proxy.revocable()

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

let target = {};let handler = {};let {proxy, revoke} = Proxy.revocable(target, handler);proxy.foo = 123;proxy.foo // 123revoke();proxy.foo // TypeError: Revoked

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

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() // falseproxy.m() // true

参考:

转载地址:http://lrarb.baihongyu.com/

你可能感兴趣的文章
joplin笔记
查看>>
JNDI+springmvc使用
查看>>
vue+springboot分页交互
查看>>
vue+springboot打包发布
查看>>
XSL 开发总结
查看>>
beta阶段第六次scrum meeting
查看>>
SpringBoot+MybatisPlus实现批量添加的两种方式
查看>>
vue 设计结构
查看>>
Sqlerver2005+按照ID分组取前几条
查看>>
Python的编码和解码
查看>>
docker
查看>>
停车场系统安全岛设计施工要求
查看>>
Docker实战
查看>>
asp.net core结合Gitlab-CI实现自动化部署
查看>>
RDIFramework.NET ━ .NET快速信息化系统开发框架 V2.7 版本发布
查看>>
EasyNVR H5无插件摄像机直播解决方案前端解析之:关于直播页面和视频列表页面切换的问题...
查看>>
django搭建一个小型的服务器运维网站-拿来即用的bootstrap模板
查看>>
redis事务
查看>>
Java_基础语法之dowhile语句
查看>>
HDU 2175 汉诺塔IX
查看>>