Android：Retrofit 2.0 使用攻略（含例項講解）

Carson_Ho發表於2018-04-09

Android

前言

在Andrroid開發中，網路請求十分常用
而在Android網路請求庫中，Retrofit是當下最熱的一個網路請求庫

今天，我將獻上一份非常詳細Retrofit v2.0的使用教程，希望你們會喜歡。

如果對Retrofit v2.0的原始碼感興趣，可看文章：Android：手把手帶你深入剖析 Retrofit 2.0 原始碼

1. 簡介

特別注意：

準確來說，Retrofit 是一個 RESTful 的 HTTP 網路請求框架的封裝。
原因：網路請求的工作本質上是 OkHttp 完成，而 Retrofit 僅負責網路請求介面的封裝

App應用程式通過 Retrofit 請求網路，實際上是使用 Retrofit 介面層封裝請求引數、Header、Url 等資訊，之後由 OkHttp 完成後續的請求操作
在服務端返回資料之後，OkHttp 將原始的結果交給 Retrofit，Retrofit根據使用者的需求對結果進行解析

2. 與其他開源請求庫對比

除了Retrofit，如今Android中主流的網路請求框架有：

Android-Async-Http
Volley
OkHttp

下面是簡單介紹：

一圖讓你瞭解全部的網路請求庫和他們之間的區別！

附：各個主流網路請求庫的Github地址

3. 使用介紹

使用 Retrofit 的步驟共有7個：

步驟1： 新增Retrofit庫的依賴

步驟2： 建立接收伺服器返回資料的類

步驟3： 建立用於描述網路請求的介面

步驟4： 建立 Retrofit 例項

步驟5： 建立網路請求介面例項並配置網路請求引數

步驟6： 傳送網路請求（非同步 / 同步）

封裝了資料轉換、執行緒切換的操作

步驟7： 處理伺服器返回的資料

接下來，我們一步步進行講解。

步驟1：新增Retrofit庫的依賴

1. 在 Gradle加入Retrofit庫的依賴

build.gradle

dependencies {
    compile 'com.squareup.retrofit2:retrofit:2.0.2'
    // Retrofit庫
  }
複製程式碼

2. 新增網路許可權 AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET"/>
複製程式碼

步驟2：建立接收伺服器返回資料的類

Reception.java

public class Reception {
    ...
    // 根據返回資料的格式和資料解析方式（Json、XML等）定義
    // 下面會在例項進行說明
        }
複製程式碼

步驟3：建立用於描述網路請求的介面

Retrofit將 Http請求抽象成 Java介面：採用註解描述網路請求引數和配置網路請求引數

用動態代理動態將該介面的註解“翻譯”成一個 Http 請求，最後再執行 Http 請求

注：介面中的每個方法的引數都需要使用註解標註，否則會報錯

GetRequest_Interface.interface

public interface GetRequest_Interface {

    @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
    Call<Translation>  getCall();
    // @GET註解的作用:採用Get方法傳送網路請求
 
    // getCall() = 接收網路請求資料的方法
    // 其中返回型別為Call<*>，*是接收資料的類（即上面定義的Translation類）
    // 如果想直接獲得Responsebody中的內容，可以定義網路請求返回值為Call<ResponseBody>
}
複製程式碼

下面詳細介紹Retrofit 網路請求介面的註解型別。

註解型別

註解說明

第一類：網路請求方法

詳細說明： a. @GET、@POST、@PUT、@DELETE、@HEAD 以上方法分別對應 HTTP中的網路請求方式

public interface GetRequest_Interface {

    @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
    Call<Translation>  getCall();
    // @GET註解的作用:採用Get方法傳送網路請求
    // getCall() = 接收網路請求資料的方法
    // 其中返回型別為Call<*>，*是接收資料的類（即上面定義的Translation類）
}
複製程式碼

此處特意說明URL的組成：Retrofit把網路請求的URL 分成了兩部分設定：

// 第1部分：在網路請求介面的註解設定
 @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
