Retrofit

A type-safe HTTP client for Android and Java
適用于Java和Android的安全的HTTP客戶端

Retrofit是一個可用于Android和Java的網(wǎng)絡(luò)庫，使用它可以簡化我們的網(wǎng)絡(luò)操作，提高效率和正確率。它將請求過程和底層代碼封裝起來只暴露我們業(yè)務(wù)中的請求和返回數(shù)據(jù)模型。

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

@這是一個Retrofit將Rest API(服務(wù)端post或get請求)轉(zhuǎn)換為Java接口的例子

每一個由接口返回的Call對象都可以與遠(yuǎn)程web服務(wù)端進(jìn)行同步或者異步的HTTP請求通信。例如：

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

為什么選擇Retrofit

AsyncHttp ,Volley和Retrofit的對比

Retrofit中的注解

Retrofit使用注解來描述HTTP請求

請求方式

每一個請求必須指定http請求相對應(yīng)的url注解和請求方式（內(nèi)置5種請求方式注解：GET、POST、PUT 、DELETE、HEAD)

@GET("users/list")

也可以將參數(shù)跟在后面

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

URL操作

一個請求的URL的參數(shù)可以通過{}包裹快來動態(tài)替換，然后在相應(yīng)的@Path參數(shù)中進(jìn)行賦值。

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

例如這個{id}在groupList請求中的@Path(“id”) int groupId來對應(yīng)賦值。

也可以使用@Query給groupList請求方法動態(tài)添加其他請求參數(shù)

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

如果是比較多的請求參數(shù)，我們可以使用Map來構(gòu)建

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

請求的Body

能夠通過@Body注解來指定一個方法作為HTTP請求主體

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

這個參數(shù)對象會被Retrofit實例中的converter進(jìn)行轉(zhuǎn)化。如果沒有給Retrofit實例添加任何converter的話則只有RequestBody可以作為參數(shù)使用。

form encode 和 multipart

方法也可以通過聲明來發(fā)送form-encoded和multipart類型的數(shù)據(jù)。

可以通過@FormUrlEncoded注解方法來發(fā)送form-encoded的數(shù)據(jù)。每個鍵值對需要用@Filed來注解鍵名，隨后的對象需要提供值。

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

也可以通過@Multipart注解方法來發(fā)送Mutipart請求。每個部分需要使用@Part來注解。

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

多個請求部分需要使用Retrofit的converter或者是自己實現(xiàn) RequestBody來處理自己內(nèi)部的數(shù)據(jù)序列化

頭部操作

可以通過使用@Headers注解來設(shè)置請求靜態(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);

注意的是頭部參數(shù)并不會相互覆蓋，同一個名稱的所有頭參數(shù)都會被包含進(jìn)請求里面。

當(dāng)然你可以通過 @Header 注解來動態(tài)更新請求頭。一個相應(yīng)的參數(shù)必須提供給 @Header 注解。如果這個值是空（null）的話，那么這個頭部參數(shù)就會被忽略。否則的話， 值的 toString 方法將會被調(diào)用，并且使用調(diào)用結(jié)果。

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

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，謝謝大家對腳本之家的支持。如果你想了解更多相關(guān)內(nèi)容請查看下面相關(guān)鏈接

最新評論