一、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();
}
});