两种方式封装Retrofit+协程,实现优雅快速的网络请求

文章介绍了两种Android开发中的数据请求封装方式:封装一使用LiveData贯穿请求链,优点是简洁但解耦不彻底;封装二分离UI和请求,提高可维护性和灵活性。作者还讨论了封装二如何遵循职责单一原则并支持多数据源。
摘要由CSDN通过智能技术生成

private val repository by lazy { WxArticleRepository() }

val wxArticleLiveData = StateLiveData<List>()

fun requestNet() {

viewModelScope.launch {

repository.fetchWxArticle(wxArticleLiveData)

}

}

}

很简单,引入对应的数据仓库Repo,然后使用协程执行网络请求方法。来看下Repo中的代码。

Repository中代码示例


class WxArticleRepository : BaseRepository() {

private val mService by lazy { RetrofitClient.service }

suspend fun fetchWxArticle(stateLiveData: StateLiveData<List>) {

executeResp(stateLiveData, mService::getWxArticle)

}

}

interface ApiService {

@GET(“wxarticle/chapters/json”)

suspend fun getWxArticle(): BaseResponse<List>

}

获取一个Retrofit实例,然后调用ApiService接口方法。

封装一的优势

======

  • 代码很简洁,不需要手写线程切换代码,没有很多的接口回调。

  • 自带Loading状态,不需要手动启用Loading和关闭Loading。

  • 数据驱动ui,以LiveData为载体,将页面状态和网络结果通过在LiveData返回给ui。

封装一的不足

======

封装一的核心思想是:一个LiveData贯穿整个网络请求链。这是它的优势,也是它的劣势。

  • 解耦不彻底,违背了"在应用的各个模块之间设定明确定义的职责界限"的思想

  • LiveData监听时,如果需要Loading,BaseActivity都需要实现带有Loading方法接口。

  • obserState()方法第二个参数中传入了UI引用。

  • 不能达到"看方法如其意",如果是刚接触,会有很多疑问:为什么需要一个livedata作为方法的参数。网络请求的返回值去哪了?

  • 封装一还有一个最大的缺陷:对于是多数据源,封装一就展示了很不友好的一面。

Repository是做一个数据仓库,项目中获取数据的方式都在这里同意管理,网络获取数据只是其中一个方式而已。

如果想加一个从数据库或者缓存中获取数据,封装一想改都不好改,如果强制改就破坏了封装,侵入性很大。

针对封装一的不足,优化出了封装二。

二、封装二

=====

思路

  • 想要解决上面的不足,不能以LiveData为载体贯穿整个网络请求。

  • Observe()方法中去掉ui引用,不要小看一个ui引用,这个引用代表着具体的ActivityObserve耦合起来了,并且Activity还要实现IUiView接口。

  • 网络请求跟Loading状态分开了,需要手动控制Loading。

  • Repository中的方法都有返回值,会返回结果,也不需要用livedata作为方法参数。

  • LiveData只存在于ViewModel中,LiveData不会贯穿整个请求链。Repository中也不需要LiveData的引用,Repository的代码就是单纯的获取数据。

  • 针对多数据源,也非常好处理。

  • 跟ui没任何关系,可以完全作为一个独立的Lib使用。

Activity中代码


// 请求网络

mViewModel.login(“username”, “password”)

// 注册监听

mViewModel.userLiveData.observeState(this) {

onSuccess {data ->

mBinding.tvContent.text = data.toString()

}

onComplete {

dismissLoading()

}

}

observeState()中不再需要一个ui引用了。

ViewModel中


class MainViewModel {

val userLiveData = StateLiveData<User?>()

fun login(username: String, password: String) {

viewModelScope.launch {

userLiveData.value = repository.login(username, password)

}

}

}

通过livedata的setValue或者postValue方法将数据发送出去。

Repository中


suspend fun login(username: String, password: String): ApiResponse<User?> {

return executeHttp {

mService.login(username, password)

}

}

