【Jetpack篇】協(xié)程+Retrofit網(wǎng)絡(luò)請(qǐng)求狀態(tài)封裝實(shí)戰(zhàn)

前言

在App中，對(duì)于網(wǎng)絡(luò)請(qǐng)求狀態(tài)一般性的就分為加載中、請(qǐng)求錯(cuò)誤、請(qǐng)求成功、請(qǐng)求成功但數(shù)據(jù)為null。為了用戶體驗(yàn)，不同的狀態(tài)需要對(duì)用戶展示不同的界面，例如網(wǎng)絡(luò)異常的提醒，點(diǎn)擊重新請(qǐng)求等。

之前項(xiàng)目一直都是以Retrofit+RxJava+OkHttp為網(wǎng)絡(luò)請(qǐng)求框架，RxJava已經(jīng)很好的封裝了不同的請(qǐng)求狀態(tài)，onSubscribe、onNext、onError等，只需要在不同的回調(diào)中做出相應(yīng)的動(dòng)作就ok了。

RxJava很好用，但隨著新技術(shù)的出現(xiàn)，RxJava的可替代性也就越高。Kotlin的協(xié)程就是這么一個(gè)存在。

本文是以Jetpack架構(gòu)為基礎(chǔ)，協(xié)程+Retrofit+Okhttp為網(wǎng)絡(luò)請(qǐng)求框架，對(duì)不同的請(qǐng)求狀態(tài)（loading，error，empty等）做了封裝，讓開發(fā)者不用再去關(guān)心哪里需要loading，哪里需要展示error提示。

同時(shí)，在封裝的過程中，Jetpack和協(xié)程的使用也存在著幾個(gè)坑，本文也將一一描述。

協(xié)程的基本使用

API：https://www.wanandroid.com/project/tree/json 來自鴻洋大大的wanandroid

如果需要使用協(xié)程，則添加依賴

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
}

在Retrofit2.6.0前，我們使用協(xié)程，api請(qǐng)求后返回的數(shù)據(jù)可以用Call<Data>或者Defeerd包裹處理，2.6后，可以直接返回?cái)?shù)據(jù)，只不過需要加上suspend的修飾，如下：

interface ProjectApi {

    @GET("project/tree/json")
    suspend fun loadProjectTree(): BaseResp<List<ProjectTree>>
}

因?yàn)槭褂玫氖荍etpack架構(gòu)，所以將整個(gè)網(wǎng)絡(luò)請(qǐng)求主要分為UI、ViewModel、Repository三層，以LiveData為媒介進(jìn)行通信。

首先是Repository層進(jìn)行網(wǎng)絡(luò)請(qǐng)求，

 class ProjectRepo{
    private lateinit var mService: ProjectApi

    init {
        mService = RetrofitManager.initRetrofit().getService(ProjectApi::class.java)
    }

    suspend fun loadProjectTree(): List<ProjectTree> {
        return mService.loadProjectTree()
    }
 }

利用Retrofit和OkHttp創(chuàng)建了一個(gè)apiService，內(nèi)部細(xì)節(jié)在這里就先不展開，接著直接調(diào)用loadProjectTree()進(jìn)行網(wǎng)絡(luò)請(qǐng)求，將數(shù)據(jù)返回。loadProjectTree()用suspend關(guān)鍵字進(jìn)行標(biāo)記，Kotlin 利用此關(guān)鍵字強(qiáng)制從協(xié)程內(nèi)調(diào)用函數(shù)。

接著ViewModel層，

class ProjectViewModel : ViewModel(){
      //LiveData
      val mProjectTreeLiveData = MutableLiveData<List<ProjectTree>>()
      fun loadProjectTree() {
        viewModelScope.launch(Dispatchers.IO) {
            val data = mRepo.loadProjectTree()
            mProjectTreeLiveData.postValue(data)
        }
    }
}

