RxJava 入门

Posted 2020-08-07

简介

项目地址：
https://github.com/ReactiveX/RxJava
https://github.com/ReactiveX/RxAndroid 
引入依赖： 
compile ‘io.reactivex:rxjava:1.1.0‘
compile ‘io.reactivex:rxandroid:1.1.0‘
RxJava 是什么？
一个词：异步。
RxJava 在 GitHub 主页上的自我介绍是【"a library for composing组成 asynchronous异步的 and event-based programs using observable可观测的 sequences序列 for the Java VM"】（一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库）。
其实， RxJava 的本质可以压缩为异步这一个词。说到根上，它就是一个实现异步操作的库，而别的定语都是基于这之上的。
RxJava 好在哪？
一个词：简洁。
异步操作很关键的一点是程序的简洁性，因为在调度过程比较复杂的情况下，异步代码经常会既难写也难被读懂。 Android 创造的AsyncTask 和Handler ，其实都是为了让异步代码更加简洁。RxJava 的优势也是简洁，但它的简洁的与众不同之处在于，随着程序逻辑变得越来越复杂，它依然能够保持简洁。
假设有这样一个需求：界面上有一个自定义的视图，它的作用是显示多张图片，并能任意增加显示的图片。现在需要将一个给出的目录数组中每个目录下的 png 图片都加载出来并显示在View中。需要注意的是，由于读取图片的这一过程较为耗时，需要放在后台执行，而图片的显示则必须在 UI 线程执行。其中一种方式：
        new Thread() {
            void run() {
                super.run();
                for (File folder : folders) {
                    File[] files = folder.listFiles();
                    for (File file : files) {
                        if (file.getName().endsWith(".png")) {
                            final Bitmap bitmap = getBitmapFromFile(file);
                            getActivity().runOnUiThread(new Runnable() {
                                void run() {
                                    imageCollectorView.addImage(bitmap);
                                }
                            });
                        }
                    }
                }
            }
        }.start();
而如果使用 RxJava ，实现方式是这样的：
        Observable.from(folders)
           .flatMap(new Func1<File, Observable<File>>() {
            Observable<File> call(File file) {return Observable.from(file.listFiles());}
        }).filter(new Func1<File, Boolean>() {
            Boolean call(File file) {return file.getName().endsWith(".png");}
        }).map(new Func1<File, Bitmap>() {
            Bitmap call(File file) {return getBitmapFromFile(file);}
        }).subscribeOn(Schedulers.io())
          .observeOn(AndroidSchedulers.mainThread())
          .subscribe(new Action1<Bitmap>() {
            void call(Bitmap bitmap) {
                imageCollectorView.addImage(bitmap);
            }
        });
观察一下你会发现， RxJava 的这个实现，是一条从上到下的链式调用，没有任何嵌套，这在逻辑的简洁性上是具有优势的。当需求变得复杂时，这种优势将更加明显。
另外，如果你的 IDE 是 Android Studio ，其实每次打开某个 Java 文件的时候，你会看到被自动 Lambda 化的预览，这将让你更加清晰地看到程序逻辑。

原理

RxJava 的异步实现，是通过一种【扩展的观察者模式】来实现的。
RxJava 有四个基本概念：Observable (可观察者，即被观察者)、 Observer (观察者)、 subscribe (订阅)、事件。
Observable 和Observer 通过 subscribe() 方法实现订阅关系，从而 Observable 可以在需要的时候发出事件来通知 Observer。
与传统观察者模式不同， RxJava 的事件回调方法除了普通事件 onNext()之外，还定义了两个特殊的事件：onCompleted() 和 onError()。
onCompleted(): 事件队列完结。RxJava 不仅把每个事件单独处理，还会把它们看做一个队列。RxJava 规定，当不会再有新的onNext() 发出时，需要触发 onCompleted() 方法作为标志。
onError(): 事件队列异常。在事件处理过程中出异常时，onError() 会被触发，同时队列自动终止，不允许再有事件发出。
在一个正确运行的事件序列中, onCompleted() 和 onError() 有且只有一个，并且是事件序列中的最后一个。
需要注意的是，onCompleted() 和 onError() 二者也是互斥的，即在队列中调用了其中一个，就不应该再调用另一个。
基于以上的概念， RxJava 的基本实现主要有三点：
1、创建 Observer，它决定事件触发的时候将有怎样的行为。 
RxJava 中的 Observer 接口的实现方式：
        Observer<String> observer = new Observer<String>() {
            void onNext(String s) {
                Log.d(tag, "Item: " + s);
            }
            void onCompleted() {
                Log.d(tag, "Completed!");
            }
            void onError(Throwable e) {
                Log.d(tag, "Error!");
            }
        };
