Rxjava源码分析之IO.Reactivex.CompositeDisposable
江子石
Rxjava 源码系列目录
- Rxjava源码分析之IO.Reactivex.Observer
- Rxjava源码分析之IO.Reactivex.CompositeDisposable
- Rxjava源码分析之IO.Reactivex.Observable
博客创建时间：2020.04.26
博客更新时间：2021.04.12
以Android studio build=4.1.3，gradle=6.5，SdkVersion 30来分析讲解。如图文和网上其他资料不一致，可能是别的资料版本较低而已
前言
该处源码分析是基于Rxjava3而非Rxjava2，两者有细微的差别。
RxJava容易造成内存泄漏，在某些情况下没有及时的取消订阅会导致内存泄漏。CompositeDisposable就是专用于Disposable管理的。
CompositeDisposable是一个Disposable容器，它提供了多种算法时间复杂度为O(1)的方法，如add、remove、delete等方法。实质是内部有一个OpenHashSet实例resources专用于添加移除管理Disposable。
主要方法
1. dispose()
resources置空，并且为逐个Dispose在resources中的每一个Disposable
2.add(@NonNull Disposable disposable)和addAll(@NonNull Disposable disposable)
添加Disposable或其集合到resources中，如果CompositeDisposable已经disposed，则添加的Disposable会直接dispose取消订阅，无法执行Disposable中的任务。
3. remove(@NonNull Disposable disposable)
remove方法实质调用了delete,且多了一步 disposable.dispose()。remove即从容器resources中不但remove,且执行完毕后该 disposable取消与订阅者的连接关系dispose()
4. delete(@NonNull Disposable disposable)
删除resources中的该disposable
5. clear()
dispose容器resources中所包含的所有Disposable
注意事项
该类中所有需要传Disposable的参数都不能为null,否则抛出NullPointerException一般在OnCreate中创建CompositeDisposable实例，在onDestory方法中进行clear()操作为了方便disposable 的管理，可以在Observer.onSubscribe(Disposable d)中将Disposable的实例加入CompositeDisposable中。
.subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
if(d!=null){
compositeDisposable.add(d);
}
}
源码
public class IO_Reactivex_CompositeDisposable implements Disposable, DisposableContainer {
/**
* 存放 disposable 的 set
*/
private OpenHashSet<Disposable> resources;
/**
* 是否已经处理过
*/
private volatile boolean disposed;
/**
* Creates an empty {@code CompositeDisposable}.
*/
public IO_Reactivex_CompositeDisposable() {
}
/**
* Creates a {@code CompositeDisposable} with the given array of initial {@link Disposable} elements.
* 创建 一个CompositeDisposable 通过给定的 初始元素数组。
*
* @param disposables the array of {@code Disposable}s to start with 起始的Disposables
* @throws NullPointerException if {@code disposables} or any of its array items is {@code null} 如果存在一个disposable,则抛空异常
*/
public IO_Reactivex_CompositeDisposable(@NonNull Disposable... disposables) {
Objects.requireNonNull(disposables, "disposables is null");
this.resources = new OpenHashSet<>(disposables.length + 1);
for (Disposable d : disposables) {
Objects.requireNonNull(d, "A Disposable in the disposables array is null");
this.resources.add(d);
}
}
/**
* 创建 一个CompositeDisposable 通过给定的初始化元素 Iterable 序列
* Creates a {@code CompositeDisposable} with the given {@link Iterable} sequence of initial {@link Disposable} elements.
*
* @param disposables the {@code Iterable} sequence of {@code Disposable} to start with 初始参数
* @throws NullPointerException if {@code disposables} or any of its items is {@code null} 存在null 抛异常
*/
public IO_Reactivex_CompositeDisposable(@NonNull Iterable<? extends Disposable> disposables) {
Objects.requireNonNull(disposables, "disposables is null");
this.resources = new OpenHashSet<>();
for (Disposable d : disposables) {
Objects.requireNonNull(d, "A Disposable item in the disposables sequence is null");
this.resources.add(d);
}
}
@Override
public void dispose() {
//已经处理过，不在调用
if (disposed) {
return;
}
OpenHashSet<Disposable> set;
// 前面添加的OpenHashSet<Disposable> 清空，置null
synchronized (this) {
if (disposed) {
return;
}
disposed = true;
set = resources;
resources = null;
}
dispose(set);
}
@Override
public boolean isDisposed() {
return disposed;
}
//TODO CompositeDisposable 的初始化，add 等方法中传入参数Disposable 或其数组都不可为null,否则抛空异常
/**
* TODO 添加一个Disposable 到 container容器中 ，如果container已经disposed,此时返回false且disposable.dispose();
* Adds a {@link Disposable} to this container or disposes it if the
* container has been disposed.
*
* @param disposable the {@code Disposable} to add, not {@code null}
* @return {@code true} if successful, {@code false} if this container has been disposed
* @throws NullPointerException if {@code disposable} is {@code null}
*/
@Override
public boolean add(@NonNull Disposable disposable) {
Objects.requireNonNull(disposable, "disposable is null");
if (!disposed) {
synchronized (this) {
if (!disposed) {
OpenHashSet<Disposable> set = resources;
// 刚刚初始化的CompositeDisposable,此时resources=null
if (set == null) {
set = new OpenHashSet<>();
resources = set;
}
set.add(disposable);
return true;
}
}
}
disposable.dispose();
return false;
}
/**
* 一次添加一个Disposable数组成功则返回true，如果容器disposed,则Disposable数组批量dispose此时返回false
* Atomically adds the given array of {@link Disposable}s to the container or
* disposes them all if the container has been disposed.
*
* @param disposables the array of {@code Disposable}s
* @return {@code true} if the operation was successful, {@code false} if the container has been disposed
* @throws NullPointerException if {@code disposables} or any of its array items is {@code null}
*/
public boolean addAll(@NonNull Disposable... disposables) {
Objects.requireNonNull(disposables, "disposables is null");
if (!disposed) {
synchronized (this) {
if (!disposed) {
OpenHashSet<Disposable> set = resources;
if (set == null) {
set = new OpenHashSet<>(disposables.length + 1);
resources = set;
}
for (Disposable d : disposables) {
Objects.requireNonNull(d, "A Disposable in the disposables array is null");
set.add(d);
}
return true;
}
}
}
for (Disposable d : disposables) {
d.dispose();
}
return false;
}
/**
* TODO 如果disposable是resources中的一个，则从resources中移除，并且将该Disposable.dispose
* Removes and disposes the given {@link Disposable} if it is part of this container.
*
* @param disposable the disposable to remove and dispose, not {@code null}
* @return {@code true} if the operation was successful
* @throws NullPointerException if {@code disposable} is {@code null}
*/
@Override
public boolean remove(@NonNull Disposable disposable) {
if (delete(disposable)) {
disposable.dispose();
return true;
}
return false;
}
/**
* TODO 从resources中移除Disposable，但不dispose。 如果resources=null，
* TODO 或者resources.remove返回false,则该方法返回false
* Removes (but does not dispose) the given {@link Disposable} if it is part of this container.
*
* @param disposable the disposable to remove, not {@code null}
* @return {@code true} if the operation was successful
* @throws NullPointerException if {@code disposable} is {@code null}
*/
@Override
public boolean delete(@NonNull Disposable disposable) {
Objects.requireNonNull(disposable, "disposable is null");
if (disposed) {
return false;
}
synchronized (this) {
if (disposed) {
return false;
}
OpenHashSet<Disposable> set = resources;
if (set == null || !set.remove(disposable)) {
return false;
}
}
return true;
}
/**
* 原子性的清理container， 然后dispose 前面所有包含的Disposables
* Atomically clears the container, then disposes all the previously contained {@link Disposable}s.
*/
public void clear() {
if (disposed) {
return;
}
OpenHashSet<Disposable> set;
synchronized (this) {
if (disposed) {
return;
}
set = resources;
resources = null;
}
dispose(set);
}
/**
* 返回 resources中的count
* Returns the number of currently held {@link Disposable}s.
*
* @return the number of currently held {@code Disposable}s
*/
public int size() {
if (disposed) {
return 0;
}
synchronized (this) {
if (disposed) {
return 0;
}
OpenHashSet<Disposable> set = resources;
return set != null ? set.size() : 0;
}
}
/**
* TODO Dispose OpenHashSet中的元素 通过非致命的方式最后。 如果该过程中产生了异常，则抛出异常。
* Dispose the contents of the {@link OpenHashSet} by suppressing non-fatal
* {@link Throwable}s till the end.
*
* @param set the {@code OpenHashSet} to dispose elements of
*/
private void dispose(@Nullable OpenHashSet<Disposable> set) {
if (set == null) {
return;
}
List<Throwable> errors = null;
Object[] array = set.keys();
for (Object o : array) {
if (o instanceof Disposable) {
try {
((Disposable) o).dispose();
} catch (Throwable ex) {
Exceptions.throwIfFatal(ex);
if (errors == null) {
errors = new ArrayList<>();
}
errors.add(ex);
}
}
}
if (errors != null) {
if (errors.size() == 1) {
throw ExceptionHelper.wrapOrThrow(errors.get(0));
}
throw new CompositeException(errors);
}
}
}
总结
CompositeDisposable的存在是为了解决Rxjava耗时操作的内存泄漏，用好它非常重要。
本测试Demo源码
gitee:https://gitee.com/luofaxin/RxJava3Analysis.git
github:https://github.com/l424533553/RxJava3Analysis.git
相关链接：
- Rxjava源码分析之IO.Reactivex.Observer
- Rxjava源码分析之IO.Reactivex.CompositeDisposable
- Rxjava源码分析之IO.Reactivex.Observable
扩展链接：
扩展训练：
- CompositeDisposable几个常用方法的使用
- CompositeDisposable存在的意义
博客书写不易，您的点赞收藏是我前进的动力，千万别忘记点赞、 收藏 ^ _ ^ !
类似资料：