阅读 1602

协程+Retrofit 让你的代码足够优雅

最近我司大佬们在项目中引入了协程,之前已经和大家介绍过协程了,不清楚的同学可以看一下之前的文章。

《抽丝剥茧Kotlin - 协程》

今天和大家介绍一个协程的小技巧,Retrofit自 2.6 版本后,原生支持协程,所以使用 协程 + Retrofit 可以缩减我们的代码,加速我们的应用开发。

虽然,很多大佬们都已经十分熟悉这个技巧,万一有同学不熟悉呢?

目标

简单起见,我们使用 Github 官方的 Api,查询官方返回的仓库列表。

如果你学习过官方 Paging Demo 的源码,会发现这份代码很熟悉,因为这份代码很大一部分来自这个Demo。

一、引入依赖

协程和 Retrofit 的版本:

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.2'
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.2"
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
    implementation 'com.squareup.okhttp3:logging-interceptor:4.0.0'
}
复制代码

二、使用Retrofit

创建一个 interface

interface GithubApi {
    @GET("search/repositories?sort=stars")
    suspend fun searchRepos(
        @Query("q") query: String,
        @Query("page") page: Int,
        @Query("per_page") itemsPerPage: Int
    ): RepoSearchResponse
}
复制代码

和我们平时使用 Retrofit 有两点不一样:

  1. 需要在函数前加上 suspend 修饰符
  2. 直接使用我们需要返回的类型,不需要包上 Call<T> 或者 Observable<T>

RepoSearchResponse 是返回的数据:

data class RepoSearchResponse(
    @SerializedName("total_count") val total: Int = 0,
    @SerializedName("items") val items: List<Repo> = emptyList()
)

data class Repo(
    @SerializedName("id") val id: Long,
    @SerializedName("name") val name: String,
    @SerializedName("full_name") val fullName: String,
    @SerializedName("description") val description: String?,
    @SerializedName("html_url") val url: String,
    @SerializedName("stargazers_count") val stars: Int,
    @SerializedName("forks_count") val forks: Int,
    @SerializedName("language") val language: String?
)
复制代码

之后的步骤就和我们平常使用 Retrofit 一致:

  1. 创建一个 OkHttpClient
  2. 创建一个 Retrofit
  3. 返回上面创建的接口

代码:

interface GithubApi {
    //... 代码省略

    companion object {
        private const val BASE_URL = "https://api.github.com/"

        fun createGithubApi(): GithubApi {
            val logger = HttpLoggingInterceptor()
            logger.level = HttpLoggingInterceptor.Level.BASIC

            val client = OkHttpClient.Builder()
                    .addInterceptor(logger)
                    .sslSocketFactory(SSLSocketClient.getSSLSocketFactory(),
                            object : X509TrustManager {
                                override fun checkClientTrusted(
                                        chain: Array<X509Certificate>,
                                        authType: String
                                ) {}
                                override fun checkServerTrusted(
                                        chain: Array<X509Certificate>,
                                        authType: String
                                ) {}
                                override fun getAcceptedIssuers(): Array<X509Certificate> {
                                    return arrayOf()
                                }
                            })
                    .hostnameVerifier(SSLSocketClient.getHostnameVerifier())
                    .build()
            return Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(client)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build()
                    .create(GithubApi::class.java)
        }
    }
}
复制代码

因为接口是 Https 请求,所以需要加上忽略 SSL 的验证,其他都一样了。

三、使用协程去请求

初始化 RecyclerView 的代码就不放了,比较简单:

class MainActivity : AppCompatActivity() {
    val scope = MainScope()
    private val mAdapter by lazy {
        MainAdapter()
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // ... 初始化RecyclerView
        fetchData()
    }

    private fun fetchData(){
        scope.launch {
            try {
                val result = GithubApi.createGithubApi().searchRepos("Android", 0, 20)
                if(result != null && !result.items.isNullOrEmpty()){
                    mAdapter.submitList(result.items)
                }
            }catch (e: Exception){
                e.printStackTrace()
            }
        }
    }

    override fun onDestroy() {
        super.onDestroy()
        scope.cancel()
    }
}
复制代码

协程中最方便的还是省去切线程的步骤,用同步代码处理耗时的异步网络请求

需要注意的是,由于没有使用 LifecycleKTX 的扩展库,所以协程作用域的生命周期得我们自己去释放,在上面的代码中,我是在 onCreate 方法中启动了一个协程,然后在 onDestroy 方法中去取消了正在执行的任务,以防内存泄漏。

总结

协程 + Retrofit 的方便之处在于:使用同步代码处理异步的网络请求,减去 Retrofit 中网络回调或者 RxJava + Retrofit 的请求回调

精彩内容

如果觉得本文不错,「点赞」是对作者最大的鼓励~

技术不止,文章有料,关注公众号 九心说,每周一篇高质好文,和九心在大厂路上肩并肩。

文章分类
Android
文章标签