LiveData+Retrofit网络请求实战

LiveData和Rxjava中的Observable类似，是一个被观察者的数据持有类。但是不同的是LiveData具有生命周期感知，相当于RxJava+RxLifecycle。LiveData使用起来相对简单轻便，所以当它加入到项目中后，再使用RxJava便显得重复臃肿了(RxJava包1～2M容量)。为了移除RxJava，我们将Retrofit的Call请求适配成LiveData，因此我们需要自定义CallAdapterFactory。根据接口响应格式不同，对应的适配器工厂会有所区别。本次便以广为人知的wanandroid的api为例子，来完成LiveData网络请求实战。 首先根据它的响应格式：

{
data:[],//或者{}
errorCode:0,
errorMsg:“”
}

定义一个通用的响应实体ApiResponse

class ApiResponse(
var data: T?,
var errorCode: Int,
var errorMsg: String
)

然后我们定义对应的LiveDataCallAdapterFactory

import androidx.lifecycle.LiveData
import retrofit2.CallAdapter
import retrofit2.Retrofit
import java.lang.reflect.Type
import retrofit2.CallAdapter.Factory
import java.lang.reflect.ParameterizedType

class LiveDataCallAdapterFactory : Factory() {
override fun get(returnType: Type, annotations: Array, retrofit: Retrofit): CallAdapter<*, *>? {
if (getRawType(returnType) != LiveData::class.java) return null
//获取第一个泛型类型
val observableType = getParameterUpperBound(0, returnType as ParameterizedType)
val rawType = getRawType(observableType)
if (rawType != ApiResponse::class.java) {
throw IllegalArgumentException(“type must be ApiResponse”)
}
if (observableType !is ParameterizedType) {
throw IllegalArgumentException(“resource must be parameterized”)
}
return LiveDataCallAdapter(observableType)
}
}

然后在LiveDataCallAdapter将Retrofit的Call对象适配成LiveData

import androidx.lifecycle.LiveData
import retrofit2.Call
import retrofit2.CallAdapter
import retrofit2.Callback
import retrofit2.Response
import java.lang.reflect.Type
import java.util.concurrent.atomic.AtomicBoolean

class LiveDataCallAdapter(private val responseType: Type) : CallAdapter<T, LiveData> {
override fun adapt(call: Call): LiveData {
return object : LiveData() {
private val started = AtomicBoolean(false)
override fun onActive() {
super.onActive()
if (started.compareAndSet(false, true)) {//确保执行一次
call.enqueue(object : Callback {
override fun onFailure(call: Call, t: Throwable) {
val value = ApiResponse(null, -1, t.message ?: “”) as T
postValue(value)
}

override fun onResponse(call: Call, response: Response) {
postValue(response.body())
}
})
}
}
}
}

override fun responseType() = responseType
}

第一个请求

以首页banner接口(www.wanandroid.com/banner/json)为例，完成第一个请求。 新建一个WanApi接口，加入Banner列表api，以及Retrofit初始化方法,为方便查看http请求和响应，加入了okhttp自带的日志拦截器。

interface WanApi {
companion object {
fun get(): WanApi {
val clientBuilder = OkHttpClient.Builder()
.connectTimeout(60, TimeUnit.SECONDS)
if (BuildConfig.DEBUG) {
val loggingInterceptor = HttpLoggingInterceptor()
loggingInterceptor.level = HttpLoggingInterceptor.Level.BODY
clientBuilder.addInterceptor(loggingInterceptor)
}
return Retrofit.Builder()
.baseUrl(“https://www.wanandroid.com/”)
.client(clientBuilder.build())
.addCallAdapterFactory(LiveDataCallAdapterFactory())
.addConverterFactory(GsonConverterFactory.create())
.build()
.create(WanApi::class.java)
}
}
/**

• 首页banner
  */
  @GET(“banner/json”)
  fun bannerList(): LiveData<ApiResponse<List>>
  }

BannerVO实体

data class BannerVO(
var id: Int,
var title: String,
var desc: String,
var type: Int,
var url: String,
var imagePath:String
)

我们在MainActivity中发起请求

private fun loadData() {
val bannerList = WanApi.get().bannerList()
bannerList.observe(this, Observer {
Log.e(“main”, “res:$it”)
})
}

调试结果如下：

LiveData的map与switchMap操作

LiveData可以通过Transformations的map和switchMap操作，将一个LiveData转成另一种类型的LiveData，效果与RxJava的map/switchMap操作符类似。可以看看两个函数的声明

public static <X, Y> LiveData map(
@NonNull LiveData source,
@NonNull final Function<X, Y> mapFunction)

public static <X, Y> LiveData switchMap(
@NonNull LiveData source,
@NonNull final Function<X, LiveData> switchMapFunction)

根据以上代码，我们可以知道，对应的变换函数返回的类型是不一样的：map是基于泛型类型的变换，而switchMap则返回一个新的LiveData。

还是以banner请求为例，我们将map和switchMap应用到实际场景中： 1: 为了能够手动控制请求，我们需要一个refreshTrigger触发变量，当这个变量被设置为true时，通过switchMap生成一个新的LiveData用作请求banner

private val refreshTrigger = MutableLiveData()
private val api = WanApi.get()
private val bannerLis:LiveData<ApiResponse<List>> = Transformations.switchMap(refreshTrigger) {
//当refreshTrigger的值被设置时，bannerList
api.bannerList()
}

2: 为了展示banner，我们通过map将ApiResponse转换成最终关心的数据是List<BannerVO>

val banners: LiveData<List> = Transformations.map(bannerList) {
it.data ?: ArrayList()
}

LiveData与ViewModel结合

为了将LiveData与Activity解耦，我们通过ViewModel来管理这些LiveData。

class HomeVM : ViewModel() {
private val refreshTrigger = MutableLiveData()
private val api = WanApi.get()
private val bannerList: LiveData<ApiResponse<List>> = Transformations.switchMap(refreshTrigger) {
//当refreshTrigger的值被设置时，bannerList
api.bannerList()
}

val banners: LiveData<List> = Transformations.map(bannerList) {
it.data ?: ArrayList()
}

fun loadData() {
refreshTrigger.value = true
}
}

在activity_main.xml中加入banner布局，这里使用BGABanner-Android来显示图片

<?xml version="1.0" encoding="utf-8"?>

<cn.bingoogolapple.bgabanner.BGABanner
android:id=“@+id/banner”
android:layout_width=“match_parent”
android:layout_height=“120dp”
android:paddingLeft=“16dp”
android:paddingRight=“16dp”
app:banner_indicatorGravity=“bottom|right”
app:banner_isNumberIndicator=“true”
app:banner_pointContainerBackground=“#0000”
app:banner_transitionEffect=“zoom”/>

然后在MainActivity完成Banner初始化,通过监听ViewModel中的banners实现轮播图片的展示。

class MainActivity : AppCompatActivity() {
lateinit var binding: ActivityMainBinding
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
binding = DataBindingUtil.setContentView(this, R.layout.activity_main)
val vm = ViewModelProviders.of(this).get(HomeVM::class.java)
binding.lifecycleOwner = this
binding.vm = vm
initBanner()
}

private fun initBanner() {
binding.run {
val bannerAdapter = BGABanner.Adapter<ImageView, BannerVO> { _, image, model, _ ->
image.displayWithUrl(model?.imagePath)
}
banner.setAdapter(bannerAdapter)
vm?.banners?.observe(this@MainActivity, Observer {
banner.setData(it, null)
})
}
}
}

