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.foo和proxy['foo']园爷。
最后一個參數receiver是一個對象宠蚂,可選,參見下面Reflect.get的部分童社。
(2)set(target, propKey, value, receiver)
攔截對象屬性的設置求厕,比如proxy.foo = v或proxy['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攔截诗鸭,實現(xiàn)數組讀取負數的索引。
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的值變?yōu)?(target.length+index)= 3+(-1)=2;
然后執(zhí)行反射函數 Reflect;
Reflect.get(target, propKey, receiver)
通過字面意思翻譯以及上面代碼的返回值 可猜測到? Refect為反射函數;
而該句的意思為:用過Reflect 調用 攔截對象 本身的get方法執(zhí)行;
利用 Proxy参滴,可以將讀取屬性的操作(get)强岸,轉變?yōu)閳?zhí)行某個函數,從而實現(xiàn)屬性的鏈式操作砾赔。
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方法的第一個參數是回調函數,函數格式如下
而回調函數的第一個參數為上次回調的值,如果首次調用該函數,則參數的值為initalValue.
所以
funcStack.reduce(function (val, fn) {
return fn(val);
},value);
該行代碼的執(zhí)行結果為:?
? 第一次調用? 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;
因此,最后的執(zhí)行結果為 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方法攔截函數的調用脆诉、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) // 6
proxy.call(null, 5, 6) // 22
proxy.apply(null, [7, 8]) // 30
上面代碼中宫仗,每當執(zhí)行proxy函數(直接調用或call和apply調用)够挂,就會被apply方法攔截。
另外藕夫,直接調用Reflect.apply方法孽糖,也會被攔截。
Reflect.apply(proxy,null,[9,10])// 38
has()
has方法用來攔截HasProperty操作毅贮,即判斷對象是否具有某個屬性時办悟,這個方法會生效。典型的操作就是in運算符嫩码。
下面的例子使用has方法隱藏某些屬性誉尖,不被in運算符發(fā)現(xiàn)。
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運算符發(fā)現(xiàn)丢间。
如果原對象不可配置或者禁止擴展探熔,這時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循環(huán)也用到了in運算符嚎货,但是has攔截對for...in循環(huán)不生效橘霎。
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循環(huán)生效殖属,對for...in循環(huán)不生效姐叁,導致不符合要求的屬性沒有被排除在for...in循環(huán)之外。
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梯皿,因此報錯仇箱。
為了防止出現(xiàn)這個問題,通常要在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實例犯眠。上面代碼中按灶,當執(zhí)行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 也可以用來實現(xiàn)數據庫的 ORM 層。