ECMAScript 6学习(六)

defineProperty()

学习书籍《ECMAScript 6 入门 》

Proxy


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

Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。Proxy 这个词的原意是代理,用在这里表示由它来“代理”某些操作,可以译为“代理器”。

Proxy 构造函数

var proxy = new Proxy(target,handler);

Proxy 对象的所有用法,都是上面这种形式,不同的只是handler参数的写法。其中,new Proxy()表示生成一个Proxy实例,target参数表示所要拦截的目标对象,handler参数也是一个对象,用来定制拦截行为。

实例代码:

var handler = {

    get: function(target, name) {

        if (name === 'prototype') {

            return Object.prototype;

        }

        return 'Hello, ' + name;

    },

    apply: function(target, thisBinding, args) {

        return args[0];

    },

   construct: function(target, args) {

        return {value: args[1]};

    }

};

var fproxy = new Proxy(function(x, y) {

    return x + y;

  }, handler);

fproxy(1, 2)  // 1

new fproxy(1,2) // {value: 2}

fproxy.prototype === Object.prototype // true

fproxy.foo // "Hello, foo"

下面是 Proxy 支持的拦截操作一览。

(1)get(target, propKey, receiver)

拦截对象属性的读取,比如proxy.fooproxy['foo']

最后一个参数receiver是一个对象,可选,参见下面Reflect.get的部分。

(2)set(target, propKey, value, receiver)

拦截对象属性的设置,比如proxy.foo = vproxy['foo'] = v,返回一个布尔值。

(3)has(target, propKey)

拦截propKey in proxy的操作,返回一个布尔值。

(4)deleteProperty(target, propKey)

拦截delete proxy[propKey]的操作,返回一个布尔值。

(5)ownKeys(target)

拦截Object.getOwnPropertyNames(proxy)Object.getOwnPropertySymbols(proxy)Object.keys(proxy),返回一个数组。该方法返回目标对象所有自身的属性的属性名,而Object.keys()的返回结果仅包括目标对象自身的可遍历属性。

(6)getOwnPropertyDescriptor(target, propKey)

拦截Object.getOwnPropertyDescriptor(proxy, propKey),返回属性的描述对象。

(7)defineProperty(target, propKey, propDesc)

拦截Object.defineProperty(proxy, propKey, propDesc)Object.defineProperties(proxy, propDescs),返回一个布尔值。

(8)preventExtensions(target)

拦截Object.preventExtensions(proxy),返回一个布尔值。

(9)getPrototypeOf(target)

拦截Object.getPrototypeOf(proxy),返回一个对象。

(10)isExtensible(target)

拦截Object.isExtensible(proxy),返回一个布尔值。

(11)setPrototypeOf(target, proto)

拦截Object.setPrototypeOf(proxy, proto),返回一个布尔值。

如果目标对象是函数,那么还有两种额外操作可以拦截。

(12)apply(target, object, args)

拦截 Proxy 实例作为函数调用的操作,比如proxy(...args)proxy.call(object, ...args)proxy.apply(...)

(13)construct(target, args)

拦截 Proxy 实例作为构造函数调用的操作,比如new proxy(...args)

get()

下面的例子使用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

该例子,通过判定index来对数组的角标返回值进行拦截过滤

if(index<0){

    propKey=String(target.length+index);

}

即当index小于0时,propkey也就是 arr[-1]  传入的-1的index,对其进行修改,让 propkey的值变为 (target.length+index)= 3+(-1)=2;

然后执行反射函数 Reflect;

Reflect.get(target, propKey, receiver)

通过字面意思翻译以及上面代码的返回值 可猜测到  Refect为反射函数;

而该句的意思为:用过Reflect 调用 拦截对象 本身的get方法执行;


利用 Proxy,可以将读取属性的操作(get),转变为执行某个函数,从而实现属性的链式操作。


var pipe = (function () {

    return function (value) {

        var funcStack = [];

       var oproxy = new Proxy({} , {

            get : function (pipeObject, fnName) {

                if (fnName === 'get') {

                   return funcStack.reduce(function (val, fn) {

                        return fn(val);

                   },value);

                 }

                funcStack.push(window[fnName]);

                return oproxy;

          }

       });

        return oproxy;

      }

    }());

var double = n => n * 2;

var pow    = n => n * n;

var reverseInt = n => n.toString().split("").reverse().join("") | 0;

pipe(3).double.pow.reverseInt.get; // 63

该例子用到了一个没见过的方法也就是reduce();通过百度知道了 这是Array 数组里面的一个方法;

reduce()对数组中的所有元素调用指定的回调函数。该回调函数的返回值为累积结果,并且此返回值在下一次调用该回调函数时作为参数提供。

reduce()

也就是说reduce方法的第一个参数是回调函数,函数格式如下


reduce方法的回调函数

而回调函数的第一个参数为上次回调的值,如果首次调用该函数,则参数的值为initalValue.

所以

funcStack.reduce(function (val, fn) {

return fn(val);

},value);

该行代码的执行结果为: 

  第一次调用  val = value = 3  ;  fn =  n => n * 2  ;   return 值 : 3*2 = 6;

  第二次调用  val = 6 ; value = 3  ;  fn =  n => n * n ;  return 值 : 6*6 = 36;

  第三次调用  val = 36 ; value = 3  ;  fn =  n =>n.toString().split("").reverse().join("") | 0  ;  

                       return 值 :把36变成字符串 然后分割 反转 变成 '63' ,在转换成 数字  63;

因此,最后的执行结果为 63 .


set()

