JS监听一个变量改变的两种方法

更新时间：2023年11月14日 11:37:24 作者：sorryhc

在业务中,由于项目采用微前端架构,需要通过A应用的某个值的变化对B应用中的DOM进行改变（如弹出一个Modal）,第一个想到的可能是发布订阅模式,其实不如将问题缩小化,采用原生的能力去解决,本文介绍了两种方法来使用JS监听一个变量改变,需要的朋友可以参考下

需求和背景

在业务中，由于项目采用微前端架构，需要通过A应用的某个值的变化对B应用中的DOM进行改变（如弹出一个Modal），第一个想到的可能是发布订阅模式，其实不如将问题缩小化，采用原生的能力去解决。

下面给出两种解决方案，同时也是尤大写Vue时的思路

ES5 的 Object.defineProperty
ES6 的 Proxy

Object.defineProperty

Object.defineProperty() 方法会直接在一个对象上定义一个新属性，或者修改一个对象的现有属性，并返回此对象

——MDN

用法如下：

Object.defineProperty(obj, prop, option)

入参用法：

obj：代理对象;
prop：代理对象中的key;
option：配置对象，get、set都在其中配置;

例子：

var obj = { 
  name: 'sorryhc' 
}
var rocordName = 'sorryhc';

Object.defineProperty(obj, 'name', {
  enumerable: true,
  configurable:true,
  set: function(newVal) {
      rocordName = newVal 
      console.log('set: ' + rocordName)
  },
  get: function() {
      console.log('get: ' + rocordName)
      return rocordName
  }
})

obj.name = 'sorrycc' // set: sorrycc
console.log(obj.name) // get: sorrycc

对一个对象进行整体响应式监听：

// 监视对象
function observe(obj) {
  // 遍历对象，使用 get/set 重新定义对象的每个属性值
   Object.keys(obj).forEach(key => {
       defineReactive(obj, key, obj[key])
   })
}

function defineReactive(obj, k, v) {
   // 递归子属性
   if (typeof(v) === 'object') observe(v)
   
   // 重定义 get/set
   Object.defineProperty(obj, k, {
       enumerable: true,
       configurable: true,
       get: function reactiveGetter() {
           console.log('get: ' + v)
           return v
       },
       // 重新设置值时，触发收集器的通知机制
       set: function reactiveSetter(newV) {
           console.log('set: ' + newV)
           v = newV
       },
   })
}

let data = {a: 1}
// 监视对象
observe(data)
data.a // get: 1
data.a = 2 // set: 2

整体思路就是遇到子对象就递归，和深拷贝一样的读参顺序。

缺陷

如果学习过Vue2源码的同学可能比较熟，基于下面的缺陷，也是出现了$set、$get的用法。

IE8 及更低版本 IE 是不支持的
无法检测到对象属性的新增或删除
如果修改数组的 length （ Object.defineProperty 不能监听数组的长度），以及数组的 push 等变异方法是无法触发 setter 的

Proxy

Proxy 对象用于创建一个对象的代理，从而实现基本操作的拦截和自定义（如属性查找、赋值、枚举、函数调用等）

— MDN

const obj = new Proxy(target, handler)

其中：

target ：要使用 Proxy 包装的目标对象（可以是任何类型的对象，包括原生数组，函数，甚至另一个代理）
handler ：一个通常以函数作为属性的对象，各属性中的函数分别定义了在执行各种操作时代理 obj 的行为

例子

const handler = {
  get: function(target, name){
      return name in target ? target[name] : 'no prop!'
  },
  set: function(target, prop, value, receiver) {
      target[prop] = value;
      console.log('property set: ' + prop + ' = ' + value);
      return true;
  }
};

var user = new Proxy({}, handler)
user.name = 'sorryhc' // property set: name = sorryhc

console.log(user.name) // sorryhc
console.log(user.age) // no prop!

并且Proxy提供了更丰富的代理能力：

getPrototypeOf / setPrototypeOf
isExtensible / preventExtensions
ownKeys / getOwnPropertyDescriptor
defineProperty / deleteProperty
get / set / has
apply / construct