創(chuàng)建類ProjectViewModel并繼承ViewModel，內(nèi)部新建一個(gè)LiveData做UI通信使用，利用viewModelScope.launch(Dispatchers.IO) 創(chuàng)建一個(gè)新的協(xié)程，然后在 I/O 線程上執(zhí)行網(wǎng)絡(luò)請(qǐng)求，請(qǐng)求的數(shù)據(jù)利用LiveData通知給UI。

這里提到了viewModelScope.launch(Dispatchers.IO)，viewModelScope是一個(gè)協(xié)程的作用域，ViewModel KTX 擴(kuò)展中已經(jīng)將此作用域封裝好，直接使用就可以。Dispatchers.IO 表示此協(xié)程在 I/O線程上執(zhí)行，而launch則是創(chuàng)建一個(gè)新的協(xié)程。

最后是UI層，

class ProjectFragment : Fragment {

    override fun initData() {
        //請(qǐng)求數(shù)據(jù)，調(diào)用loadProjectTree
        mViewModel?.loadProjectTree()
        mViewModel?.mProjectTreeLiveData?.observe(this, Observer {
            //更新UI
        })
    }

UI層開始調(diào)用ViewModel的請(qǐng)求方法執(zhí)行網(wǎng)絡(luò)請(qǐng)求，LiveData注冊(cè)一個(gè)觀察者，觀察數(shù)據(jù)變化，并且更新UI。

到這里，網(wǎng)絡(luò)請(qǐng)求的邏輯基本上通順了。

在一切環(huán)境正常的情況下，上面的請(qǐng)求是可以的，但是app還存在網(wǎng)絡(luò)不暢，異常，數(shù)據(jù)為null的情況，上述就不在滿足要求了，接下來就開始對(duì)數(shù)據(jù)異常的情況進(jìn)行處理。

網(wǎng)絡(luò)請(qǐng)求異常處理

對(duì)于協(xié)程異常的處理，Android開發(fā)者的官網(wǎng)上也給出了答案（https://developer.android.google.cn/kotlin/coroutines?hl=zh-cn ） ，直接對(duì)網(wǎng)絡(luò)請(qǐng)求進(jìn)行一個(gè)try-catch處理，發(fā)生異常了，直接在catch中做出相應(yīng)動(dòng)作就ok了，我們就來看看具體實(shí)現(xiàn)。

class ProjectViewModel : ViewModel(){
      //LiveData
      val mProjectTreeLiveData = MutableLiveData<List<ProjectTree>>()
      fun loadProjectTree() {
        viewModelScope.launch(Dispatchers.IO) {
          try {
                  val data = mRepo.loadProjectTree()
                  mProjectTreeLiveData.postValue(data)
               } catch (e: Exception) {
                    //異常
                    error(e)
               } finally {
                    
               }
        }
    }
}

還是在ViewModel層，對(duì)mRepo.loadProjectTree()的請(qǐng)求加上了try-catch塊，當(dāng)發(fā)生異常時(shí)根據(jù)Exception類型對(duì)用戶做出提示。

到這里，異常的來源已經(jīng)找到了，接著就需要將異常顯示在UI層來提醒用戶。我們都知道m(xù)ProjectTreeLiveData利用PostValue將數(shù)據(jù)分發(fā)給了UI，如法炮制，也就可以利用LiveData將異常也分發(fā)給UI。

說干就干。

網(wǎng)絡(luò)請(qǐng)求狀態(tài)封裝

1、 [Error狀態(tài)]

依舊在ViewModel層，我們新添加一個(gè)針對(duì)異常的LiveData：errorLiveData

class ProjectViewModel : ViewModel(){
      //異常LiveData
      val errorLiveData = MutableLiveData<Throwable>()
      //LiveData
      val mProjectTreeLiveData = MutableLiveData<List<ProjectTree>>()
      fun loadProjectTree() {
        viewModelScope.launch(Dispatchers.IO) {
          try {
                  val data = mRepo.loadProjectTree()
                  mProjectTreeLiveData.postValue(data)
               } catch (e: Exception) {
                    //異常
                    error(e)
                    errorLiveData.postValue(e)
               } finally {
                    
               }
        }
    }
}

在UI層，利用errorLiveData注冊(cè)一個(gè)觀察者，如果有異常通知，則顯示異常的UI（UI層代碼省略）。這樣確實(shí)可以實(shí)現(xiàn)我們一開始要的功能：請(qǐng)求成功則顯示成功界面，失敗顯示異常界面。但是有一個(gè)問題，就是不夠優(yōu)雅，如果有多個(gè)ViewModel，多個(gè)UI，那就要每個(gè)頁面都要寫errorLiveData，很冗余。

那我們可以將公共方法抽離出來，新建一個(gè)BaseViewModel類,

open class BaseViewModel : ViewModel() {
     val errorLiveData = MutableLiveData<Throwable>()

