老版本 Retrofit 的使用
在介绍如何使用 Retrofit 2.6.0
之前,我们先来看一下老版本的 Retrofit 是如何基于 Kotlin Coroutines 工作的,以登录接口为例。
首先在 WanService 接口中作如下定义:
@POST("/user/login") fun login(@Field("username") userName: String, @Field("password") passWord: String): Deferred<WanResponse<User>> 复制代码
注意这里使用的返回值是 Deferred<T>
对象,这就意味着使用的时候要通过 await
来获取返回值。那么如何让 Retrofit 直接返回 Deferred<T>
呢?使用的也是 JakeWharton 的开源库:
implementation 'com.jakewharton.retrofit:retrofit2-kotlin-coroutines-adapter:0.9.2' 复制代码
在构建 Client 的时候添加上这个适配器:
... .addCallAdapterFactory(CoroutineCallAdapterFactory.invoke()) ... 复制代码
然后给 LoginRepository 提供一个 suspend 方法:
suspend fun login(userName: String, passWord: String): WanResponse<User> { return apiCall { WanRetrofitClient.service.login(userName, passWord).await() } } 复制代码
这里使用 await
来获取 Deferred<T>
的返回值。
最后在 LoginViewModel 中是这样调用的:
fun login(userName: String, passWord: String) { launch { val response = withContext(Dispatchers.IO) { repository.login(userName, passWord) } executeResponse(response, { mLoginUser.value = response.data }, { errMsg.value = response.errorMsg }) } } 复制代码
launch()
方法做了简单的封装,感兴趣的同学可以到源码中看一下。
以上就是在 Retrofit 2.4.0
中使用协程的基本方式了,其实代码也很简洁。而 Retrofit 2.6.0
让这一切更加简单!就让我们一睹为快吧!
Retrofit 2.6.0 中协程的使用
Talking is cheap, show me the code !
还是上面的登录接口,基于 Retrofit 2.6.0
来改造一下。
第一步,修改 Retrofit 依赖。
implementation 'com.squareup.retrofit2:retrofit:2.6.0' 复制代码
第二步,修改 WanService
中接口的定义。
@POST("/user/login") suspend fun login(@Field("username") userName: String, @Field("password") passWord: String): WanResponse<User> 复制代码
看到区别了吗?首先,不再返回 Deferred<T>
对象,而是直接返回我们需要的 WanResponse
对象。其次,使用了 suspend
来修改方法,标记这是挂起函数。
第三步,修改 LoginRepository
中方法定义。
suspend fun login(userName: String, passWord: String): WanResponse<User> { return apiCall { WanRetrofitClient.service.login(userName, passWord) } } 复制代码
与之前的版本相比,这里不需要调用 await
方法了。其实并不是不调用了,而是 Retrofit 帮助我们自动调用了。
最后别忘了去除之前添加的 kotlin-coroutines-adapter
,因为我们不再需要人工返回 Deferred<T>
对象,也不再需要手动调用 await
了。
... //.addCallAdapterFactory(CoroutineCallAdapterFactory.invoke()) ... 复制代码
至此,基于 Retrofit 2.6.0
版本的改造就已经完成了。我的 Wanandroid 项目已经完成全部修改,具体修改内容可见 commit。
总结
随着 Kotlin 成为 Android 开发的首选语言,越来越多的新特性都将在 Kotlin 上优先实现。协程作为 Kotlin 的异步利器,很值得我们学习。如果你还没有入手,那么,从我的 Wanandroid 开始吧 !