Call<Translation>  getCall();

// 第2部分：在建立Retrofit例項時通過.baseUrl()設定
Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") //設定網路請求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) //設定資料解析器
                .build();

// 從上面看出：一個請求的URL可以通過 替換塊 和 請求方法的引數 來進行動態的URL更新。
// 替換塊是由 被{}包裹起來的字串構成
// 即：Retrofit支援動態改變網路請求根目錄
複製程式碼

網路請求的完整 Url =在建立Retrofit例項時通過.baseUrl()設定 +網路請求介面的註解設定（下面稱 “path“ ）
具體整合的規則如下：

建議採用第三種方式來配置，並儘量使用同一種路徑形式。

b. @HTTP

作用：替換**@GET、@POST、@PUT、@DELETE、@HEAD**註解的作用及更多功能擴充
具體使用：通過屬性method、path、hasBody進行設定

public interface GetRequest_Interface {
    /**
     * method：網路請求的方法（區分大小寫）
     * path：網路請求地址路徑
     * hasBody：是否有請求體
     */
    @HTTP(method = "GET", path = "blog/{id}", hasBody = false)
    Call<ResponseBody> getCall(@Path("id") int id);
    // {id} 表示是一個變數
    // method 的值 retrofit 不會做處理，所以要自行保證準確
}
複製程式碼

第二類：標記

a. @FormUrlEncoded

作用：表示傳送form-encoded的資料

每個鍵值對需要用@Filed來註解鍵名，隨後的物件需要提供值。

b. @Multipart

作用：表示傳送form-encoded的資料（適用於有檔案上傳的場景）

每個鍵值對需要用@Part來註解鍵名，隨後的物件需要提供值。

具體使用如下： GetRequest_Interface

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

第三類：網路請求引數

詳細說明

a. @Header & @Headers

作用：新增請求頭 &新增不固定的請求頭
具體使用如下：

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

// @Headers
@Headers("Authorization: authorization")
@GET("user")
Call<User> getUser()

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

b. @Body

作用：以 Post方式傳遞自定義資料型別給伺服器
特別注意：如果提交的是一個Map，那麼作用相當於 @Field

不過Map要經過 FormBody.Builder 類處理成為符合 Okhttp 格式的表單，如：

FormBody.Builder builder = new FormBody.Builder();
builder.add("key","value");

複製程式碼

c. @Field & @FieldMap

作用：傳送 Post請求時提交請求的表單欄位
具體使用：與 @FormUrlEncoded 註解配合使用

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

