概念概要
Retrofit
A type-safe HTTP client for Android and Java （一个类型安全的HTTP客户端Android和Java）
简介
- 将HTTP API封装为Java接口
public interface GitHubService {
@GET("users/{user}/repos")
Call> listRepos(@Path("user") String user);
}
- 使用Retrofit提供的封装方法将我们的生成我们接口的实现类
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.build();
GitHubService service = retrofit.create(GitHubService.class);
- 创建的Service的每个调用都可以向远程web服务器发出同步或异步HTTP请求。
Call
Retrofit的使用步骤大致是以上三步
REQUEST METHOD请求方法
总体大概有5种请求方式GET, POST, PUT, DELETE, HEAD.
使用形式大致如下所示
@GET("users/list")
还可以在URL指定参数设置
@GET("users/list?sort=desc")
URL操作
可以使用方法上的替换块和参数动态更新请求URL。替换块是由{和}包围的字母数字字符串。必须使用相同的字符串用@Path注释对应的参数。
这里的参数是id因此在方法参数里也要使用id作为注释
@GET("group/{id}/users")
Call> groupList(@Path("id") int groupId);
还可以添加查询参数。
新增sort查询参数
@GET("group/{id}/users")
Call> groupList(@Path("id") int groupId, @Query("sort") String sort);
对于复杂的查询参数组合，可以使用map。
比如需要添加较复杂的数据，那么就可以使用map
@GET("group/{id}/users")
Call> groupList(@Path("id") int groupId, @QueryMap Map options);
REQUEST BODY请求体
可以使用@Body注释将对象指定为HTTP请求体。
这里使用User实体作为请求体
@POST("users/new")
Call createUser(@Body User user);
该对象还将使用Retrofit实例上指定的转换器进行转换。如果没有添加转换器，则只能使用RequestBody。
FORM ENCODED AND MULTIPART形式编码和多部分
还可以声明方法来发送表单编码和多部分数据。
当方法上出现@FormUrlEncoded时，发送表单编码的数据。每个键-值对都使用@Field进行注释，其中包含名称和提供值的对象。
@FormUrlEncoded
@POST("user/edit")
Call updateUser(@Field("first_name") String first, @Field("last_name") String last);
当@Multipart出现在方法上时，将使用Multipart请求。使用@Part注释声明部件。
@Multipart
@PUT("user/photo")
Call updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
多部件部件使用一个Retrofit的转换器，或者它们可以实现RequestBody来处理它们自己的序列化。
HEADER MANIPULATION头操作
可以使用@Headers注释为方法设置静态标头。
添加单个Header
@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call> widgetList();
添加多个Header，只需添加花括号{ }
@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit-Sample-App"
})
@GET("users/{username}")
Call getUser(@Path("username") String username);
注意，头文件不会相互覆盖。所有具有相同名称的标头将包含在请求中。
可以使用@Header注释动态更新请求标头。必须为@Header提供相应的参数。如果该值为空，则标头将被省略。否则，将对该值和使用的结果调用toString。
@GET("user")
Call getUser(@Header("Authorization") String authorization)
与查询参数类似，对于复杂的标头组合，可以使用映射。
@GET("user")
Call getUser(@HeaderMap Map headers)
可以使用OkHttp拦截器指定需要添加到每个请求的头。