Repository中的方法都返回请求结果,并且方法参数不需要livedata。Repository完全可以独立出来了。

针对多数据源


// WxArticleRepository

class WxArticleRepository : BaseRepository() {

private val mService by lazy {

RetrofitClient.service

}

suspend fun fetchWxArticleFromNet(): ApiResponse<List> {

return executeHttp {

mService.getWxArticle()

}

}

suspend fun fetchWxArticleFromDb(): ApiResponse<List> {

return getWxArticleFromDatabase()

}

}

// MainViewModel.kt

private val dbLiveData = StateLiveData<List>()

private val apiLiveData = StateLiveData<List>()

val mediatorLiveDataLiveData = MediatorLiveData<ApiResponse<List>>().apply {

this.addSource(apiLiveData) {

this.value = it

}

this.addSource(dbLiveData) {

this.value = it

}

}

可以看到,封装二更符合职责单一原则,Repository单纯的获取数据,ViewModel对数据进行处理和发送。

三、实现原理

======

数据来源于鸿洋大神的玩Android 开放API

回数据结构定义:

{

“data”: …,

“errorCode”: 0,

“errorMsg”: “”

}

封装一和封装二的代码差距很小,主要看封装二。

定义数据返回类


open class ApiResponse(

open val data: T? = null,

open val errorCode: Int? = null,

open val errorMsg: String? = null,

open val error: Throwable? = null,

) : Serializable {

val isSuccess: Boolean

get() = errorCode == 0

}

data class ApiSuccessResponse(val response: T) : ApiResponse(data = response)

class ApiEmptyResponse : ApiResponse()

data class ApiFailedResponse(override val errorCode: Int?, override val errorMsg: String?) : ApiResponse(errorCode = errorCode, errorMsg = errorMsg)

data class ApiErrorResponse(val throwable: Throwable) : ApiResponse(error = throwable)

基于后台返回的基类,根据不同的结果,定义不同的状态数据类。

网络请求统一处理:BaseRepository


open class BaseRepository {

suspend fun executeHttp(block: suspend () -> ApiResponse): ApiResponse {

runCatching {

block.invoke()

}.onSuccess { data: ApiResponse ->

return handleHttpOk(data)

}.onFailure { e ->

return handleHttpError(e)

}

return ApiEmptyResponse()

}

/**

  • 非后台返回错误,捕获到的异常

*/

private fun handleHttpError(e: Throwable): ApiErrorResponse {

if (BuildConfig.DEBUG) e.printStackTrace()

handlingExceptions(e)

return ApiErrorResponse(e)

}

/**

  • 返回200,但是还要判断isSuccess

*/

private fun handleHttpOk(data: ApiResponse): ApiResponse {

return if (data.isSuccess) {

getHttpSuccessResponse(data)

} else {

handlingApiExceptions(data.errorCode, data.errorMsg)

ApiFailedResponse(data.errorCode, data.errorMsg)

}

}

/**

  • 成功和数据为空的处理

*/

private fun getHttpSuccessResponse(response: ApiResponse): ApiResponse {

return if (response.data == null || response.data is List<> && (response.data as List<>).isEmpty()) {

ApiEmptyResponse()

} else {

ApiSuccessResponse(response.data!!)

}

}

}

Retrofit协程的错误码处理是通过异常抛出来的,所以通过try…catch来捕捉非200的错误码。包装成不同的数据类对象返回。

扩展LiveData和Observer


在LiveData的Observer()来判断是哪种数据类,进行相应的回调处理:

