Retrofit網路框架介紹

RmondJone發表於2018-04-16
框架

一、Retrofit是什麼？

官網介紹：A type-safe HTTP client for Android and Java。Retrofit是一個型別安全的Android和Java網路Http請求框架。

二、Retrofit的使用方式

1、介面定義

public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}
複製程式碼

2、建立Retrofit例項

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();
複製程式碼

3、呼叫介面

GitHubService service = retrofit.create(GitHubService.class);

Call<List<Repo>> repos = service.listRepos("octocat");
複製程式碼

三、API文件

1、每個方法都必須有一個HTTP註釋，提供請求方法和相對URL路徑。內建的請求註解有5種方式：@GET、@POST、@PUT、@DELETE、@HADE

@GET("users/list")
複製程式碼

你也可以把請求引數放置在註解裡

@GET("users/list?sort=desc")
複製程式碼

2、URL的相關操作 你可以使用@Path註解替換URL相對路徑

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId);
複製程式碼

如果你需要新增請求引數，你可以使用@Query

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);
//如果傳參是這樣 groupList(2,"8080");
//等價於group/2/users?sort=8080
複製程式碼

如果你需要一次性傳遞多個引數，你可以使用@QueryMap註解

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);
複製程式碼

3、如果是POST請求，可以指定Http請求的請求體，使用@Body註解

@POST("users/new")
Call<User> createUser(@Body User user);
複製程式碼

4、表單 @FormUrlEncoded 表示請求體是一個表單資料，表示傳送form-encoded的資料。每個鍵值對需要使用@Filed來標註

@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);
複製程式碼

5、檔案上傳 @Multipart表示檔案上傳，表示傳送form-encoded的資料。每個鍵值對需要使用@Part來標註

@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
複製程式碼

使用案例

public interface GetRequest_Interface {
		/**
		 *表明是一個表單格式的請求（Content-Type:application/x-www-form-urlencoded）
		 * <code>Field("username")</code> 表示將後面的 <code>String name</code> 中name的取值作為 username 的值
		 */
		@POST("/form")
		@FormUrlEncoded
		Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);

		/**
		 * {@link Part} 後面支援三種型別，{@link RequestBody}、{@link okhttp3.MultipartBody.Part} 、任意型別
		 * 除 {@link okhttp3.MultipartBody.Part} 以外，其它型別都必須帶上表單欄位({@link okhttp3.MultipartBody.Part} 中已經包含了表單欄位的資訊)，
		 */
		@POST("/form")
		@Multipart
		Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

}

GetRequest_Interface service = retrofit.create(GetRequest_Interface.class);

// @FormUrlEncoded 
Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);

//  @Multipart
RequestBody name = RequestBody.create(textType, "Carson");
RequestBody age = RequestBody.create(textType, "24");
MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);

Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);
複製程式碼

6、你可以使用@Headers構造請求頭

@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);
複製程式碼

7、你可以使用@Header構造不固定的請求頭

@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)

//這種方式等同於
@Headers("Authorization:authorization")
@GET("user")
Call<User> getUser()

// 區別在於使用場景和使用方式
// 1. 使用場景：@Header用於新增不固定的請求頭，@Headers用於新增固定的請求頭
// 2. 使用方式：@Header作用於方法的引數；@Headers作用於方法
複製程式碼

四、Retrofit的配置

1、資料解析器

Retrofit預設返回的是ResponseBody資料，如果不做特殊處理則需要自己處理轉換。如果返回資料為JSON格式，通過新增Gson解析器可直接把JSON格式資料轉換為實體類。

資料解析器 Gradle依賴
Gson com.squareup.retrofit2:converter-gson:2.0.2
Jackson com.squareup.retrofit2:converter-jackson:2.0.2
Simple XML com.squareup.retrofit2:converter-simplexml:2.0.2
Protobuf com.squareup.retrofit2:converter-protobuf:2.0.2
Moshi com.squareup.retrofit2:converter-moshi:2.0.2
Wire com.squareup.retrofit2:converter-wire:2.0.2
Scalars com.squareup.retrofit2:converter-scalars:2.0.2

使用方式

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 設定網路請求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) // 設定資料解析器
                .build();
複製程式碼

2、網路請求設配器

使用時如使用的是 Android 預設的 CallAdapter，則不需要新增網路請求介面卡的依賴，否則則需要按照需求進行新增 Retrofit 提供的 CallAdapter

網路請求設配器 Gradle依賴
guava com.squareup.retrofit2:adapter-guava:2.0.2
Java8 com.squareup.retrofit2:adapter-java8:2.0.2
rxjava com.squareup.retrofit2:adapter-rxjava:2.0.2

使用方式

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 設定網路請求的Url地址
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支援RxJava平臺
                .build();
複製程式碼

Retrofit擴充

Retrofit原理解析：blog.csdn.net/guiman/arti…

Github: github.com/square/retr…

相關文章