除了 Observer 接口之外，RxJava 还内置了一个实现了 Observer 的抽象类：Subscriber。 Subscriber 对 Observer 接口进行了一些扩展，但他们的基本使用方式是完全一样的。实质上，在 RxJava 的 subscribe 过程中，Observer 也总是会先被转换成一个 Subscriber 再使用。所以如果你只想使用基本功能，选择 Observer 和 Subscriber 是完全一样的。它们的区别对于使用者来说主要有两点：
onStart(): 这是 Subscriber 增加的方法。它会在 subscribe 刚开始，而事件还未发送之前被调用，可以用于做一些准备工作，例如数据的清零或重置。这是一个可选方法，默认情况下它的实现为空。需要注意的是，如果对准备工作的线程有要求， onStart() 就不适用了，因为它总是在 subscribe 所发生的线程被调用，而不能指定线程。要在指定的线程来做准备工作，可以使用 doOnSubscribe() 方法。
unsubscribe(): 这是 Subscriber 所实现的另一个 Subscription 接口的方法，用于取消订阅。在这个方法被调用后，Subscriber 将不再接收事件。一般在这个方法调用前，可以使用 isUnsubscribed() 先判断一下状态。 unsubscribe() 这个方法很重要，因为在subscribe() 之后， Observable 会持有 Subscriber 的引用，这个引用如果不能及时被释放，将有内存泄露的风险。所以最好保持一个原则：要在不再使用的时候尽快在合适的地方调用 unsubscribe() 来解除引用关系，以避免内存泄露的发生。
正如前面所提到的原因，从这里开始，后面的描述我将用 Subscriber 来代替 Observer ，这样更加严谨。
2、创建 Observable，它决定什么时候触发事件以及触发怎样的事件。 
RxJava 使用 create() 方法来创建一个 Observable ，并为它定义事件触发规则：
        Observable observable = Observable.create(new Observable.OnSubscribe<String>() {
            @Overridepublic
            void call(Subscriber<? super String> subscriber) {
                subscriber.onNext("Hello");
                subscriber.onNext("Hi");
                subscriber.onNext("Aloha");
                subscriber.onCompleted();
            }
        });
可以看到，这里传入了一个 OnSubscribe 对象作为参数。OnSubscribe 会被存储在返回的 Observable 对象中，它的作用相当于一个计划表，当 Observable 被订阅的时候，OnSubscribe 的 call() 方法会自动被调用，事件序列就会依照设定依次触发。这样，由被观察者调用了观察者的回调方法，就实现了由被观察者向观察者的事件传递，即观察者模式。

create() 方法是 RxJava 最基本的创造事件序列的方法。基于这个方法， RxJava 还提供了一些方法用来快捷创建事件队列，如上面的示例等价于
just(T...)：将传入的参数依次发送出来 Observable observable = Observable.just("Hello", "Hi", "Aloha");
from(T[]) / from(Iterable<? extends T>)：将传入的数组或 Iterable 拆分成具体对象后依次发送出来  Observable observable = Observable.from(new String[]{"Hello", "Hi", "Aloha"});
3、使用订阅方法subscribe()将它们联结起来
代码形式很简单：
observable.subscribe(observer或subscriber);
有人可能会注意到， subscribe() 这个方法有点怪：它看起来是『observalbe 订阅了 observer / subscriber』而不是『observer /subscriber 订阅了 observalbe』，这看起来就像『杂志订阅了读者』一样颠倒了对象关系。这让人读起来有点别扭，不过如果按照那种设计虽然更加符合思维逻辑，但对流式 API 的设计就造成影响了，比较起来明显是得不偿失的。
Observable.subscribe(Subscriber) 的内部实现是这样的（仅核心代码）：
    public Subscription subscribe(Subscriber subscriber) {
        subscriber.onStart();
        onSubscribe.call(subscriber);
        return subscriber;
    }
