Kotlin + 協程 + Retrofit + MVVM優雅的實現網絡請求

前言

最近一直在修煉Kotlin，說實話真香真好用，剛好公司準備交給我一個新項目，於是打算直接用Kotlin來構建項目。剛好整體架構搭建完畢了，於是把網絡請求這一部分先分享給大家。這次使用到的是協程+ retrofit +mvvm的模式，我這兒直接用一個簡單的demo來看一下具體的實現方式吧。文章只是描述實現思路，需要demo的直接跳到文末。

項目配置

首先先引入所需要的依賴

implementation 'android.arch.lifecycle:extensions:1.1.1'
 //協程
 implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.1.1'
 implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.1.1'
 //retrofit + okHttp3
 implementation 'com.squareup.retrofit2:retrofit:2.4.0'
 implementation 'com.squareup.retrofit2:converter-gson:2.4.0'
 implementation 'com.jakewharton.retrofit:retrofit2-kotlin-coroutines-adapter:0.9.2'

實現思路

不管設計模式這些，先來一個簡單的網絡請求，就retrofit的基本實現，看看需要哪些步驟

1.創建retrofit

~~~
 val retrofit = Retrofit.Builder()
 .baseUrl(RetrofitClient.BASE_URL)
 .addConverterFactory(GsonConverterFactory.create())
 .addCallAdapterFactory(CoroutineCallAdapterFactory())
 .build()
~~~

2.創建service接口

~~~
 interface RequestService {
 @GET("wxarticle/chapters/json")
 fun getDatas() : Call<DataBean>
 }
~~~

3.發起請求

~~~
 val service = retrofit.create(RequestService::class.java)
 service.getDatas().enqueue(object : Callback<DataBean> {
 override fun onFailure(call: retrofit2.Call<DataBean>, t: Throwable) {
 TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
 }
 override fun onResponse(call: retrofit2.Call<DataBean>, response: Response<DataBean>) {
 TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
 }
 })
~~~

這只是描述了一個retrofit的簡單請求方式，實際項目中基本上都會封裝之後再使用，也爲了提高代碼的可讀性，降低各部分的耦合性，通俗點來說，只有各司其職才能把工作幹好嘛，接下來咱們就圍繞着各司其職來一個一個實現

協程實現

接下來把上面的請求換成協程的方式來實現

1.創建RetrofitClient

object爲了使RetrofitClient 只能有一個實例
~~~
 object RetrofitClient {
 val BASE_URL = "https://wanandroid.com/"
 val reqApi by lazy {
 val retrofit = Retrofit.Builder()
 .baseUrl(BASE_URL)
 .addConverterFactory(GsonConverterFactory.create())
 .addCallAdapterFactory(CoroutineCallAdapterFactory())
 .build()
 return@lazy retrofit.create(RequestService::class.java)
 }
 }
~~~

2.創建service接口類

~~~
interface RequestService {
 @GET("wxarticle/chapters/json")
 fun getDatas() : Deferred<DataBean>
}
~~~

因爲我們後續會使用到協程，所以這兒將Call換成了Deferred

3.發起請求

~~~
 GlobalScope.launch(Dispatchers.Main) {
 withContext(Dispatchers.IO){
 val dataBean = RetrofitClient.reqApi.getDatas().await()
 }
 //更新ui
 }
~~~

上面用到了協程，這兒只講述他的應用了，具體的移步官方文檔進一步瞭解。網絡請求在協程中，並且在IO調度單元，所以不用擔會阻塞主線程

協程 + ViewModel + LiveData實現

上面也只是簡單的實現，只不過是換成了協程，在項目中，還可以進一步封裝，方便使用前面也提到了MVVM，所以還用到了Android 新引入的組件架構之ViewModel和LiveData，先看ViewModel的實現

class ScrollingViewModel : ViewModel() {
 private val TAG = ScrollingViewModel::class.java.simpleName
 private val datas: MutableLiveData<DataBean> by lazy { MutableLiveData<DataBean>().also { loadDatas() } }
 private val repository = ArticleRepository()
 fun getActicle(): LiveData<DataBean> {
 return datas
 }
 private fun loadDatas() {
 GlobalScope.launch(Dispatchers.Main) {
 getData()
 }
 // Do an asynchronous operation to fetch users.
 }
 private suspend fun getData() {
 val result = withContext(Dispatchers.IO){
// delay(10000)
 repository.getDatas()
 }
 datas.value = result
 }
}

ViewModel將作爲View與數據的中間人，Repository專職數據獲取，下面看一下Repository的代碼，用來發起網絡請求獲取數據

 class ArticleRepository {
 suspend fun getDatas(): DataBean {
 return RetrofitClient.reqApi.getDatas().await()
 }
 }

在Activity中代碼如下

 private fun initData() {
 model.getActicle().observe(this, Observer{
 //獲取到數據
 toolbar.setBackgroundColor(Color.RED)
 })
 }

後續優化

1.內存泄漏問題解決方案

結和了各位大佬們的意見，將使用GlobalScope可能會出現內存泄漏的問題進行了優化。因爲在協程進行請求的過程中，若此時ViewModel銷燬，裏面的協程正在請求的話，將無法銷燬，出現內存泄漏，所以在ViewModel onCleared 裏面，即使結束協程任務，參考代碼如下。

 open class BaseViewModel : ViewModel(), LifecycleObserver{
 private val viewModelJob = SupervisorJob()
 private val uiScope = CoroutineScope(Dispatchers.Main + viewModelJob)
 //運行在UI線程的協程
 fun launchUI( block: suspend CoroutineScope.() -> Unit) {
 try {
 uiScope.launch(Dispatchers.Main) {
 block()
 }
 }catch (e:Exception){
 e.printStackTrace()
 }
 }
 override fun onCleared() {
 super.onCleared()
 viewModelJob.cancel()
 }
}