/**
         * Map的key作為表單的鍵
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded2(@FieldMap Map<String, Object> map);

}

// 具體使用
         // @Field
        Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);

        // @FieldMap
        // 實現的效果與上面相同，但要傳入Map
        Map<String, Object> map = new HashMap<>();
        map.put("username", "Carson");
        map.put("age", 24);
        Call<ResponseBody> call2 = service.testFormUrlEncoded2(map);
複製程式碼

d. @Part & @PartMap

作用：傳送 Post請求時提交請求的表單欄位

與@Field的區別：功能相同，但攜帶的引數型別更加豐富，包括資料流，所以適用於有檔案上傳的場景

具體使用：與 @Multipart 註解配合使用

public interface GetRequest_Interface {

          /**
         * {@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);

        /**
         * PartMap 註解支援一個Map作為引數，支援 {@link RequestBody } 型別，
         * 如果有其它的型別，會被{@link retrofit2.Converter}轉換，如後面會介紹的 使用{@link com.google.gson.Gson} 的 {@link retrofit2.converter.gson.GsonRequestBodyConverter}
         * 所以{@link MultipartBody.Part} 就不適用了,所以檔案只能用<b> @Part MultipartBody.Part </b>
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload2(@PartMap Map<String, RequestBody> args, @Part MultipartBody.Part file);

        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload3(@PartMap Map<String, RequestBody> args);
}

// 具體使用
 MediaType textType = MediaType.parse("text/plain");
        RequestBody name = RequestBody.create(textType, "Carson");
        RequestBody age = RequestBody.create(textType, "24");
        RequestBody file = RequestBody.create(MediaType.parse("application/octet-stream"), "這裡是模擬檔案的內容");

        // @Part
        MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
        Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);
        ResponseBodyPrinter.printResponseBody(call3);

        // @PartMap
        // 實現和上面同樣的效果
        Map<String, RequestBody> fileUpload2Args = new HashMap<>();
        fileUpload2Args.put("name", name);
        fileUpload2Args.put("age", age);
        //這裡並不會被當成檔案，因為沒有檔名(包含在Content-Disposition請求頭中)，但上面的 filePart 有
        //fileUpload2Args.put("file", file);
        Call<ResponseBody> call4 = service.testFileUpload2(fileUpload2Args, filePart); //單獨處理檔案
        ResponseBodyPrinter.printResponseBody(call4);
}

複製程式碼

e. @Query和@QueryMap

作用：用於 @GET 方法的查詢引數（Query = Url 中 ‘?’ 後面的 key-value）

如：url = http://www.println.net/?cate=android，其中，Query = cate

具體使用：配置時只需要在介面方法中增加一個引數即可：

   @GET("/")    
   Call<String> cate(@Query("cate") String cate);
}

// 其使用方式同 @Field與@FieldMap，這裡不作過多描述

複製程式碼

f. @Path

作用：URL地址的預設值
具體使用：

public interface GetRequest_Interface {

        @GET("users/{user}/repos")
        Call<ResponseBody>  getBlog（@Path("user") String user ）;
        // 訪問的API是：https://api.github.com/users/{user}/repos
        // 在發起請求時， {user} 會被替換為方法的第一個引數 user（被@Path註解作用）
    }
複製程式碼

g. @Url

作用：直接傳入一個請求的 URL變數用於URL設定
具體使用：

public interface GetRequest_Interface {

        @GET
        Call<ResponseBody> testUrlAndQuery(@Url String url, @Query("showAll") boolean showAll);
       // 當有URL註解時，@GET傳入的URL就可以省略
       // 當GET、POST...HTTP等方法中沒有設定Url時，則必須使用 {@link Url}提供

}
複製程式碼

彙總

步驟4：建立 Retrofit 例項

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

a. 關於資料解析器（Converter）

Retrofit支援多種資料解析方式
使用時需要在Gradle新增依賴

資料解析器	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

b. 關於網路請求介面卡（CallAdapter）

Retrofit支援多種網路請求介面卡方式：guava、Java8和rxjava

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

使用時需要在Gradle新增依賴：

網路請求介面卡	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

步驟5：建立網路請求介面例項

        // 建立 網路請求介面 的例項
        GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);

        //對 傳送請求 進行封裝
        Call<Reception> call = request.getCall();
複製程式碼

步驟6：傳送網路請求（非同步 / 同步）

封裝了資料轉換、執行緒切換的操作

//傳送網路請求(非同步)
        call.enqueue(new Callback<Translation>() {
            //請求成功時回撥
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                //請求處理,輸出結果
                response.body().show();
            }

            //請求失敗時候的回撥
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                System.out.println("連線失敗");
            }
        });

// 傳送網路請求（同步）
Response<Reception> response = call.execute();

複製程式碼

步驟7：處理返回資料

通過response類的 body（）對返回的資料進行處理

//傳送網路請求(非同步)
        call.enqueue(new Callback<Translation>() {
            //請求成功時回撥
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                // 對返回資料進行處理
                response.body().show();
            }

            //請求失敗時候的回撥
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                System.out.println("連線失敗");
            }
        });

// 傳送網路請求（同步）
  Response<Reception> response = call.execute();
  // 對返回資料進行處理
  response.body().show();

複製程式碼

4. 例項講解

接下來，我將用兩個例項分別對 Retrofit GET方式和 POST方式進行網路請求講解。

4.1 例項1

實現功能：將中文翻譯成英文
實現方案：採用Get方法對金山詞霸API 傳送網路請求

採用 Gson 進行資料解析

步驟說明

步驟1： 新增Retrofit庫的依賴

步驟2： 建立接收伺服器返回資料的類

步驟3： 建立用於描述網路請求的介面

步驟4： 建立 Retrofit 例項

步驟5： 建立網路請求介面例項並配置網路請求引數

步驟6： 傳送網路請求（採用最常用的非同步方式）

封裝了資料轉換、執行緒切換的操作

步驟7： 處理伺服器返回的資料

接下來，我們一步步進行講解。

具體使用

步驟1：新增Retrofit庫的依賴

1. 在 Gradle加入Retrofit庫的依賴

build.gradle

dependencies {
    compile 'com.squareup.retrofit2:retrofit:2.0.2'
    // Retrofit庫
  }
複製程式碼

2. 新增網路許可權 AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET"/>
複製程式碼

步驟2：建立接收伺服器返回資料的類

金山詞霸API 的資料格式說明如下：

// URL模板
http://fy.iciba.com/ajax.php

// URL例項
http://fy.iciba.com/ajax.php?a=fy&f=auto&t=auto&w=hello%20world

// 引數說明：
// a：固定值 fy
// f：原文內容型別，日語取 ja，中文取 zh，英語取 en，韓語取 ko，德語取 de，西班牙語取 es，法語取 fr，自動則取 auto
// t：譯文內容型別，日語取 ja，中文取 zh，英語取 en，韓語取 ko，德語取 de，西班牙語取 es，法語取 fr，自動則取 auto
// w：查詢內容
複製程式碼

根據金山詞霸API 的資料格式，建立接收伺服器返回資料的類：

Translation.java

public class Translation {
        private int status;

    private content content;
    private static class content {
        private String from;
        private String to;
        private String vendor;
        private String out;
        private int errNo;
    }

    //定義 輸出返回資料 的方法
    public void show() {
        System.out.println(status);
        
        System.out.println(content.from);
        System.out.println(content.to);
        System.out.println(content.vendor);
        System.out.println(content.out);
        System.out.println(content.errNo);
    }
}
    
複製程式碼

步驟3：建立用於描述網路請求的介面

採用 **註解 ** 描述網路請求引數。 GetRequest_Interface.java

public interface GetRequest_Interface {
    
 @GET("ajax.php?a=fy&f=auto&t=auto&w=hello%20world")
    Call<Translation> getCall();
    // 註解裡傳入 網路請求 的部分URL地址
    // Retrofit把網路請求的URL分成了兩部分：一部分放在Retrofit物件裡，另一部分放在網路請求介面裡
    // 如果介面裡的url是一個完整的網址，那麼放在Retrofit物件裡的URL可以忽略
    // getCall()是接受網路請求資料的方法
}
複製程式碼

接下來的步驟均在GetRequest.java內實現（看註釋）

步驟4：建立Retrofit物件步驟5：建立網路請求介面的例項步驟6：傳送網路請求

以最常用的非同步請求為例

步驟7：處理返回資料

GetRequest.java

public class GetRequest extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        request();
        // 使用Retrofit封裝的方法
    }
    public void request() {

        //步驟4:建立Retrofit物件
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fy.iciba.com/") // 設定 網路請求 Url
                .addConverterFactory(GsonConverterFactory.create()) //設定使用Gson解析(記得加入依賴)
                .build();

        // 步驟5:建立 網路請求介面 的例項
        GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);

        //對 傳送請求 進行封裝
        Call<Translation> call = request.getCall();

        //步驟6:傳送網路請求(非同步)
        call.enqueue(new Callback<Translation>() {
            //請求成功時回撥
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                // 步驟7：處理返回的資料結果
                response.body().show();
            }

            //請求失敗時回撥
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                System.out.println("連線失敗");
            }
        });
    }
}
複製程式碼

由於此處採用了 Gson 解析，所以需要在 Gradle加入依賴 build.gradle

compile 'com.squareup.retrofit2:converter-gson:2.0.2'
複製程式碼

執行結果

Demo地址

Carson_Ho的Github：https://github.com/Carson-Ho/RetrofitDemo

4.2 例項2

實現的功能：將英文翻譯成中文
實現方法：採用Post方法對有道API 傳送網路請求

採用 Gson 進行資料解析

使用步驟

步驟1： 新增Retrofit庫的依賴

步驟2： 建立接收伺服器返回資料的類

步驟3： 建立用於描述網路請求的介面

步驟4： 建立 Retrofit 例項

步驟5： 建立網路請求介面例項並配置網路請求引數

步驟6： 傳送網路請求（採用最常用的非同步方式）

封裝了資料轉換、執行緒切換的操作

步驟7： 處理伺服器返回的資料

接下來，我們一步步進行Retrofit的使用。

具體使用

步驟1：新增Retrofit庫的依賴

1. 在 Gradle加入Retrofit庫的依賴

build.gradle

dependencies {
    compile 'com.squareup.retrofit2:retrofit:2.0.2'
    // Retrofit庫
  }
複製程式碼

2. 新增網路許可權 AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET"/>
複製程式碼

步驟2：建立接收伺服器返回資料的類

API 的資料格式說明如下：

// URL
http://fanyi.youdao.com/translate

// URL例項
http://fanyi.youdao.com/translate?doctype=json&jsonversion=&type=&keyfrom=&model=&mid=&imei=&vendor=&screen=&ssid=&network=&abtest=


// 引數說明
// doctype：json 或 xml
// jsonversion：如果 doctype 值是 xml，則去除該值，若 doctype 值是 json，該值為空即可
// xmlVersion：如果 doctype 值是 json，則去除該值，若 doctype 值是 xml，該值為空即可
// type：語言自動檢測時為 null，為 null 時可為空。英譯中為 EN2ZH_CN，中譯英為 ZH_CN2EN，日譯中為 JA2ZH_CN，中譯日為 ZH_CN2JA，韓譯中為 KR2ZH_CN，中譯韓為 ZH_CN2KR，中譯法為 ZH_CN2FR，法譯中為 FR2ZH_CN
// keyform：mdict. + 版本號 + .手機平臺。可為空
// model：手機型號。可為空
// mid：平臺版本。可為空
// imei：???。可為空
// vendor：應用下載平臺。可為空
// screen：螢幕寬高。可為空
// ssid：使用者名稱。可為空
// abtest：???。可為空

// 請求方式說明
// 請求方式：POST
// 請求體：i
// 請求格式：x-www-form-urlencoded
複製程式碼

根據有道API 的資料格式，建立接收伺服器返回資料的類：

Translation.java

public class Translation1 {

    private String type;
    private int errorCode;
    private int elapsedTime;
    private List<List<TranslateResultBean>> translateResult;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(int errorCode) {
        this.errorCode = errorCode;
    }

    public int getElapsedTime() {
        return elapsedTime;
    }

    public void setElapsedTime(int elapsedTime) {
        this.elapsedTime = elapsedTime;
    }

    public List<List<TranslateResultBean>> getTranslateResult() {
        return translateResult;
    }

    public void setTranslateResult(List<List<TranslateResultBean>> translateResult) {
        this.translateResult = translateResult;
    }

    public static class TranslateResultBean {
        /**
         * src : merry me
         * tgt : 我快樂
         */

        public String src;
        public String tgt;

        public String getSrc() {
            return src;
        }

        public void setSrc(String src) {
            this.src = src;
        }

        public String getTgt() {
            return tgt;
        }

        public void setTgt(String tgt) {
            this.tgt = tgt;
        }
    }

}
複製程式碼

