你是怎么理解ES6中Proxy的?使用场景? - 图1

一、介绍

定义: 用于定义基本操作的自定义行为

本质: 修改的是程序默认形为,就形同于在编程语言层面上做修改,属于元编程(meta programming)

元编程(Metaprogramming,又译超编程,是指某类计算机程序的编写,这类计算机程序编写或者操纵其它程序(或者自身)作为它们的数据,或者在运行时完成部分本应在编译时完成的工作

一段代码来理解

  1. #!/bin/bash
  2. # metaprogram
  3. echo '#!/bin/bash' >program
  4. for ((I=1; I<=1024; I++)) do
  5. echo "echo $I" >>program
  6. done
  7. chmod +x program

这段程序每执行一次能帮我们生成一个名为program的文件,文件内容为1024行echo,如果我们手动来写1024行代码,效率显然低效

  • 元编程优点:与手工编写全部代码相比,程序员可以获得更高的工作效率,或者给与程序更大的灵活度去处理新的情形而无需重新编译

Proxy 亦是如此,用于创建一个对象的代理,从而实现基本操作的拦截和自定义(如属性查找、赋值、枚举、函数调用等)

二、用法

Proxy为 构造函数,用来生成 Proxy实例

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

参数

target表示所要拦截的目标对象(任何类型的对象,包括原生数组,函数,甚至另一个代理))

handler通常以函数作为属性的对象,各属性中的函数分别定义了在执行各种操作时代理 p 的行为

handler解析

关于handler拦截属性,有如下:

  • get(target,propKey,receiver):拦截对象属性的读取
  • set(target,propKey,value,receiver):拦截对象属性的设置
  • has(target,propKey):拦截propKey in proxy的操作,返回一个布尔值
  • deleteProperty(target,propKey):拦截delete proxy[propKey]的操作,返回一个布尔值
  • ownKeys(target):拦截Object.keys(proxy)for...in等循环,返回一个数组
  • getOwnPropertyDescriptor(target, propKey):拦截Object.getOwnPropertyDescriptor(proxy, propKey),返回属性的描述对象
  • defineProperty(target, propKey, propDesc):拦截Object.defineProperty(proxy, propKey, propDesc),返回一个布尔值
  • 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 实例作为函数调用的操作
  • construct(target, args):拦截 Proxy 实例作为构造函数调用的操作

Reflect

若需要在Proxy内部调用对象的默认行为,建议使用Reflect,其是ES6中操作对象而提供的新 API

基本特点:

  • 只要Proxy对象具有的代理方法,Reflect对象全部具有,以静态方法的形式存在
  • 修改某些Object方法的返回结果,让其变得更合理(定义不存在属性行为的时候不报错而是返回false
  • Object操作都变成函数行为

下面我们介绍proxy几种用法:

get()

get接受三个参数,依次为目标对象、属性名和 proxy 实例本身,最后一个参数可选

  1. var person = {
  2. name: "张三"
  3. };
  4. var proxy = new Proxy(person, {
  5. get: function(target, propKey) {
  6. return Reflect.get(target,propKey)
  7. }
  8. });
  9. proxy.name // "张三"

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

注意:如果一个属性不可配置(configurable)且不可写(writable),则 Proxy 不能修改该属性,否则会报错

  1. const target = Object.defineProperties({}, {
  2. foo: {
  3. value: 123,
  4. writable: false,
  5. configurable: false
  6. },
  7. });
  8. const handler = {
  9. get(target, propKey) {
  10. return 'abc';
  11. }
  12. };
  13. const proxy = new Proxy(target, handler);
  14. proxy.foo
  15. // TypeError: Invariant check failed

set()

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

假定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方法将不起作用

  1. const obj = {};
  2. Object.defineProperty(obj, 'foo', {
  3. value: 'bar',
  4. writable: false,
  5. });
  6. const handler = {
  7. set: function(obj, prop, value, receiver) {
  8. obj[prop] = 'baz';
  9. }
  10. };
  11. const proxy = new Proxy(obj, handler);
  12. proxy.foo = 'baz';
  13. proxy.foo // "bar"

注意,严格模式下,set代理如果没有返回true,就会报错

  1. 'use strict';
  2. const handler = {
  3. set: function(obj, prop, value, receiver) {
  4. obj[prop] = receiver;
  5. // 无论有没有下面这一行,都会报错
  6. return false;
  7. }
  8. };
  9. const proxy = new Proxy({}, handler);
  10. proxy.foo = 'bar';
  11. // TypeError: 'set' on proxy: trap returned falsish for property 'foo'

deleteProperty()

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

  1. var handler = {
  2. deleteProperty (target, key) {
  3. invariant(key, 'delete');
  4. Reflect.deleteProperty(target,key)
  5. return true;
  6. }
  7. };
  8. function invariant (key, action) {
  9. if (key[0] === '_') {
  10. throw new Error(`无法删除私有属性`);
  11. }
  12. }
  13. var target = { _prop: 'foo' };
  14. var proxy = new Proxy(target, handler);
  15. delete proxy._prop
  16. // Error: 无法删除私有属性

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

取消代理

  1. Proxy.revocable(target, handler);

三、使用场景

Proxy其功能非常类似于设计模式中的代理模式,常用功能如下:

  • 拦截和监视外部对对象的访问
  • 降低函数或类的复杂度
  • 在复杂操作前对操作进行校验或对所需资源进行管理

使用 Proxy 保障数据类型的准确性

  1. let numericDataStore = { count: 0, amount: 1234, total: 14 };
  2. numericDataStore = new Proxy(numericDataStore, {
  3. set(target, key, value, proxy) {
  4. if (typeof value !== 'number') {
  5. throw Error("属性只能是number类型");
  6. }
  7. return Reflect.set(target, key, value, proxy);
  8. }
  9. });
  10. numericDataStore.count = "foo"
  11. // Error: 属性只能是number类型
  12. numericDataStore.count = 333
  13. // 赋值成功

声明了一个私有的 apiKey,便于 api 这个对象内部的方法调用,但不希望从外部也能够访问 api._apiKey

  1. let api = {
  2. _apiKey: '123abc456def',
  3. getUsers: function(){ },
  4. getUser: function(userId){ },
  5. setUser: function(userId, config){ }
  6. };
  7. const RESTRICTED = ['_apiKey'];
  8. api = new Proxy(api, {
  9. get(target, key, proxy) {
  10. if(RESTRICTED.indexOf(key) > -1) {
  11. throw Error(`${key} 不可访问.`);
  12. } return Reflect.get(target, key, proxy);
  13. },
  14. set(target, key, value, proxy) {
  15. if(RESTRICTED.indexOf(key) > -1) {
  16. throw Error(`${key} 不可修改`);
  17. } return Reflect.get(target, key, value, proxy);
  18. }
  19. });
  20. console.log(api._apiKey)
  21. api._apiKey = '987654321'
  22. // 上述都抛出错误

还能通过使用Proxy实现观察者模式

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

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集合,当修改obj的值,在会set函数中拦截,自动执行Set所有的观察者