一、Retrofit框架
Retrofit是一种基于OkHttp的RESTful API请求框架,提供了一个轻量、易于学习和使用的API。Retrofit可以让我们通过注解为每一个请求配置请求方法、url、参数、请求头等信息,它通过动态代理技术,把java接口转化成HTTP请求,在结构上比较清晰。下面详细介绍四大注解用法。
1、@Get
注解用于指定请求类型。
@GET("https://www.myapi.com/data")
Call<ResponseBody> getData();
2、@Path
注解用于指定 URL 中变量的取值。
@GET("https://www.myapi.com/data/{id}")
Call<ResponseBody> getDataById(@Path("id") int id);
3、@Query
注解用于指定查询参数。它可以添加多个 Query 参数,只需要再写一个 @Query 即可。
@GET("https://www.myapi.com/data")
Call<ResponseBody> getDataByQuery(@Query("page") int page, @Query("count") int count);
4、@Body
注解使用一个对象作为其请求体。POST和PUT请求使用它传递实体。
@POST("https://www.myapi.com/data")
Call<ResponseBody> createData(@Body Data data); // Data对象即为请求体
二、Retrofit协程
在调用请求时,Retrofit默认是运行在主线程上的,如果在请求一些耗时的数据,可能会导致主线程卡死,出现ANR等问题。因此在这种情况下,可以选择使用协程处理请求。Retrofit的协程版本需要引入一个扩展库,下面给出具体的代码实现。
//1、在gradle中引入扩展库
implementation "com.squareup.retrofit2:retrofit:2.x.y"
implementation "com.squareup.retrofit2:converter-gson:2.x.y"
implementation 'com.jakewharton.retrofit:retrofit2-kotlin-coroutines-adapter:0.9.2'
//2、定义一个协程请求接口
interface ApiService {
@GET("https://www.myapi.com/data")
suspend fun getData(): ResponseBody
}
//3、使用协程调用请求
val apiService = Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(CoroutineCallAdapterFactory())
.build().create(ApiService::class.java)
GlobalScope.launch(Dispatchers.Main) {
try {
val response = withContext(Dispatchers.IO) { apiService.getData() }
//处理请求结果
} catch (e: Exception) {
//处理异常
}
}
三、Retrofit下载文件
Retrofit同样支持下载文件,我们可以通过设置下载文件的地址以及回调函数来实现文件的下载,下面给出一个具体的例子。
//1、定义一个文件下载的接口
interface DownloadService {
@Streaming
@GET
fun downloadFile(@Url fileUrl: String): Call
}
//2、创建下载文件时需要的OkHttp Client,并设置连接和读取超时时间
val httpClient = OkHttpClient.Builder()
.connectTimeout(60, TimeUnit.SECONDS)
.readTimeout(60, TimeUnit.SECONDS)
.build()
//3、创建Retrofit对象
val retrofit = Retrofit.Builder()
.baseUrl(baseUrl)
.client(httpClient)
.build()
//4、创建下载服务对象
val downloadService = retrofit.create(DownloadService::class.java)
//5、开始进行文件的下载
val downloadCall = downloadService.downloadFile(fileUrl)
downloadCall.enqueue(object : Callback
{
override fun onResponse(call: Call
, response: Response
) {
//下载完成,开始处理
}
override fun onFailure(call: Call
, t: Throwable) { //下载失败,进行异常处理 } })
四、Retrofit的所有形式
Retrofit不仅支持GET和POST请求,还支持PUT、DELETE等多种请求方式,并提供了RxJava、Java8 Lambda、协程等多种形式供我们选择。下面给出不同形式的代码实现。
1、RxJava形式
//1、定义一个接口
interface ApiService {
@GET("https://www.myapi.com/data")
fun getData(): Observable<ResponseBody>
}
//2、创建RxJava请求接口对象并进行请求
val apiService = Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.build()
.create(ApiService::class.java)
apiService.getData().subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe({
//处理请求结果
}, {
//处理异常
})
2、Java8 Lambda形式
//1、定义一个接口
interface ApiService {
@GET("https://www.myapi.com/data")
Call<ResponseBody> getData();
}
//2、创建Java8 Lambda请求接口对象并进行请求
ApiService apiService = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build()
.create(ApiService.class);
Call
call = apiService.getData();
call.enqueue(new Callback
() {
@Override
public void onResponse(Call
call, Response
response) {
//处理请求结果
}
@Override
public void onFailure(Call
call, Throwable throwable) { //处理异常 } });
3、协程形式
//1、定义一个接口
interface ApiService {
@GET("https://www.myapi.com/data")
suspend fun getData(): ResponseBody
}
//2、使用协程请求接口
val apiService = Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build()
.create(ApiService::class.java)
GlobalScope.launch(Dispatchers.Main) {
try {
val response = withContext(Dispatchers.IO) { apiService.getData() }
//处理请求结果
} catch (e: Exception) {
//处理异常
}
}