     fun launch(
          block: suspend () -> Unit,
          error: suspend (Throwable) -> Unit,
          complete: suspend () -> Unit
     ) {
          viewModelScope.launch(Dispatchers.IO) {
               try {
                    block()
               } catch (e: Exception) {
                    error(e)
               } finally {
                    complete()
               }
          }
     }


}

除了定義errorLiveData外，還將新建協(xié)程的操作放到其中，開發(fā)者只需要將每個(gè)ViewModel繼承BaseViewModel，重寫launch（）即可，那么上面的案例中的ViewModel就修改成下面這種，

class ProjectViewModel : BaseViewModel(){
    
      //LiveData
      val mProjectTreeLiveData = MutableLiveData<List<ProjectTree>>()
      fun loadProjectTree() {
        launch(
            {
                val state = mRepo.loadProjectTree()
                mProjectTreeLiveData.postValue(state.data)
            },
            {
                errorLiveData.postValue(it)
            },
            {
                loadingLiveData.postValue(false)
            }
        )
    }
}

同樣的，UI層也可以新建一個(gè)BaseFragment抽象類，在onViewCreated中利用errorLiveData注冊(cè)觀察者，收到異常通知，則進(jìn)行相應(yīng)的動(dòng)作。

abstract class BaseFragment<T : ViewDataBinding, VM : BaseViewModel> : Fragment(){

   override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        mViewModel = getViewModel()
        
        mViewModel?.errorLiveData?.observe(viewLifecycleOwner, Observer {
            Log.d(TAG, "onViewCreated: error ")
            showError()
            throwableHandler(it)
        })
    }
}

每個(gè)子Fragment只需要繼承BaseFragment即可，具體的異常監(jiān)聽就不用開發(fā)者管理。

2、 [Loading狀態(tài)]

除了異常狀態(tài)外，請(qǐng)求必不可少的就是Loading，這里L(fēng)oading分為兩種，一種是整個(gè)頁面替換為L(zhǎng)oading，例如Recyclerview列表時(shí)，就可以直接整個(gè)頁面先Loading，而后顯示數(shù)據(jù)；還有一種是數(shù)據(jù)界面不替換，只是個(gè)Loading Dialog顯示在上層，例如點(diǎn)擊登錄時(shí)，需要一個(gè)loading。

Loading和異常處理的思路一致，可以在BaseViewModel中添加一個(gè)LoadingLiveData，數(shù)據(jù)類型為Boolean，在每個(gè)請(qǐng)求一開始LoadingLiveData.postValue(true)，結(jié)束請(qǐng)求或者請(qǐng)求異常時(shí)，就LoadingLiveData.postValue(false)。UI層BaseFragment中，則可以監(jiān)聽LoadingLiveData發(fā)出的是true還是false，以便對(duì)Loading的顯示和隱藏進(jìn)行控制。

ViewModel層：

