在上一篇文章RxJava2笔记(一、事件订阅流程)中,我们讲解了RxJava的事件订阅流程,本文我们将继续讲解RxJava的订阅取消流程。
我们对上一篇文章开始的代码做一些修改:
private Disposable disposable;
private void init() {
Observer observer = new Observer() {
@Override
public void onSubscribe(Disposable d) {
Log.i(TAG, "onSubscribe:");
disposable = d;
}
@Override
public void onNext(Integer integer) {
Log.i(TAG, "onNext: " + integer);
}
@Override
public void onError(Throwable e) {
Log.i(TAG, "onError: " + e.getMessage());
e.printStackTrace();
}
@Override
public void onComplete() {
Log.i(TAG, "onComplete:");
}
};
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter emitter) {
emitter.onNext(1);
emitter.onNext(2);
disposable.dispose();
emitter.onNext(3);
emitter.onComplete();
}
}).subscribe(observer);
}
我们在emitter.onNext(2)和emitter.onNext(3)之间添加了一行代码disposable.dispose(),我们来看下输出结果:
可以看到observer没有收到observable发送的onNext(3)和onComplete事件,原因在于observable在发送完emitter.onNext(2)后调用了disposable.dispose(),由此可以看出这个disposable应该就是用于中断事件订阅的,这个disposable则是在observer调用onSubscribe(Disposable d) 方法时获取的。
这个disposable.dispose()执行了哪些操作呢?我们点进去看下:
public interface Disposable {
/**
* Dispose the resource, the operation should be idempotent.
*/
void dispose();
/**
* Returns true if this resource has been disposed.
* @return true if this resource has been disposed
*/
boolean isDisposed();
}
可以看到这是一个接口方法,其中dispose()方法就是用来中断事件订阅流程的;isDisposed()方法则是判断当前事件订阅是否被中断,具体的实现细节在其实现类中。不知道大家还有没有印象,在上一节中我们提到一个关键类ObservableCreate类,我们再看一下这个类的相关代码:
在上一篇文章中,我们在分析事件订阅流程时提到过,在source.subscribe(parent);代码执行之前会先执行observer.onSubscribe(parent);代码。也就是obsever的4个方法中,onSubscribe方法最先被执行,而这个parent就是我们前面获取的Disposable接口对象,也就是CreateEmitter,我们可以看到这个类继承了Disposable接口,因此当我们调用disposable.dispose()方法时,实际上执行的是CreateEmitter类中的实现方法,isDisposed()方法同理。那我们就来看下CreateEmitter类中这两个实现方法:
@Override
public void dispose() {
DisposableHelper.dispose(this);
}
@Override
public boolean isDisposed() {
return DisposableHelper.isDisposed(get());
}
可以看到,它是委托给了DisposableHelper这个类来完成的,这个DisposableHelper又是什么东西?我们点进去看下:
public enum DisposableHelper implements Disposable {
/**
* The singleton instance representing a terminal, disposed state, don't leak it.
*/
DISPOSED
;
/**
* Checks if the given Disposable is the common {@link #DISPOSED} enum value.
* @param d the disposable to check
* @return true if d is {@link #DISPOSED}
*/
public static boolean isDisposed(Disposable d) {
return d == DISPOSED;
}
//.......代码省略
/**
* Atomically disposes the Disposable in the field if not already disposed.
* @param field the target field
* @return true if the current thread managed to dispose the Disposable
*/
public static boolean dispose(AtomicReference field) {
//......代码省略
}
//......代码省略
}
可以看到这个类是一个枚举类,它有一个枚举常量DISPOSED,这是一个事件订阅中断标识,在isDisposed(Disposable d)方法中,就是判断传入的参数对象(Disposable)是否等于该标识位从而判断该对象的订阅是否被中断。
我们要重点分析的是这个dispose(AtomicReference
public static boolean dispose(AtomicReference field) {
//1、获取当前传递进来的对象所持有的disposable对象
Disposable current = field.get();
//2、终止标识
Disposable d = DISPOSED;
//3、当前current不等于终止标识(dispose()方法还未被调用)
if (current != d) {
//4、使用AtomicReference的原子方法将终止标识设置到field对象中,并返回field对象中的旧值
//并将其保存在current中
current = field.getAndSet(d);
//5、current仍旧不等于终止标识
//备注:当第一次调用dispose()方法时,此时current为空,满足这个条件,下面的current != null为false,直接返回true;
//另外一种情况就是程序多次调用了dispose()方法,但是disposable值不等于终止标识,说明之前的设置失败了,
//此时current不为空,再次调用dispose()方法
if (current != d) {
if (current != null) {
current.dispose();
}
//7、返回true,表示当前线程成功的设置了终止标识
return true;
}
}
//8、之前已经调用过dispose()方法,并且已经正确设置了disposable终止标识,
//订阅事件已经被终止了,再次调用该方法时直接返回false,表示设置终止标识失败
return false;
}
从上面的代码分析中可以看出,dispose()方法中断订阅的方式只是向AtomicReference
@Override
public void onNext(T t) {
if (t == null) {
onError(new NullPointerException("onNext called with null. Null values are generally not allowed in 2.x operators and sources."));
return;
}
if (!isDisposed()) {
observer.onNext(t);
}
}
@Override
public void onError(Throwable t) {
if (!tryOnError(t)) {
RxJavaPlugins.onError(t);
}
}
@Override
public boolean tryOnError(Throwable t) {
if (t == null) {
t = new NullPointerException("onError called with null. Null values are generally not allowed in 2.x operators and sources.");
}
if (!isDisposed()) {
try {
observer.onError(t);
} finally {
dispose();
}
return true;
}
return false;
}
@Override
public void onComplete() {
if (!isDisposed()) {
try {
observer.onComplete();
} finally {
dispose();
}
}
}
我们来看onNext方法,它先判断要发射的数据是否为空,为空就抛出异常。接着在if语句中判断isDisposed()返回值,如果isDisposed()返回false,表示订阅已经被终止,随后的observer.onNext(t)也就不会被执行。
随后的onComplete和onError都是通过判断isDisposed()的返回值来决定是否执行接下来的操作(即observer.onComplete和observer.onError),而且我们发现observer中的onComplete和onError之间是互斥的,也就是说这两个方法只有一个会执行,如果先执行了onComplete,onError就不会执行;反之先执行onError,onComplete就不会执行。我们通过分析源码发现不管是先执行onError还是先执行onComplete,只要当前订阅事件还未被终止,他们最终都会调用dispose()方法来终止订阅事件,最终会导致isDisposed()返回为false,自然也就不会再执行另外一个了。
到此为止,整个的事件订阅取消流程就分析完了,我们来总结下:
- 1、在事件订阅开始时,最先执行的是observer中的onSubscribe(Disposable d)方法,也就是ObservableCreate类中subscribeActual(Observer super T> observer)方法里面的observer.onSubscribe(parent)这个方法,我们获取到的disposable实际上就是这个parent,也就是包装了外部传进来的observer观察者的CreateEmitter类(该类继承了Disposable接口)
- 2、调用disposable.dispose()方法终止事件订阅流程,实际上调用的是Disposable的实现类CreateEmitter中的实现方法
- 3、在CreateEmitter的dispose()实现方法中,委托DisposableHelper类实现具体的取消订阅流程;isDisposed()方法也是如此
- 4、DisposableHelper类是一个枚举类,它也实现了Disposable接口,内部有一个枚举常量DISPOSED,这是一个标识位。在dispose()方法中,给传入的CreateEmitter设置该标识位,而CreateEmitter当中的onNext,onComplete以及onError方法均需要根据isDisposed()的返回值来决定接下来的操作是否执行;而isDisposed()方法正是根据传入对象所持有的标识位是否等于DISPOSED终止标识来决定其返回true还是false。至此,中断标识位就是通过这样的方式来影响事件中的订阅相关方法(即CreateEmitter中的onNext,onComplete以及onError方法),进而影响到外部观察者对象(observer)中对应的事件接收方法。
在下一章RxJava2笔记(三、订阅线程切换)中,我们将接着分析订阅线程切换时如何进行的。