RxJava1 升級到 RxJava2 所踩過的坑

Tony沈哲發表於2017-03-19

RxJava2

RxJava2 釋出已經有一段時間了,是對 RxJava 的一次重大的升級,由於我的一個庫cv4j使用了 RxJava2 來嚐鮮,但是 RxJava2 跟 RxJava1 是不能同時存在於一個專案中的,逼不得已我得把自己所有框架中使用 RxJava 的地方以及
App 中使用 RxJava 的地方都升級到最新版本。所以我整理並記錄了一些已經填好的坑。

填坑記錄

1. RxJava1 跟 RxJava2 不能共存

如果,在同一個module中同時使用RxJava1和RxJava2,類似如下:

compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
compile 'io.reactivex.rxjava2:rxjava:2.0.7'
compile 'io.reactivex:rxandroid:1.2.0'
compile 'io.reactivex:rxjava:1.1.5'複製程式碼

那麼,很不幸你會遇到這樣的錯誤

RxJava1 升級到 RxJava2 所踩過的坑
Rxjava1和Rxjava2無法共存.jpeg

同理,在 App 中如果使用了 Rxjava2,但是某個第三方的 library 還在使用 Rxjava1 也會遇到同樣的錯誤。

上面的錯誤是因為 RxAndroid 2.0.1 本身依賴了 RxJava 2.0.1。我們嘗試去掉對 RxJava 的依賴,只留下 RxAndroid 。還是會遇到問題。

compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
//compile 'io.reactivex.rxjava2:rxjava:2.0.7'
compile 'io.reactivex:rxandroid:1.2.0'
//compile 'io.reactivex:rxjava:1.1.5'複製程式碼

RxJava1 升級到 RxJava2 所踩過的坑
去掉對Rxjava的依賴.jpeg

所以使用RxAndroid不能去掉對RxJava的依賴,我是這樣使用的。

compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
compile 'io.reactivex.rxjava2:rxjava:2.0.7'複製程式碼

官方也是這樣解釋的

Because RxAndroid releases are few and far between, it is recommended you also
explicitly depend on RxJava's latest version for bug fixes and new features.

最後,我建議要升級到 RxJava2 的時候必須所有使用的地方都要升級,並且用最新的版本。

2. 新增Flowable

RxJava1 中 Observable 不能很好地支援 backpressure ,會丟擲MissingBackpressureException。所以在 RxJava2 中 Oberservable 不再支援 backpressure ,而使用新增的 Flowable 來支援 backpressure 。關於backpressure 的理解,可以看這篇文章

Flowable的用法跟原先的Observable是一樣的。

3. ActionN 和 FuncN 改名

ActionN 和 FuncN 遵循Java 8的命名規則。
其中,Action0 改名成Action,Action1改名成Consumer,而Action2改名成了BiConsumer,而Action3 - Action9都不再使用了,ActionN變成了Consumer

同樣,Func改名成Function,Func2改名成BiFunction,Func3 - Func9 改名成 Function3 - Function9,FuncN 由 Function 取代。

4. Observable.OnSubscribe 變成 ObservableOnSubscribe

原先RxJava1的寫法:

        Observable.create(new Observable.OnSubscribe<String>() {

            @Override
            public void call(Subscriber<? super String> subscriber) {
                subscriber.onNext("hello");
            }

        }).subscribe(new Action1<String>() {

            @Override
            public void call(String s) {
                System.out.println(s);
            }
        });複製程式碼

現在的寫法:

        Observable.create(new ObservableOnSubscribe<String>() {

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

        }).subscribe(new Consumer<String>() {

            @Override
            public void accept(String s) {
                System.out.println(s);
            }
        });複製程式碼

5. ObservableOnSubscribe 中使用 ObservableEmitter 傳送資料給 Observer

結合上一條,ObservableOnSubscribe 不再使用 Subscriber 而是用 ObservableEmitter 替代。

ObservableEmitter 可以理解為發射器,是用來發出事件的,它可以發出三種型別的事件,通過呼叫emitter的onNext(T value)、onComplete()和onError(Throwable error)可以分別發出next事件、complete事件和error事件。 如果只關心next事件的話,只需單獨使用onNext()即可。

需要特別注意,emitter的onComplete()呼叫後,Consumer不再接收任何next事件。

6. Observable.Transformer 變成 ObservableTransformer

原先RxJava1的寫法:

    /**
     * 跟compose()配合使用,比如ObservableUtils.wrap(obj).compose(toMain())
     * @param <T>
     * @return
     */
    public static <T> Observable.Transformer<T, T> toMain() {
        return new Observable.Transformer<T, T>() {
           @Override
            public Observable<T> call(Observable<T> tObservable) {
                return tObservable
                        .subscribeOn(Schedulers.io())
                        .observeOn(AndroidSchedulers.mainThread());
            }
        };
    }複製程式碼

現在的寫法:

    /**
     * 跟compose()配合使用,比如ObservableUtils.wrap(obj).compose(toMain())
     * @param <T>
     * @return
     */
    public static <T> ObservableTransformer<T, T> toMain() {

        return new ObservableTransformer<T, T>() {

            @Override
            public ObservableSource<T> apply(Observable<T> upstream) {
                return upstream.subscribeOn(Schedulers.io())
                        .observeOn(AndroidSchedulers.mainThread());
            }
        };
    }複製程式碼