感兴趣的可以查看 MDN ，一一尝试一下，这里不再赘述

在React中的实践

这里展示两段伪代码，大概业务流程是，当点击页面某个按钮（打开/关闭弹窗），触发window.obj.showModal的切换，从而被监听到全局变量的变化，从而改变React中的state状态，最终触发Modal的弹窗。

Object.defineProperty

window.obj = {
  showModal: false
}

const [visible, setVisible] = useState(false);

useEffect(() => {
  visible && Modal.show({
    // ...
  })
}, [visible])

Object.defineProperty(window.obj, 'showModal', {
  enumerable: true,
  configurable:true,
  set: function(newVal) {
    setVisible(newVal);
      console.log('set: ' + newVal)
  },
  get: function() {
      console.log('get: ' + visible)
      return visible
  }
})

window.obj.showModal = !window.obj.showModal // set: true
console.log(window.obj.showModal) // get: true

Proxy

const [visible, setVisible] = useState(false);

useEffect(() => {
  visible && Modal.show({
    // ...
  })
}, [visible])

const handler = {
  get: function(target, name){
      return name in target ? target[name] : 'no prop!'
  },
  set: function(target, prop, value, receiver) {
      target[prop] = value;
      setVisible(value);
      console.log('property set: ' + prop + ' = ' + value);
      return true;
  }
};

window.obj = new Proxy({showModal: false}, handler)
window.obj.showModal = !window.obj.showModal // property set: showModal = true

console.log(window.obj.showModal) // true

总结

Proxy 相比于 defineProperty 的优势：

基于 Proxy 和 Reflect ，可以原生监听数组，可以监听对象属性的添加和删除
不需要深度遍历监听：判断当前 Reflect.get 的返回值是否为 Object ，如果是则再通过 reactive 方法做代理，这样就实现了深度观测
只在 getter 时才对对象的下一层进行劫持(优化了性能)

而Proxy除了兼容性不足以外，其他方面的表示都优于Object.defineProperty。

所以，建议使用 Proxy 监测变量变化

以上就是JS监听一个变量改变的两种方法的详细内容，更多关于JS监听变量改变的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

javascript实现双端队列
这篇文章主要为大家详细介绍了使用javascript实现双端队列，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-11-11
Layui实现主窗口和Iframe层参数传递
今天小编就为大家分享一篇Layui实现主窗口和Iframe层参数传递，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2019-11-11
通过大白话理解微信小程序的授权登录
很多人会把微信小程序的登录和授权搞混淆,下面这篇文章主要给大家介绍了如何通过大白话理解微信小程序授权登录的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-12-12
javascript图片滑动效果实现
这篇文章主要介绍了超实用的javascript图片滑动效果实现方法,实例分析了javascript通过对页面元素与相关属性的操作实现滑动菜单效果的相关技巧，具有一定参考借鉴价值，需要的朋友可以参考下
2015-11-11
常见的原始JS选择器使用方法总结
常见的原始JS选择器有getElementById，getElementsByName，getElementsByTagName，就使用上为大家总结下
2014-04-04
js实现发送验证码后的倒计时功能
本文解决方案的基本思路是点击就将按钮设为disabled,然后根据cookie判断是否设置过期时间,将手机利用ajax提交到后台的发短信接口，就可以了
2015-05-05
javascript删除元素节点removeChild()用法实例
这篇文章主要介绍了javascript删除元素节点removeChild()用法,实例分析了removeChild()方法移除节点的使用技巧,需要的朋友可以参考下
2015-05-05
微信小程序实现多张照片上传功能
这篇文章主要介绍了微信小程序实现多张照片上传功能,当服务器的状态码为200且图片上传完毕后将图片的src转化为Json字符串存在数组中以便将其添加到数据库,本文通过实例代码介绍的非常详细,需要的朋友可以参考下
2024-03-03
ionic grid(栅格)九宫格制作详解
这篇文章主要为大家详细介绍了ionic grid九宫格的制作方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-06-06
JavaScript Array扩展实现代码
最近看了一下developer.mozilla.org里的东西，发现它为Array对象添加了不少generic method，赶得上Prototype的热心程度。
2009-10-10