可以看到，subscribe() 做了3件事：
调用 Subscriber.onStart() ，这是一个可选的准备方法
调用 Observable 中的 OnSubscribe.call(Subscriber) 。在这里，事件发送的逻辑开始运行。从这也可以看出，在 RxJava 中，Observable 并不是在创建的时候就立即开始发送事件，而是在它被订阅的时候，即当 subscribe() 方法执行的时候
将传入的 Subscriber 作为 Subscription 返回。这是为了方便 unsubscribe()
不完整定义回调
除了 subscribe(Observer) 和 subscribe(Subscriber) ，subscribe() 还支持不完整定义的回调，RxJava 会自动根据定义创建出Subscriber 。形式如下：
        Action1<String> onNextAction = new Action1<String>() {
            public void call(String s) { // onNext()
            }
        };
        Action1<Throwable> onErrorAction = new Action1<Throwable>() {
            public void call(Throwable throwable) { // onError()
            }
        };
        Action0 onCompletedAction = new Action0() {
            @Override
            public void call() {// onCompleted()
            }
        };
        observable.subscribe(onNextAction);// 自动创建 Subscriber，并使用 onNextAction 来定义 onNext()
        observable.subscribe(onNextAction, onErrorAction);
        observable.subscribe(onNextAction, onErrorAction, onCompletedAction);
        这段代码中出现的Action0 是 RxJava 中定义的一个接口，它只有一个方法 call()，这个方法是无参无返回值的，由于 onCompleted() 方法也是无参无返回值的，因此 Action0 可以被当成一个包装对象，将 onCompleted() 的内容打包起来将自己作为一个参数传入 subscribe() 以实现不完整定义的回调。这样其实也可以看做将 onCompleted() 方法作为参数传进了subscribe()，相当于其他某些语言中的『闭包』。 
        Action1 也是一个接口，它同样只有一个方法 call(T param)，这个方法也无返回值，但有一个参数；与 Action0 同理，由于 onNext(T obj) 和 onError(Throwable error) 也是单参数无返回值的，因此 Action1 可以将onNext(obj) 和 onError(error) 打包起来传入 subscribe() 以实现不完整定义的回调。
        事实上，虽然 Action0 和 Action1 在 API 中使用最广泛，但 RxJava 是提供了多个 ActionX 形式的接口 (例如 Action2, Action3) 的，它们可以被用以包装不同的无返回值的方法。
场景示例
将字符串数组中的所有字符串依次打印出来：
        Observable.from(new String[]{"包青天", "白乾涛", "baiqiantao"}).subscribe(new Action1<String>() {
            @Override
            public void call(String name) {Log.i("bqt", name);}
        });

线程控制