由於新增了Flowable,同理也增加了FlowableTransformer

    public static <T> FlowableTransformer<T, T> toMain() {

        return new FlowableTransformer<T, T>() {

            @Override
            public Publisher<T> apply(Flowable<T> upstream) {
                return upstream.subscribeOn(Schedulers.io())
                        .observeOn(AndroidSchedulers.mainThread());
            }
        };
    }複製程式碼

7. Subscription 改名為 Disposable

在 RxJava2 中,由於已經存在了 org.reactivestreams.subscription 這個類,為了避免名字衝突將原先的 rx.Subscription 改名為 io.reactivex.disposables.Disposable。

剛開始不知道,在升級 RxJava2 時發現 org.reactivestreams.subscription 這個類完全沒法做原先 rx.Subscription 的事情:(

順便說下,Disposable必須單次使用,用完就要銷燬。

8. first() 用法改變

官方文件是這麼描述的first()的用法

1.x 2.x
first() RC3 renamed to firstElement and returns Maybe
first(Func1) dropped, use filter(predicate).first()
firstOrDefault(T) renamed to first(T) and RC3 returns Single
firstOrDefault(Func1, T) renamed to first(T) and RC3 returns Single

以first(Func1)為例,first(Func1)後面還使用了push(),原先 Rxjava1會這樣寫

ConnectableObservable<Data> connectableObservable = Observable.concat(Observable.from(list)).first(new Func1<Data, Boolean>() {
                @Override
                public Boolean call(Data data) {
                    return DataUtils.isAvailable(data);
                }
            }).publish();複製程式碼

RxJava2 改成這樣

ConnectableObservable<Data> connectableObservable = Observable.concat(Observable.fromIterable(list)).filter(new Predicate<Data>() {

                @Override
                public boolean test(@NonNull Data data) throws Exception {
                    return DataUtils.isAvailable(data);
                }
            }).firstElement().toObservable().publish();複製程式碼

9. toBlocking().y 被 blockingY() 取代

在我的框架中存在著一個Optional類,它跟Java 8的Optional作用差不多,原先是使用RxJava1來編寫的。

import rx.Observable;

/**
 * 使用方法:
 *         String s = null;
 *         Optional.ofNullable(s).orElse("default")); // 如果s為null,則顯示default,否則顯示s的值
 * @author Tony Shen
 *
 */
public class Optional<T> {

    Observable<T> obs;

    public Optional(Observable<T> obs) {
        this.obs = obs;
    }

    public static <T> Optional<T> of(T value) {
        if (value == null) {
            throw new NullPointerException();
        } else {
            return new Optional<T>(Observable.just(value));
        }
    }

    public static <T> Optional<T> ofNullable(T value) {
        if (value == null) {
            return new Optional<T>(Observable.<T>empty());
        } else {
            return new Optional<T>(Observable.just(value));
        }
    }

    public T get() {
        return obs.toBlocking().single();
    }

    public T orElse(T defaultValue) {
        return obs.defaultIfEmpty(defaultValue).toBlocking().single();
    }
}複製程式碼

升級到RxJava2之後,get() 和 orElse() 方法都會報錯,修改之後是這樣的。

import io.reactivex.Observable;

/**
 * 使用方法:
 *         String s = null;
 *         Optional.ofNullable(s).orElse("default"); // 如果s為null,則顯示default,否則顯示s的值
 * @author Tony Shen
 *
 */
public class Optional<T> {

    Observable<T> obs;

    public Optional(Observable<T> obs) {
        this.obs = obs;
    }

    public static <T> Optional<T> of(T value) {
        if (value == null) {
            throw new NullPointerException();
        } else {
            return new Optional<T>(Observable.just(value));
        }
    }

    public static <T> Optional<T> ofNullable(T value) {
        if (value == null) {
            return new Optional<T>(Observable.<T>empty());
        } else {
            return new Optional<T>(Observable.just(value));
        }
    }

    public T get() {

        return obs.blockingSingle();
    }

    public T orElse(T defaultValue) {

        return obs.defaultIfEmpty(defaultValue).blockingSingle();
    }
}複製程式碼

10. PublishSubject

包括 PublishSubject 以及各種 Subject(ReplaySubject、BehaviorSubject、AsyncSubject) 都不再支援backpressure。

總結

RxJava2 所帶來的變化遠遠不止這些,以後遇到的話還會繼續整理和總結,畢竟我使用的 RxJava2 還是很少的一部分內容。

RxJava2 最好到文件依然是官方文件。如果是新專案到話,可以毫不猶豫地使用RxJava2,如果是線上上已經成熟穩定的專案,可以再等等。對於新手的話,可以直接從 RxJava2 學起,RxJava1 就直接略過吧。對於老手,RxJava2 還是使用原來的思想,區別不大,從 RxJava1 遷移到 Rxjava2 也花不了多少工夫。

參考資料:

  1. github.com/ReactiveX/R…
  2. github.com/ReactiveX/R…
  3. www.dundunwen.com/article/275…

相關文章