Retrofit+Kotlin+MVVM的网络请求框架的封装尝试

之前在学习郭霖《第一行代码》时按部就班地写过一个彩云天气 App&＃xff0c;对里面的网络请求框架的封装印象非常深刻&＃xff0c;很喜欢这种 Retrofit &＃43; Kotlin &＃43; 协程的搭配使用。随后也在自己的项目里参考了这部分的代码。但随着代码的深入编写和功能的复杂&＃xff0c;原来的框架已经无法满足我的使用了。原主要有如下的痛点&＃xff1a;

• 缺少失败的回调
• 显示加载中动画比较麻烦

后面我自己试着努力去封装一个简单易用的框架&＃xff0c;可惜个人能力有限&＃xff0c;自己封装的框架总是不如人意。好在还有很多优秀的博客和代码可供参考。在此基础上&＃xff0c;对彩云天气 App中的网络请求框架做了一些修改&＃xff0c;尽可能地做到简单易用。以请求玩安卓的登录接口为例&＃xff08;用户名和密码是我自己申请的&＃xff0c;见代码&＃xff09;&＃xff0c;页面上有一个按钮&＃xff0c;点击按钮后就发起登录请求。

先来看看发起请求后的回调怎么写&＃xff1a;

viewModel.loginLiveData.observeState(this)
onStart
LoadingDialog.show(activity)
Log.d(TAG, "请求开始")

onSuccess
Log.d(TAG, "请求成功")
showToast("登录成功")
binding.tvResult.text &＃61; it.toString()

onEmpty
showToast("数据为空")

onFailure
Log.d(TAG, "请求失败")
showToast(it.errorMsg.orEmpty())
binding.tvResult.text &＃61; it.toString()

onFinish
LoadingDialog.dismiss(activity)
Log.d(TAG, "请求结束")




回调一共有五种&＃xff0c;会在下文详细介绍。这里采用了DSL的写法&＃xff0c;如果你喜欢传统的写法&＃xff0c;可以调用另外一个扩展方法observeResponse()&＃xff0c;由于它最后一个参数就是请求成功的回调&＃xff0c;所以借助 Lambda 表达式的特性&＃xff0c;可以简洁地写成如下的形式&＃xff1a;

viewModel.loginLiveData.observeResponse(this)
binding.tvResult.text &＃61; it.toString()



如果还需要其他回调&＃xff0c;可以使用具名参数加上&＃xff0c;如下所示&＃xff1a;

viewModel.loginLiveData.observeResponse(this, onStart &＃61;
LoadingDialog.show(this)
, onFinish &＃61;
LoadingDialog.dismiss(activity)
)
binding.tvResult.text &＃61; it.toString()


2、框架搭建

开始之前必须说明&＃xff0c;这个框架是基于《第一行代码》&＃xff08;第三版&＃xff09;中的彩云天气 App的&＃xff0c;它的架构图如下所示&＃xff0c;如果你阅读过《第一行代码》或者谷歌的相关文档&＃xff0c;那么想必对此不会陌生。

2.1 添加依赖库

//简化在 Activity 中声明 ViewModel 的代码
implementation "androidx.activity:activity-ktx:1.3.1"
// lifecycle
def lifecycle_version &＃61; "2.3.1"
implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version"
implementation "androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version"
// retrofit2
def retrofit_version &＃61; "2.9.0"
implementation "com.squareup.retrofit2:retrofit:$retrofit_version"
implementation "com.squareup.retrofit2:adapter-rxjava2:$retrofit_version"
implementation "com.squareup.retrofit2:converter-gson:$retrofit_version"
implementation &＃39;io.reactivex.rxjava2:rxandroid:2.1.1&＃39;
// okhttp
def okhttp_version &＃61; "4.8.1"
implementation "com.squareup.okhttp3:okhttp:$okhttp_version"
//日志拦截器
implementation(&＃39;com.github.ihsanbal:LoggingInterceptor:3.1.0&＃39;)
exclude group: &＃39;org.json&＃39;, module: &＃39;json&＃39;