在 RxJava 的默认规则中，事件的发出和消费都是在同一个线程的。也就是说，如果只用上面的方法，实现出来的只是一个同步的观察者模式。观察者模式本身的目的就是『后台处理，前台回调』的异步机制，因此异步对于 RxJava 是至关重要的。而要实现异步，则需要用到 RxJava 的另一个概念： Scheduler （调度程序，日程安排程序）。
Scheduler 的 API 
在RxJava 中，Scheduler（调度器）相当于线程控制器，RxJava 通过它来指定每一段代码应该运行在什么样的线程。RxJava 已经内置了几个 Scheduler ，它们已经适合大多数的使用场景：
Schedulers.immediate()：直接在当前线程运行，相当于不指定线程，这是默认的 Scheduler。
Schedulers.newThread()：总是启用新线程，并在新线程执行操作。
Schedulers.io()：I/O 操作（读写文件、读写数据库、网络信息交互等）所使用的 Scheduler。行为模式和 newThread() 差不多，区别在于 io() 的内部实现是是用一个无数量上限的线程池，可以重用空闲的线程，因此多数情况下 io() 比 newThread() 更有效率。不要把计算工作放在 io() 中，可以避免创建不必要的线程。
Schedulers.computation()：计算所使用的 Scheduler。这个计算指的是 CPU 密集型计算，即不会被 I/O 等操作限制性能的操作，例如图形的计算。这个 Scheduler 使用的固定的线程池，大小为 CPU 核数。不要把 I/O 操作放在 computation() 中，否则 I/O 操作的等待时间会浪费 CPU。
AndroidSchedulers.mainThread()，是Android 专用的Scheduler，它指定的操作将在 Android 主线程运行。
有了这几个 Scheduler ，就可以使用 subscribeOn() 或 observeOn() 两个方法来对线程进行控制了。
subscribeOn(): 指定subscribe() 所发生的线程，即 Observable.OnSubscribe 被激活时所处的线程。或者叫做事件产生的线程。
observeOn(): 指定Subscriber 所运行在的线程。或者叫做事件消费的线程。
示例
        Observable.just(1, 2, 3, 4)
                .subscribeOn(Schedulers.io()) // 指定 subscribe() 发生在 IO 线程
                .observeOn(AndroidSchedulers.mainThread()) // 指定 Subscriber 的回调发生在主线程
                .subscribe(new Action1<Integer>() {
                    @Override
                    public void call(Integer number) {
                        Log.d(tag, "number:" + number);
                    }
                });
事实上，这种在 subscribe() 之前写上两句 subscribeOn(Scheduler.io()) 和 observeOn(AndroidSchedulers.mainThread()) 的使用方式非常常见，它适用于多数的 『后台线程取数据，主线程显示』的程序策略。
Scheduler 的原理
╮(╯▽╰)╭，以后再扯了

变换

RxJava 提供了对事件序列进行变换的支持，这是它的核心功能之一，也是大多数人说『RxJava 真是太好用了』的最大原因。
所谓变换，就是将事件序列中的对象或整个序列进行加工处理，转换成不同的事件或事件序列。
1、map()
首先看一个 map() 的例子：
        Observable.just("images/logo.png") // 输入类型 String
                .map(new Func1<String, Bitmap>() {
                    @Override
                    public Bitmap call(String filePath) { // 参数类型 String
                        return getBitmapFromPath(filePath); // 返回类型 Bitmap
                    }
                }).subscribe(new Action1<Bitmap>() {
                    @Override
                    public void call(Bitmap bitmap) { // 参数类型 Bitmap
                        showBitmap(bitmap);
                    }
                });
这里出现了一个叫做 Func1 的类，它和 Action1 非常相似，也是 RxJava 的一个接口，用于包装含有一个参数的方法。和 ActionX 一样， FuncX 也有多个，用于不同参数个数的方法，FuncX 和ActionX 的区别在 FuncX 包装的是有返回值的方法。
可以看到，map() 方法将参数中的 String 对象转换成一个 Bitmap 对象后返回，而在经过 map() 方法后，事件的参数类型也由 String 转为了 Bitmap。
这种直接变换对象并返回的，是最常见的也最容易理解的变换。不过 RxJava 的变换远不止这样，它不仅可以针对事件对象，还可以针对整个事件队列，这使得 RxJava 变得非常灵活。
2、flatMap()
这是一个很有用但非常难理解的变换。假设有一个数据结构『学生』，每个学生有多个课程，请打印出每个学生所需要修的所有课程的名称：
        Subscriber<Course> subscriber = new Subscriber<Course>() {
            @Override
            public void onNext(Course course) {
                Log.d(tag, course.getName());
            }
        };
        Observable.from(students)
            .flatMap(new Func1<Student, Observable<Course>>() {
                @Override
                public Observable<Course> call(Student student) {
                    return Observable.from(student.getCourses());
                }
            })
            .subscribe(subscriber);
