本文旨在解决当实例字段为数组时，如何监听数组的变动（例如 push 或 splice 操作）并执行额外任务的问题。通过使用 JavaScript 的 Proxy 对象，我们可以拦截对数组 length 属性的修改，从而在数组发生变化时触发自定义逻辑，例如更新 sessionStorage。本文将提供详细的代码示例和解释，帮助开发者理解和应用这一技术。
当我们需要在一个类的实例字段（该字段是一个数组）发生变化时，执行一些额外的操作，比如更新 sessionStorage，直接使用 set 访问器是无法实现的。因为 push、splice 等数组方法并不会触发 set 访问器。 为了解决这个问题，我们可以使用 JavaScript 的 Proxy 对象。
使用 Proxy 监听数组变动
Proxy 对象可以拦截对象的操作，包括属性的读取、赋值、删除等。我们可以创建一个 Proxy 对象来代理数组，并拦截对数组 length 属性的修改。当数组的 length 属性发生变化时，我们就可以执行额外的任务。
以下是一个示例代码：
class Environment {
constructor() {
// 初始化数组，从 sessionStorage 获取或创建一个空数组
const crumbList =
JSON.parse(sessionStorage.getItem('crumbs') ?? null) ?? [];
this.crumbs = new Proxy(crumbList, {
set(obj, prop, value) {
// debugger; // 可以使用 debugger 进行调试
// console.log({ obj, prop, value }); // 打印相关信息
// 执行默认的 set 操作
const result = Reflect.set(...arguments);
// 只有当修改的是 length 属性时，才执行额外的任务
if (prop === 'length') {
// 更新 sessionStorage
sessionStorage.setItem('crumbs', JSON.stringify(crumbList));
}
return result;
}
});
// 添加 valueOf 方法，返回数组的浅拷贝
Object.defineProperty(this.crumbs, 'valueOf', {
value: function valueOf () {
return [...crumbList];
},
});
}
}
const env = new Environment();
const metricId = 6;
const concept = 'Back orders';
const crumb = { metricId, concept };
env.crumbs.push(crumb);
env.crumbs.push('foo');
env.crumbs.push('bar');
env.crumbs.length = 5;
env.crumbs.push('baz');
env.crumbs.push('biz');
env.crumbs.length = 9;
console.log('... after initial `push` operations and `crumbs.length` changes ...');
console.log({ "current value": env.crumbs });
env.crumbs.shift();
env.crumbs.pop();
env.crumbs.pop();
console.log('... after `shift` and `pop` operations ...');
console.log({ "current value": env.crumbs });
env.crumbs.splice(1, 3);
console.log('... after a final `splice` operation ...');
console.log({ "current valueOf()": env.crumbs.valueOf() });
console.log({ "currently stored JSON": sessionStorage.getItem('crumbs') });代码解释：
- Environment 类: 该类维护一个名为 crumbs 的数组属性，该属性实际上是一个 Proxy 对象。
-
constructor 构造函数:
- 从 sessionStorage 中尝试获取名为 'crumbs' 的数据，如果存在则解析为 JSON，否则初始化为空数组。
- 创建 Proxy 对象，并将 crumbList 作为目标对象。
- set 陷阱函数拦截对 Proxy 对象属性的设置操作。
- 在 set 陷阱函数中，首先使用 Reflect.set(...arguments) 执行默认的属性设置操作。
- 判断被设置的属性是否为 length，如果是，则将 crumbList 转换为 JSON 字符串并存储到 sessionStorage 中。
- 添加 valueOf 方法，返回数组的浅拷贝，方便查看数组内容。
- Proxy 对象: Proxy 对象的第二个参数是一个处理程序对象，该对象定义了拦截操作。在本例中，我们只定义了 set 陷阱函数，用于拦截属性设置操作。
-
set 陷阱函数:
- obj: 目标对象（即 crumbList 数组）。
- prop: 被设置的属性名。
- value: 被设置的属性值。
- Reflect.set(...arguments): 用于执行默认的属性设置操作。如果不执行该操作，则属性设置将不会生效。
- sessionStorage.setItem('crumbs', JSON.stringify(crumbList)): 将 crumbList 数组转换为 JSON 字符串并存储到 sessionStorage 中。
注意事项：
- Proxy 对象只能拦截对 Proxy 对象本身的操作。如果直接操作目标对象（即 crumbList 数组），则 Proxy 对象将不会生效。
- Reflect.set(...arguments) 必须被调用，否则属性设置将不会生效。
- 该方法只监听 length 属性的变化，这意味着只有当数组的长度发生变化时，才会触发额外的任务。如果只是修改数组中的元素，而数组的长度没有变化，则不会触发额外的任务。
总结
通过使用 Proxy 对象，我们可以方便地监听数组的变动并执行额外的任务。这种方法可以应用于各种场景，例如数据同步、状态管理等。希望本文能够帮助读者理解和应用这一技术。