最终效果如下：

加载进度显示

SwipeRefreshLayout

请求网络过程中，必不可少的是加载进度的展示。这里我们列举两种常用的的加载方式，一种在布局中的进度条(如SwipeRefreshLayout)，另一种是加载对话框。 为了控制加载进度条显示隐藏，我们在HomeVM中添加loading变量，在调用loadData时通过loading.value=true控制进度条的显示，在map中的转换函数中控制进度的隐藏

val loading = MutableLiveData()
val banners: LiveData<List> = Transformations.map(bannerList) {
loading.value = false
it.data ?: ArrayList()
}
fun loadData() {
refreshTrigger.value = true
loading.value = true
}

我们在activity_main.xml的外层嵌套一个SwipeRefreshLayout，通过databinding设置加载状态，添加刷新事件

<androidx.swiperefreshlayout.widget.SwipeRefreshLayout
android:layout_width=“match_parent”
android:layout_height=“match_parent”
app:onRefreshListener=“@{() -> vm.loadData()}”
app:refreshing=“@{vm.loading}”>
…
</androidx.swiperefreshlayout.widget.SwipeRefreshLayout>

然后我们再看下效果：

加载对话框KProgressHUD

为了能和ViewModel解藕，我们将加载对话框封装到一个Observer中。

class LoadingObserver(context: Context) : Observer {
private val dialog = KProgressHUD(context)
.setStyle(KProgressHUD.Style.SPIN_INDETERMINATE)
.setCancellable(false)
.setAnimationSpeed(2)
.setDimAmount(0.5f)

override fun onChanged(show: Boolean?) {
if (show == null) return
if (show) {
dialog.show()
} else {
dialog.dismiss()
}
}
}

然后在MainActivity添加这个Observer

vm.loading.observe(this, LoadingObserver(this))

效果：

我们还可以将LoadingObserver注册到BaseActivity

class BaseActivity : AppCompatActivity() {
val loadingState = MutableLiveData()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
loadingState.observe(this, LoadingObserver(this))
}
}

然后在HomeVM中添加一个attachLoading方法

class HomeVM:ViewModel{
fun attachLoading(otherLoadingState: MutableLiveData) {
loading.observeForever {
otherLoadingState.value = it
}
}
}

最终如果想要显示进度对话框，在BaseActivity到子类中，只需调用vm.attachLoading(loadingState)即可。

分页请求

分页请求是另个一常用请求，它的请求状态就比刷新数据多了几种。以wanandroid首页文章列表api为例，我们在HomeVM中加入page,refreshing,moreLoading，hasMore变量控制分页请求

private val page = MutableLiveData() //分页数据
val refreshing = MutableLiveData()//下拉刷新状态
val moreLoading = MutableLiveData()//上拉加载更多状态
val hasMore = MutableLiveData()//是否还有更多数据
private val articleList = Transformations.switchMap(page) {
api.articleList(it)
}

val articlePage = Transformations.map(articleList) {
refreshing.value = false
先自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

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

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

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

如果你觉得这些内容对你有帮助，可以扫码领取！！！！

最后

**要想成为高级安卓工程师，必须掌握许多基础的知识。**在工作中，这些原理可以极大的帮助我们理解技术，在面试中，更是可以帮助我们应对大厂面试官的刁难。

---

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可免费领取！

含大厂面经、学习笔记、源码讲义、实战项目、讲解视频**

如果你觉得这些内容对你有帮助，可以扫码领取！！！！

最后

**要想成为高级安卓工程师，必须掌握许多基础的知识。**在工作中，这些原理可以极大的帮助我们理解技术，在面试中，更是可以帮助我们应对大厂面试官的刁难。

---

[外链图片转存中…(img-MneMoCey-1711249499618)]

[外链图片转存中…(img-FDE9GZeI-1711249499618)]
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可免费领取！