2.2 Retrofit构建器

Retrofit构建器这里做了分层&＃xff0c;基类做了一些基本的配置&＃xff0c;子类继承后可以添加新的配置&＃xff0c;并配置自己喜欢的日志拦截器。

private const val TIME_OUT_LENGTH &＃61; 8L
private const val BASE_URL &＃61; "https://www.wanandroid.com/"
abstract class BaseRetrofitBuilder
private val okHttpClient: OkHttpClient by lazy
val builder &＃61; OkHttpClient.Builder()
.callTimeout(TIME_OUT_LENGTH, TimeUnit.SECONDS)
.connectTimeout(TIME_OUT_LENGTH, TimeUnit.SECONDS)
.readTimeout(TIME_OUT_LENGTH, TimeUnit.SECONDS)
.writeTimeout(TIME_OUT_LENGTH, TimeUnit.SECONDS)
.retryOnConnectionFailure(true)
initLoggingInterceptor()?.also
builder.addInterceptor(it)

handleOkHttpClientBuilder(builder)
builder.build()

private val retrofit &＃61; Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create())
.client(okHttpClient)
.build()
fun <T> create(serviceClass: Class<T>): T &＃61; retrofit.create(serviceClass)
inline fun <reified T> create(): T &＃61; create(T::class.java)
/**
* 子类自定义 OKHttpClient 的配置
*/
abstract fun handleOkHttpClientBuilder(builder: OkHttpClient.Builder)
/**
* 配置日志拦截器
*/
abstract fun initLoggingInterceptor(): Interceptor?



RetrofitBuilder&＃xff1a;

private const val LOG_TAG_HTTP_REQUEST &＃61; "okhttp_request"
private const val LOG_TAG_HTTP_RESULT &＃61; "okhttp_result"
object RetrofitBuilder : BaseRetrofitBuilder()
override fun handleOkHttpClientBuilder(builder: OkHttpClient.Builder)
override fun initLoggingInterceptor()&＃61; LoggingInterceptor
.Builder()
.setLevel(Level.BASIC)
.log(Platform.INFO)
.request(LOG_TAG_HTTP_REQUEST)
.response(LOG_TAG_HTTP_RESULT)
.build()



2.3 全局异常处理

请求时可能会遇到诸如网络断开、Json 解析失败等意外情况&＃xff0c;如果我们每次请求都要处理一遍这些异常&＃xff0c;那也未免太麻烦了。正确的做法是把异常集中到一起处理。

创建一个定义各种异常的枚举类&＃xff1a;

enum class HttpError(val code: Int, val message: String)
UNKNOWN(-100,"未知错误"),
NETWORK_ERROR(1000, "网络连接超时&＃xff0c;请检查网络"),
JSON_PARSE_ERROR(1001, "Json 解析失败")
//······



创建一个文件&＃xff0c;在里面定义一个全局方法&＃xff0c;用于处理各种异常&＃xff1a;

fun handleException(throwable: Throwable) &＃61; when (throwable)
is UnknownHostException -> RequestException(HttpError.NETWORK_ERROR, throwable.message)
is HttpException ->
val errorModel &＃61; throwable.response()?.errorBody()?.string()?.run
Gson().fromJson(this, ErrorBodyModel::class.java)
?: ErrorBodyModel()
RequestException(errorMsg &＃61; errorModel.message, error &＃61; errorModel.error)

is JsonParseException -> RequestException(HttpError.JSON_PARSE_ERROR, throwable.message)
is RequestException -> throwable
else -> RequestException(HttpError.UNKNOWN, throwable.message)



实际项目中遇到的异常当然不止这几个&＃xff0c;这里只是作为举例写了少部分&＃xff0c;实际开放中把它丰富完善即可。

2.4 回调状态监听

回调状态一共有四种&＃xff1a;

