Retrofit封装网络请求框架

Retrofit

A type-safe HTTP client for Android and Java
适用于Java和Android的安全的HTTP客户端

Retrofit是一个RESTful的可用于Android和Java的HTTP网络请求框架的封装,使用它可以简化我们的网络操作,提高效率和正确率。它将请求过程和底层代码封装起来只暴露我们业务中的请求和返回数据模型。

值得注意的是,Retrofit并不是完成了网络请求,而是对网络请求框架Okhttp的封装,在Retrofit 2.0开始内置了Okhttp.

开始使用Retrofit,引入依赖:

1
compile 'com.squareup.retrofit2:retrofit:2.0.2'

定义一个Service接口并定义listRepos()请求。

1
2
3
4
public interface GitHubService {
@GET("users/{user}/repos")
Call<List<Repo>> listRepos(@Path("user") String user);
}

这是一个Retrofit将Rest API(服务端post或get请求)转换为Java接口的例子

每一个由接口返回的Call对象都可以与远程web服务端进行同步或者异步的HTTP请求通信。例如:

1
Call<List<Repo>> repos = service.listRepos("octocat");

Service接口有了,接下来就是初始化(构造)Retrofit:

1
2
3
4
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.build();
GitHubService service = retrofit.create(GitHubService.class);

为什么选择Retrofit

AsyncHttp ,Volley和Retrofit的对比

One DiscussionDashboard( 7 request )25 Discussions
AsyncTask941ms4539ms13957ms
Volley560ms2202ms4275ms
Retrofit312ms889ms1059ms

Retrofit中的注解

Retrofit使用注解来描述HTTP请求

请求方式

每一个请求必须指定http请求相对应的url注解和请求方式(内置5种请求方式注解:GET、POST、PUT 、DELETE、HEAD)

1
@GET("users/list")

也可以将参数跟在后面

1
@GET("users/list?sort=desc")

URL操作

一个请求的URL的参数可以通过{}包裹快来动态替换,然后在相应的@Path参数中进行赋值。

1
2
@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId);

例如这个{id}在groupList请求中的@Path(“id”) int groupId来对应赋值。

也可以使用@Query给groupList请求方法动态添加其他请求参数

1
2
@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);

如果是比较多的请求参数,我们可以使用Map来构建

1
2
@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);

请求的Body

能够通过@Body注解来指定一个方法作为HTTP请求主体

1
2
@POST("users/new")
Call<User> createUser(@Body User user);

这个参数对象会被Retrofit实例中的converter进行转化。如果没有给Retrofit实例添加任何converter的话则只有RequestBody可以作为参数使用。

form encode 和 multipart

方法也可以通过声明来发送form-encoded和multipart类型的数据。
可以通过@FormUrlEncoded注解方法来发送form-encoded的数据。每个键值对需要用@Filed来注解键名,随后的对象需要提供值。

1
2
3
@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

也可以通过@Multipart注解方法来发送Mutipart请求。每个部分需要使用@Part来注解。

1
2
@Multipart@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);

多个请求部分需要使用Retrofit的converter或者是自己实现 RequestBody来处理自己内部的数据序列化

头部操作

可以通过使用@Headers注解来设置请求静态头。

1
2
3
@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call<List<Widget>> widgetList();
1
2
3
4
5
6
@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit-Sample-App"
})
@GET("users/{username}")
Call<User> getUser(@Path("username") String username);

注意的是头部参数并不会相互覆盖,同一个名称的所有头参数都会被包含进请求里面。
当然你可以通过 @Header 注解来动态更新请求头。一个相应的参数必须提供给 @Header 注解。如果这个值是空(null)的话,那么这个头部参数就会被忽略。否则的话, 值的 toString 方法将会被调用,并且使用调用结果。

1
2
@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)