步驟3：建立用於描述網路請求的介面

採用註解描述網路請求引數。

PostRequest_Interface.java

public interface PostRequest_Interface {

    @POST("translate?doctype=json&jsonversion=&type=&keyfrom=&model=&mid=&imei=&vendor=&screen=&ssid=&network=&abtest=")
    @FormUrlEncoded
    Call<Translation1> getCall(@Field("i") String targetSentence);
    //採用@Post表示Post方法進行請求（傳入部分url地址）
    // 採用@FormUrlEncoded註解的原因:API規定採用請求格式x-www-form-urlencoded,即表單形式
    // 需要配合@Field 向伺服器提交需要的欄位
}
複製程式碼

接下來的步驟均在PostRequest.java內實現（看註釋）

步驟4： 建立Retrofit物件

步驟5： 建立網路請求介面的例項

步驟6： 傳送網路請求

以最常用的非同步請求為例

步驟7： 處理返回資料

PostRequest.java

public class PostRequest extends AppCompatActivity {


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        request();
    }
    public void request() {

        //步驟4:建立Retrofit物件
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 設定 網路請求 Url
                .addConverterFactory(GsonConverterFactory.create()) //設定使用Gson解析(記得加入依賴)
                .build();

        // 步驟5:建立 網路請求介面 的例項
        PostRequest_Interface request = retrofit.create(PostRequest_Interface.class);

        //對 傳送請求 進行封裝(設定需要翻譯的內容)
        Call<Translation1> call = request.getCall("I love you");

        //步驟6:傳送網路請求(非同步)
        call.enqueue(new Callback<Translation1>() {

            //請求成功時回撥
            @Override
            public void onResponse(Call<Translation1> call, Response<Translation1> response) {
                // 步驟7：處理返回的資料結果：輸出翻譯的內容
                System.out.println(response.body().getTranslateResult().get(0).get(0).getTgt());
            }

            //請求失敗時回撥
            @Override
            public void onFailure(Call<Translation1> call, Throwable throwable) {
                System.out.println("請求失敗");
                System.out.println(throwable.getMessage());
            }
        });
    }


}
複製程式碼

