CleanLiveData 隔绝 LiveData 数据回流(LiveData 数据/消息重复)

github地址

CleanLiveData

相同 LifecycleOwner、Observer 多次注册到 LiveData(比如在 onResume里注册,在 onPause 里反注册)时会重复收到粘滞数据,这种情况有博客描述为“数据倒灌”,我觉得叫“数据回流”也可以,不管叫什么,这种收到重复数据的现象相信在项目中应用到 Lifecycle 组件的同学应该都遇见过,而且针对这个问题应该也造好自己的轮子了,我这里记录的是我结合 LiveData 数据版本控制以及 SingleLiveEvent 数据过滤而实现的一种基本保持 LiveData 原本使用习惯的解决思路。

使用方法

防止数据回流的实现只有 CleanLiveData 这一个类,使用者把类直接 copy 到项目中的合适位置,然后用 CleanLiveData 替换掉原本的 MutableLiveData(如果你用的是 LiveData 的其他派生类,那么只要把 CleanLiveData 粘到项目里然后将超类 MutableLiveData 替换为你需要的类) 就好。

注:以下是类 CleanLiveData 的实现解析

数据的版本控制

在思考如何解决数据回流的时候我的第一反应就是能不能给每条数据和数据接收者 observer 都加上版本,然后在接收数据时判断当前数据的版本是不是新于也就是大于 observer 已经接收到的数据的版本,如果是新数据就处理,老数据就不处理。
不过在想要着手实施的时候就发现了这种实现的问题,就是代码的侵入性会很强,需要替换原有 observer 和数据类,这样的修改面积太大,相当于一次重构了。还是得想想有没有侵入性更低的办法。
其实答案就在 LiveData 的源码中,在 LiveData 分发数据时是有对数据和 observer 版本进行判断的操作的:

private void considerNotify(ObserverWrapper observer) {
        if (!observer.mActive) {
            return;
        }
        // Check latest state b4 dispatch. Maybe it changed state but we didn't get the event yet.
        //
        // we still first check observer.active to keep it as the entrance for events. So even if
        // the observer moved to an active state, if we've not received that event, we better not
        // notify for a more predictable notification order.
        if (!observer.shouldBeActive()) {
            observer.activeStateChanged(false);
            return;
        }
        // 版本判断就在这里
        if (observer.mLastVersion >= mVersion) {
            return;
        }
        observer.mLastVersion = mVersion;
        //noinspection unchecked
        observer.mObserver.onChanged((T) mData);
    }

就是此方法将数据分发到各个 observer 的 onChanged 回调中的,可以看到这个方法就是通过对 observer.mLastVersion >= mVersion 的比较来判断是否向 observer 发送数据的,那么这里就有个问题了,既然数据和 observer 都是有版本的怎么还会发生数据回流的现象呢?看方法的参数列表就可以发现这里的 observer 并不是我们注册时传入的 Observer 类型,而是一种新的 LiveData 私有的内部类型 ObserverWrapper,这个 ObserverWrapper 是个包装类,里面包装了 observer 和一个版本号,而这个包装类的实例是在每次注册调用
void observe(@NonNull LifecycleOwner owner, @NonNull Observer<? super T> observer)
方法时实例化的,这也就解释了为什么数据和 observer 都有版本号为什么还是会收到重复消息了,因为这里的 observer 并不是我们传入的那个 observer 而是一个经过包装的 ObserverWrapper,每次注册都会有一个新的 ObserverWrapper 新的 ObserverWrapper 的 mLastVersion 是默认值 -1,那么每次注册时就会收到一份粘滞数据也就是必然的了,这就是所谓的“设计如此”。
看到这里解题思路也就出来了,对数据添加版本的思路是没错的,我们只需要继承 LiveData(具体实现时 CleanLiveData 派生自 MutableLiveData 类,因为这个是 LiveData 比较常用的派生类,如果使用者有其他需求,依样画葫芦,选择合适的类继承就可以了) 类并重写 observer 方法,对传入的 observer 也进行一次包装,包装类干脆还叫 ObserverWrapper 好了,里面先不干别的,就做版本控制,不过这次的包装类对象并不是每次都实例化,而是存在一个 HashMap 里,如果 map 里不存在这个 observer 就新建一个并塞进去,如果存在就拿出来并调用 super.observer 方法注册。这样我们就有了自己的数据版本控制,而且不会每次新建,只要在数据分发的时候判断这个版本号就可以对 observer 进行过滤,收到过数据就不需要在分发了。
至于数据分发和版本判断部分就是借鉴的 SingleLiveEvent 里数据分发的部分了:


@MainThread
public void observe(LifecycleOwner owner, final Observer<? super T> observer) {
        if (hasActiveObservers()) {
                Log.w(TAG, "Multiple observers registered but only one will be notified of changes.");
        }

        // Observe the internal MutableLiveData
        super.observe(owner, new Observer<T>() {
                @Override
                public void onChanged(@Nullable T t) {
                        if (mPending.compareAndSet(true, false)) {
                             observer.onChanged(t);
                         }
                }
        });
}

对 observer 进行包装分发数据的时候添加判断,我们已经有了包装类 ObserverWrapper 了,只要在类的 onChange 方法中添加版本控制就可以了:

private boolean received(Observer<? super T> observer) {
        if (null != observerWrappers.get(observer.hashCode())) {
            ObserverWrapper observerWrapper = observerWrappers.get(observer.hashCode());
            // observer 上次接收到的消息版本大于等于当前消息的版本时跳过这个 observer
            if (observerWrapper.mLastVersion >= mVersion) {
                return true;
            } else {
                observerWrapper.mLastVersion = mVersion;
                return false;
            }
        }
        return false;
    }

    private class ObserverWrapper implements Observer<T> {
        final Observer<? super T> mObserver;
        /**
         * 记录 Observer 上次接收到的消息版本
         */
        int mLastVersion = -1;

        ObserverWrapper(Observer<? super T> observer) {
            mObserver = observer;
        }

        @Override
        public void onChanged(T t) {
            if (!received(mObserver)) {
                mObserver.onChanged(t);
            }
        }
    }

以上完毕

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