• onStart()&＃xff1a;请求开始&＃xff08;可在此展示加载动画&＃xff09;
• onSuccess()&＃xff1a;请求成功
• onEmpty()&＃xff1a;请求成功&＃xff0c;但data为null或者data是集合类型但为空
• onFailure()&＃xff1a;请求失败
• onFinish()&＃xff1a;请求结束&＃xff08;可在此关闭加载动画&＃xff09;

这里要注意onSuccess的标准&＃xff1a;并不仅仅是 Http 请求的结果码&＃xff08;status code&＃xff09;等于 200&＃xff0c;而且要达到Api请求成功的标准&＃xff0c;以玩安卓的Api 为例&＃xff0c;errorCode 为 0时&＃xff0c;发起的请求才是执行成功&＃xff1b;否则&＃xff0c;都应该归为onFailure()的情况&＃xff08;可以参考文章附带的思维导图&＃xff09;。

理清楚有几种回调状态后&＃xff0c;就可以实施监听了。那么在哪里监听呢&＃xff1f;LiveData的observe()方法的第二个函数可以传入Observer参数。Observer是一个接口&＃xff0c;我们继承它自定义一个Oberver&＃xff0c;借此我们就可以监听LiveData的值的变化。

interface IStateObserver<T> : Observer<BaseResponse<T>>
override fun onChanged(response: BaseResponse<T>?)
when (response)
is StartResponse ->
//onStart()回调后不能直接就调用onFinish()&＃xff0c;必须等待请求结束
onStart()
return

is SuccessResponse -> onSuccess(response.data)
is EmptyResponse -> onEmpty()
is FailureResponse -> onFailure(response.exception)

onFinish()

/**
* 请求开始
*/
fun onStart()
/**
* 请求成功&＃xff0c;且 data 不为 null
*/
fun onSuccess(data: T)
/**
* 请求成功&＃xff0c;但 data 为 null 或者 data 是集合类型但为空
*/
fun onEmpty()
/**
* 请求失败
*/
fun onFailure(e: RequestException)
/**
* 请求结束
*/
fun onFinish()



接下来我们准备一个HttpRequestCallback类&＃xff0c;用于实现DSL的回调形式&＃xff1a;

typealias OnSuccessCallback<T> &＃61; (data: T) -> Unit
typealias OnFailureCallback &＃61; (e: RequestException) -> Unit
typealias OnUnitCallback &＃61; () -> Unit
class HttpRequestCallback<T>
var startCallback: OnUnitCallback? &＃61; null
var successCallback: OnSuccessCallback<T>? &＃61; null
var emptyCallback: OnUnitCallback? &＃61; null
var failureCallback: OnFailureCallback? &＃61; null
var finishCallback: OnUnitCallback? &＃61; null
fun onStart(block: OnUnitCallback)
startCallback &＃61; block

fun onSuccess(block: OnSuccessCallback<T>)
successCallback &＃61; block

fun onEmpty(block: OnUnitCallback)
emptyCallback &＃61; block

fun onFailure(block: OnFailureCallback)
failureCallback &＃61; block

fun onFinish(block: OnUnitCallback)
finishCallback &＃61; block




然后声明新的监听方法&＃xff0c;考虑到某些时候需要自定义的LiveData(比如为了解决数据倒灌的问题)&＃xff0c;这里采用扩展函数的写法&＃xff0c;便于扩展。

/**
* 监听 LiveData 的值的变化&＃xff0c;回调为 DSL 的形式
*/
inline fun <T> LiveData<BaseResponse<T>>.observeState(
owner: LifecycleOwner,
crossinline callback: HttpRequestCallback<T>.() -> Unit
)
val requestCallback &＃61; HttpRequestCallback<T>().apply(callback)
observe(owner, object : IStateObserver<T>
override fun onStart()
requestCallback.startCallback?.invoke()

override fun onSuccess(data: T)
requestCallback.successCallback?.invoke(data)

override fun onEmpty()
requestCallback.emptyCallback?.invoke()

override fun onFailure(e: RequestException)
requestCallback.failureCallback?.invoke(e)

override fun onFinish()
requestCallback.finishCallback?.invoke()

)