abstract class IStateObserver : Observer<ApiResponse> {

override fun onChanged(apiResponse: ApiResponse) {

when (apiResponse) {

is ApiSuccessResponse -> onSuccess(apiResponse.response)

is ApiEmptyResponse -> onDataEmpty()

is ApiFailedResponse -> onFailed(apiResponse.errorCode, apiResponse.errorMsg)

is ApiErrorResponse -> onError(apiResponse.throwable)

}

onComplete()

}

再扩展LiveData,通过kotlin的DSL表达式替换java的callback回调,简写代码。

class StateLiveData : MutableLiveData<ApiResponse>() {

fun observeState(owner: LifecycleOwner, listenerBuilder: ListenerBuilder.() -> Unit) {

val listener = ListenerBuilder().also(listenerBuilder)

val value = object : IStateObserver() {

override fun onSuccess(data: T) {

listener.mSuccessListenerAction?.invoke(data)

}

override fun onError(e: Throwable) {

listener.mErrorListenerAction?.invoke(e) ?: toast(“Http Error”)

}

override fun onDataEmpty() {

学习交流

群内有许多来自一线的技术大牛,也有在小厂或外包公司奋斗的码农,我们致力打造一个平等,高质量的Android交流圈子,不一定能短期就让每个人的技术突飞猛进,但从长远来说,眼光,格局,长远发展的方向才是最重要的。

35岁中年危机大多是因为被短期的利益牵着走,过早压榨掉了价值,如果能一开始就树立一个正确的长远的职业规划。35岁后的你只会比周围的人更值钱。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》点击传送门,即可获取!
server() {

override fun onSuccess(data: T) {

listener.mSuccessListenerAction?.invoke(data)

}

override fun onError(e: Throwable) {

listener.mErrorListenerAction?.invoke(e) ?: toast(“Http Error”)

}

override fun onDataEmpty() {

学习交流

[外链图片转存中…(img-KVA4LID3-1714993309187)]

[外链图片转存中…(img-RE48dd2d-1714993309189)]

群内有许多来自一线的技术大牛,也有在小厂或外包公司奋斗的码农,我们致力打造一个平等,高质量的Android交流圈子,不一定能短期就让每个人的技术突飞猛进,但从长远来说,眼光,格局,长远发展的方向才是最重要的。

35岁中年危机大多是因为被短期的利益牵着走,过早压榨掉了价值,如果能一开始就树立一个正确的长远的职业规划。35岁后的你只会比周围的人更值钱。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》点击传送门,即可获取!

好的,我来回答你的问题。 首先,Kotlin 是一种基于 JVM 的静态类型编程语言,它的语法简洁易懂,支持函数式编程和面向对象编程。 协程是 Kotlin 中的一种轻量级线程,可以实现异步编程和并发执行。Retrofit 是一款网络请求库,它可以帮助我们轻松地实现网络请求和数据解析。MVVM 是一种软件架构模式,可以将应用程序分为三个部分:模型、视图和视图模型。 下面是一个基于 Kotlin + 协程 + Retrofit + MVVM 的网络请求优雅实现: 1. 定义 API 接口 首先定义 API 接口,使用 Retrofit 注解来描述请求方法和参数。 ```kotlin interface ApiService { @GET("api/news") suspend fun getNews(@Query("category") category: String): NewsResponse } ``` 2. 创建数据模型 根据 API 接口的返回数据,我们可以创建一个数据模型。 ```kotlin data class News(val title: String, val content: String) data class NewsResponse(val code: Int, val message: String, val newsList: List<News>) ``` 3. 创建 ViewModel ViewModel 是连接数据模型和视图的中间层,它处理数据逻辑并提供可观察的数据。 ```kotlin class NewsViewModel : ViewModel() { private val _newsList = MutableLiveData<List<News>>() val newsList: LiveData<List<News>> = _newsList fun loadNews(category: String) { viewModelScope.launch { val response = retrofit.create(ApiService::class.java).getNews(category) if (response.code == 200) { _newsList.value = response.newsList } } } } ``` 4. 创建视图 视图负责展示数据,并与用户交互。 ```kotlin class NewsActivity : AppCompatActivity() { private val viewModel by viewModels<NewsViewModel>() override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_news) viewModel.newsList.observe(this, Observer { newsList -> // 更新视图 }) viewModel.loadNews("tech") } } ``` 通过使用 Kotlin + 协程 + Retrofit + MVVM,我们可以实现优雅网络请求,代码简洁易懂,逻辑清晰。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值