原文:一种针对 Android 和 Java 的类型安全的 HTTP 代理
简介
Retrofit 可以将 HTTP API 转换为 Java 接口。
public interface GithubService{
@GET("/user/{user}/repos")
Call<List<Repo> listRepos(@Path("user") String user);
}
Retrofit 类生成 GitHubService 接口的实现。
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com")
.build();
GitHubService service = retrofit.create(GitHubService.class);
每个 GitHubService 的 Call 方法能进行一个到远程服务器的同步或异步的 HTTP 请求。
Call<List<Repo>> repos = service.listRepos("octocat");
使用注解来描述 HTTP 请求:
- URL 参数替代和查询参数的支持
- 将对象转换为请求体(例如:JSON,协议缓冲等)
- 多部分的请求体和文件上传
注释:这个网页仍然为了新的2.0的API在扩展。
API 声明
接口和其参数上的注解表明了这个请求将被如何处理。
请求方法
每个方法都必须有一个 HTTP 注解用来定义请求方法和相关的 URL。共有五种内置的注解:GET、POST、PUT、DELETE,和 HEAD。相关的 URL 资源定义在注解内。
@GET("/user/list")
你也可以在 URL 中定义查询参数。
@GET("/user/list?sort=desc")
URL 处理
请求 URL 可以通过使用方法中的替换区块和参数来动态更改。替换区块是指被 { 和 } 包围的字母数字串。合适的参数必须以相同的字符串的@Path 注解来标识。
@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId);
也可以添加查询参数。
@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId, @Query("sort") String sort);
对于复杂的查询条件可以使用 Map。
@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);
请求体
通过 @Body 注解来声明一个对象可以用作 HTTP 请求体。
@POST("/users/new")
Call<User> createUser(@Body User user);
该对象会被定义在 Retrofit 实例中的转换器转换。如果没有已添加的转换器,那么只有 RequestBody 可以被用于请求体。
实在翻译不下来了,以后再尝试吧。
初次翻译,好难。