/**
* 监听 LiveData 的值的变化
*/
inline fun <T> LiveData<BaseResponse<T>>.observeResponse(
owner: LifecycleOwner,
crossinline onStart: OnUnitCallback &＃61; ,
crossinline onEmpty: OnUnitCallback &＃61; ,
crossinline onFailure: OnFailureCallback &＃61; e: RequestException -> ,
crossinline onFinish: OnUnitCallback &＃61; ,
crossinline onSuccess: OnSuccessCallback<T>
)
observe(owner, object : IStateObserver<T>
override fun onStart()
onStart()

override fun onSuccess(data: T)
onSuccess(data)

override fun onEmpty()
onEmpty()

override fun onFailure(e: RequestException)
onFailure(e)

override fun onFinish()
onFinish()

)



2.5 Repository 层的封装

Repository层作为数据的来源&＃xff0c;有个两个渠道&＃xff1a;网络请求和数据库。这里暂时只处理了网络请求。

基类Repository&＃xff1a;

abstract class BaseRepository
protected fun <T> fire(
context: CoroutineContext &＃61; Dispatchers.IO,
block: suspend () -> BaseResponse<T>
): LiveData<BaseResponse<T>> &＃61; liveData(context)
this.runCatching
emit(StartResponse())
block()
.onSuccess
//status code 为200&＃xff0c;继续判断 errorCode 是否为 0
emit(
when (it.success)
true -> checkEmptyResponse(it.data)
false -> FailureResponse(handleException(RequestException(it)))

)
.onFailure throwable ->
emit(FailureResponse(handleException(throwable)))


/**
* data 为 null&＃xff0c;或者 data 是集合类型&＃xff0c;但是集合为空都会进入 onEmpty 回调
*/
private fun <T> checkEmptyResponse(data: T?): ApiResponse<T> &＃61;
if (data &＃61;&＃61; null || (data is List<*> && (data as List<*>).isEmpty()))
EmptyResponse()
else
SuccessResponse(data)




子类Repository:

object Repository : BaseRepository()
fun login(pwd: String) &＃61; fire
NetworkDataSource.login(pwd)




网络请求数据源&＃xff0c;在这里调用网络接口&＃xff1a;

object NetworkDataSource
private val apiService &＃61; RetrofitBuilder.create<ApiService>()
suspend fun login(pwd: String) &＃61; apiService.login(password &＃61; pwd)



2.6 ViewModel层的封装

ViewModel基本遵循了《第一行代码》中的写法&＃xff0c;创建了两个LiveData。用户点击按钮时&＃xff0c;loginAction的值就会发生改变&＃xff0c;触发switchMap中的代码&＃xff0c;从而达到请求数据的目的。

class MainViewModel : ViewModel()
private val loginAction &＃61; MutableLiveData<Boolean>()
/**
* loginAction 在这里只传递布尔值&＃xff0c;不传递密码&＃xff0c;在实际项目中&＃xff0c;会使用 DataBinding 绑定 xml 布局和 ViewModel&＃xff0c;
* 不需要从 Activity 或者 Fragment 中把密码传入 ViewModel
*/
val loginLiveData &＃61; loginAction.switchMap
if (it)
Repository.login("PuKxVxvMzBp2EJM")
else
Repository.login("123456")


/**
* 点击登录
*/
fun login()
loginAction.value &＃61; true

fun loginWithWrongPwd()
loginAction.value &＃61; false




注意&＃xff1a;这种写法通常不从View向ViewModel层传递数据&＃xff0c;是需要搭配DataBinding 的。如果你不想这样写&＃xff0c;可以修改BaseRepository中的返回值&＃xff0c;直接返回BaseResponse。

最后&＃xff0c;用一张思维导图总结本文&＃xff1a;

源码地址&＃xff1a;GitHub &＃xff08;注意分支要选择 dev1.0&＃xff09;

• JetpackMvvm
• FastJetpack