RxJava2 + Retrofit2 結合使用詳解

不講 rxjava 和 retrofit 而是直接上手 2 了,因爲 2 封裝的更好用的更多。

1. 觀察者模式

常見的 button 點擊事件爲例,button 是被觀察者,listener 是觀察者,setOnClickListener 過程是訂閱,有了訂閱關係後在 button 被點擊的時候,監聽者 listener 就可以響應事件。

這裏的button.setOnClickListener(listener)看上去意思是被觀察者訂閱了觀察者(雜誌訂閱了讀者),邏輯上不符合日常生活習慣。其實這是設計模式的習慣,不必糾結,習慣了這種模式就利於理解觀察者模式了。

2. RxJava 中的觀察者模式

  • Observable:被觀察者(ble 結尾的單詞一般表示 可...的,可觀察的)
  • Observer:觀察者(er 結尾的單詞一般表示 ...者,...人)
  • subscribe:訂閱

首先創建 Observable 和 Observer,然後 observable.subscribe(observer),這樣 Observable 發出的事件就會被 Observer 響應。一般我們不手動創建 Observable,而是由 Retrofit 返回給我們,我們拿到 Observable 之後只需關心如何操作 Observer 中的數據即可。
不過爲了由淺入深的演示,還是手動創建 Observable 來講解。

2.1 創建 Observable

常見的幾種方式,不常用的不寫了,因爲我覺得這個模塊不是重點。

  • var observable=Observable.create(ObservableOnSubscribe<String> {...})
  • var observable=Observable.just(...)
  • var observable = Observable.fromIterable(mutableListOf(...))

2.1.1 create()

var observable2=Observable.create(object :ObservableOnSubscribe<String>{
            override fun subscribe(emitter: ObservableEmitter<String>) {
                emitter.onNext("Hello ")
                emitter.onNext("RxJava ")
                emitter.onNext("GoodBye ")
                emitter.onComplete()            }

        })

ObservableOnSubscribeObservableEmitter都是陌生人,這個要是詳細講涉及到源碼分析,東西可就多了(主要是我不熟悉),所以可以理解成 ObservableOnSubscribe 是用來幫助創建 Observable 的,ObservableEmitter 是用來發出事件的(這些事件在觀察者 Observer 中可以響應處理)。
emitter 一次發射了三個事件,然後調用了 onComplete() 這些在下面講觀察者 Observer 時還會提到,一併講解。

2.1.2 just

var observable=Observable.just("Hello","RxJava","GoodBye")

這句的效果等同於上面用 create 創建 observable,即 調用 3 次 onNext 後再調 onComplete。

2.1.3 fromIterable

var observable = Observable.fromIterable(mutableListOf("Hello","RxJava","GoodBye"))

這句的效果等同於上面用 create 創建 observable,即 調用 3 次 onNext 後再調 onComplete。

2.2 創建 Observer

val observer = object : Observer<String> {
            override fun onComplete() {
                Log.e("abc", "-----onComplete-----")
            }

            override fun onSubscribe(d: Disposable) {
                Log.e("abc", "-----onSubscribe-----")
            }

            override fun onNext(t: String) {
                Log.e("abc", "-----onNext-----$t")
            }

            override fun onError(e: Throwable) {
                Log.e("abc", "-----onError-----$e")
            }
        }
//訂閱
observable.subscribe(observer)

log 打印情況:

-----onSubscribe-----
-----onNext-----Hello
-----onNext-----RxJava
-----onNext-----GoodBye
-----onComplete-----

可以看到,先是建立訂閱關係,然後根據前面 observable 的發射順序來打印 onNext,參數通過 onNext(t: String) 傳進來,最後調用 onComplete,多說一句,在 just 和 fromIterable 的情況下,沒有手動調用 Emitter,但是仍會先調用 onNext,最後調用 onComplete

2.3 Consumer 和 Action

這兩個詞意思分別是消費者(可以理解爲消費被觀察者發射出來的事件)和行爲(可以理解爲響應被觀察者的行爲)。對於 Observer 中的 4 個回調方法,我們未必都能用得到,如果只需要用到其中的一部分,就需要 Consumer 和 Action 上場了。

有參數的onSubscribeonNextonError我們用 Consumer 來代替,無參的onComplete用 Action 代替:

2.3.1 subscribe(Consumer<? super T> onNext)

