Retrofit

A type-safe HTTP client for Android and Java

介紹

Retrofit將你的 HTTP接口轉(zhuǎn)換為Java interface.

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

The Retrofit的實(shí)例生成GitHubService的對(duì)象

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();

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

GitHubService創(chuàng)建的Call可以發(fā)送一個(gè)同步或者異步的Http請(qǐng)求到遠(yuǎn)程服務(wù)器

Call<List<Repo>> repos = service.listRepos("octocat");

使用注解的方式去描述一個(gè)HTTP請(qǐng)求:

URL參數(shù)替換和查詢(xún)參數(shù)的支持
對(duì)象轉(zhuǎn)換為請(qǐng)求主體(e.g., JSON, protocol buffers)
多部分請(qǐng)求主體和文件上傳

API Declaration

注解的接口方法及其參數(shù)指示如何處理一個(gè)請(qǐng)求。

請(qǐng)求方法

每個(gè)方法必須有HTTP的注解，然后注解提供請(qǐng)求方法和相關(guān)的URL。一共五個(gè)內(nèi)置注釋:GET, POST, PUT, DELETE, 和HEAD，相關(guān)的URL可以指定在注釋中。

@GET("users/list")

或者把查詢(xún)的參數(shù)寫(xiě)在URL中

@GET("users/list?sort=desc")

URL操作

請(qǐng)求URL使用替換塊和參數(shù)可以動(dòng)態(tài)更新方法，替換塊請(qǐng)使用{}包裹著,相應(yīng)的參數(shù)必須與@ path注釋使用相同的字符串。

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

查詢(xún)參數(shù)也可以被添加。

 @GET("group/{id}/users")
 Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);

對(duì)于復(fù)雜的查詢(xún)參數(shù)組合可以使用Map。

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

請(qǐng)求BODY(REQUEST BODY)

可以指定一個(gè)對(duì)象作為HTTP請(qǐng)求體，使用@Body注釋。

@POST("users/new")
Call<User> createUser(@Body User user);

指定的對(duì)象也將使用一個(gè)轉(zhuǎn)換器轉(zhuǎn)換的Retrofit實(shí)例。如果沒(méi)有添加轉(zhuǎn)換器,只有RequestBody能被使用。

表單編碼和多部分(FORM ENCODED AND MULTIPART)

方法也可以聲明發(fā)送表單編碼和多部分?jǐn)?shù)據(jù)。
表單數(shù)據(jù)發(fā)送，需要在方法中寫(xiě)上@FormUrlEncoded。每個(gè)鍵-值對(duì)，鍵是注釋@Field包含名稱(chēng)，值是對(duì)象調(diào)用時(shí)加入

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

多部分請(qǐng)求時(shí)使用@Multipart存在的方法。部分使用@Part注釋聲明。

@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);

請(qǐng)求頭操作(HEADER MANIPULATION)

你可以設(shè)置使用@Headers注釋靜態(tài)頭的方法。

@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);