一點點入坑JetPack:實戰前戲NetworkBoundResource篇

前言

最近很不順利,每天晚上回家都打不到車!之前晚上10點很容易叫到車,不是說好996福報的麼?難不成大家都在享受福報,司機都忙不過來了?管他呢,就算打不到車,我也要學習,畢竟一天不學習我渾身難受!

之前幾篇文章聊過JatPack中LiveData和ViewModel的基本使用和原理。歷史文章如下:

一點點入坑JetPack:LiveData篇

一點點入坑JetPack:ViewModel篇

一點點入坑JetPack:Lifecycle篇

今天咱們繼續看一下實際的應用。實戰篇初步打算倆篇文章,分別是:

  • Google Sample寫的一個簡易的網絡框架:NetworkBoundResource。
  • MVVM項目實戰

NetworkBoundResource篇

一、什麼是NetworkBoundResource

首先來說一下 NetworkBoundResource是什麼,其實 NetworkBoundResource單純就是一個類,全類也就100+行,但是這個類結合LiveData,創造了極爲便利的常用網絡功能,比如:

  • 不請求網絡,直接使用緩存
  • 自定義策略,是否請求網絡
  • 網絡加載失敗後使用緩存
  • 返回類型處理
  • 等等

不說了,直接上代碼!先看一段這個類的使用:

// UI層直接調用這個方法,拿到LiveData,監聽即可(當然,正常來說需要設計一番,UI層直接粗暴的調用,不大合適~)
fun loadData(queryId: Long = -1): LiveData<Resource<DataResp>> {
        return object :
            NetworkBoundResource<DataResp, DataResp>(
                appExecutors
            ) {

            override fun saveCallResult(item: DataResp) {
                // 此方法,在網絡數據回來後調用,我們可以做一些持久化的邏輯
            }

            override fun shouldFetch(data: DataResp?): Boolean {
                // 自己控制,是否觸發網絡請求,如果false,則調用loadFromDb()
                return isUseNetWork
            }

            override fun loadFromDb(): LiveData<MusicStoreMainResp> {
                // 自己實現從非網絡環境下獲取數據的邏輯(比如內存,DB)
                return data
            }

            override fun createCall(): LiveData<ApiResponse<DataResp>> {
                return 
        }.asLiveData()
    }

我們可以看到,4個實現方法,分別對應了:

  • 數據返回後的持久化回調
  • 是否走網絡請求
  • 從本地請求數據(業務方自己實現)
  • 網絡請求(業務方自己實現)

對於我們業務方來說,只需要調用oadData(),然後observe(),返回的LiveData即可。

當然對應的正真的業務請求需要自己實現

二、NetworkBoundResource流程圖

也就是說NetworkBoundResource幫我們抽象了一系列的邏輯,而且,它的實現非常的短,讓我們來看一下代碼,NetworkBoundResource做了什麼?能幫我們如此簡單的完成這麼多邏輯?

三、NetworkBoundResource源碼實現

上源碼:

詳細使用可以參考Google Sample:https://github.com/googlesamples/android-architecture-components/tree/master/GithubBrowserSample

abstract class NetworkBoundResource @MainThread constructor(private val appExecutors: AppExecutors) {
//這裏是業務能拿到的數據,livedata
//MediatorLiveData不多說了吧,上文已經介紹過了
private val result = MediatorLiveData<Resource<ResultType>>()
init {
    // 先發一個LOADIN,通知業務放處理LOADING態
    result.value = Resource.loading(null)
    @Suppress("LeakingThis")
    //db也是一個數據源
    val dbSource = loadFromDb()
    result.addSource(dbSource) { data ->
        //db的第一次回調,是用來判斷數據有效期的
        result.removeSource(dbSource)
        //是否有效,業務自行定義(請求網絡的策略)
        if (shouldFetch(data)) {
            fetchFromNetwork(dbSource)
        } else {
            //數據有效,重新觀察一次,觀察者會立馬收到一次回調{Source.plug}
            result.addSource(dbSource) { newData ->
                setValue(Resource.success(newData))
            }
        }
    }
}
@MainThread
private fun setValue(newValue: Resource<ResultType>) {
    if (result.value != newValue) {
        result.value = newValue
    }
}
private fun fetchFromNetwork(dbSource: LiveData<ResultType>) {
    val apiResponse = createCall()
    // 將dbsource重新add,它將快速地發送其最新值。db有數據,但是過期了,先回調給業務展示
    // 這裏保證了,LOADING態時也可以拿到數據,並展示給用戶。
    result.addSource(dbSource) { newData ->
        setValue(Resource.loading(newData))
    }
    result.addSource(apiResponse) { response ->
        //這裏又是用來控制流程,移除,避免數據亂入,而且設計者不讓add重複的source
        result.removeSource(apiResponse)
        result.removeSource(dbSource)
        when (response) {
            is ApiSuccessResponse -> {
                appExecutors.diskIO.execute {
                    //數據回來先存緩存,這樣我們下次請求過來時,可能保證LOADING態拿到的數據是最新的。             
                    saveCallResult(processResponse(response))
                    appExecutors.mainThread.execute {
                        // 原註釋:we specially request a new live data,
                        // otherwise we will get immediately last cached value,
                        // which may not be updated with latest results received from network.
                        //重新從庫裏面讀取
                        result.addSource(loadFromDb()) { newData ->
                            setValue(Resource.success(newData))
                        }
                    }
                }
            }
            is ApiEmptyResponse -> {
                appExecutors.mainThread.execute {
                    // reload from disk whatever we had
                    result.addSource(loadFromDb()) { newData ->
                        setValue(Resource.success(newData))
                    }
                }
            }
            is ApiErrorResponse -> {
                onFetchFailed()
                result.addSource(dbSource) { newData ->
                    setValue(Resource.error(response.exception, newData))
                }
            }
        }
    }
}
// 業務方自行處理的抽象方法
protected open fun onFetchFailed() {}
fun asLiveData() = result as LiveData<Resource<ResultType>>
@WorkerThread
protected open fun processResponse(response: ApiSuccessResponse<RequestType>) = response.data
@WorkerThread
protected abstract fun saveCallResult(item: RequestType)
@MainThread
protected abstract fun shouldFetch(data: ResultType?): Boolean
@MainThread
protected abstract fun loadFromDb(): LiveData<ResultType>
@MainThread
protected abstract fun createCall(): LiveData<ApiResponse<RequestType>>
}

尾聲

這一部分,建議大家好好理解一下。因爲真的真的真的很好用,它的設計結合了LiveData一系列的巧妙應用。理解之後,大家絕對會對LiveData有更加深入的理解,並且在接下來的MVVM中,也會感受到這其中的巧妙和爽快。

接下來的實戰篇,基本就是結合NetworkBoundResource的MVVM設計,希望能夠給大家在業務架構上帶來幫助。

我是一個應屆生,最近和朋友們維護了一個公衆號,內容是我們在從應屆生過渡到開發這一路所踩過的坑,以及我們一步步學習的記錄,如果感興趣的朋友可以關注一下,一同加油~

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章