observable.subscribe(object :Consumer<String>{
            override fun accept(t: String?) {
                Log.e("abc", "-----onNext-----$t")
            }
        })
//打印
-----onNext-----Hello
-----onNext-----RxJava
-----onNext-----GoodBye

說明一下,如果 subscribe 中我們只傳一個對象參數,那隻能是subscribe(Consumer<? super T> onNext)(onNext 方法),不能是 Action 或 Consumer<? super Throwable> onError、Consumer<? super Disposable> onSubscribe

==注意==:Consumer 中的回調方法名稱是 accept,區別於前面的 onNext

2.3.2 subscribe(Consumer<? super T> onNext, Consumer<? super Throwable> onError)

帶有兩個 Consumer 參數,分別負責 onNext 和 onError 的回調。

observable.subscribe(object : Consumer<String> {
            override fun accept(t: String?) {
                Log.e("abc", "-----onNext-----$t")
            }
        }, object : Consumer<Throwable> {
            override fun accept(t: Throwable?) {
                Log.e("abc", "-----onError-----$e")
            }
        })

如果想要一個帶有兩個 Consumer 但是不是這種搭配(比如subscribe(Consumer<? super T> onNext, Consumer<? super Disposable> onSubscribe)),可以嗎?答案是:不行

2.3.3 subscribe(Consumer<? super T> onNext, Consumer<? super Throwable> onError,Action onComplete)

帶有三個參數,分別負責onNext、onError和onComplete的回調。

observable.subscribe(object : Consumer<String> {
            override fun accept(t: String?) {
                Log.e("abc", "-----onNext-----$t")
            }
        }, object : Consumer<Throwable> {
            override fun accept(t: Throwable?) {
                Log.e("abc", "-----onError-----$e")
            }
        }, object : Action {
            override fun run() {
                Log.e("abc", "-----onComplete-----")
            }
        })

同樣,三個參數只能有這一種搭配

==注意==:Action 中的回調方法名稱是 run,區別於前面的 onComplete

2.3.4 subscribe(Consumer<? super T> onNext, Consumer<? super Throwable> onError,Action onComplete, Consumer<? super Disposable> onSubscribe)

這種情況和直接 new 出來的 Observer 效果一樣。

observable2.subscribe(object : Consumer<String> {
            override fun accept(t: String?) {
                Log.e("abc", "-----onNext-----$t")
            }
        }, object : Consumer<Throwable> {
            override fun accept(t: Throwable?) {
                Log.e("abc", "-----onError-----$e")
            }
        }, object : Action {
            override fun run() {
                Log.e("abc", "-----onComplete-----")
            }
        },object : Consumer<Disposable>{
            override fun accept(t: Disposable?) {
                Log.e("abc", "-----onSubscribe-----")            }
        })

3. 變換

在上面的例子中,Observable 發送的都是 String 類型的數據,所以在 Observer 中接收的也都是 String,現實開發中的數據多種多樣,而且有時候 Observable 提供的數據不是我們理想的情況,這種情況下就需要用到轉換操作符。
同樣我們只講常用的:

3.1 map

比如我們想把上游的 Int 類型的數據轉換成 String 可以這樣操作:

Observable.fromIterable(mutableListOf<Int>(1, 3, 5, 7, 8))
                .map(object : Function<Int, String> {
                    override fun apply(t: Int): String {
                        return "zb$t"
                    }
                })
                .subscribe(object : Consumer<String> {
                    override fun accept(t: String?) {
                        Log.e("abc","-- $t --")
                    }
                })
//Log日誌
-- zb1 --
-- zb3 --
-- zb5 --
-- zb7 --
-- zb8 --

通過map操作符,Int 類型數據,到 Consumer 裏已經成了 String(這裏爲了簡單的只看數據就沒用 Observer 而改用 Consumer,兩者都可以)。這裏面用到了Function,它的第一個泛型是 Observable 中發射的數據類型,第二個泛型是我們想要裝換之後的數據類型,在 Function 的 apply 方法中手動完成數據的轉化。
示意圖:map 把圓的變成了方的。
map

3.2 flatMap

與 map 相似,不過 flatMap 返回的是一個 Observable,也就是說 Function 的第二個泛型固定了,就是 Observable,這樣說不太好理解,看個例子:
假如現在有多個學生,每個學生有多個科目,每個科目考了多次試,現在要打印所有的分數。單單隻用 map 就不能直接搞定,試試吧

