第12章 Proxies

Proxy

代理是指对对象(也包含函数)行为进行拦截,设置"陷阱"( trap ),来定义对象的行为,同时也能创建内置对象。


一.Proxy 和 Reflection

代理可视化目标,因此代理和目标对象功能相同。代理允许拦截普通对象操作,这些操作一般都是内部行为,通过 trap 来完成,trap 表示 function

Reflection API: 通过 Reflect 对象来表示,是方法集合,这些方法和代理能够重写的普通操作的行为一致。每一个proxy trap 都对应着一个 Reflect method,并且他们的签名一致。

1.trap

Each trap overrides some built-in behavior of Javascript objects, allowing you to intercept and modify the behavior

trap分类:

  • get(trapTarget, key, receiver) / set(trapTarget, key, value, receiver)
  • has(trapTarget, key)
  • deleteProperty(trapTarget, key) / defineProperty(trapTarget, key, descriptor)
  • getPrototypeof(trapTarget) / setPrototypeOf(trapTarget, proto)
  • isExtensible(trapTarget) / preventExtensions(trapTarget)
  • getOwnPropertyDescriptor(traoTarget, key)
  • ownKeys(trapTarget)
  • apply(trapTarget, thisArg, argumentsList) / construct(trapTarget, argumentsList)

对应的Reflect方法与之一致

2.简单的代理构造器

Proxy构造器包含2个参数:一个目标对象,一个handler对象包含trap方法

var target = {};
var proxy = new Proxy(target, {}); // 这个代理不包含trap

target.name = "james";
console.log(proxy.name); // "james"

二.验证属性--set, 对象形状验证--get

1.set

拦截书写写入(write),重写默认的set行为,属性设置成功返回true,反之false

4个参数:

  • trapTarget: 代理的目标;
  • key: 属性key(string 或 symbol);
  • value: 要写入的属性值;
  • receiver: 实际发生操作的对象,通常是代理本身

Reflect.set()是set trap相对应的反射方法。

比如加入想添加的属性值必须是数字类型,可以通过set来监视(inspect)传入的值:

var target = {name: "james"};
var proxy = new Proxy(target, {
    set(trapTarget, key, value, receiver) {
        
        // 忽略存在的值不受影响
        if (!trapTarget.hasOwnProperty(key)) {
            if (isNaN(value)) {
                throw new Error("property must be numeric");
            }
        }
        // 添加属性
        return Reflect.set(trapTarget, key, value, receiver);
    }
});

// 添加属性
proxy.age = 26;

// 因为target中已经存在"name"属性, 所以可以更改
proxy.name = "kobe"; // OK

// 再添加属性,不是数值, 抛出异常
// Uncaught error: property must be numeric
proxy.job = "software engineer";

// 同时目标对象通过反射,也会添加属性"age"
console.log(target); // {name: "kobe", age: 26}

2.get

拦截对象读取(read)行为

3个参数:

  • trapTarget: 代理的对象;
  • key: 属性key;
  • receiver: 实际发生操作的对象(通常是proxy本身)

javascript读取不存在的属性一般返回undefined,而其他语言读取不存在的属性一般抛出错误。

let target = {name: "james"};
console.log(target.age); // "undefined"

可以通过 get trap 和 Reflect.get()改变这种情况:

let proxy = new Proxy({}, {
    get(trapTarget, key, receiver) {
        // 此处使用receiver 而不是trapTarget,这是考虑到 has trap的原因,下面会讲到
        if (!(key in receiver)) {
            throw new TypeError(`property ${key} doesn't exist`);
        }
        return Reflect.get(trapTarget, key, receiver);
    }
});
proxy.name = "james";
// 读取
console.log(proxy.name); // "james" ok
// 不小心打错了name属性
console.log(proxy.nme); // throw error: property nme doesn't exist

三.隐藏属性的存在---has

拦截对象存在性

in 操作符对存在在对象自身或原型上的属性,返回true, 可以通过 has trap 拦截这种操作,当使用 "in" 操作符时, has trap将会被调用。

2个参数:

  • trapTarget: 代理的目标对象;
  • key: 用于检验的键

可以使用 hasReflect.has()来拦截这种操作

