微信小程序实现watch属性监听数据变化

Vue 提供了一种通用的方式来观察和响应 Vue 实例上的数据变动:监听属性 watch。

虽然watch的滥用会导致性能不佳,但在一些情况下我们还是需要watch,使得代码更加简洁、逻辑更加清晰(其实就是嫌麻烦...)。

接下来我将逐步讲解微信小程序中如何实现一个监听器 watch,若想直接看最终代码,可直接滑动至底部。

监听器的原理,将data中需监听的属性写在watch对象中,并给其提供一个方法,当被监听属性的值改变时,调用该方法。

所以很显然,我们需要用到Javascript中的Object.defineProperty()方法,来手动劫持对象的getter/setter,从而实现给对象赋值时(调用setter),执行watch对象中相对应的函数,达到监听效果。Object.defineProperty()不在这里详细介绍,还不会使用的童鞋速戳这里-> Object.defineProperty()介绍。

首先,既然是微信小程序自定义watch属性,我建议直接将代码写在app.js内,需要使用的页面直接在onLoad()内调用getApp().setWatch(...)即可

    // app.js
 
    /**
     * 小程序初始化
     */
    onLaunch(){...} 
 
  /**
     * 设置监听器
     */
  setWatcher(data, watch,page) { // 接收index.js传过来的data对象和watch对象
      Object.keys(watch).forEach(v => { // 将watch对象内的key遍历
          this.observe(page,data, v,watch[v]); // 监听data内的v属性,传入watch内对应函数以调用
      })
  },
  /**
   * 监听属性 并执行监听函数
   */
  observe(page,obj, key,watchFun) {
    var val = obj[key]; // 给该属性设默认值
    Object.defineProperty(obj, key, {
        configurable: true,
        enumerable: true,
        set: function(value) {
            console.log(value,val)
            // val = value;//这里赋值会导致newValue oldValue一样
            watchFun.call(page,value,val); // 赋值(set)时,调用对应函数
        },
        get: function() {
            return val;
        }
    })
  }

此时在index.js中已经可以实现简单的属性监听:

  /**
   * 生命周期函数--监听页面加载
   */
  onLoad: function (options) {
    // this.getBrandList();
    getApp().setWatcher(this.data, this.watch,this); // 设置监听器
    this.setData({
        name:'fuYang1111'
    })
  },
  watch:{
    name:function(newValue,oldValue){
        console.log(newValue,oldValue); // name改变时,调用该方法输出新值。
    }
  },

我们可以看到,index页面启动后,name被赋值成'lxm',同时触发其setter,调用watch内的name()方法,控制台打印出 lxm。

是不是挺简单的呢?掌握了这一点,接下来的事情就好办多了。

我们知道,Vue中 watch对象内不光是能写name、age这类属性,还能用引号写出'my.name'、'my.age'这类属性,即对my对象下的name、age进行监听。 我们只需要改进一下setWatcher方法:
我们需要修改一下app.js中的两个函数:

    /**
     * 设置监听器
     */
    setWatcher(page) {
        let data = page.data;
        let watch = page.watch;
        Object.keys(watch).forEach(v => {
            let key = v.split('.'); // 将watch中的属性以'.'切分成数组
            let nowData = data; // 将data赋值给nowData
            for (let i = 0; i < key.length - 1; i++) { // 遍历key数组的元素,除了最后一个!
                nowData = nowData[key[i]]; // 将nowData指向它的key属性对象
            }
            let lastKey = key[key.length - 1];
            // 假设key==='my.name',此时nowData===data['my']===data.my,lastKey==='name'
            let watchFun = watch[v].handler || watch[v]; // 兼容带handler和不带handler的两种写法
            let deep = watch[v].deep; // 若未设置deep,则为undefine
            this.observe(nowData, lastKey, watchFun, deep, page); // 监听nowData对象的lastKey
        })
    },
    /**
     * 监听属性 并执行监听函数
     */
    observe(obj, key, watchFun, deep, page) {
        var val = obj[key];
        // 判断deep是true 且 val不能为空 且 typeof val==='object'(数组内数值变化也需要深度监听)
        if (deep && val != null && typeof val === 'object') { 
            Object.keys(val).forEach(childKey=>{ // 遍历val对象下的每一个key
                this.observe(val,childKey,watchFun,deep,page); // 递归调用监听函数
            })
        }
        var that = this;
        Object.defineProperty(obj, key, {
            configurable: true,
            enumerable: true,
            set: function(value) {
                // 用page对象调用,改变函数内this指向,以便this.data访问data内的属性值
                watchFun.call(page,value,val); // value是新值,val是旧值
                val = value;
                if(deep){ // 若是深度监听,重新监听该对象,以便监听其属性。
                    that.observe(obj, key, watchFun, deep, page); 
                }
            },
            get: function() {
                return val;
            }
        })
    }

其中需要特别注意,若是data中先声明一个对象userInfo = {},再给userInfo赋值一个对象(比如从服务器获取用户数据),则需要重新遍历监听才能实现深度监听,故需加上这段代码:

if(deep){ // 若是深度监听,重新监听该对象,以便监听其属性。
that.observe(obj, key, watchFun, deep);
}

此时index.js中需要深度监听的属性,可以这样写:

//index.js
 
Page({
    data: {
        my: {
            name: 'xuyang',
            age: 21,
            hobby: ['girls', 'games']
        },
        nameInfo:{}
    },
    onLoad() {
        getApp().setWatcher(this);
        this.data.my.hobby[0] = 'study';
        this.setData({
            nameInfo:{name:'haha',sex:'boy'}
        })
        console.log(this.data)
    },
    watch: {
        my:{
            handler(newValue) {
                console.log(newValue);
            },
            deep:true
        }
    }
})

控制台中首先输出 study ,接着输出{ name: 'haha', sex: 'boy' },接着输出this.data的值,如下图:


image.png

可见my对象以及内部的所有属性都有setter/getter,nameInfo对象内也都有setter/getter,深度监听完成。

注:watch只能监听已存在的属性,数组的push(),pop()等方法并不会触发监听函数哦~
————————————————
原文链接:https://blog.csdn.net/xuyangxinlei/article/details/81408200

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

推荐阅读更多精彩内容