本文主要介紹Retrofit的使用
一唧龄、定義
一個類型安全的 HTTP客戶端請求框架兼砖，適用于Android和Java
Retrofit是一個Restful的HTTP網(wǎng)絡(luò)請求框架的封裝。網(wǎng)絡(luò)請求實(shí)際上由OKHttp完成的既棺，而Retrofit僅負(fù)責(zé)網(wǎng)絡(luò)請求接口的封裝
二讽挟、依賴添加
Gradle方式：
implementation 'com.squareup.retrofit2:retrofit:(insert latest version)'
當(dāng)前最新版本 2.9.0
三、混淆配置
如果使用R8編譯器（Gradle插件3.4.0及以上版本默認(rèn)）則不需要配置丸冕，壓縮和混淆規(guī)則已經(jīng)打包Jar中耽梅，R8能夠自動解釋運(yùn)行。
使用ProGuard胖烛，則需要手動配置如下規(guī)則：
四褐墅、框架使用
4.1、使用示例
- 步驟1：將HTTP API轉(zhuǎn)換成Java接口
public interface WanAndroidService {
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@Path("index") int index);
}
- 步驟2：使用Retrofit生成Java接口（對應(yīng)步驟1的
WanAndroidService）的實(shí)現(xiàn)
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://wanandroid.com/")
.addConverterFactory(GsonConverterFactory.create())
.build();
WanAndroidService wanAndroidService = retrofit.create(WanAndroidService.class);
- 步驟3：使用Java接口（
WanAndroidService）創(chuàng)建Call對象洪己，Call對象可以向Web服務(wù)器發(fā)起同步或者異步HTTP請求
Call<JsonObject> articles = wanAndroidService.getArticles(0);
JsonObject body = articles.execute().body();
System.out.println("響應(yīng)數(shù)據(jù)："+body);打印結(jié)果：
4.2妥凳、API說明
Retrofit通過在接口方法和參數(shù)添加注解的方式來處理請求邏輯，
4.2.1答捕、請求方法
每個接口方法都必須有一個指定請求方法和相對URL的注解逝钥。Retrofit一共有8個內(nèi)置請求方法注解：HTTP, GET, POST, PUT, PATCH, DELETE, OPTIONS and HEAD。請求的相對URL通過注解屬性指定
- 示例：
@GET("users/list")
4.2.2拱镐、URL配置
請求URL可以通過方法中替換塊和參數(shù)動態(tài)的修改艘款。一個可替換塊是由{和}符號包圍的字母數(shù)字字符串。相應(yīng)的參數(shù)必須使用@Path注解沃琅，并且注解屬性值保持和代碼塊字符串一致
- 示例1:
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@Path("index") int index);
- 示例2:(使用
@Query注解添加請求參數(shù))
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@Path("index") int index, @Query("cid") int cid);
- 示例3:(復(fù)雜的參數(shù)組合可以使用map集合的方式)
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@Path("index") int index, @QueryMap Map<String,String> params);
4.2.3哗咆、請求體
使用@Body注解可以指定一個對象作為請求體
該對象將使用再Retrofit實(shí)例創(chuàng)建時(shí)指定的轉(zhuǎn)換器進(jìn)行轉(zhuǎn)換，如果不添加轉(zhuǎn)換器益眉，則默認(rèn)只能使用RequestBody
- 示例：
@POST("user/login")
Call<JsonObject> login(@Body User user);
4.2.4晌柬、FORM ENCODED和MULTIPART
方法也能被聲明來發(fā)送from-encoded和multipart數(shù)據(jù)
方法使用@FromUrlEncoded注解修飾時(shí)，將發(fā)送from-encoded數(shù)據(jù)郭脂。每個健值對使用包含名稱和提供值的參數(shù)對象的@Field注解進(jìn)行注解
- 示例：
@FormUrlEncoded
@POST("user/login")
Call<JsonObject> login(@Field("username") String username, @Field("password") String password);
方法使用@Multipart注解修飾時(shí)年碘，將發(fā)送Multipart請求。請求Parts使用@Part注解注解
Multipart parts將使用Rotrofit提供的轉(zhuǎn)換器之一或者自定義實(shí)現(xiàn)RequestBody來處理參數(shù)的序列化
- 示例：
@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
4.2.5展鸡、請求頭配置
使用@Headers可以設(shè)置靜態(tài)請求頭
- 示例：
@Headers("Accept-Encoding: gzip, deflate")
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@Path("index") int index, @Query("cid") int cid);
@Headers({
"Accept: application/json,application/xml,application/xhtml+xml,text/html;q=0.9,image/webp,*/*;q=0.8",
"Accept-Encoding: gzip, deflate"
})
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@Path("index") int index, @Query("cid") int cid);
- ??：請求頭不會相互覆蓋屿衅。具有相同名稱的請求頭都會包含在請求中
使用@Header注解可以動態(tài)的修改請求頭。必須為@Header提供相應(yīng)的參數(shù)莹弊，如果參數(shù)值為null涤久，則這個Header頭會被忽略涡尘，否則將使用參數(shù)值的toString結(jié)果做為請求頭的值
- 示例：
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@Header("test") String test, @Path("index") int index);
和請求參數(shù)相似，對應(yīng)復(fù)雜的請求頭响迂，可以使用Map集合
- 示例：
@GET("article/list/{index}/json")
Call<JsonObject> getArticles(@HeaderMap Map<String, String> test, @Path("index") int index);
需要在每個請求上添加請求頭參數(shù)悟衩，可以使用OkHttp interceptor實(shí)現(xiàn)
4.2.6、同步 VS 異步
call實(shí)例可以同步或者異步執(zhí)行栓拜。每個實(shí)例只能執(zhí)行一次座泳，但是使用clone()方法可以重新創(chuàng)建一個可使用的實(shí)例
在Android設(shè)備上，異步回調(diào)方法將會在主線程中執(zhí)行幕与。在JVM上挑势，異步回調(diào)方法將在會請求執(zhí)行的線程中執(zhí)行
五、Retorfit配置
Retrofit是將API接口轉(zhuǎn)換為可調(diào)用對象的類啦鸣。默認(rèn)情況下潮饱，Retrofit將會為平臺提供合理的默認(rèn)值，同時(shí)也允許自定義
5.1诫给、轉(zhuǎn)換器
默認(rèn)情況下香拉，Retrofit僅能將Http響應(yīng)反序列化為OkHttp的ResponseBody類型，并且對于@Body僅能接受RequestBody類型
添加轉(zhuǎn)換器可以實(shí)現(xiàn)對其他類型的支持中狂。Retrofit提供相似的模塊凫碌，封裝最受歡迎的幾個序列化庫，方便用戶使用
- 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
- JAXB: com.squareup.retrofit2:converter-jaxb
- Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars
如下是GsonConverterFactory類的使用實(shí)例胃榕，生成WanAndroidService接口的實(shí)現(xiàn)盛险，使用Gson庫反序列化響應(yīng)數(shù)據(jù)
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://wanandroid.com/")
.addConverterFactory(GsonConverterFactory.create())
.build();
WanAndroidService wanAndroidService = retrofit.create(WanAndroidService.class);
5.2、自定義轉(zhuǎn)換器
我們可以輕松自定義轉(zhuǎn)換器勋又，如果我們需要使用Retrofit沒有提供支持的格式（例如：YAML苦掘，txt,自定義格式）的API進(jìn)行通信，或者需要使用不同的庫來支持現(xiàn)有的格式楔壤。
自定義方式：創(chuàng)建Converer.Factory的子類鹤啡，并在構(gòu)建適配器時(shí)傳入該子類的實(shí)例