class Course(var name: String, var scores: MutableList<Int>)
class Student(var name: String, var courses: MutableList<Course>)

var stu1Course1 = Course("體育",mutableListOf(80, 81, 82))
var stu1Course2 = Course("美術",mutableListOf(63, 62, 60))
var stu1 = Student("StuA", mutableListOf(stu1Course1, stu1Course2))
var stu2Course1 = Course("音樂",mutableListOf(74, 77, 79))
var stu2Course2 = Course("希臘語",mutableListOf(90, 90, 91))
var stu2 = Student("StuB", mutableListOf(stu2Course1, stu2Course2))

Observable.just(stu1,stu2)
                .map(object :Function<Student,MutableList<Course>>{
                    override fun apply(t: Student): MutableList<Course> {
                        return t.courses
                    }
                })
                .subscribe(object :Consumer<MutableList<Course>>{
                    override fun accept(t: MutableList<Course>?) {
                        for (item in t!!){
                            for (i in item.scores){
                                Log.e("abc","--->$i")
                            }
                        }
                    }
                })

通過兩層 for 循環可以打印,這也是沒辦法的事,因爲在 map 裏面只能拿到 Course 集合。使用 flatMap 的情況是這樣的:

Observable.just(stu1, stu2)
                .flatMap(object : Function<Student, ObservableSource<Course>> {
                    override fun apply(t: Student): ObservableSource<Course> {
                        return Observable.fromIterable(t.courses)
                    }
                })
                .flatMap(object : Function<Course, ObservableSource<Int>> {
                    override fun apply(t: Course): ObservableSource<Int> {
                        return Observable.fromIterable(t.scores)
                    }

                })
                .subscribe(object : Consumer<Int> {
                    override fun accept(t: Int?) {
                        Log.e("abc", "---> $t")
                    }
                })
// log 打印
    ---> 80
    ---> 81
    ---> 82
    ---> 63
    ---> 62
    ---> 60
    ---> 74
    ---> 77
    ---> 79
    ---> 90
    ---> 90
    ---> 91

用了兩次 flatMap,鏈式調用比縮進式更清晰。這裏面的 flatMap 返回值類型的是 ObservableSource 並不是我們在前面提到的 Observable,查看 Observable 源碼可以看到,它繼承了 ObservableSource,所以這種多態用法是可以的。
另外在 apply 中返回的Observable.fromIterable(t.courses)這一句不就是我們創建 Observable 的方式嗎?
簡單的說,map 是把 Observable 發射的數據變換一下類型,flatMap 是把數據中集合/數組中的每個元素再次通過 Observable 發射。
示意圖:faltMap 把一系列圓的通過一系列的 Observable 變成了一系列方的。
map

圖雖然畫的醜,但是我想意思比較明白了。

3.3 filter

filter是過濾的意思,通過判斷是否符合我們想要的邏輯,來決定是否發射事件,只有返回 true 的事件才被髮射,其他的被拋棄。還以上面的例子爲例,假如我們只想看 80 分以上的成績可以這樣過濾:

Observable.just(stu1, stu2)
                .flatMap(object : Function<Student, ObservableSource<Course>> {
                    override fun apply(t: Student): ObservableSource<Course> {
                        return Observable.fromIterable(t.courses)
                    }
                })
                .flatMap(object : Function<Course, ObservableSource<Int>> {
                    override fun apply(t: Course): ObservableSource<Int> {
                        return Observable.fromIterable(t.scores)
                    }

                })
                .filter(object :Predicate<Int>{
                    override fun test(t: Int): Boolean {
                        return t > 80
                    }

                })
                .subscribe(object : Consumer<Int> {
                    override fun accept(t: Int?) {
                        Log.e("abc", "---> $t")
                    }
                })
// log 打印
    ---> 81
    ---> 82
    ---> 90
    ---> 90
    ---> 91

注意,filter 裏面不是用 Function 了,而是 Predicate,這個單詞是“基於...”的意思,基於 t > 80,也就是選擇大於 80 分的成績。

4. 結合 Retrofit 使用

前面 3 小節講了很多,都是爲了講清楚 RxJava 的整個工作流程,還沒涉及到線程切換。現實開發中更多的時候 Observable 是通過 Retrofit 返回給我們的。Retrofit 是一個網絡請求框架,它基於 OkHttp3,做了更好的封裝,結合 RxJava 用慣了的話可以大大提到開發效率。還是一樣,我們只看怎麼用,不涉及源碼解讀。