open class BaseViewModel : ViewModel() {
     //加載中
     val loadingLiveData = SingleLiveData<Boolean>()
     //異常
     val errorLiveData = SingleLiveData<Throwable>()

     fun launch(
          block: suspend () -> Unit,
          error: suspend (Throwable) -> Unit,
          complete: suspend () -> Unit
     ) {
          loadingLiveData.postValue(true)
          viewModelScope.launch(Dispatchers.IO) {
               try {
                    block()
               } catch (e: Exception) {
                    Log.d(TAG, "launch: error ")
                    error(e)
               } finally {
                    complete()
               }
          }
     }
}

在BaseViewModel 中l(wèi)aunch一開始就通知Loading顯示，在try-catch-finally代碼塊的finally中將請(qǐng)求結(jié)束的通知分發(fā)出去。

UI層：

abstract class BaseFragment<T : ViewDataBinding, VM : BaseViewModel> : Fragment(){

   override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        mViewModel = getViewModel()
        //Loading 顯示隱藏的監(jiān)聽
        mViewModel?.loadingLiveData?.observe(viewLifecycleOwner, Observer {
            if (it) {
                //show loading
                showLoading()
            } else {
               
                dismissLoading()
            }
        })
        
        //請(qǐng)求異常的監(jiān)聽
        mViewModel?.errorLiveData?.observe(viewLifecycleOwner, Observer {
            Log.d(TAG, "onViewCreated: error ")
            showError()
            throwableHandler(it)
        })
    }
}

注冊(cè)一個(gè)loading的觀察者，當(dāng)通知為true時(shí)，顯示loading，false則隱藏。

3、 [Empty狀態(tài)]

數(shù)據(jù)為空的狀態(tài)發(fā)生在請(qǐng)求成功后，對(duì)于這種情況，可以直接在UI層中，請(qǐng)求成功的監(jiān)聽中對(duì)數(shù)據(jù)是否為null進(jìn)行判斷。

到這里，網(wǎng)絡(luò)請(qǐng)求的基本封裝已經(jīng)完成，但是在運(yùn)行測(cè)試的過程中，存在幾個(gè)問題需要去解決，例如網(wǎng)絡(luò)不通的情況下try-catch卻不會(huì)拋出異常。接下來就開始進(jìn)行二次封裝。

暴露問題二次封裝

問題一：網(wǎng)絡(luò)請(qǐng)求異常，try-catch卻不會(huì)將異常拋出

因?yàn)闃I(yè)務(wù)場(chǎng)景比較復(fù)雜，只依賴try-catch來獲取異常，明顯也會(huì)有所遺漏，那這種情況下我們可以直接以服務(wù)器返回的code，作為請(qǐng)求狀態(tài)的依據(jù)。以上面Wanandroid的api為例，當(dāng)errorCode=0時(shí)，則表示請(qǐng)求成功，其他的值都表示失敗，那這就好辦了。

我們新建一個(gè)密封類ResState，存放Success和Error狀態(tài)，

sealed class ResState<out T : Any> {
    data class Success<out T : Any>(val data: T) : ResState<T>()
    data class Error(val exception: Exception) : ResState<Nothing>()
}

對(duì)Repository層請(qǐng)求返回的數(shù)據(jù)進(jìn)行code判斷處理，新建一個(gè)BaseRepository類，

open class BaseRepository() {

    suspend fun <T : Any> executeResp(
        resp: BaseResp<T>, successBlock: (suspend CoroutineScope.() -> Unit)? = null,
        errorBlock: (suspend CoroutineScope.() -> Unit)? = null
    ): ResState<T> {
        return coroutineScope {
            if (resp.errorCode == 0) {
                successBlock?.let { it() }
                ResState.Success(resp.data)
            } else {
                Log.d(TAG, "executeResp: error")
                errorBlock?.let { it() }
                ResState.Error(IOException(resp.errorMsg))
            }
        }
    }

}

