有道翻译的Retrofit官方文档(需要翻墙才能看~)
一:定义:
用于Android和Java的类型安全HTTP客户机
二:介绍
1.改进将您的HTTP API转换为Java接口。
public interface GitHubService{
@GET("users/{user}/repos")
Call<List<Pro> listRepos(@Path("user") String user);
}
2.Retrofit类生成一个GitHubService接口的实现。
Retrofit retrofit=new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.build();
GitHubService service=retrofit.create(GitHubService.class);
3.来自创建的GitHubService的每个调用都可以向远程web服务器发出同步或异步的HTTP请求。
Call<List<Pero>> repos=service.listRepos("octocat");
4.使用注释来描述HTTP请求:
URL参数替换和查询参数支持
对象转换为请求主体(例如、JSON、协议缓冲区)
多部件请求体和文件上传
三:API声明:
接口方法及其参数上的注释指示如何处理请求。
1.请求方法:
每个方法都必须有一个提供请求方法和相对URL的HTTP注释。有5个内置注释:GET、POST、PUT、DELETE和HEAD。该资源的相对URL是在注释中指定的。
@GET("users/list")
您还可以在URL中指定查询参数。
@GET("users/list?sort=desc")
2.URL操作:
可以使用该方法的替换块和参数动态地更新请求URL。替换块是由字母和数字包围的字母数字字符串。一个相应的参数必须使用相同的字符串对@path进行注释。
@GET("group/{id}/users")
Call<List<User> groupList(@Path("id") int groupId);
还可以添加查询参数。
@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);
对于复杂的查询参数组合,可以使用映射。
@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String,String> options);
3.请求体
可以指定一个对象作为一个带有@body注释的HTTP请求体。
@POST("users/new")
Call<User> createUser(@Body User user);
该对象还将使用Retrofit实例中指定的转换器进行转换。如果不添加任何转换器,则只能使用RequestBody。
4.表单编码和多部分
方法也可以被声明为发送表单编码和多部分数据。
表单编码的数据是在该方法上出现@formurlen编码时发送的。每个键值对都带有@field的注释,其中包含名称和提供该值的对象。
@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name")String first,@Field("last_name")String last);
当@multi部件出现在该方法时,将使用多部件请求。部分是使用@part注释声明的。
@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo,@Part("description") RequestBody description);
多部件部件使用一个Retrofit转换器,或者他们可以实现请求体来处理他们自己的序列化。
5.头操作
您可以使用@header注释为方法设置静态标题。
@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call<List<Widget> widgetList();
@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将调用该值,并使用该结果。
@GET("user")
Call<User> getUser(@Header("Authorization")String authorization)
需要添加到每个请求的头信息都可以使用OkHttp拦截器来指定。
6.同步或异步
调用实例可以同步或异步执行。每个实例只能使用一次,但是调用克隆()将创建一个可以使用的新实例。
在Android上,回调将在主线程上执行。在JVM上,回调将发生在执行HTTP请求的同一线程上。
四:要改装配置
Retrofit是将您的API接口转化为可调用对象的类。默认情况下,Retrofit会为你的平台提供合理的默认值,但它允许定制。
1.转换器
默认情况下,Retrofit只能将HTTP主体反序列化为OkHttp的ResponseBody类型,并且只能接受它的请求体类型为@body。
可以添加转换器来支持其他类型。为了方便,6个兄弟模块调整了流行的序列化库。
Gson:com.squareup.retrofit2:converter-gson
Jackson:com.squareup.retrofit2:converter-jackson
Moshi:com.squareup.retrofit2:converter-moshi
Protobuf:com.squareup.retrofit2:converter-protobuf
Wire:com.squareup.retrofit2:converter-wire
Simple XML:com.squareup.retrofit2:converter-simplexml
Scalars (primitives, boxed, and String):com.squareup.retrofit2:converter-scalars
这里有一个使用GsonConverterFactory类来生成GitHubService接口的示例,该接口使用Gson进行反序列化。
Retrofitretrofit=newRetrofit.Builder()
.baseUrl("https://api.github.com")
.addConverterFactory(GsonConverterFactory.create()
.build();
GitHubService service=retrofit.create(GitHubService.class);
2.自定义转换器
如果您需要使用一个API,该API使用的内容格式并不支持box(例如YAML、txt、定制格式),或者您希望使用不同的库来实现现有的格式,那么您可以轻松地创建自己的转换器。创建一个扩展转换器的类。工厂类,并在构建适配器时传入一个实例。
五:应用?
以下为我项目中的应用
compile'com.squareup.retrofit2:retrofit:2.2.0'
compile'com.squareup.retrofit2:converter-gson:2.2.0'
compile'com.squareup.retrofit2:adapter-rxjava:2.2.0'
compile'com.squareup.retrofit2:converter-scalars:2.2.0'
具体应用查看:你真的会用Retrofit2吗?Retrofit2完全教程