let target = {
    name: "james",
    age: 26
};
let proxy = new Proxy(target, {
    has(trapTarget, key) {
        if ("name" in trapTarget) {
            return false;
        } else {
            return Reflect.has(trapTarget, key);
        }
    }
});
console.log("name" in target); // false
console.log("toString" in target); // true

这也可以解释为什么上面的get trap中要使用 receiver, 而不是trapTarget来作为逻辑


四.阻止删除行为---deleteProperty

拦截删除行为

2个参数:

  • trapTarget: 代理的目标对象;
  • key: 拦截删除的键

delete操作符用于删除对象属性,如果删除成功返回true,失败false,对于 nonconfigurable 的属性, 在非严格模式下,返回false,对于严格模式则抛出异常。

let target = {
    name: "james",
    age: 26
};
let proxy = new Proxy(target, {
    deleteProperty(trapTarget, key) {
        // 禁止删除name属性
        if (key === "name") {
            return false;
        } else {
            return Reflect.deleteProperty(trapTarget, key);
        }
    }
});
delete proxy.name; // false
console.log("name" in proxy); // true
// 当然这些拦截行为都是针对代理对象而言的
// 直接删除目标对象属性是可以得,不过这样就失去了代理的意义了
delete target.name; // true

五.对象原型代理--getPrototypeOf / setPrototypeOf

代理允许拦截 Object.getPrototypeOf()Object.setPrototypeOf() 两个方法的执行。

原型代理的限制:

  1. getPrototypeOf trap 必须返回一个对象或者null,其余的返回值都不出现runtime error;
  2. setPrototypeOf trap 操作失败必须返回false, 这样 Object.setPrototypeOf()会抛出异常.如果返回其余值则Object.setPrototypeOf()操作成功

参数:

  • trapTarget: 代理的目标对象; getPrototypeOf trap只有这一个参数
  • proto: 原型对象
    let target = {};
    let proxy = new Proxy(target, {
        getPrototypeOf(trapTarget) {
            return null;
        },
        setPrototypeOf(trapTarget, proto) {
            return false;
        }
    });
    
    // 再次强调这些操作是针对代理自身的, 目标对象是不受影响的
    var targetProto = Object.getPrototypeOf(target);
    console.log(targetProto === Object.prototype); // true
    Object.setPrototypeOf(target, {}); // 成功

    var proxyProto = Object.getPrototypeOf(proxy); // 返回null
    console.log(proxyProto === Object.prototype); // false
    console.log(proxyProto); // null
    Object.setPrototypeOf(proxy); // 抛出错误

如果要使用默认的行为,则使用相应的Reflect方法

let target = {};
let proxy = new Proxy(target, {
    getPrototypeOf(trapTarget) {
        return Reflect.getPrototypeOf(trapTarget);
    },
    setPrototypeOf(trapTarget, proto) {
        return Reflect.setPrototypeOf(trapTarget, proto);
    }
});
// 这样target 和 proxy 都可以使用2个方法了

六.对象扩展性--isExtensible / preventExtensions

是否阻止对象的可扩展性

1个参数:

trapTarget: 代理的目标对象

let target = {};
let proxy = new Proxy(target, {
    isExtensible(trapTarget) {
        return Reflect.isExtensible(trapTarget);
    },
    // 使Object.preventExtensions()失效
    preventExtensions(trapTarget) {
        return false;
    }
});
console.log(Object.isExtensible(target)); // true
console.log(Object.isExtensible(proxy)); // true

Object.preventExtensions(proxy); // 无效

console.log(Object.isExtensible(target)); // true
console.log(Object.isExtensible(proxy)); // true

七.属性描述器---getOwnPropertyDescriptor

拦截调用Object.defineProperty() 和 Object.getOwnPropertyDescriptor()方法, 通过相应的拦截器

1.defineProperty

3个参数:

  • trapTarget: 代理的目标对象;
  • key: string 或者 symbol 属性;
  • descriptor: 对象属性的描述器

defineProperty拦截器如果操作成功返回true, 失败返回false

屏蔽属性定义

let proxy = new Proxy({}, {
    defineProperty(trapTraget, key, descriptor) {
        // 拦截symbol类型的属性
        if (typeof key === "symbol") {
            return false;
        }
        return Reflect.defineProperty(trapTarget, key, descriptor);
    }
});
Object.defineProperty(proxy, "name", {
    value: "james";
});   // 成功