set方法用来拦截某个属性的赋值操作。

假定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 // 100

person.age = 'young' // 报错

person.age = 300 // 报错


apply()

apply方法拦截函数的调用、callapply操作。

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) // 6

proxy.call(null, 5, 6) // 22

proxy.apply(null, [7, 8]) // 30

上面代码中,每当执行proxy函数(直接调用或call和apply调用),就会被apply方法拦截。

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

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


has()

has方法用来拦截HasProperty操作,即判断对象是否具有某个属性时,这个方法会生效。典型的操作就是in运算符。

下面的例子使用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

上面代码中,如果原对象的属性名的第一个字符是下划线,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

// true

for (let a in oproxy1) {

console.log(oproxy1[a]);

}

// 张三

// 59

for (let b in oproxy2) {

console.log(oproxy2[b]);

}

// 李四

// 99

上面代码中,has拦截只对in循环生效,对for...in循环不生效,导致不符合要求的属性没有被排除在for...in循环之外。


construct()

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

var handler = {

    construct (target, args, newTarget) {

        return new target(...args);

    }

};

construct方法返回的必须是一个对象,否则会报错。

construct方法可以接受两个参数。

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


deleteProperty()

deleteProperty方法用于拦截delete操作,如果这个方法抛出错误或者返回false,当前属性就无法被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

上面代码中,deleteProperty方法拦截了delete操作符,删除第一个字符为下划线的属性会报错。

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


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

注意,如果目标对象不可扩展(extensible),则defineProperty不能增加目标对象上不存在的属性,否则会报错。另外,如果目标对象的某个属性不可写(writable)或不可配置(configurable),则defineProperty方法不得改变这两个设置。


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

// undefined

Object.getOwnPropertyDescriptor(proxy, '_foo')

// undefined

Object.getOwnPropertyDescriptor(proxy, 'baz')

// { value: 'tar', writable: true, enumerable: true, configurable: true }

上面代码中,handler.getOwnPropertyDescriptor方法对于第一个字符为下划线的属性名会返回undefined


getPrototypeOf()

getPrototypeOf方法主要用来拦截Object.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

上面代码中,getPrototypeOf方法拦截Object.getPrototypeOf(),返回proto对象。

注意,getPrototypeOf方法的返回值必须是对象或者null,否则报错。另外,如果目标对象不可扩展(extensible),getPrototypeOf方法必须返回目标对象的原型对象。


isExtensible() 

isExtensible方法拦截Object.isExtensible操作。

var p = new Proxy({}, {

    isExtensible: function(target) {

        console.log("called");

        return true;

    }

});

Object.isExtensible(p)

// "called"

// true

上面代码设置了isExtensible方法,在调用Object.isExtensible时会输出called

注意,该方法只能返回布尔值,否则返回值会被自动转为布尔值。

这个方法有一个强限制,它的返回值必须与目标对象的isExtensible属性保持一致,否则就会抛出错误。


ownKeys()

ownKeys方法用来拦截以下操作。

    --Object.getOwnPropertyNames()

    --Object.getOwnPropertySymbols()

    --Object.keys()

注意,使用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),结果都被自动过滤掉。


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方法返回true,但这时Object.isExtensible(proxy)会返回true,因此报错。

为了防止出现这个问题,通常要在proxy.preventExtensions方法里面,调用一次Object.preventExtensions

var p = new Proxy({}, {

    preventExtensions: function(target) {

         console.log('called');

        Object.preventExtensions(target);

        return true;

    }

});

Object.preventExtensions(p)

// "called"

// true


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

上面代码中,只要修改target的原型对象,就会报错。

注意,该方法只能返回布尔值,否则会被自动转为布尔值。另外,如果目标对象不可扩展(extensible),setPrototypeOf方法不得改变目标对象的原型。


Proxy.revocable()

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

let target = {};

let handler = {};

let {proxy, revoke} = Proxy.revocable(target, handler);

proxy.foo = 123;

proxy.foo // 123

revoke();

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() // false

proxy.m()  // true

上面代码中,一旦proxy代理target.m,后者内部的this就是指向proxy,而不是target


实例:Web 服务的客户端

Proxy 对象可以拦截目标对象的任意属性,这使得它很合适用来写 Web 服务的客户端。

const service = createWebService ('http://example.com/data');

service.employees().then(json => {

    const employees = JSON.parse(json);

    // ···

});

上面代码新建了一个 Web 服务的接口,这个接口返回各种数据。Proxy 可以拦截这个对象的任意属性,所以不用为每一种数据写一个适配方法,只要写一个 Proxy 拦截就可以了。

function createWebService(baseUrl) {

    return new Proxy({}, {

        get(target, propKey, receiver) {

         return () => httpGet(baseUrl+'/' + propKey);

        }

    });

}

同理,Proxy 也可以用来实现数据库的 ORM 层。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,490评论 18 139
  • 本人自学es6已经有一段时间了,只觉得有些时候很是枯燥无味, 时而又觉得在以后的职业生涯中会很有用,因为es6的很...
    可乐_37d3阅读 1,498评论 0 0
  • Proxy代理是一个共通的概念,可以起到拦截的作用。ES6里将Proxy标准化了,提供了Proxy构造函数,用来生...
    张歆琳阅读 10,131评论 1 7
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,670评论 0 9
  • 上了贼船,就跟贼走。走自己的路,和爱情兵分两路。是狼就炼好牙,是羊就炼好腿。 都说姐漂亮,其实都是妆出来的小鸟虽小...
    jianghu000阅读 199评论 0 1