Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kunminx/unpeek-livedata

LiveData 数据倒灌：别问，问就是不可预期 - Perfect alternative to SingleLiveEvent, supporting multiple observers.
https://github.com/kunminx/unpeek-livedata

android androidx event eventbus jetpack jetpack-android lifecycle livedata livedata-viewmodel livedatabus singlelivedata singleliveevent

Last synced: about 1 month ago
JSON representation

LiveData 数据倒灌：别问，问就是不可预期 - Perfect alternative to SingleLiveEvent, supporting multiple observers.

Awesome Lists containing this project

README 

        
![](https://images.xiaozhuanlan.com/photo/2022/11110ff4abb5e546b05031baee3ea97e.png)



## 背景



LiveData 是效仿响应式编程 BehaviorSubject 的设计，由于



1.Jetpack 架构示例通常只包含 “表现层” 和 “数据层” 两层，缺乏在 “领域层” 分发数据的工具，



2.LiveData Observer 的设计缺乏边界感，



容易让开发者误当做 “一次性事件分发组件” 来使用，造成订阅时 "自动回推脏数据"；



容易让开发者误将同一控件实例放在多个 Observer 回调中 造成恢复状态时 “数据不一致” 等问题（具体可参见[《MVI 存在意义》篇](https://juejin.cn/post/7145317979708735496) 关于 “响应式编程漏洞” 的描述）



3.DataBinding ObservableField 组件的 Observer 能限定为 "与控件一对一绑定"，更适合承担表现层 BehaviorSubject 工作，



4.LiveData 具备生命周期安全等优势，



因此决定将 LiveData 往领域层 PublishSubject 方向改造，去除其 “自动推送最后一次状态” 的能力，使其专职生命周期安全的数据分发，



 



## 框架现状



> **Note 2023.4.25：**



由于 LiveData 存在的初衷并非是专业的 “一次性事件分发组件”，改造过的 UnPeekLiveData 也只适用于 “低频次数据分发（例如每秒推送 1 次）” 场景，



因而若想满足 “高频次事件分发” 需求（例如每秒推送 5 次以上），请改用或参考专职 “领域层” 数据分发的 [MVI-Dispatcher](https://github.com/KunMinX/MVI-Dispatcher) 组件，该组件内部通过消息队列设计，确保不漏掉每一次推送。



> **Note 2021.8.20：**



腾讯音乐小伙伴贡献过 v5 版重构代码，用于月活过亿 “生产环境” 痛点治理。



最新版基于 2021 年 8 月小伙伴 RebornWolfman 贡献 v7 版重构代码，稳定运行至今。



为契合消息分发语义，我们于最新版加入 MutableResult/Result 类命名。



 



- - - - - - - - - - - - - - -



 



## 前言



大家好，我是[《Jetpack MVVM Best Practice》](https://github.com/KunMinX/Jetpack-MVVM-Best-Practice)作者 KunMinX。



今天提到 “数据倒灌” 一词，缘于我为方便理解和记忆 **“再入二级页面时收到旧数据推送” 情况**，而于 2019 年 **自创并在网上传播的关于此类现象概括**。



它主要发生于：SharedViewModel + LiveData 组合实现页面通信场景。



 



## 背景



由于本文目标是介绍官方 Demo 现有解决方案缺陷，及经过 2 年迭代趋于完美解决方案，



所以我们假设在座诸位对最基本 “背景缘由” 有一定了解，知道：



> 为何 LiveData 默认被设计为粘性事件



> 为何 [官方文档 ](https://developer.android.google.cn/topic/libraries/architecture/viewmodel#sharing) 推荐使用 SharedViewModel + LiveData（文档没明说，事实上包含三个关键背景缘由）



> 乃至为何存在 “数据倒灌” 现象



> 及为何 “页面通信” 场景下，不用静态单例或 EventBus、LiveDataBus 等消息总线，



如对这些 “前置知识” 也尚无体会，可结合个人兴趣前往[《LiveData 数据倒灌 背景缘由全貌 独家解析》](https://xiaozhuanlan.com/topic/6719328450)查阅，此处不再累述。



 



## 现有解决方案及各自缺陷



在[《Jetpack MVVM 精讲》](https://juejin.im/post/5dafc49b6fb9a04e17209922)中我们分别提到 **Event 事件包装器、反射方式、SingleLiveEvent** 三种方式解决 “数据倒灌” 问题。它们分别来自文中提到的[外网](https://medium.com/androiddevelopers/livedata-with-snackbar-navigation-and-other-events-the-singleliveevent-case-ac2622673150)、[美团](https://tech.meituan.com/2018/07/26/android-livedatabus.html)文章，和[官方最新 demo](https://github.com/android/architecture-samples/blob/dev-todo-mvvm-live/todoapp/app/src/main/java/com/example/android/architecture/blueprints/todoapp/SingleLiveEvent.java)。



但正如[《Jetpack MVVM 精讲》](https://juejin.im/post/5dafc49b6fb9a04e17209922)所述，它们分别存在如下问题：



> **Event 事件包装器：**



对于多观察者情况，只允许第一个观察者消费，这不符合现实需求；



且手写 Event 事件包装器，在 Java 中存在 Null 安全一致性问题。



> **反射干预 Version 方式：**



存在延迟，无法用于对实时性有要求场景；



且数据会随着 SharedViewModel 长久滞留内存中得不到释放。



> **官方最新 demo SingleLiveEvent：**



是对 Event 事件包装器 “一致性问题” 改进，但未解决 “多观察者消费” 问题；



且额外引入 “消息未能从内存中释放” 问题。



 



## UnPeek-LiveData 特点



> 1.一条消息能被多个观察者消费（since v1.0）



> 2.消息被所有观察者消费完毕后才开始阻止倒灌（since v4.0）



> 3.可通过 clear 方法手动将消息从内存中移除（since v4.0）



> 4.让非入侵设计成为可能，遵循开闭原则（since v3.0）



> 5.基于 "访问权限控制" 支持 "读写分离"，遵循 “唯一可信源” 消息分发理念（since v2.0，详见 ProtectedUnPeekLiveData）



```java

public class TestFragment extends Fragment {

  protected void onViewCreate(){

    viewModel.getXXXResult().observe(this, xxx ->{

      renderUI(...);

    })



    viewModel.requestXXX();

  }

}



public class SharedViewModel extends ViewModel {

  private final MutableResult xxxResult = new MutableResult<>();



  public Result getXXXResult(){

    return xxxResult;

  }



  public void requestXXX(){

    //业务逻辑 ...

    ...

    xxxResult.setValue(...);

  }

}

```



且 UnPeekLiveData 提供构造器模式，后续可通过构造器组装适合自己业务场景 UnPeekLiveData。



```java

MutableResult test =

        new MutableResult.Builder()

        .setAllowNullValue(false)

        .create();

```



 



## Maven 依赖



```groovy

implementation 'com.kunminx.arch:unpeek-livedata:7.8.0'

```



> 温馨提示：

>

> 1.上述 implementation 命名，我们已从 `archi` 改为 `arch`，请注意修改，

>

> 2.鉴于 Jcenter 关闭，我们已将仓库迁移至 Maven Central，请自行在根目录 build.gradle 添加 `mavenCentral()`。



 



## Thanks



PS：感谢近期 [hegaojian](https://github.com/hegaojian)、Angki、Flynn、[Joker_Wan](https://juejin.im/user/5829b958d20309005403f4d6)、小暑知秋、[大棋](https://juejin.im/user/1785262613208376/posts)、空白、qh、lvrenzhao、半节树人 等小伙伴积极试用和反馈，使潜在问题被及时发现和纳入考虑。



 



## 谁在使用



根据小伙伴们私下反馈和调查问卷，我们了解到



包括 “腾讯音乐、BMW、TCL” 在内诸多知名厂商软件，都参考过我们开源的 [Jetpack MVVM Scaffold](https://github.com/KunMinX/Jetpack-MVVM-Scaffold) 架构模式，及正在使用我们维护的 UnPeek-LiveData 等框架。



“问卷调查” 我们长期保持对外开放，如有意可自行登记，以吸引更多小伙伴参与使用和反馈，集众人之所长，让架构组件得以不断演化和升级。



https://wj.qq.com/s2/8362688/124a/



| 集团 / 公司          | 产品           |

| -------------------- | -------------- |

| 腾讯音乐             | QQ 音乐        |

| ezen                 | Egshig音乐     |

| TCL                  | 内置文件管理器 |

| 左医科技             | 诊室听译机器人 |

| BMW                  | Speech         |

| 上海互教信息有限公司 | 知心慧学教师   |

| 美术宝               | 弹唱宝         |

|                      | 网安           |



 



## 历史版本



| 版本                | 更新日期   |

| ------------------- | ---------- |

| UnPeekLiveData v7.8 | 2022.9.06  |

| UnPeekLiveData v7.6 | 2022.6.13  |

| UnPeekLiveData v7.5 | 2022.6.12  |

| UnPeekLiveData v7.2 | 2021.8.20  |

| UnPeekLiveData v7.1 | 2021.8.16  |

| UnPeekLiveData v7   | 2021.8.10  |

| UnPeekLiveData v6.1 | 2021.7.15  |

| UnPeekLiveData v6   | 2021.6.17  |

| UnPeekLiveData v5   | 2021.4.21  |

| UnPeekLiveData v4.4 | 2021.1.27  |

| UnPeekLiveData v4.2 | 2020.12.15 |

| UnPeekLiveData v4   | 2020.10.16 |

| UnPeekLiveData v3   | 2020.07.10 |

| UnPeekLiveData v2   | 2020.05.09 |

| UnPeekLiveData v1   | 2019.07.15 |



 



## 最新更新动态



## UnPeekLiveData v7.8 特点



clear 方法改名 clean，以免开发者和集合 clear 方法弄混。



### UnPeekLiveData v7.6 特点



事件 Event 倾向于 "发送" 语境，事件通常来自 UI 层，例如通过 Button click 发起某事件。



而 mutable 系框架倾向于 "接收事件、处理业务逻辑" 后的末流消息分发。



为此，基于 "单一职责原则"，最终我们将 UnPeekLiveData 更名为 Result，示意其纯粹 "消息分发" 用途，



通过语义，让团队成员在 Activity/Fragment 中使用 result.setValue 时感觉别扭，促使其仅于 "唯一可信源" 内部业务逻辑末端使用。



 



### UnPeekLiveData v7.5 特点



为方便后来者学习参考，往期版本 UnPeekLiveData 类皆存留库中，



**现将过往类从库中移至 [Wiki](https://github.com/KunMinX/UnPeek-LiveData/wiki/UnPeekLiveData-v7-%E8%AE%BE%E8%AE%A1%E6%80%9D%E8%B7%AF)**，感兴趣可自行查阅。



 



### UnPeekLiveData v7.2 特点



根据小伙伴 @[RebornWolfman](https://github.com/RebornWolfman) 的[分享](https://github.com/KunMinX/UnPeek-LiveData/issues/21)，通过更简便方式修复 v7.0 潜在 removeObserver 内存泄漏问题。



 



### UnPeekLiveData v7.1 特点



修复 removeObserver 潜在的内存泄漏。



 



### UnPeekLiveData v7.0 特点



感谢小伙伴 @[RebornWolfman](https://github.com/RebornWolfman) 的[分享](https://github.com/KunMinX/UnPeek-LiveData/issues/17)。



相较上一版，V7 版源码在 "代理类/包装类" 自行维护一个版本号，在 UnPeekLiveData 中维护一个当前版本号，且分别在 setValue 和 Observe 时机改变和对齐版本号，如此使得无需额外管理 Observer Map，从而进一步规避内存管理问题，



是继 V6 版源码以来，最简源码设计。



> 具体可参见 UnPeekLiveData 最新源码及注释说明。



 



### UnPeekLiveData v6.1 特点



根据小伙伴 @[liweiGe](https://github.com/liweiGe) 的[启发](https://github.com/KunMinX/UnPeek-LiveData/issues/16)，我们将 state 演变为 ObserverProxy 字段来管理，从而使 Map 合二为一，代码逻辑进一步简化。



 



### UnPeekLiveData v6.0 特点



V6 版源码翻译和完善自小伙伴 @[wl0073921](https://github.com/wl0073921) 的[分享](https://github.com/KunMinX/UnPeek-LiveData/issues/11)。



相比 V5 版改进之处在于，引入 Observer 代理类设计，这使页面旋屏重建时，无需通过反射方式跟踪和复用基类 Map 中 Observer，转而通过 removeObserver 方式自动移除和在页面重建后重建新 Observer，



因而复杂度由原先分散于基类数据结构，到集中在 proxy 对象这一处，进一步方便源码逻辑阅读和后续修改。



> 具体可参见 UnPeekLiveData 最新源码及注释说明。



 



### UnPeekLiveData v5.0 特点



感谢 “腾讯音乐” 小伙伴 @[zhangjianlaoda](https://github.com/zhangjianlaoda) 贡献的重构优化代码。



**该版本保留 UnPeekLiveData v4 下述几大特点**，且在适当时机基于反射等机制，彻底解决 UnPeekLiveData v4 下 Observers 无法释放、重复创建，及 foreverObserver、removeObserver 被禁用等问题，将 UnPeekLiveData 内存性能再往上提升一阶梯。



同时，该版本使 Observe 等方法方法名和形参列表与官方 API 保持一致，尽可能减少学习成本。



> 具体可参见 UnPeekLiveData 最新源码及注释说明。



 



### UnPeekLiveData v4.0 特点



我们在 UnPeekLiveData v3.0 基础上，参考小伙伴 [Flywith24](https://github.com/Flywith24) - [WrapperLiveData](https://github.com/Flywith24/WrapperLiveData) 遍历 ViewModelStore 思路，以此提升 “防止倒灌时机” 精准度。



> 注：为在现有 AndroidX 源码背景下实现 "防倒灌机制"，**v4.0 对 Observe 方法使用做了微调**，改为分别针对 Activity/Fragment 提供 ObserveInActivity 和 ObserveInFragment 方法，具体缘由详见源码注释说明。



 



### UnPeekLiveData v3.0



Update since 2020.7.10



通过 **独创 “延时自动清理消息” 设计**，满足：



> 1.消息被分发给多个观察者时，**不会因第一个观察者消费过而直接被置空**



> 2.时限到，**消息便不再会被倒灌**



> 3.时限到，**消息自动从内存中清理释放**



> 4.使非入侵设计成为可能，并结合官方 SingleLiveEvent 设计实现 **遵循开闭原则非入侵重写**。



 



### UnPeekLiveData v2.0



Update since 2020.5



> 1.结合 Event 包装类使用，对 LiveData 类进行入侵性修改。



> 2.提供 ProtectedUnPeekLiveData，基于访问权限控制实现 "读写分离"：支持只从 "唯一可信源"（例如 ViewModel）内部发送、而 Activity/Fragment 只允许 Observe。



 



### UnPeekLiveData v1.0



Update since 2019



> 1.针对 **“二次进入二级页面时收到旧数据推送” 情况** 创建 “数据倒灌” 定义，并于网上交流传播。



> 2.参考美团 LiveDataBus 设计，透过反射方式拦截并修改 Last Version 来防止倒灌。



 



## License



本文以 [CC 署名-非商业性使用-禁止演绎 4.0 国际协议](https://creativecommons.org/licenses/by-nc-nd/4.0/deed.zh) 发行。



Copyright © 2019-present KunMinX



![](https://images.xiaozhuanlan.com/photo/2020/8fc6f51263babeb544bb4a7dae6cde59.jpg)



文中提到的 对 “**数据倒灌**” 一词及其现象概括、对 Event 事件包装器、反射方式、SingleLiveEvent **各自存在的缺陷** 理解，及对 UnPeekLiveData “**延迟自动清理消息**” 设计，**均属于本人独立原创成果**，本人对此享有最终解释权。



文中 "最新更新动态" 处提到新版源码设计，及对新版源码思路理解和解析，属于参与过新版设计讨论有效贡献者及本人共同成果，我们对此享有所有权和最终解释权。



任何个人或组织在引用上述内容时，**须注明原作者和链接出处**。未经授权不得用于洗稿、广告包装、卖课等商业用途。



```

Copyright 2019-present KunMinX



Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at



   http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```