var myId = Symbol("unique ID");
Object.defineProperty(proxy, myId, {
    value: 1234;
}); // 抛出错误

2.getOwnPropertyDescriptor

返回值为null, undefined或者一个对象

2个参数:

  • trapTarget: 代理的目标对象;
  • key: string 或者 symbol 属性;

对应的Reflect方法接受相同的参数, 描述器对应的属性只能有enumerable, wriable, configurable, get, set, value

let proxy = new Proxy({}, {
    defineProperty(trapTarget, key, descriptor) {
        console.log(trapTarget.value); // "value" 是允许的描述器
        console.log(trapTarget.name);  // "name" 不被允许
        return Reflect.defineProperty(trapTarget, key, descriptor); 
    }
});

Object.defineProperty(proxy, "name", {
    value: "proxy",
    name: "custom"
});
// 输出
// "proxy"
// "custom"

八.ownKeys

用于拦截内部属性[[OwnPropertyKeys]], 允许重写一个数组返回值内容,数组包括Object.keys(), Object.getOwnPropertyNames(), Object.getOwnPropertySymbols()和Object.assign();

1个参数:

  • trapTarget: 代理的目标对象;

必须返回一个数组或者类数组对象

let proxy = new Proxy({}, {
    ownKeys(trapTarget) {
        return Reflect.ownKeys(trapTarget).filter(key => {
            return typeof key !== "string" || key[0] !== "_";
        });
    }
});
let nameSymbol = Symbol("name");
proxy.name = "james";
proxy._name = "private";
proxy[nameSymbol] = "symbol";

let keys = Object.keys(proxy);
console.log(keys.length); // 1
console.log(keys[0]); // "james"

let names = Object.getOwnPropertyNames(proxy);
console.log(names.length); // 1
console.log(names[0]); // "james"

let symbols = Object.getOwnPropertySymbols(proxy);
console.log(symbols.length); // 1
console.log(symbols[0]); // "Symbol(name)"

九.函数的调用方式---apply / construct

拦截函数的调用方式

1.apply

3个参数:

  • trapTarget: 代理的目标对象;
  • thisArg: 函数调用时this的值
  • argumentsList: 传入的参数数组

2.construct

2个参数:

  • trapTarget: 代理的目标对象;
  • argumentsList: 传入的参数数组

十.revocable

有时候由于安全原因或者取消某些功能而取消代理,可以使用Proxy.revocable()方法,接受Proxy构造器相同的参数,返回一个对象,有如下2个属性:

  • proxy: 能够取消代理的proxy object;
  • revoke: the function to call to revoke the proxy;

当调用revoke()方法,则不能再对代理对象进行操作

let target = {
    name: "james"
};
// 创建一个可取消代理的对象, 使用解构赋值
let {proxy, revoke} = Proxy.revocable(target, {});
console.log(proxy.name); // "james"

// 取消代理
revoke();

// 再操作抛出错误
console.log(proxy.name); // error

总结

Proxy的出现使我们能够定义一些对象的非标准行为,由于篇幅原因有很多使用功能暂未涉及,比如proxy对象当作原型, 还有模拟数组的索引等功能都未讲到,这些希望以后能够在补充。

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

推荐阅读更多精彩内容

  • defineProperty() 学习书籍《ECMAScript 6 入门 》 Proxy Proxy 用于修改某...
    Bui_vlee阅读 649评论 0 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 官方中文版原文链接 感谢社区中各位的大力支持,译者再次奉上一点点福利:阿里云产品券,享受所有官网优惠,并抽取幸运大...
    HetfieldJoe阅读 6,546评论 3 22
  • 本人自学es6已经有一段时间了,只觉得有些时候很是枯燥无味, 时而又觉得在以后的职业生涯中会很有用,因为es6的很...
    可乐_37d3阅读 1,521评论 0 0
  • 此篇写于2009年10月—— 看过根据麦家小说改编的柳云龙版的《暗算》,也看过题材大同小异的麦家的小说《风声》,虽...
    陌上花开wen阅读 316评论 0 5