當(dāng)errorCode == 0時(shí)，將ResState置為Success并將數(shù)據(jù)返回，errorCode !=0時(shí)，則將狀態(tài)置為Error并將Exception返回。而子Repository則只需要繼承BaseRepository即可，

class ProjectRepo : BaseRepository() {

    suspend fun loadProjectTree(): ResState<List<ProjectTree>> {
        return executeResp(mService.loadProjectTree())
    }

修改后返回值用ResState<>包裹，并直接將請(qǐng)求的結(jié)果傳給executeResp（）方法，而ViewModel中也做出相應(yīng)的修改，

class ProjectViewModel : BaseViewModel() {
    val mProjectTreeLiveData = MutableLiveData<List<ProjectTree>>()

    fun loadProjectTree() {
        launch(
            {
                val state = mRepo.loadProjectTree()
                //添加ResState判斷
                if (state is ResState.Success) {
                    mProjectTreeLiveData.postValue(state.data)
                } else if (state is ResState.Error) {
                    Log.d(TAG, "loadProjectTree: ResState.Error")
                    errorLiveData.postValue(state.exception)
                }
            },
            {
                errorLiveData.postValue(it)
            },
            {
                loadingLiveData.postValue(false)
            }
        )
    }
}

ViewModel層新增了一個(gè)ResState判斷，通過請(qǐng)求的返回值ResState，如果是ResState.Success則將數(shù)據(jù)通知給UI，如果是ResState.Error，則將異常通知給UI。

以服務(wù)器返回的code值進(jìn)行判斷，無疑是最準(zhǔn)確的。

問題二：errorLiveData注冊(cè)觀察者一次后，不管請(qǐng)求失敗還是成功，它還是會(huì)收到通知。

這是MutableLiveData的一個(gè)特性，只要當(dāng)注冊(cè)的觀察者處于前臺(tái)時(shí)，都會(huì)收到通知。那這個(gè)特性又影響了什么呢？
我在errorLiveData的監(jiān)聽中，對(duì)不同的異常進(jìn)行了Toast的彈出提醒，如果每次進(jìn)入一個(gè)頁面，雖然請(qǐng)求成功了，但是因?yàn)閑rrorLiveData還是能接收到通知，就會(huì)彈出一個(gè)Toast提醒框。現(xiàn)象如下：

dem.gif

那我們針對(duì)MutableLiveData將其修改為單事件響應(yīng)的liveData，只有一個(gè)接收者能接收到信息，可以避免不必要的業(yè)務(wù)的場(chǎng)景中的事件消費(fèi)通知。

class SingleLiveData<T> : MutableLiveData<T>() {

    private val mPending = AtomicBoolean(false)

    @MainThread
    override fun observe(owner: LifecycleOwner, observer: Observer<in T>) {

        if (hasActiveObservers()) {
            Log.w(TAG, "多個(gè)觀察者存在的時(shí)候，只會(huì)有一個(gè)被通知到數(shù)據(jù)更新")
        }

        super.observe(owner, Observer { t ->
            if (mPending.compareAndSet(true, false)) {
                observer.onChanged(t)
            }
        })

    }

    override fun setValue(value: T?) {
        mPending.set(true)
        super.setValue(value)
    }

    @MainThread
    fun call() {
        value = null
    }

    companion object {
        private const val TAG = "SingleLiveData"
    }
}

將BaseViewModel中的MutableLiveData替換為SingleLiveData就可以了。

最后

至此，協(xié)程+Retrofit網(wǎng)絡(luò)請(qǐng)求狀態(tài)封裝也就完成了，對(duì)于Error、Empty等view的切換以及點(diǎn)擊重新請(qǐng)求等操作，這里就不一一展示了，可以移步到github里查看。最后我們來看一下請(qǐng)求效果。

demoo.gif

源碼:組件化+Jetpack+kotlin+mvvm
https://juejin.cn/user/1556564197255975/posts

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容