Retrofit 基础篇
2018-09-11 本文已影响0人
kjy_112233
一、Retrofit 网络请求接口的注解类型：网络请求方法、标记类、网络请求参数
（1）网络请求方法
@GET //采用get方法发送网络请求
@POST //采用post方法发送网络请求
@PUT //采用put方法发送网络请求
@DELETE //采用delete方法发送网络请求
@PATCH //patch请求，该请求是对put请求的补充，用于更新局部资源
@HEAD //采用head方法发送网络请求
@OPTIONS //采用options方法发送网络请求
@HTTP //用于替换以上七个注解的作用及更多功能的扩展。其拥有三个属性：method：表示请求的方法,不区分大小写、path：path表示路径、hasBody：表示是否有请求体
（2）标记类
@FormUrlEncoded //表示请求体是一个Form表单
@Multipart //表示请求体是一个支持文件上传的Form表单
@Streaming //表示返回的数据已流的形式返回（适用于返回数据较大的场景）默认会把数据全部载入到内存中.该注解在下载大文件特别有用
（3）网络请求参数
@Body //用于post请求发送非表单数据,比如想要以post方式传递json格式数据
@Field //用于post请求中表单字段,Filed和FieldMap需要FormUrlEncoded结合使用
@FieldMap //和@Filed作用一致，用于不确定表单参数
@Part //用于表单字段,Part和PartMap与Multipart注解结合使用,适合文件上传的情况
@PartMap //用于表单字段,可用于实现多文件上传
@Path //用于url中的占位符
@Query //用于Get中指定参数
@QueryMap //和Query使用类似
@Url //指定请求路径
二、OkHttpClient拦截器
（1）日志拦截器
Application Interceptors应用程序拦截器：addInterceptor添加的是应用拦截器Application Interceptor他只会在response被调用一次。主要用于查看请求信息及返回信息，如链接地址、头信息、参数信息等。
private static HttpLoggingInterceptor getHttpLoggingInterceptor() {
HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(
new HttpLoggingInterceptor.Logger() {
@Override
public void log(String message) {
LogUtils.Le("OkHttp", "log = " + message);
}
});
loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
return loggingInterceptor;
}
添加应用拦截器
方式一：在OkHttpClient.Builder中添加
new OkHttpClient.Builder().addInterceptor(getHttpLoggingInterceptor())
方式二：在okHttpClient中直接添加
okHttpClient.interceptors().add(getHttpLoggingInterceptor())
（2）请求头拦截器
Network Interceptors网络拦截器：addNetworkInterceptor添加的是网络拦截器Network Interceptors它会在request和response时分别被调用一次。主要用于添加、删除或替换请求头信息，还可以改变的请求携带的实体。
private static Interceptor getRequestHeader() {
Interceptor headerInterceptor = new Interceptor() {
@Override
public okhttp3.Response intercept(Chain chain) throws IOException {
Request originalRequest = chain.request();
Request.Builder builder = originalRequest.newBuilder();
//使用addHeader()不会覆盖之前设置的header,若使用header()则会覆盖之前的header
builder.addHeader("Accept", "application/json");
builder.addHeader("Content-Type", "application/json; charset=utf-8");
builder.removeHeader("User-Agent");
builder.method(originalRequest.method(), originalRequest.body());
Request.Builder requestBuilder =
builder.method(originalRequest.method(), originalRequest.body());
Request request = requestBuilder.build();
return chain.proceed(request);
}
};
return headerInterceptor;
}
添加网络拦截器
方式一：在OkHttpClient.Builder中添加
new OkHttpClient.Builder().addNetworkInterceptor(getRequestHeader() )
方式二：在okHttpClient中直接添加
okHttpClient. networkInterceptors().add(getRequestHeader() )
（3）统一的请求参数截器
private static Interceptor commonParamsInterceptor() {
Interceptor commonParams = new Interceptor() {
@Override
public okhttp3.Response intercept(Chain chain) throws IOException {
Request originRequest = chain.request();
Request request;
HttpUrl httpUrl = originRequest.url().newBuilder().
addQueryParameter("paltform", "android").
addQueryParameter("version", "1.0.0").build();
request = originRequest.newBuilder().url(httpUrl).build();
return chain.proceed(request);
}
};
return commonParams;
}
（4）在无网络的情况下读取缓存，有网络的情况下根据缓存的过期时间重新请求
public static Interceptor getCacheInterceptor() {
Interceptor commonParams = new Interceptor() {
@Override
public okhttp3.Response intercept(Chain chain) throws IOException {
Request request = chain.request();
if (!NetworkUtils.isConnected()) {
//无网络下强制使用缓存，无论缓存是否过期,此时该请求实际上不会被发送出去。
request = request.newBuilder().cacheControl(CacheControl.FORCE_CACHE)
.build();
}
okhttp3.Response response = chain.proceed(request);
if (NetworkUtils.isConnected()) {//有网络情况下，根据请求接口的设置，配置缓存。
//这样在下次请求时，根据缓存决定是否真正发出请求。
String cacheControl = request.cacheControl().toString();
//当然如果你想在有网络的情况下都直接走网络，那么只需要
//将其超时时间这是为0即可:String cacheControl="Cache-Control:public,max-age=0"
int maxAge = 60 * 60; // read from cache for 1 minute
return response.newBuilder()
// .header("Cache-Control", cacheControl)
.header("Cache-Control", "public, max-age=" + maxAge)
.removeHeader("Pragma")
.build();
} else {
//无网络
int maxStale = 60 * 60 * 24 * 28; // tolerate 4-weeks stale
return response.newBuilder()
.header("Cache-Control", "public,only-if-cached,max-stale=" + maxStale)
.removeHeader("Pragma")
.build();
}
}
};
return commonParams;
}
三、Retrofit使用步骤
（1）创建接收服务器返回数据的类
public class User {
private int code;
private String message;
//code...
}
（2）创建用于描述网络请求的接口
public interface Request_Interface {
String HOST = "http://192.168.45.30:2005/";
@POST()
Call<User> postBody(@Url String url, @Body RequestBody body);
}
（3）创建Retrofit实例并配置网络请求参数
public class RetrofitManager {
private static volatile Request_Interface request_interface = null;
//创建网络请求接口实例
public static Request_Interface getRequestInterface() {
if (request_interface == null) {
synchronized (Request_Interface.class) {
request_interface = provideRetrofit().create(Request_Interface.class);
}
}
return request_interface;
}
//初始化必要对象和参数
public static Retrofit provideRetrofit() {
OkHttpClient client = new OkHttpClient.Builder()
.cache(new Cache(new File(CPApplication.getContext().getExternalCacheDir(), "test_cache"), 10 * 1024 * 1024))
.addInterceptor(getHttpLoggingInterceptor())//Application拦截器
.addNetworkInterceptor(getRequestHeader())//Network拦截器
.addNetworkInterceptor(commonParamsInterceptor())
.addNetworkInterceptor(getCacheInterceptor())
.build();
Retrofit retrofit = new Retrofit
.Builder()
.client(client)
.baseUrl(Request_Interface.HOST)//设置网络请求的Url地址
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())//支持RxJava平台
.addConverterFactory(GsonConverterFactory.create())//设置数据解析器
.build();
return retrofit;
}
//code...
}
（4）发送网络请求
Request_Interface request_interface = RetrofitManager.getRequestInterface();
Call<User> call = request_interface.postBody();
call.enqueue(new Callback<User>() {
@Override
public void onResponse(Call<User> call, Response<User> response) {
mMovieAdapter.setMovies(response.body().subjects);
mMovieAdapter.notifyDataSetChanged();
}
@Override
public void onFailure(Call<User> call, Throwable t) {
t.printStackTrace();
}
});