从上面的代码可以看出， flatMap() 和 map() 有一个相同点：它也是把传入的参数转化之后返回另一个对象。但需要注意，和map() 不同的是， flatMap() 中返回的是个 Observable 对象，并且这个 Observable 对象并不是被直接发送到了 Subscriber 的回调方法中。
flatMap() 的原理是这样的：
1. 使用传入的事件对象创建一个 Observable 对象；
2. 并不发送这个 Observable，而是将它激活，于是它开始发送事件；
3. 每一个创建出来的 Observable 发送的事件，都被汇入同一个 Observable，而这个 Observable 负责将这些事件统一交给Subscriber 的回调方法。
这三个步骤，把事件拆成了两级，通过一组新创建的 Observable 将初始的对象『铺平』之后通过统一路径分发了下去。而这个『铺平』就是 flatMap() 所谓的 flat。
扩展
由于可以在嵌套的 Observable 中添加异步代码， flatMap() 也常用于嵌套的异步操作，例如嵌套的网络请求。
示例代码（Retrofit + RxJava）：
        networkClient.token() // 返回 Observable<String>，在订阅时请求 token，并在响应后发送 token
        .flatMap(new Func1<String, Observable<Messages>>() {
            @Override
            public Observable<Messages> call(String token) {
                return networkClient.messages(); // 返回 Observable<Messages>，在订阅时请求消息列表，并在响应后发送请求到的消息列表
            }
        })
        .subscribe(new Action1<Messages>() {
            @Override
            public void call(Messages messages) {
                showMessages(messages);// 处理显示消息列表
            }
        });
传统的嵌套请求需要使用嵌套的 Callback 来实现，而通过 flatMap() ，可以把嵌套的请求写在一条链中，从而保持程序逻辑的清晰。
3、throttleFirst()
在每次事件触发后的一定时间间隔内丢弃新的事件，常用作去抖动过滤，例如按钮的点击监听器：
        RxView.clickEvents(button) // RxBinding 代码，后面的文章有解释 
        .throttleFirst(500, TimeUnit.MILLISECONDS) // 设置防抖间隔为 500ms
        .subscribe(subscriber);
此外， RxJava 还提供很多便捷的方法来实现事件序列的变换，这里就不一一举例了。

变换的原理

这些变换虽然功能各有不同，但实质上都是针对事件序列的处理和再发送。而在 RxJava 的内部，它们是基于同一个基础的变换方法： lift(Operator)。首先看一下 lift() 的内部实现（仅核心代码）：
    public <R> Observable<R> lift(Operator<? extends R, ? super T> operator) {
        return Observable.create(new OnSubscribe<R>() {
            @Override
            public void call(Subscriber subscriber) {
                Subscriber newSubscriber = operator.call(subscriber);
                newSubscriber.onStart();
                onSubscribe.call(newSubscriber);
            }
        });
    }
这段代码很有意思：它生成了一个新的 Observable 并返回，而且创建新 Observable 所用的OnSubscribe参数的回调方法 call() 中的实现竟然看起来和前面讲过的 Observable.subscribe() 一样！然而它们并不一样哟~~~不一样的地方关键就在于第二行 onSubscribe.call(subscriber) 中的 onSubscribe 所指代的对象不同。
高能预警：接下来的几句话可能会导致身体的严重不适！

