Retrofit 入門

Retrofit用法詳解

參考：

Retrofit 官方API

Retrofit用法詳解（入門看這篇就夠了）

一、簡介

官方介紹：A type-safe HTTP client for Android and Java

Retrofit是Square公司開發(fā)的一款針對Android網(wǎng)絡(luò)請求的框架，Retrofit2底層基于OkHttp實現(xiàn)的，OkHttp現(xiàn)在已經(jīng)得到Google官方認(rèn)可，大量的app都采用OkHttp做網(wǎng)絡(luò)請求。

二、用法

簡單示例

1.創(chuàng)建業(yè)務(wù)請求接口，具體代碼如下：

public interface BlueService {
@GET("book/search")
Call<BookSearchResponse> getSearchBooks(@Query("q") String name, 
        @Query("tag") String tag, @Query("start") int start, 
        @Query("count") int count);
}

這里需要稍作說明，@GET注解就表示get請求，@Query表示請求參數(shù)，將會以key=value的方式拼接在url后面

2.需要創(chuàng)建一個Retrofit的示例，并完成相應(yīng)的配置

 Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.douban.com/v2/")
.addConverterFactory(GsonConverterFactory.create())
.build();
 BlueService service = retrofit.create(BlueService.class);

這里的baseUrl就是網(wǎng)絡(luò)請求URL相對固定的地址，一般包括請求協(xié)議（如Http）、域名或IP地址、端口號等，當(dāng)然還會有很多其他的配置，下文會詳細(xì)介紹。還有addConverterFactory方法表示需要用什么轉(zhuǎn)換器來解析返回值，GsonConverterFactory.create()表示調(diào)用Gson庫來解析json返回值，具體的下文還會做詳細(xì)介紹。

3.調(diào)用請求方法，并得到Call實例

Call<BookSearchResponse> call = mBlueService.getSearchBooks("小王子", "", 0, 3);

4.使用Call實例完成同步或異步請求

同步請求：
BookSearchResponse response = call.execute().body();
異步請求
call.enqueue(new Callback<BookSearchResponse>() {
@Override
public void onResponse(Call<BookSearchResponse> call,Response<BookSearchResponse> response) {
}
 @Override
 public void onFailure(Call<BookSearchResponse> call, Throwable t) {

}
});

使用:

首先需要在build.gradle文件中引入需要的第三包，配置如下：

compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'

常用注解

前面我們說道，retrofit通過使用注解來簡化請求，這里我們先來認(rèn)識一下常用的注解。retrofit中的注解大體分為以下基類：用于標(biāo)注請求方式的注解，用于標(biāo)記請求頭的注解以及用于標(biāo)記請求參數(shù)的注解。其實，任何一種Http庫都提供了相關(guān)的支持，無非在retrofit中是用注解來簡化

1.請求方法注解,該類型的注解用于標(biāo)注不同的http請求方式，主要有以下幾種：
2.請求頭注解,該類型的注解用于為請求添加請求頭。
3.請求和響應(yīng)格式注解,該類型的注解用于標(biāo)注請求和響應(yīng)的格式。
4.請求參數(shù)類注解,該類型的注解用來標(biāo)注請求參數(shù)的格式，有些需要結(jié)合上面請求和響應(yīng)格式的注解一起使用。
5.請求參數(shù)詳細(xì)說明

Get方法

  1. @Query

Get方法請求參數(shù)都會以key=value的方式拼接在url后面，Retrofit提供了兩種方式設(shè)置請求參數(shù)。第一種就是像上文提到的直接在interface中添加@Query注解，還有一種方式是通過Interceptor實現(xiàn)，直接看如何通過Interceptor實現(xiàn)請求參數(shù)的添加。

public class CustomInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
    Request request = chain.request();
    HttpUrl httpUrl = request.url().newBuilder()
            .addQueryParameter("token", "tokenValue")
            .build();
    request = request.newBuilder().url(httpUrl).build();
    return chain.proceed(request);
}
}

addQueryParameter就是添加請求參數(shù)的具體代碼，這種方式比較適用于所有的請求都需要添加的參數(shù)，一般現(xiàn)在的網(wǎng)絡(luò)請求都會添加token作為用戶標(biāo)識，那么這種方式就比較適合。
創(chuàng)建完成自定義的Interceptor后，還需要在Retrofit創(chuàng)建client處完成添加

ddInterceptor(new CustomInterceptor())

2.@QueryMap

如果Query參數(shù)比較多，那么可以通過@QueryMap方式將所有的參數(shù)集成在一個Map統(tǒng)一傳遞，還以上文中的get請求方法為例

public interface BlueService {
@GET("book/search")
Call<BookSearchResponse> getSearchBooks(@QueryMap Map<String, String> options);
}

調(diào)用的時候?qū)⑺械膮?shù)集合在統(tǒng)一的map中即可

//https://api.douban.com/v2/book/search?q=%E5%B0%8F%E7%8E%8B%E5%AD%90&tag=&start=0&count=3
Map<String, String> options = new HashMap<>();
map.put("q", "小王子");
map.put("tag", null);
map.put("start", "0");
map.put("count", "3");
Call<BookSearchResponse> call = mBlueService.getSearchBooks(options);

