前言
随着 Kotlin 1.3 的发布，JetBrains 正式为我们带来了协程，协程的好处这里不多介绍了，那么是时候将 RxJava + Retrofit 网络库升级为协程 + Retrofit，使我们的代码更加简洁，程序更加健壮。
准备
这里我们以玩 Android Api 为例，向大家演示如何使用协程封装网络库，先看一下接口的返回格式，为了方便查看，做了精简处理
{
"data": [
{
"desc": "扔物线",
"id": 29,
"imagePath": "https://wanandroid.com/blogimgs/8a0131ac-05b7-4b6c-a8d0-f438678834ba.png",
"isVisible": 1,
"order": 0,
"title": "声明式 UI？Android 官方怒推的 Jetpack Compose 到底是什么？",
"type": 0,
"url": "https://www.bilibili.com/video/BV1c5411K75r"
}
],
"errorCode": 0,
"errorMsg": ""
}
和大多数 Api 接口一样，提供了通用的 errorCode, errorMsg 和 data 模板字段，当接口出现异常，我们可以根据状态码和消息给用户提示。
不过还有一种异常情况，即网络错误，我们无法通过 errorCode 识别
另外有一些通用的异常情况，比如用户登录过期，我们也可以统一处理
正文
要使用协程，我们需要添加以下依赖
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.1'
我们创建一个返回对象的实体
data class ResponseResult<T>(
@SerializedName("errorCode") var errorCode: Int = -1,
@SerializedName("errorMsg") var errorMsg: String? = "",
@SerializedName("data") var data: T? = null
)
banner 对象实体，省略部分属性
data class Banner(
@SerializedName("id") var id: Long = 0,
@SerializedName("title") var title: String = "",
@SerializedName("desc") var desc: String = "",
@SerializedName("url") var url: String = ""
)
创建 Retrofit Api 接口，Retrofit 自 2.6 版本开始，原生支持了协程，我们只需要在方法前添加 suspend 修饰符，即可直接返回实体对象
interface IApi {
@GET("banner/json")
suspend fun getBanner(): ResponseResult<List<Banner>>
}
创建 Api 代理对象
object Api {
private val api by lazy {
val retrofit = Retrofit.Builder()
.baseUrl("https://www.wanandroid.com/")
.addConverterFactory(GsonConverterFactory.create())
.client(OkHttpClient.Builder().build())
.build()
retrofit.create(IApi::class.java)
}
fun get(): IApi {
return api
}
}
在 ViewModel 中请求数据
class BannerViewModel : ViewModel(){
val mBannerLiveData = MutableLiveData<List<Banner>>()
fun getBanner() {
viewModelScope.launch {
val res = Api.get().getBanner()
if (res.errorCode == 0 && res.data != null) {
mBannerLiveData.postValue(res.data)
}
}
}
}
不知道大家发现没，这样的写法是有问题的，当网络错误时，会导致 Crash，因此我们还需要对 Api 方法添加 try-catch
class BannerViewModel : ViewModel(){
val mBannerLiveData = MutableLiveData<List<Banner>>()
fun getBanner() {
viewModelScope.launch {
val res = try {
Api.get().getBanner()
} catch (e: Exception) {
null
}
if (res != null && res.errorCode == 0 && res.data != null) {
mBannerLiveData.postValue(res.data)
}
}
}
}
如果还要处理登录过期的异常，还需要添加更多代码，那我们能否更加优雅地处理这些异常情况呢？
针对请求出错，我们可以将错误的状态码和消息封装为一个
ResponseResult，即可与业务异常统一处理登录过期的时候，我们一般是中断当前逻辑，并跳转登录界面，针对这种情况，我们可以封装一个方法统一处理
创建 apiCall 方法，统一处理异常逻辑
suspend inline fun <T> apiCall(crossinline call: suspend CoroutineScope.() -> ResponseResult<T>): ResponseResult<T> {
return withContext(Dispatchers.IO) {
val res: ResponseResult<T>
try {
res = call()
} catch (e: Throwable) {
Log.e("ApiCaller", "request error", e)
// 请求出错，将状态码和消息封装为 ResponseResult
return@withContext ApiException.build(e).toResponse<T>()
}
if (res.code == ApiException.CODE_AUTH_INVALID) {
Log.e("ApiCaller", "request auth invalid")
// 登录过期，取消协程，跳转登录界面
// 省略部分代码
cancel()
}
return@withContext res
}
}
// 网络、数据解析错误处理
class ApiException(val code: Int, override val message: String?, override val cause: Throwable? = null)
: RuntimeException(message, cause) {
companion object {
// 网络状态码
const val CODE_NET_ERROR = 4000
const val CODE_TIMEOUT = 4080
const val CODE_JSON_PARSE_ERROR = 4010
const val CODE_SERVER_ERROR = 5000
// 业务状态码
const val CODE_AUTH_INVALID = 401
fun build(e: Throwable): ApiException {
return if (e is HttpException) {
ApiException(CODE_NET_ERROR, "网络异常(${e.code()},${e.message()})")
} else if (e is UnknownHostException) {
ApiException(CODE_NET_ERROR, "网络连接失败，请检查后再试")
} else if (e is ConnectTimeoutException || e is SocketTimeoutException) {
ApiException(CODE_TIMEOUT, "请求超时，请稍后再试")
} else if (e is IOException) {
ApiException(CODE_NET_ERROR, "网络异常(${e.message})")
} else if (e is JsonParseException || e is JSONException) {
// Json解析失败
ApiException(CODE_JSON_PARSE_ERROR, "数据解析错误，请稍后再试")
} else {
ApiException(CODE_SERVER_ERROR, "系统错误(${e.message})")
}
}
}
fun <T> toResponse(): ResponseResult<T> {
return ResponseResult(code, message)
}
}
精简后的 ViewModel
class BannerViewModel : ViewModel(){
val mBannerLiveData = MutableLiveData<List<Banner>>()
fun getBanner() {
viewModelScope.launch {
val res = apiCall { Api.get().getBanner() }
if (res.errorCode == 0 && res.data != null) {
mBannerLiveData.postValue(res.data)
} else {
// 报错
}
}
}
}
封装之后，所有的异常情况都可以在 apiCall 中处理，调用方只需要关注结果即可。
总结
很久没有写博客了，主要是没有想到一些可以让大家眼前一亮的点子。今天姑且水一篇，目前看到的相对比较简洁，无入侵，且包含统一异常处理的协程网络库，希望大家喜欢😄
