阮一峰ES6教程读书笔记(十一)Proxy

Proxy

1. 概述

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

我们可以把Proxy理解为一种拦截器,在我们通过Proxy来访问对象的时候,会先执行Proxy设置的一些过滤操作,就像我们在使用axios的时候,一般都会添拦截器,用来在发出请求前或者接收到res后先执行特定的操作。为我们提供一些定制化的功能。

2. Proxy的使用

ES6 提供Proxy的构造函数,用来生成代理器的实例:

var proxy = new Proxy(target, handler)

其中,target是需要执行代理操作的对象,而handler则是代理操作的配置对象,里面可以写一些代理规则。

一般来说,我们会将targetProxy实例再挂载到target对象上,比如:

var obj = {name: 'bing', age: 23}
var handler = {
    set: function(target, prop, val) {
        console.log(`set ${prop}: ${val}`)
        target[prop] = val
    }
}
var proxy = new Proxy(obj, handler)

obj.proxy = proxy

obj.proxy.age = 24 // set age: 24
obj.age // 24

3. handler对象

前面我们提到了handler对象中是Proxy的过滤规则,所以我们在通过Proxy操作对象的时候,如果handler对象中有该操作的规则,那么就会执行规则,下面是Proxy支持拦截操作的类型:

  • get(target, propKey, receiver):拦截对象属性的读取,比如proxy.fooproxy['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)

4. Proxy的的运用

上周末我在写一个node接口的时候,我发现JavaScript的一个运算规则让我遇到了些许麻烦,因为我需要对一个对象的某个属性的值做累加操作,即obj[key] += number,但是我遇到一个问题,就是undefined + 1的值为NaN,而NaN和任何数的和都为NaN,所以我在执行累加操作前得先判断该变量的值是否为undefined。如果此时不使用拦截器,那么我必须得这么操作:

// keys: []
// res: {}

for (let key of keys) {
    if (some condition) {
        if (res.hasOwnProperty(key)) {
            res[key] += 1
        } else {
            res[key] = 1
        }
    }
    // 或者可以这么写
    if (some condition) {
        res[key] = (res[key] || 0) + 1
    }
}

总之这样的写法是不够优雅的,但是如果采用代理的方式来实现的话,我们可以这么写:

// keys: []
// res: {}

var handler = {
    get (target, prop) {
        return target[prop] ? target[prop] : 0
    }
}

res.py = new Proxy(res, handler)

for (let key of keys) {
    if (some condition) {
        res.py[key] += 1
    }
}

通过代理来操作对象可以把我们预知的风险操作给规避掉,这样可以让我们在写逻辑代码时减少其他影响阅读的代码。

还有一个例子就是,我们知道在其他脚本语言中,比如Python中我们可以通过array[-1]来访问数组的最后一个元素,但是在JavaScript中我们必须通过array[array.length - 1]的方式来访问,这样的代码也是会对代码的可读性造成一定影响,所以我们可以将数组对象的get操作进行一定的改造,从而满足我们的需求:

function createArray(...elements) {
  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');
arr[-1] // c

结束语

因为时间关系,这篇文章没法写得太长,还有一些很有趣的方法没有写,另外使用Proxy还有一些需要注意的问题,比如this的指向,有兴趣的读者可以去往参考链接一探究竟。

参考链接

作者:阮一峰

链接:http://es6.ruanyifeng.com/#docs/proxy

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351

推荐阅读更多精彩内容

  • 笔记,完全摘录自阮一峰 proxy的概念 proxy英文原意是代理的意思,在ES6中,可以翻译为"代理器"。它主要...
    布蕾布蕾阅读 22,462评论 0 8
  • Proxy 概述 Proxy 用于修改某些操作的默认行为,等同于在语言层面做出修改,所以属于一种“元编程”(met...
    pauljun阅读 3,250评论 0 1
  • defineProperty() 学习书籍《ECMAScript 6 入门 》 Proxy Proxy 用于修改某...
    Bui_vlee阅读 650评论 0 1
  • Proxy Proxy用于修改某些操作的默认行为,等同于在语言层面作出修改,所以属于一种“元编程”,即对编程语言进...
    南蓝NL阅读 452评论 0 0
  • 马太福音 17:4 彼得对耶稣说:「主啊,我们在这里真好!马太福音 17:9 下山的时候,
    神是舜的神阅读 242评论 0 1