之前看过阮老师在《ECMAScript 6 入门》中写的proxy,不过没有使用过很快便忘记了。。今天在一篇文章中看到了用proxy实现了链式取值(我们写代码时经常有这种写法:res.data && res.data.a ? res.data.a : ''; 因为如果res==={}的话直接res.data.a就会报错)。这个实现就可以在取值时不报错并且可以赋默认值
function pointer(obj, path = []) {
return new Proxy(function(){}, {
get (target, property) {
return pointer(obj, path.concat(property))
},
apply (target, self, args) {
let val = obj;
let parent;
for(let i = 0; i < path.length; i++) {
if(val === null || val === undefined) break;
parent = val;
val = val[path[i]]
}
if(val === null || val === undefined) {
val = args[0]
}
return val;
}
})
}
其实就是在读取属性的时候保存了属性名,最后执行方法的时候判断并读取属性值,没有该属性的话就赋默认值。
出处:文章链接
文章中有一点错误就是new Proxy()的第一个参数是对象,应该是一个函数,因为apply拦截的是函数调用的操作。
借着这个例子又看了一遍proxy,顺便做个笔记加强一下印象 ^_^
概述
proxy的中文意思是“代理”,这也很形象的说明了它的功能,就是所有对对象的操作,访问也好赋值也好都必须经过它的一层处理。
语法
let proxy = new Proxy(target, handler);
- target: 表示所要拦截的目标对象(对象、数组、函数等都可以)
- handler:也是一个对象,用来定制拦截行为
注:要想Proxy起作用,必须针对Proxy实例进行操作,而不是目标对象
如果handler是个空对象,将没有任何拦截效果,访问proxy相当于访问target
例:
var obj = {};
var proxy = new Proxy(obj, {
get: (target, prop) => {
console.log('取值啦');
return target[prop];
},
set: (target, prop, value) => {
console.log('赋值啦');
target[prop] = value;
}
})
proxy.a = 1
// 赋值啦
obj.a = 2;
proxy.a;
// 取值啦
// 2
obj.a;
// 2
拦截方法
-
get(target, prop, receiver) 拦截对象属性的读取操作
- target: 目标对象
- prop:属性名
- receriver: proxy实例本身(可选参数)
如果一个属性不可配置(configurable)且不可写(writable),则 Proxy 不能修改该属性,否则通过 Proxy 对象访问该属性会报错。
例一,访问不存在的属性抛出错误:
var person = {
name: "张三"
};
var proxy = new Proxy(person, {
get: (target, property) => {
if (property in target) {
return target[property];
} else {
throw new ReferenceError("Property \"" + property + "\" does not exist.");
}
}
});
proxy.name // "张三"
proxy.age // 抛出一个错误
例二,实现数组读取负数的索引:
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
-
set(target, prop, value, receiver) 拦截属性的赋值操作
- target: 目标对象
- prop:属性名
- value: 属性值
- receriver: proxy实例本身(可选参数)
如果目标对象自身的某个属性,不可写且不可配置,那么set方法将不起作用。
例一,数据验证:
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 // 报错
对person对象的age属性进行验证,必须是不大于200的整数。
例二,验证内部属性(以_开头),保证不被外部读写:
const handler = {
get (target, key) {
invariant(key, 'get');
return target[key];
},
set (target, key, value) {
invariant(key, 'set');
target[key] = value;
return true;
}
};
function invariant (key, action) {
if (key[0] === '_') {
throw new Error(`Invalid attempt to ${action} private "${key}" property`);
}
}
const target = {};
const proxy = new Proxy(target, handler);
proxy._prop
// Error: Invalid attempt to get private "_prop" property
proxy._prop = 'c'
// Error: Invalid attempt to set private "_prop" property
-
apply(target, object, args):拦截 Proxy 实例作为函数调用的操作,比如proxy(...args)、proxy.call(object, ...args)、proxy.apply(...)。
- target: 目标对象
- object:目标对象的上下文对象(this)
- 目标对象的参数数组
例:
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
4.construct(target, args): 拦截Proxy实例作为构造函数调用的操作,如new proxy(...args)。
- target:目标对象
- args:构造函数的参数对象
construct必须返回一个对象,否则会报错
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
5.has(target, propKey), 拦截in运算符,例如propKey in proxy的操作,但是对for...in循环不生效。返回一个布尔值
- target:目标对象
- propKey:属性名
例,拦截特殊属性不被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
-
ownKeys(target):
拦截以下操作:- Object.getOwnPropertyNames(proxy)
- Object.getOwnPropertySymbols(proxy)
- Object.keys(proxy)
- for...in循环
返回一个数组。该方法返回目标对象所有自身的属性的属性名,而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']
拦截for...in循环:
const obj = { hello: 'world' };
const proxy = new Proxy(obj, {
ownKeys: function () {
return ['a', 'b'];
}
});
for (let key in proxy) {
console.log(key); // 没有任何输出, 因为a、b 属性并不在obj对象内
}
ownKeys方法返回的数组成员,只能是字符串或 Symbol 值
。如果有其他类型的值,或者返回的根本不是数组,就会报错。
var obj = {};
var p = new Proxy(obj, {
ownKeys: function(target) {
return [123, true, undefined, null, {}, []];
}
});
Object.getOwnPropertyNames(p)
// Uncaught TypeError: 123 is not a valid property name
如果目标对象自身包含不可配置的属性,则该属性必须被ownKeys方法返回,否则报错。
var obj = {};
Object.defineProperty(obj, 'a', {
configurable: false,
enumerable: true,
value: 10 }
);
var p = new Proxy(obj, {
ownKeys: function(target) {
return ['b'];
}
});
Object.getOwnPropertyNames(p)
// Uncaught TypeError: 'ownKeys' on proxy: trap result did not include 'a'
如果目标对象是不可扩展的(non-extensible),这时ownKeys方法返回的数组之中,必须包含原对象的所有属性,且不能包含多余的属性,否则报错。
var obj = {
a: 1
};
Object.preventExtensions(obj);
var p = new Proxy(obj, {
ownKeys: function(target) {
return ['a', 'b'];
}
});
Object.getOwnPropertyNames(p)
// Uncaught TypeError: 'ownKeys' on proxy: trap returned extra keys but proxy target is non-extensible
这里就列出使用频率比较高的几个实例方法,更详细的请看阮大大的文章哦~