subscribe() 中这句话的 onSubscribe 指的是 Observable 中的 onSubscribe 对象，这个没有问题，但是 lift() 之后的情况就复杂了点。
当含有 lift() 时： 
1、lift() 创建了一个 Observable 后，加上之前的原始 Observable，已经有两个 Observable 了； 
2、而同样地，新 Observable 里的新 OnSubscribe 加上之前的原始 Observable 中的原始 OnSubscribe，也就有了两个 OnSubscribe； 
3、当用户调用经过 lift() 后的 Observable 的 subscribe() 的时候，使用的是 lift() 所返回的新的 Observable ，于是它所触发的 onSubscribe.call(subscriber)，也是用的新 Observable 中的新 OnSubscribe，即在 lift() 中生成的那个 OnSubscribe； 
4、而这个新 OnSubscribe 的 call() 方法中的 onSubscribe ，就是指的原始 Observable 中的原始 OnSubscribe ，在这个 call() 方法里，新 OnSubscribe 利用 operator.call(subscriber) 生成了一个新的 Subscriber（Operator 就是在这里，通过自己的 call() 方法将新 Subscriber 和原始 Subscriber 进行关联，并插入自己的『变换』代码以实现变换），然后利用这个新 Subscriber 向原始 Observable 进行订阅。 
这样就实现了 lift() 过程，有点像一种代理机制，通过事件拦截和处理实现事件序列的变换。
精简掉细节的话，也可以这么说：在 Observable 执行了 lift(Operator) 方法之后，会返回一个新的 Observable，这个新的 Observable 会像一个代理一样，负责接收原始的 Observable 发出的事件，并在处理后发送给 Subscriber。
举一个具体的 Operator 的实现。下面这是一个将事件中的 Integer 对象转换成 String 的例子，仅供参考：
        observable.lift(new Observable.Operator<String, Integer>() {
            @Override
            public Subscriber<? super Integer> call(final Subscriber<? super String> subscriber) {
                return new Subscriber<Integer>() {// 将事件序列中的 Integer 对象转换为 String 对象
                    @Override
                    public void onNext(Integer integer) {
                        subscriber.onNext("" + integer);
                    }
                    @Override
                    public void onCompleted() {
                        subscriber.onCompleted();
                    }
                    @Override
                    public void onError(Throwable e) {
                        subscriber.onError(e);
                    }
                };
            }
        });
讲述 lift() 的原理只是为了让你更好地了解 RxJava，从而可以更好地使用它。然而不管你是否理解了 lift() 的原理，RxJava 都不建议开发者自定义Operator 来直接使用 lift()，而是建议尽量使用已有的 lift() 包装方法（如 map()、flatMap() 等）进行组合来实现需求，因为直接使用 lift() 非常容易发生一些难以发现的错误。

针对自身变换

除了 lift() 之外， Observable 还有一个变换方法叫做 compose(Transformer)。它和 lift() 的区别在于， lift() 是针对事件项和事件序列的，而 compose() 是针对 Observable 自身进行变换。
举个例子，假设在程序中有多个 Observable ，并且他们都需要应用一组相同的 lift() 变换。你可以这么写：
        observable1.lift1().lift2().lift3().lift4().subscribe(subscriber1);
        observable2.lift1().lift2().lift3().lift4().subscribe(subscriber2);
你觉得这样太不软件工程了，于是你改成了这样：
    private Observable liftAll(Observable observable) {
        return observable.lift1().lift2().lift3().lift4();
    }
        liftAll(observable1).subscribe(subscriber1);
        liftAll(observable2).subscribe(subscriber2);
可读性、可维护性都提高了。可是 Observable 被一个方法包起来，这种方式对于 Observale 的灵活性似乎还是增添了那么点限制。怎么办？这个时候，就应该用 compose() 来解决了：
public class LiftAllTransformer implements Observable.Transformer<Integer, String> {
    @Override
    public Observable<String> call(Observable<Integer> observable) {
        return observable.lift1().lift2().lift3().lift4();
    }
}
        observable1.compose(liftAll).subscribe(subscriber1);
        observable2.compose(liftAll).subscribe(subscriber2);
像上面这样，使用 compose() 方法，Observable 可以利用传入的 Transformer 对象的 call 方法直接对自身进行处理，也就不必被包在方法的里面了。

来自为知笔记(Wiz)