Android-最好用的网络库：Retrofit

一、简介

Retrofit是一款由Square公司开发的网络库，但是它和OkHttp的定位完全不同。

OkHttp侧重的是底层通信的实现，而Retrofit侧重的是上层接口的封装。

事实上，Retrofit就是Square公司在OkHttp的基础上进一步开发出来的应用层网络通信库，使得我们可以用更加面向对象的思维进行网络操作。

Retrofit的项目主页地址是：https://github.com/square/retrofit。

二、使用

1、添加依赖

要想使用Retrofit，我们需要先在项目中添加必要的依赖库。编辑app/build.gradle文件，在dependencies闭包中添加如下内容：

dependencies {
    …
    implementation 'com.squareup.retrofit2:retrofit:2.6.1'
    implementation 'com.squareup.retrofit2:converter-gson:2.6.1'
}

2、添加json对应的数据对象

例如：
Retrofit会借助GSON将JSON数据转换成对象，因此这里同样需要新增一个App类，并加入id、name和version这3个字段，如下所示：

class App(val id: String, val name: String, val version: String)

3、新建接口

新建AppService接口，代码如下所示：

interface AppService {
    @GET("get_data.json")
    fun getAppData(): Call<List<App>>
}

这里使用了一个@GET注解，表示当调用getAppData()方法时Retrofit会发起一条GET请求，请求的地址就是我们在@GET注解中传入的具体参数。

另外，getAppData()方法的返回值必须声明成Retrofit中内置的Call类型，并通过泛型来指定服务器响应的数据应该转换成什么对象。

复杂接口地址

传入一个参数
GET http://example.com//get_data.json

    @GET("{page}/get_data.json")
    fun getData(@Path("page ") page: Int): Call<Data>

传入一系列参数
GET http://example.com/get_data.json?u=&t=

@GET("get_data.json")
fun getData(@Query("u") user: String, @Query("t") token: String): Call<Data>
    

@POST

POST http://example.com/data/create
{“id”: 1, “content”: “The description for this data” }

@POST("data/creat")
fun createData(@Body data: Data): Call<ResponseBody>

@POST对于服务器响应的数据并不关心，这个时候可以使用ResponseBody，表示Retrofit能够接收任意类型的响应数据，并且不会对响应的数据进行解析

在header中指定参数

GET http://example.com/get_data.json
User-Agent: okhttp
Cache-Control: max-age=0

@Headers("User-Agent: okhttp", "Cache-Control: max-age=0")
@GET("get_data.json")
 fun getData(): Call<Data>

4、Retrofit构建器（最佳写法）

object ServiceCreator {

    private const val BASE_URL = "https://api.caiyunapp.com/"

    private val retrofit = Retrofit.Builder()
        .baseUrl(BASE_URL)
        .addConverterFactory(GsonConverterFactory.create())
        .build()

    fun <T> create(serviceClass: Class<T>): T = retrofit.create(serviceClass)

    inline fun <reified T> create(): T = create(T::class.java)

}

5、使用

val appService = ServiceCreator.create<AppService>()

appService.getAppData().enqueue(object : Callback<List<App>> {
                override fun onResponse(call: Call<List<App>>, response: Response<List<App>>) {
                	//得到retrofit解析后的对象
                    val list = response.body()
                   
                   //处理逻辑
                }

                override fun onFailure(call: Call<List<App>>, t: Throwable) {
                    t.printStackTrace()
                }
            })