3.Query非必填

如果請求參數(shù)為非必填，也就是說即使不傳該參數(shù)，服務(wù)端也可以正常解析，那么如何實現(xiàn)呢？其實也很簡單，請求方法定義處還是需要完整的Query注解，某次請求如果不需要傳該參數(shù)的話，只需填充null即可。
針對文章開頭提到的get的請求，加入按以下方式調(diào)用

Call<BookSearchResponse> call = mBlueService.getSearchBooks("小王子", null, 0, 3);
//https://api.douban.com/v2/book/search?q=%E5%B0%8F%E7%8E%8B%E5%AD%90&start=0&count=3

4.@Path

如果請求的相對地址也是需要調(diào)用方傳遞，那么可以使用@Path注解，示例代碼如下：

 @GET("book/{id}")
 Call<BookResponse> getBook(@Path("id") String id);

業(yè)務(wù)方想要在地址后面拼接書籍id，那么通過Path注解可以在具體的調(diào)用場景中動態(tài)傳遞，具體的調(diào)用方式如下：

Call<BookResponse> call = mBlueService.getBook("1003078");

Post請求

1.@field

Post請求需要把請求參數(shù)放置在請求體中，而非拼接在url后面，先來看一個簡單的例子

@FormUrlEncoded
@POST("book/reviews")
Call<String> addReviews(@Field("book") String bookId, @Field("title") String title,
@Field("content") String content, @Field("rating") String rating);

FormUrlEncoded不能用于Get請求

@Field注解將每一個請求參數(shù)都存放至請求體中，還可以添加encoded參數(shù)，該參數(shù)為boolean型，具體的用法為

@Field(value = "book", encoded = true) String book，encoded參數(shù)為true的話，key-value-pair將會被編碼，即將中文和特殊字符進行編碼轉(zhuǎn)換

2.@FieldMap

上述Post請求有4個請求參數(shù)，假如說有更多的請求參數(shù)，那么通過一個一個的參數(shù)傳遞就顯得很麻煩而且容易出錯，這個時候就可以用FieldMap

@FormUrlEncoded
@POST("book/reviews")
Call<String> addReviews(@FieldMap Map<String, String> fields);

3.@Body

如果Post請求參數(shù)有多個，那么統(tǒng)一封裝到類中應(yīng)該會更好，這樣維護起來會非常方便

@FormUrlEncoded
@POST("book/reviews")
Call<String> addReviews(@Body Reviews reviews);
public class Reviews {
public String book;
public String title;
public String content;
public String rating;
}

4.除了Get和Post請求，Http請求還包括Put,Delete等等，用法和Post相似，所以就不再單獨介紹了。

6.添加自定義的header

Retrofit提供了兩個方式定義Http請求頭參數(shù)：靜態(tài)方法和動態(tài)方法，靜態(tài)方法不能隨不同的請求進行變化，頭部信息在初始化的時候就固定了。而動態(tài)方法則必須為每個請求都要單獨設(shè)置。

靜態(tài)方法

public interface BlueService {
@Headers("Cache-Control: max-age=640000")
@GET("book/search")
Call<BookSearchResponse> getSearchBooks(@Query("q") String name, 
        @Query("tag") String tag, @Query("start") int start, 
        @Query("count") int count);
}

此外也可以通過Interceptor來定義靜態(tài)請求頭

public class RequestInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
    Request original = chain.request();
    Request request = original.newBuilder()
        .header("User-Agent", "Your-App-Name")
        .header("Accept", "application/vnd.yourapi.v1.full+json")
        .method(original.method(), original.body())
        .build();
    return chain.proceed(request);
}
}

添加header參數(shù)Request提供了兩個方法，一個是header(key, value)，另一個是.addHeader(key, value)，兩者的區(qū)別是，header()如果有重名的將會覆蓋，而addHeader()允許相同key值的header存在

然后在OkHttp創(chuàng)建Client實例時，添加RequestInterceptor即可

private static OkHttpClient getNewClient(){
 return new OkHttpClient.Builder()
.addInterceptor(new RequestInterceptor())
.connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
.build();
}

動態(tài)方法

public interface BlueService {
@GET("book/search")
Call<BookSearchResponse> getSearchBooks(
@Header("Content-Range") String contentRange, 
@Query("q") String name, @Query("tag") String tag, 
@Query("start") int start, @Query("count") int count);
}

文件上傳與下載

其他

為某個請求設(shè)置完整的URL，假如說你的某一個請求不是以base_url開頭該怎么辦呢？別著急，辦法很簡單，看下面這個例子你就懂了

public interface BlueService {  
@GET
public Call<ResponseBody> profilePicture(@Url String url);
 }

 Retrofit retrofit = Retrofit.Builder()  
.baseUrl("https://your.api.url/");
.build();

BlueService service = retrofit.create(BlueService.class);  
service.profilePicture("https://s3.amazon.com/profile-picture/path");
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容