4.1 Retrofit 進行簡單的 Get 請求

implementation 'com.squareup.retrofit2:retrofit:2.6.2'
implementation 'com.squareup.retrofit2:converter-gson:2.6.2'

先引入依賴,然後我們請求一個知乎日報的新聞數據(點擊查看數據:https://news-at.zhihu.com/api...

// ZhEntity
class ZhEntity {
    var date: String? = null
    var stories: MutableList<StoriesBean>? = null
    var top_stories: MutableList<TopStoriesBean>? = null

    class StoriesBean {
        var image_hue: String? = null
        var title: String? = null
        var url: String? = null
        var hint: String? = null
        var ga_prefix: String? = null
        var type: Int = 0
        var id: Int = 0
        var images: MutableList<String>? = null
    }

    class TopStoriesBean {
        var image_hue: String? = null
        var hint: String? = null
        var url: String? = null
        var image: String? = null
        var title: String? = null
        var ga_prefix: String? = null
        var type: Int = 0
        var id: Int = 0
    }
}
// ApiService
import retrofit2.Call
import retrofit2.http.GET
import retrofit2.http.Url
interface ApiService {
    @GET("news/latest")
    fun getLatestNews(): Call<ZhEntity>
}
// 調用
val retrofit = Retrofit.Builder()
                .addConverterFactory(GsonConverterFactory.create())
                .baseUrl("https://news-at.zhihu.com/api/4/")
                .build()
        val service: ApiService = retrofit.create(ApiService::class.java)
        val call: Call<ZhEntity> = service.getLatestNews()
        call.enqueue(object : Callback<ZhEntity> {
            override fun onFailure(call: Call<ZhEntity>?, t: Throwable?) {
                Log.e("abc", "--> $t")
            }

            override fun onResponse(call: Call<ZhEntity>?, response: Response<ZhEntity>?) {
                Log.e("abc", "-->${Gson().toJson(response?.body())}")
            }
        })

代碼有點多,分別解釋一下,ZhEntity 是實體類,ApiService 是一個接口,裏面用註解的方式定義了一個方法 getLatestNews,@GET表示 Get 請求,由此可以想象肯定有@POST@GET裏面還有參數,這是請求地址 BaseUrl 後面的子文件夾。

getLatestNews 函數返回類型是 Call,這個是 Retrofit 定義用來請求網絡的。
第三段代碼,現實創建了一個 Retrofit 對象,addConverterFactory(GsonConverterFactory.create())是把接口返回的 json 類型的數據轉換成實體類的類型,這個東西在implementation 'com.squareup.retrofit2:converter-gson:2.6.2'時被引入。

然後是一系列的 Call 調用 qnqueue 操作什麼的,看得出,沒有用 Rxjava 一樣可以完成網絡請求,而且代碼不復雜,好了,本文到此結束。

好吧,我在扯淡。繼續講,有人說不喜歡 url 被截成兩段,可以這樣修改,效果完全相同:

// ApiService
import retrofit2.Call
import retrofit2.http.GET
import retrofit2.http.Url
interface ApiService {
    @GET
    fun getLatestNews(@Url url:String): Call<ZhEntity>
}
// 調用
val retrofit = Retrofit.Builder()
                .addConverterFactory(GsonConverterFactory.create())
                .baseUrl("https://www.baidu.com")
                .build()
        val service: ApiService = retrofit.create(ApiService::class.java)
        val call: Call<ZhEntity> = service.getLatestNews("https://news-at.zhihu.com/api/4/news/latest")
        call.enqueue(object : Callback<ZhEntity> {
            override fun onFailure(call: Call<ZhEntity>?, t: Throwable?) {
                Log.e("abc", "--> $t")
            }

            override fun onResponse(call: Call<ZhEntity>?, response: Response<ZhEntity>?) {
                Log.e("abc", "-->${Gson().toJson(response?.body())}")
            }
        })
baseUrl 還是要的,不過設置成其他值無所謂了,因爲不會被請求。

4.2 Retrofit 結合 RxJava

囉嗦了這麼多,纔講到這裏。抱歉水平有限,沒辦法用簡單的語言說清複雜的問題。
首先,引入依賴時多加一句對 RxJava 的支持:

implementation 'com.squareup.retrofit2:retrofit:2.6.2'
implementation 'com.squareup.retrofit2:converter-gson:2.6.2'
implementation 'com.squareup.retrofit2:adapter-rxjava2:2.6.2'

然後,我們的 getLatestNews 就可以直接返回一個 Observable 了!

import io.reactivex.Observable
import retrofit2.http.GET

interface ApiService {
    @GET("news/latest")
    fun getLatestNews(): Observable<ZhEntity>
}

放心寫,不會報錯,有了 Observable,就好辦了,輕車熟路:

val retrofit = Retrofit.Builder()
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .baseUrl("https://news-at.zhihu.com/api/4/")
                .build()
        val service: ApiService = retrofit.create(ApiService::class.java)
        val observable = service.getLatestNews()
        observable.subscribeOn(Schedulers.newThread())
                .subscribe(object : Observer<ZhEntity> {
            override fun onComplete() {
            }

            override fun onSubscribe(d: Disposable) {
            }

            override fun onNext(t: ZhEntity) {
                Log.e("abc","-->${Gson().toJson(t)}")
            }

            override fun onError(e: Throwable) {
                Log.e("abc","-->$e")
            }
        })

除了 Observable 來源變了,其他與本文最早講的 RxJava 沒什麼不同。非要說不同,有一點,多了一句subscribeOn(Schedulers.newThread()),下面講講這個。

4.3 線程切換

  • subscribeOn:定義 Observable 發射事件所處的線程
  • observeOn:定義轉換/響應事件所處的線程(map、flatMap、Observer 等),可多次切換

線程切換比較常見,比如 子線程請求網絡數據主線程更新 UI,subscribeOnobserveOn有哪些線程可以選擇?它們又是怎樣使用的?我們先看一個例子:

Thread(object : Runnable {
            override fun run() {
                Log.e("abc","Thread當前線程:${Thread.currentThread().name}")
                observable.subscribeOn(Schedulers.newThread())
                        .doOnNext(object :Consumer<ZhEntity>{
                            override fun accept(t: ZhEntity?) {
                                Log.e("abc","doOnNext當前線程:${Thread.currentThread().name}")
                            }
                        })
                        .observeOn(Schedulers.io())
                        .flatMap(object :Function<ZhEntity,ObservableSource<ZhEntity.StoriesBean>>{
                            override fun apply(t: ZhEntity): ObservableSource<ZhEntity.StoriesBean> {
                                Log.e("abc","flatMap當前線程:${Thread.currentThread().name}")
                                return Observable.fromIterable(t.stories)
                            }
                        })
                        .observeOn(AndroidSchedulers.mainThread())
                        .subscribe(object : Observer<ZhEntity.StoriesBean> {
                            override fun onComplete() {
                            }

                            override fun onSubscribe(d: Disposable) {
                                Log.e("abc","onSubscribe當前線程:${Thread.currentThread().name}")
                            }

                            override fun onNext(t: ZhEntity.StoriesBean) {
                                Log.e("abc","Observer當前線程:${Thread.currentThread().name}")
                                Log.e("abc", "-->${Gson().toJson(t)}")
                            }

                            override fun onError(e: Throwable) {
                                Log.e("abc", "-->$e")
                            }
                        })
            }
        }).start()
// log 打印
Thread當前線程:Thread-4
onSubscribe當前線程:Thread-4
doOnNext當前線程:RxNewThreadScheduler-1
flatMap當前線程:RxCachedThreadScheduler-1
Observer當前線程:main
Observer當前線程:main
Observer當前線程:main

這裏面只有doOnNext沒講過,現在說說:每發送 onNext() 之前都會先回調這個方法,所以 doOnNext 和 Observable 的 subscribe(發射事件的方法)處於同一個線程。
從這個例子可以看出:

  1. Observable 和 Observer 建立訂閱關係是在當前線程中(Thread-4)
  2. subscribeOn決定 Observable 發射事件所處的線程(即 Retrofit 請求網絡所在線程)
  3. 第一次observeOn決定 flatMap 所在的線程(RxCachedThreadScheduler-1)
  4. 再次observeOn決定 Observer 所在線程(Android 主線程 main)

所以每次調用observeOn就會切換線程,並且決定的是接下來的變換/響應的線程。多說一句,多次設置 subscribeOn,只有第一次生效

線程可選值

線 程 名 稱 說明
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 主線程
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章