當然，最好的方式是使用viewModelScope，但是我在引入該包的時候，會報錯，由於最近比較忙暫時還沒來得急解決，後續問題有時間我也會繼續修改，還望各位大佬能幫忙指點

2.優化請求代碼

先看下之前的請求代碼

private suspend fun getData() {
 val result = withContext(Dispatchers.IO){
// delay(10000)
 repository.getDatas()
 }
 datas.value = result
 }

每一次都需要寫個withContext（），實際運用中，感覺有點不方便，於是乎想了一下，怎麼才能給他封進請求方法裏面？代碼如下

open class BaseRepository {
 suspend fun <T : Any> request(call: suspend () -> ResponseData<T>): ResponseData<T> {
 return withContext(Dispatchers.IO){ call.invoke()}
 }
}

通過在BaseRepository裏面寫了一個專門的請求方法，這樣每次只需執行request就行了請求參考如下

class ArticleRepository : BaseRepository() {
 suspend fun getDatas(): ResponseData<List<Data>> {
 return request {
 delay(10000)
 Log.i(ScrollingViewModel::class.java.simpleName,"loadDatas1 run in ${Thread.currentThread().name}")
 RetrofitClient.reqApi.getDatas().await() }
 }
}

注：這個 delay(10000)只是我測試用的，意思是休眠當前協程，防止萌新在自己項目中加上了，還是有必要說一下的

再看看ViewModel中就太簡單了

class ScrollingViewModel : BaseViewModel() {
 private val TAG = ScrollingViewModel::class.java.simpleName
 private val datas: MutableLiveData<List<Data>> by lazy { MutableLiveData<List<Data>>().also { loadDatas() } }
 private val repository = ArticleRepository()
 fun getActicle(): LiveData<List<Data>> {
 return datas
 }
 private fun loadDatas() {
 launchUI {
 Log.i(TAG,"loadDatas1 run in ${Thread.currentThread().name}")
 val result = repository.getDatas()
 Log.i(TAG,"loadDatas3 run in ${Thread.currentThread().name}")
 datas.value = result.data
 }
 // Do an asynchronous operation to fetch users.
 }
}

注意看請求部分，就兩句話，一句發起請求val result = repository.getDatas()，然後就是爲我們的LiveData賦值了，看起有沒有同步代碼的感覺，這就是協程的魅力所在，爲了驗證我們的請求沒有阻塞主線程，我打印了日誌

06-19 12:26:35.736 13648-13648/huaan.com.mvvmdemo I/ScrollingViewModel: loadDatas start run in main
06-19 12:26:45.743 13648-13684/huaan.com.mvvmdemo I/ScrollingViewModel: request run in DefaultDispatcher-worker-1
06-19 12:26:46.227 13648-13648/huaan.com.mvvmdemo I/ScrollingViewModel: loadDatas end run in main

看到了吧，各司其職，效果很棒

異常處理

搞了半天才發現沒有弄異常處理，當請求失敗之後，項目就崩潰了，這不是是我們想要的結果，由於好沒有想到更好的處理方式，只能在外面套個tyr catch 頂一頂了，參考如下

open class BaseViewModel : ViewModel(), LifecycleObserver{
 private val viewModelJob = SupervisorJob()
 private val uiScope = CoroutineScope(Dispatchers.Main + viewModelJob)
 private val error by lazy { MutableLiveData<Exception>() }
 private val finally by lazy { MutableLiveData<Int>() }
 //運行在UI線程的協程
 fun launchUI( block: suspend CoroutineScope.() -> Unit) {
 uiScope.launch(Dispatchers.Main) {
 try {
 block()
 }catch (e:Exception){
 error.value = e
 }finally {
 finally.value = 200
 }
 }
 }
 override fun onCleared() {
 super.onCleared()
 viewModelJob.cancel()
 }
 /**
 * 請求失敗，出現異常
 */
 fun getError(): LiveData<Exception> {
 return error
 }
 /**
 * 請求完成，在此處做一些關閉操作
 */
 fun getFinally(): LiveData<Int> {
 return finally
 }
}

結語

上面只是描述了一些實現過程，具體使用還得參考demo，基本上能滿足大部分的需求，要是感興趣的小夥伴，可以下載demo參考，感覺不錯的話，順手點個贊就很滿足了。於所學不精，可能會有使用不當之處，希望各位大佬能指出不當的地方，深表感謝。

Kotlin + 協程 + Retrofit + MVVM優雅的實現網絡請求

前言

項目配置

實現思路

1.創建retrofit

2.創建service接口

3.發起請求

協程實現

1.創建RetrofitClient

2.創建service接口類

3.發起請求

協程 + ViewModel + LiveData實現

後續優化

1.內存泄漏問題解決方案

2.優化請求代碼

異常處理

結語

如何成爲一名合格的Android開發工程師？前言自我介紹掌握紮實的基本功認清學校與社會的差距提高自己的動手能力如何提高自己的動手能力最後

Android研發技術人員的護城河是什麼？最後

Android研發：剛進公司就把“屎山”優化了是什麼體驗？大佬降臨

35歲程序員面試騰訊、頭條、華爲，Offer全拿，中年危機？不存在的最後

那些幹外包的程序員現在都怎麼樣了？一、“買賣” 二、“歸屬” 三、“合羣” 最後

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結