之前在掘金、简书上看到很多篇介绍retrofit的文章，但是一直没有静下心来研究这到底是什么东西。最近时间比较充裕，仔细了解了一下retrofit这个网络请求工具的用法及实现原理。现在做下简单的记录，以便日后重温。
1、Retrofit是什么？
Retrofit官网的介绍：A type-safe HTTP client for Android and Java ，一个类型安全的HTTP请求工具（现在对于类型安全理解不是太到位）。
Retrofit 是 Square 公司出品的默认基于 OkHttp 封装的一套 RESTful 网络请求框架。Retrofit 的封装可以说是很强大，里面涉及到一堆的设计模式，你可以通过注解直接配置请求 ，可以使用不同 Json Converter 来序列化数据，同时提供对 RxJava 的支持，使用 Retrofit + OkHttp + RxJava + Dagger2 可以说是目前比较潮的一套框架，但是需要有比较高的门槛。
2、基本用法
既然是网络请求工具，那么最基本的功能就是发送HTTP请求，常用的GET、POST请求。再有就是一些请求设置，比如超时时间、header等。
2.1 GET请求
先定义一个接口
/**
* Created by dell on 2016/9/7.
*
* 定义HTTP API使用接口
*
* 接口其实就是Retrofit对一个HTTP请求的描述
*/
public interface GitHubService {
@FormUrlEncoded //将会自动将请求参数的类型调整为application/x-www-form-urlencoded
@POST("query") // 请求地址是 baseurl + query
Call<PostQueryInfo> search(@Field("type") String type, @Field("postid") String postid);//@Field 参数放到请求体
@GET("query")
/**
* @Query表示请求参数，将会以key=value的方式拼接在url后面
*
* 如果参数很多， 可以使用@QueryMap , getInfo(@QueryMap Map<String,String> map)
*/
Call<PostQueryInfo> getInfo(@Query("type") String type, @Query("postid") String postid);
@GET("/users/{user}")
Call<User> getFeed(@Path("user") String user); //@Path动态的URL访问。像上面get请求中的{user}可以把它当做一个占位符，通过@Path("user")标注的参数进行替换
}
发送请求
/**
* 模拟GET 请求
*/
@OnClick(R.id.btn_get)
public void onClick() {
//retrofit是通过注解将HTTP转化为java接口
Retrofit retrofit = new Retrofit.Builder()
.client(getNewClient())//设置不同的底层网络库
.baseUrl("http://www.kuaidi100.com/")
// .addCallAdapterFactory(RxJavaCallAdapterFactory.create())//添加 RxJava 适配器
.addConverterFactory(GsonConverterFactory.create())//通过addConverterFactory来添加转化器来完成数据转化 ,把json数据转成model对象
.build();
GitHubService service = retrofit.create(GitHubService.class);
Call<PostQueryInfo> call = service.getInfo("ems","1045861721780");
// try {
// User user = call.execute().body();//同步请求 ，网络请求一定要在子线程中完成，不能直接在UI线程执行，不然会crash
// } catch (IOException e) {
// e.printStackTrace();
// }
//异步请求
call.enqueue(new Callback<PostQueryInfo>() {
@Override
public void onResponse(Call<PostQueryInfo> call, Response<PostQueryInfo> response) {
pb.dismiss();
if (response.isSuccessful()){
PostQueryInfo user = response.body();
Toast.makeText(RetrofitActivity.this, user.getMessage(), Toast.LENGTH_LONG).show();
Log.i(TAG, "user:" + user.getMessage());
}else{
ResponseBody errorBody = response.errorBody();
}
}
@Override
public void onFailure(Call<PostQueryInfo> call, Throwable t) {
pb.dismiss();
Log.e(TAG, "onFailure: " + t.getMessage());
}
});
// call.cancel();//取消请求
}
private OkHttpClient getNewClient() {
/**
* HttpLoggingInterceptor提供了4中控制打印信息类型的等级，分别是NONE，BASIC，HEADERS，BODY，接下来分别来说一下相应的打印信息类型。
*
* NONE 没有任何日志信息
* Basic 打印请求类型，URL，请求体大小，返回值状态以及返回值的大小
* Headers 打印返回请求和返回值的头部信息，请求类型，URL以及返回值状态码
* Body 打印请求和返回值的头部和body信息
*
*/
HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
logging.setLevel(HttpLoggingInterceptor.Level.BODY);
int cacheSize = 10 * 1024 * 1024; // 10 MiB
Cache cache = new Cache(this.getCacheDir(), cacheSize);
return new OkHttpClient.Builder()
// .addInterceptor(new CustomInterceptor())
.addInterceptor(logging)
.cache(cache)
// .readTimeout()
// .writeTimeout()
.connectTimeout(10, TimeUnit.SECONDS)
.build();
}
2.2 POST请求
在上一步骤中定义的接口，已经包含了POST请求，即用@POST这个注解修饰的方法。
定义完接口之后，发送请求的方法和GET请求的方法类似
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://www.kuaidi100.com/")
.client(getNewClient())
.addConverterFactory(GsonConverterFactory.create())//添加转换器，gson数据转成 model对象
.build();
/**
*
* Retrofit对象传了一个GitHubService接口的Class对象，怎么又返回一个GitHubService对象呢？
*
* create方法重要就是返回了一个动态代理对象
*
* 动态代理对象 作用：当你要调用某个类的方法前，插入你想要执行的代码。
*/
GitHubService service = retrofit.create(GitHubService.class);
/**
* service 是一个动态代理对象，并不是GitHubService 的 implements对象。当service对象调用search方法时，执行的是动态代理方法。
*
* 动态代理发挥了它的作用，你看上去是调用了contributors方法，其实此时Retrofit把Github接口翻译成一个HTTP请求
*
* 后为你生成了一个Http请求，然后，你调用call.enqueue方法时就发送了这个请求，然后你就可以处理Response的数据了
*/
Call<PostQueryInfo> call = service.search("ems", "1045861721780");
// PostBodyService service = retrofit.create(PostBodyService.class);
// Call<PostQueryInfo> call = service.getPostInfo(new PostInfo("ems","1045861721780"));
/**
* 同步请求 ， 不能在main线程中执行
*/
// try {
// PostQueryInfo info = call.execute().body();
// } catch (IOException e) {
// e.printStackTrace();
// }
/**
* 异步请求
*/
call.enqueue(new Callback<PostQueryInfo>() {
@Override
public void onResponse(Call<PostQueryInfo> call, Response<PostQueryInfo> response) {
pb.dismiss();
if (response.isSuccessful()){
String msg = response.body().getMessage();
Log.i(TAG, "msg:" + msg);
Toast.makeText(RetrofitActivity.this, msg, Toast.LENGTH_LONG).show();
}else{
ResponseBody requestBody = response.errorBody();
}
}
@Override
public void onFailure(Call<PostQueryInfo> call, Throwable t) {
pb.dismiss();
String msg = t.getMessage();
Log.e(TAG, "msg:" + msg);
}
});
2.3 自定义client ： 可以设置超时时间、缓存等
private OkHttpClient getNewClient() {
/**
* HttpLoggingInterceptor提供了4中控制打印信息类型的等级，分别是NONE，BASIC，HEADERS，BODY，接下来分别来说一下相应的打印信息类型。
*
* NONE 没有任何日志信息
* Basic 打印请求类型，URL，请求体大小，返回值状态以及返回值的大小
* Headers 打印返回请求和返回值的头部信息，请求类型，URL以及返回值状态码
* Body 打印请求和返回值的头部和body信息
*
*/
HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
logging.setLevel(HttpLoggingInterceptor.Level.BODY);
int cacheSize = 10 * 1024 * 1024; // 10 MiB
Cache cache = new Cache(this.getCacheDir(), cacheSize);
return new OkHttpClient.Builder()
// .addInterceptor(new CustomInterceptor())
.addInterceptor(logging)
.cache(cache)
// .readTimeout()
// .writeTimeout()
.connectTimeout(10, TimeUnit.SECONDS)
.build();
}
Retrofit retrofit = new Retrofit.Builder()
.client(getNewClient())//设置不同的底层网络库
.baseUrl("http://www.kuaidi100.com/")
// .addCallAdapterFactory(RxJavaCallAdapterFactory.create())//添加 RxJava 适配器
.addConverterFactory(GsonConverterFactory.create())//通过addConverterFactory来添加转化器来完成数据转化 ,把json数据转成model对象
.build();
2.4 转换器 ： 用什么方式解析服务端返回的数据，支持gson、jackson、xml等
Gson: com.squareup.retrofit2:converter-gson:2.1.0
Moshi: com.squareup.retrofit2:converter-moshi:2.1.0
Jackson: com.squareup.retrofit2:converter-jackson:2.1.0
SimpleXML: com.squareup.retrofit2:converter-simplexml:2.1.0
ProtoBuf: com.squareup.retrofit2:converter-protobuf:2.1.0
Wire: com.squareup.retrofit2:converter-wire:2.1.0
如果上面的转换器还不够你使用的话，你可以通过自己实现 Converter.Factory 来自定义转换器。
2.5 添加header ：有两种方式，静态和动态
2.5.1 静态方式
通过@Headers注解。如：下面这段是官方文档上的。
@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit-Sample-App"
})
@GET("query")
Call<PostQueryInfo> getInfo(@Query("type") String type, @Query("postid") String postid);
或者也可以通过Interceptor来定义静态请求头
public class RequestInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request original = chain.request();
Request request = original.newBuilder()
.header("User-Agent", "Your-App-Name")
.header("Accept", "application/vnd.yourapi.v1.full+json")
.method(original.method(), original.body())
.build();
return chain.proceed(request);
}
}
2.5.2 动态添加 ： 在定义的接口 方法中，添加参数
@GET("/user")
Call<User> getUser(@Header("Authorization") String authorization , @Query("q") String name)
2.6 开启log日志
Retrofit官方提供了一个很方便查看日志的Interceptor，你可以控制你需要的打印信息类型，使用方法也很简单。
添加依赖：compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'
HttpLoggingInterceptor提供了4中控制打印信息类型的等级，分别是NONE，BASIC，HEADERS，BODY，接下来分别来说一下相应的打印信息类型。
* NONE 没有任何日志信息
* Basic 打印请求类型，URL，请求体大小，返回值状态以及返回值的大小
* Headers 打印返回请求和返回值的头部信息，请求类型，URL以及返回值状态码
* Body 打印请求和返回值的头部和body信息
也是在自定义client中设置：
HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
logging.setLevel(HttpLoggingInterceptor.Level.BODY);
client.addInterceptor(logging);
此后步骤参考2.3 中的getNewClient();
2.7 常用注解解释：
@GET和@POST分别是get和post请求。括号里面的value值与上面.baseUrl组成完整的路径
@Path动态的URL访问。像上面get请求中的{user}可以把它当做一个占位符，通过@Path("user")标注的参数进行替换
@Query请求参数。无论是GET或POST的参数都可以用它来实现
@QueryMap请求参数使用Map集合。可以传递一个map集合对象
@FormUrlEncoded将会自动将请求参数的类型调整为application/x-www-form-urlencoded ，不能用于Get请求
@Body实体请求参数。顾名思义可以传递一个实体对象来作为请求的参数，不过实体属性要与参数名一一致（在测试代码中，用这种方式传递参数，会报错，就是@Body标签不能同时和@FormUrlEncoded、@Multipart标签同时使用）
@field :注解将每一个请求参数都存放至请求体中，还可以添加encoded参数
@fieldMap :POST请求参数有多个时， 可以使用这个
@Multipart 文件上传
@Url"对一个方法的参数进行注解，表明这是个url ,可以传递一个完整的url地址
取消请求
在页面退出时，要把正在进行的请求取消，否则再回调后容易发生异常。
单个请求可以调用call.cancel()
3、实现原理
动态代理机制
参考文档
1、Android网络访问库 - Retrofit学习(1)基础
2、Android 网络开源库-Retrofit(一)简单介绍
3、Retrofit 2.0:迄今为止最大的更新最好的Android HTTP客户端库
4、Retrofit用法详解（有各种常见用法样例）
5、Retrofit源码1: 为什么写一个interface就可以实现http请求
6、关于Retrofit的用法：Retrofit 是什么，1、Retrofit 怎么用，2、Retrofit的原理是什么
7、使用Retrofit2.0+OkHttp3.0实现缓存处理
8、 Android网络请求库 - Say hello to retrofit
9、Retrofit 官网
10、我们真的需要使用RxJava+Retrofit吗？
11、拆轮子系列：拆 Retrofit
12、「Android技术汇」Retrofit2 源码解析和案例说明
