RxJava2 源代码解析(一)

转载请标明出处:
http://blog.csdn.net/zxt0601/article/details/61614799
本文出自:【张旭童的博客】(http://blog.csdn.net/zxt0601)

概述

近期事情太多了,如今公司内部的变动,自己岗位的变化,以及近期决定找工作。

所以博客耽误了。准备面试中,打算看一看RxJava2的源代码。遂有了这篇文章。

不会对RxJava2的源代码逐字逐句的阅读,仅仅寻找关键处,我们平时接触得到的那些代码。
背压实际中接触较少。故仅仅分析了Observable.
分析的源代码版本号为:2.0.1

我们的目的:

  1. 知道源头(Observable)是怎样将数据发送出去的。
  2. 知道终点(Observer)是怎样接收到数据的。

  3. 何时将源头和终点关联起来的
  4. 知道线程调度是怎么实现的
  5. 知道操作符是怎么实现的

本文先达到目的1 。2 ,3。
我个人觉得主要还是适配器模式的体现,我们接触的就仅仅有ObservableObserver,事实上内部有大量的中间对象在适配:将它们两联系起来。增加一些额外功能,比如考虑dispose和hook等。

从create開始。

这是一段不涉及操作符和线程切换的简单样例:

        Observable.create(new ObservableOnSubscribe<String>() {
            @Override
            public void subscribe(ObservableEmitter<String> e) throws Exception {
                e.onNext("1");
                e.onComplete();
            }
        }).subscribe(new Observer<String>() {
            @Override
            public void onSubscribe(Disposable d) {
                Log.d(TAG, "onSubscribe() called with: d = [" + d + "]");
            }

            @Override
            public void onNext(String value) {
                Log.d(TAG, "onNext() called with: value = [" + value + "]");
            }

            @Override
            public void onError(Throwable e) {
                Log.d(TAG, "onError() called with: e = [" + e + "]");
            }

            @Override
            public void onComplete() {
                Log.d(TAG, "onComplete() called");
            }
        });

拿 create来说。

public static <T> Observable<T> create(ObservableOnSubscribe<T> source) {
        //.....
        return RxJavaPlugins.onAssembly(new ObservableCreate<T>(source));
    }

返回值是Observable,參数是ObservableOnSubscribe,定义例如以下:

public interface ObservableOnSubscribe<T> {
    void subscribe(ObservableEmitter<T> e) throws Exception;
}

ObservableOnSubscribe是一个接口。里面就一个方法,也是我们实现的那个方法:
该方法的參数是 ObservableEmitter。我觉得它是关联起 Disposable概念的一层:

public interface ObservableEmitter<T> extends Emitter<T> {
    void setDisposable(Disposable d);
    void setCancellable(Cancellable c);
    boolean isDisposed();
    ObservableEmitter<T> serialize();
}

ObservableEmitter也是一个接口。里面方法非常多,它也继承了 Emitter<T> 接口。

public interface Emitter<T> {
    void onNext(T value);
    void onError(Throwable error);
    void onComplete();
}

Emitter<T>定义了 我们在ObservableOnSubscribe中实现subscribe()方法里最经常使用的三个方法。

好,我们回到原点。create()方法里就一句话return RxJavaPlugins.onAssembly(new ObservableCreate<T>(source));,当中提到RxJavaPlugins.onAssembly():

    /**
     * Calls the associated hook function.
     * @param <T> the value type
     * @param source the hook's input value
     * @return the value returned by the hook
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    public static <T> Observable<T> onAssembly(Observable<T> source) {
        Function<Observable, Observable> f = onObservableAssembly;
        if (f != null) {
            return apply(f, source);
        }
        return source;
    }

能够看到这是一个关于hook的方法。关于hook我们暂且不表,不影响主流程。我们默认使用中都没有hook,所以这里就是直接返回source,即传入的对象。也就是new ObservableCreate<T>(source).

ObservableCreate我觉得算是一种适配器的体现,create()须要返回的是Observable,而我如今有的是(方法传入的是)ObservableOnSubscribe对象,ObservableCreateObservableOnSubscribe适配成Observable
当中subscribeActual()方法表示的是被订阅时真正被运行的方法,放后面解析:

public final class ObservableCreate<T> extends Observable<T> {
    final ObservableOnSubscribe<T> source;
    public ObservableCreate(ObservableOnSubscribe<T> source) {
        this.source = source;
    }
    @Override
    protected void subscribeActual(Observer<?

super T> observer) { CreateEmitter<T> parent = new CreateEmitter<T>(observer); observer.onSubscribe(parent); try { source.subscribe(parent); } catch (Throwable ex) { Exceptions.throwIfFatal(ex); parent.onError(ex); } }

OK,至此。创建流程结束,我们得到了Observable<T>对象。事实上就是ObservableCreate<T>.

到订阅subscribe 结束

subscribe():

    public final void subscribe(Observer<?

super T> observer) { ... try { //1 hook相关,略过 observer = RxJavaPlugins.onSubscribe(this, observer); ... //2 真正的订阅处 subscribeActual(observer); } catch (NullPointerException e) { // NOPMD throw e; } catch (Throwable e) { //3 错误处理, Exceptions.throwIfFatal(e); // can't call onError because no way to know if a Disposable has been set or not // can't call onSubscribe because the call might have set a Subscription already //4 hook错误相关,略过 RxJavaPlugins.onError(e); NullPointerException npe = new NullPointerException("Actually not, but can't throw other exceptions due to RS"); npe.initCause(e); throw npe; } }

关于hook的代码:
能够看到假设没有hook。即对应的对象是null。则是传入什么返回什么的

    /**
     * Calls the associated hook function.
     * @param <T> the value type
     * @param source the hook's input value
     * @param observer the observer
     * @return the value returned by the hook
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    public static <T> Observer<? super T> onSubscribe(Observable<T> source, Observer<?

super T> observer) { //1 默认onObservableSubscribe(可理解为一个flatmap的操作)是null BiFunction<Observable, Observer, Observer> f = onObservableSubscribe; //2 所以这句跳过,不会对其进行apply if (f != null) { return apply(f, source, observer); } //3 返回參数2 return observer; }

我也是验证了一下 三个Hook相关的变量。确实是null:

        Consumer<Throwable> errorHandler = RxJavaPlugins.getErrorHandler();
        BiFunction<Observable, Observer, Observer> onObservableSubscribe = RxJavaPlugins.getOnObservableSubscribe();
        Function<Observable, Observable> onObservableAssembly = RxJavaPlugins.getOnObservableAssembly();

        Log.e(TAG, "errorHandler = [" + errorHandler + "]");
        Log.e(TAG, "onObservableSubscribe = [" + onObservableSubscribe + "]");
        Log.e(TAG, "onObservableAssembly = [" + onObservableAssembly + "]");

所以订阅时的重点就是:

            //2 真正的订阅处
            subscribeActual(observer);

我们将第一节提到的ObservableCreate里的subscribeActual()方法拿出来看看:

    @Override
    protected void subscribeActual(Observer<? super T> observer) {
        //1 创建CreateEmitter,也是一个适配器
        CreateEmitter<T> parent = new CreateEmitter<T>(observer);
        //2 onSubscribe()參数是Disposable ,所以CreateEmitter能够将Observer->Disposable 。另一点要注意的是`onSubscribe()`是在我们运行`subscribe()`这句代码的那个线程回调的。并不受线程调度影响。

observer.onSubscribe(parent); try { //3 将ObservableOnSubscribe(源头)与CreateEmitter(Observer,终点)联系起来 source.subscribe(parent); } catch (Throwable ex) { Exceptions.throwIfFatal(ex); //4 错误回调 parent.onError(ex); } }

Observer是一个接口。里面就四个方法,我们在开头的样例中已经所有实现(打印Log)。

public interface Observer<T> {
    void onSubscribe(Disposable d);
    void onNext(T value);
    void onError(Throwable e);
    void onComplete();
}

重点在这一句:

 //3 将ObservableOnSubscribe(源头)与CreateEmitter(Observer,终点)联系起来
            source.subscribe(parent);

sourceObservableOnSubscribe对象。在本文中是:

        new ObservableOnSubscribe<String>() {
            @Override
            public void subscribe(ObservableEmitter<String> e) throws Exception {
                e.onNext("1");
                e.onComplete();
            }
        }

则会调用parent.onNext()parent.onComplete()parentCreateEmitter对象,例如以下:

 static final class CreateEmitter<T>
    extends AtomicReference<Disposable>
    implements ObservableEmitter<T>, Disposable {
        final Observer<?

super T> observer; CreateEmitter(Observer<? super T> observer) { this.observer = observer; } @Override public void onNext(T t) { ... //假设没有被dispose。会调用Observer的onNext()方法 if (!isDisposed()) { observer.onNext(t); } } @Override public void onError(Throwable t) { ... //1 假设没有被dispose。会调用Observer的onError()方法 if (!isDisposed()) { try { observer.onError(t); } finally { //2 一定会自己主动dispose() dispose(); } } else { //3 假设已经被dispose了。会抛出异常。

所以onError、onComplete彼此相互排斥。仅仅能被调用一次 RxJavaPlugins.onError(t); } } @Override public void onComplete() { //1 假设没有被dispose,会调用Observer的onComplete()方法 if (!isDisposed()) { try { observer.onComplete(); } finally { //2 一定会自己主动dispose() dispose(); } } } @Override public void dispose() { DisposableHelper.dispose(this); } @Override public boolean isDisposed() { return DisposableHelper.isDisposed(get()); } }

总结重点:

  1. ObservableObserver的关系没有被dispose。才会回调ObserveronXXXX()方法
  2. ObserveronComplete()onError() 相互排斥仅仅能运行一次。由于CreateEmitter在回调他们两中随意一个后。都会自己主动dispose()

    依据第一点,验证此结论。

  3. ObservableObserver关联时(订阅时)。Observable才会開始发送数据。
  4. ObservableCreateObservableOnSubscribe(真正的源)->Observable.
  5. ObservableOnSubscribe(真正的源)须要的是发射器ObservableEmitter.
  6. CreateEmitterObserver->ObservableEmitter,同一时候它也是Disposable.
  7. errorcompletecomplete不显示。 反之会crash。感兴趣的能够写例如以下代码验证。
      e.onNext("1");
      //先error后complete,complete不显示。

反之 会crash //e.onError(new IOException("sb error")); e.onComplete(); e.onError(new IOException("sb error"));

一个好玩的地方DisposableHelper

原本到这里,最简单的一个流程我们算是搞清了。
还值得一提的是,DisposableHelper.dispose(this);
DisposableHelper非常有趣。它是一个枚举,这是利用枚举实现了一个单例disposed state,即是否disposed,假设Disposable类型的变量的引用等于DISPOSED,则起点和终点已经断开联系。
当中大多数方法 都是静态方法,所以isDisposed()方法的实现就非常easy。直接比較引用就可以.
其它的几个方法。和AtomicReference类搅基在了一起。


这是一个实现引用原子操作的类,对象引用的原子更新。经常用法例如以下:

//返回当前的引用。
V get()
//假设当前值与给定的expect引用相等,(注意是引用相等而不是equals()相等),更新为指定的update值。
boolean compareAndSet(V expect, V update)
//原子地设为给定值并返回旧值。
V getAndSet(V newValue)

OK,铺垫完了我们看看源代码吧:

public enum DisposableHelper implements Disposable {
    /**
     * The singleton instance representing a terminal, disposed state, don't leak it.
     */
    DISPOSED
    ;

    public static boolean isDisposed(Disposable d) {
        return d == DISPOSED;
    }

    public static boolean dispose(AtomicReference<Disposable> field) {
        //1 通过断点查看,默认情况下,field的值是"null",并不是引用是null哦!大坑大坑大坑
        //可是current是null引用
        Disposable current = field.get();
        Disposable d = DISPOSED;
        //2 null不等于DISPOSED
        if (current != d) {
            //3 field是DISPOSED了,current还是null
            current = field.getAndSet(d);
            if (current != d) {
            //4 默认情况下 走不到这里,这里是在设置了setCancellable()后会走到。
                if (current != null) {
                    current.dispose();
                }
                return true;
            }
        }
        return false;
    }

总结

  1. subscribeActual()方法中。源头和终点关联起来。

  2. source.subscribe(parent);这句代码运行时,才開始从发送ObservableOnSubscribe中利用ObservableEmitter发送数据Observer。即数据是从源头push给终点的。

  3. CreateEmitter 中,仅仅有ObservableObserver的关系没有被dispose,才会回调ObserveronXXXX()方法
  4. ObserveronComplete()onError() 相互排斥仅仅能运行一次,由于CreateEmitter在回调他们两中随意一个后。都会自己主动dispose()

    依据上一点,验证此结论。

  5. errorcompletecomplete不显示。 反之会crash
  6. 另一点要注意的是onSubscribe()是在我们运行subscribe()这句代码的那个线程回调的。并不受线程调度影响

转载请标明出处:
http://blog.csdn.net/zxt0601/article/details/61614799
本文出自:【张旭童的博客】(http://blog.csdn.net/zxt0601)

原文地址:https://www.cnblogs.com/jzssuanfa/p/7294556.html