由於此處採用了 Gson 解析，所以需要在 Gradle 加入依賴 build.gradle

compile 'com.squareup.retrofit2:converter-gson:2.0.2'
複製程式碼

執行結果

Demo地址

Carson_Ho的Github：github.com/Carson-Ho/R…

5. Retrofit 的擴充使用

Retrofit的使用場景非常豐富，如支援RxJava和Prototocobuff
具體設定也非常簡單 & 方便：

<-- 主要在建立Retrofit物件中設定 -->
Retrofit retrofit = new Retrofit.Builder()
  .baseUrl(""http://fanyi.youdao.com/"")
  .addConverterFactory(ProtoConverterFactory.create()) // 支援Prototocobuff解析
  .addConverterFactory(GsonConverterFactory.create()) // 支援Gson解析
  .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支援RxJava
  .build();
複製程式碼

具體關於 RxJava的使用這裡就不展開，請期待下篇關於 Rxjava的文章。

6. 總結

看完本文，相信你已經非常熟悉 Retrofit 2.0 的使用
如果你希望繼續閱讀 Retrofit 2.0 的原始碼，請看我寫的文章:Android：手把手帶你深入剖析 Retrofit 2.0 原始碼
接下來，我將繼續分析與 Retrofit 配合使用的 RxJava，有興趣可以繼續關注Carson_Ho的安卓開發筆記

請點贊！因為你的鼓勵是我寫作的最大動力！

Retrofit2與服務端例項講解
2018-06-02
服務端
Vue.js 2.0中$on與$emit如何使用之例項講解
2018-12-08
Vue.jsMIT
Android RxJava：這是一份全面的操作符使用匯總（含詳細例項講解）
2018-05-31
AndroidRxJava
Android探索之旅 | AIDL原理和例項講解
2018-07-08
AndroidAI
Retrofit 2.0 使用教程
2019-01-03
Android Input子系統-含例項原始碼
2018-11-22
Android原始碼
Android Retrofit 2.5.0使用基礎詳解
2019-03-28
Android
SQL觸發器例項講解
2018-09-10
SQL觸發器
Android Retrofit原始碼解析：都能看懂的Retrofit使用詳解
2021-10-14
Android原始碼
Python裝飾器例項講解(三)
2023-02-16
Python
防抖和節流(例項講解)
2022-04-21
Unity射擊例項講解—主角建立
2020-12-16
Unity
【tensorflow2.0】例項2
2020-09-29
設計模式 - 原則及例項講解
2020-02-19
設計模式
設計模式例項講解 - 里氏替換
2020-01-04
設計模式
設計模式例項講解 - 介面隔離
2020-01-04
設計模式
設計模式例項講解 - 依賴倒置
2020-01-04
設計模式
Unity射擊例項講解—子彈建立
2020-12-19
Unity
設計模式例項講解 - 開放封閉
2020-01-02
設計模式
C#中的虛方法（virtual）例項講解
2020-11-22
C#
Macro / Micro / Weighted AUC 如何計算例項講解
2024-08-30
Mac
Springboot整合mybatis框架（含例項Demo）
2018-06-24
Spring BootMyBatis框架
Android中Retrofit的封裝使用
2020-12-19
Android封裝
Android 之Service使用攻略
2019-01-03
Android
Android進階：七、Retrofit2.0原理解析之最簡流程
2019-04-27
Android
BitBake使用攻略--從HelloWorld講起
2021-12-22
Retrofit2.0使用——帶進度下載檔案
2018-05-03
Android進階：七、Retrofit2.0原理解析之最簡流程【上】
2019-04-08
Android
Retrofit2.0- 原始碼分析
2018-09-01
原始碼
Linux IO模式及 select、poll、epoll詳解（含部分例項原始碼）
2020-11-28
Linux模式原始碼
python3+requests+unittest介面自動化例項講解
2019-03-04
Python
例項講解：我的強化學習初體驗！
2019-03-06
強化學習
效能測試-例項講解VU、RPS、RT公式換算
2019-07-19
公式
如何讀懂火焰圖？+ 例項講解程式效能優化
2022-03-10
優化
MySQL共享鎖：使用與例項詳解
2024-08-19
MySql
[Android]Gank 元件化例項App
2019-03-04
Android元件化APP
vue之父子元件間通訊例項講解(props、$ref、$emit)
2018-10-31
Vue元件MIT
Js 的事件迴圈(Event Loop)機制以及例項講解
2018-06-19
JS事件OOP

Android：Retrofit 2.0 使用攻略（含例項講解）

前言

目錄

1. 簡介

2. 與其他開源請求庫對比

3. 使用介紹

步驟1：新增Retrofit庫的依賴

步驟2：建立 接收伺服器返回資料 的類

步驟3：建立 用於描述網路請求 的介面

註解型別

註解說明

第二類：標記

第三類：網路請求引數

詳細說明

彙總

步驟4：建立 Retrofit 例項

a. 關於資料解析器（Converter）

b. 關於網路請求介面卡（CallAdapter）

步驟5：建立 網路請求介面例項

步驟6：傳送網路請求（非同步 / 同步）

步驟7：處理返回資料

4. 例項講解

4.1 例項1

步驟1：新增Retrofit庫的依賴

步驟2：建立 接收伺服器返回資料 的類

步驟3：建立 用於描述網路請求 的介面

接下來的步驟均在GetRequest.java內實現（看註釋）

執行結果

Demo地址

4.2 例項2

步驟1：新增Retrofit庫的依賴

步驟2：建立 接收伺服器返回資料 的類

步驟3：建立 用於描述網路請求 的介面

接下來的步驟均在PostRequest.java內實現（看註釋）

執行結果

Demo地址

5. Retrofit 的擴充使用

6. 總結

請點贊！因為你的鼓勵是我寫作的最大動力！

相關文章

步驟2：建立接收伺服器返回資料的類

步驟3：建立用於描述網路請求的介面

步驟5：建立網路請求介面例項

步驟2：建立接收伺服器返回資料的類

步驟3：建立用於描述網路請求的介面

步驟2：建立接收伺服器返回資料的類

步驟3：建立用於描述網路請求的介面