优雅的封装网络请求，协程 + Retrofit

最新推荐文章于 2024-12-08 16:12:22 发布

原创最新推荐文章于 2024-12-08 16:12:22 发布 · 920 阅读

6 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

收录于

程序员

本文介绍了如何在Android中使用JetpackCompose构建声明式UI，并结合Retrofit进行API数据请求，讨论了如何优雅地处理网络错误、登录过期等异常情况，以及使用Coroutine和GsonConverterFactory实现数据转换。

{
“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(
@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>
}

创建 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>()
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>()
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 apiCall(crossinline call: suspend CoroutineScope.() -> ResponseResult): ResponseResult {
return withContext(Dispatchers.IO) {
val res: ResponseResult
try {
res = call()
} catch (e: Throwable) {
Log.e(“ApiCaller”, “request error”, e)
// 请求出错，将状态码和消息封装为 ResponseResult
return@withContext ApiException.build(e).toResponse()
}
if (res.code == ApiException.CODE_AUTH_INVALID) {
Log.e(“ApiCaller”, “request auth invalid”)
// 登录过期，取消协程，跳转登录界面
// 省略部分代码
cancel()
}
return@withContext res
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

最后

文章不易，如果大家喜欢这篇文章，或者对你有帮助希望大家多多点赞转发关注哦。文章会持续更新的。绝对干货！！！

Android进阶学习全套手册
关于实战，我想每一个做开发的都有话要说，对于小白而言，缺乏实战经验是通病，那么除了在实际工作过程当中，我们如何去更了解实战方面的内容呢？实际上，我们很有必要去看一些实战相关的电子书。目前，我手头上整理到的电子书还算比较全面，HTTP、自定义view、c++、MVP、Android源码设计模式、Android开发艺术探索、Java并发编程的艺术、Android基于Glide的二次封装、Android内存优化——常见内存泄露及优化方案、.Java编程思想（第4版）等高级技术都囊括其中。