使用时完全不用关心网络通信的细节,只需要在接口文件中声明一系列方法和返回值,然后通过注解的方式指定该方法对应哪个服务器接口,以及需要提供哪些参数。
当我们在程序中调用该方法时,Retrofit会自动向对应的服务器接口发起请求,并将响应的数据解析成返回值声明的类型。
Retrofit允许我们对服务器接口进行归类,将功能同属一类的服务器接口定义到同一个接口文件当中,从而让代码结构变得更加合理。
用法接口文件:
interface AppService {
//@GET注解表示GET请求,请求地址的相对路径就是注解中传入的参数
@GET("get_data.json")
//方法的返回值必须声明成Retrofit中内置的Call类型,并通过泛型来指定服务器响应的数据应该转换成什么对象
fun getAppData(): Call>
}
使用:
//使用Retrofit.Builder来构建一个Retrofit对象 val retrofit = Retrofit.Builder() //指定所有请求的根路径 .baseUrl(baseUrl) //指定解析数据时所使用的转换库 .addConverterFactory(GsonConverterFactory.create()) .build() //调用create()方法,传入具体Service接口的Class类型,创建一个该接口的动态代理对象 val appService = retrofit.create(AppService::class.java) //调用接口里的方法返回一个Call对象,在调用这个对象的enqueue()方法就会进行网络请求了 //enqueue()传入Callback接口的实现 appService.getAppData().enqueue(object : Callback > { override fun onResponse(call: Call
>, response: Response
>) { //调用response.body()方法将会得到解析后的对象 val list = response.body() } override fun onFailure(call: Call
>, t: Throwable) { t.printStackTrace() } })
当发起请求的时候,Retrofit会自动在内部开启子线程,当数据回调到Callback中之后,Retrofit又会自动切换回主线程,整个操作过程中我们都不用考虑线程切换问题。
常用接口地址类型动态地址类型
@GET("{page}/get_data")
fun getData(@Path("page") page: Int): Call
带参数
@GET("get_data")
fun getDataByQuery(@Query("u") user: String, @Query("t") token: String): Call
DELETE请求
@DELETE("data/{id}")
fun deleteData(@Path("id") id: String): Call
POST请求, @Body会自动把对象转换成json格式文本
@POST("data/create")
fun postData(@Body data: App): Call
在HTTP请求的header中指定参数
@Headers("User-Agent: okhttp", "Cache-Control: max-age=0")
@GET("get_data")
fun getData(): Call
动态指定header的值使用@Header注解
@GET("get_data.json")
fun getData(@Header("User-Agent") userAgent: String,
@Header("Cache-Control") cacheControl: String): Call



