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

時間  2019-11-07
標籤 android retrofit 2.0 使用 攻略 實例 講解 欄目 Android 简体版
原文   原文鏈接

前言

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

Github截圖

  • 今天，我將獻上一份很是詳細Retrofit v2.0的使用教程，但願大家會喜歡。

若是對Retrofit v2.0的源碼感興趣，可看文章：Android：手把手帶你深刻剖析 Retrofit 2.0 源碼php

目錄

目錄

1. 簡介

示意圖

特別注意：java

  • 準確來講，Retrofit 是一個 RESTful 的 HTTP 網絡請求框架的封裝。
  • 緣由：網絡請求的工做本質上是 OkHttp 完成，而 Retrofit 僅負責 網絡請求接口的封裝

本質過程

  • App應用程序經過 Retrofit 請求網絡，其實是使用 Retrofit 接口層封裝請求參數、Header、Url 等信息，以後由 OkHttp 完成後續的請求操做
  • 在服務端返回數據以後，OkHttp 將原始的結果交給 Retrofit，Retrofit根據用戶的需求對結果進行解析

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

除了Retrofit，現在Android中主流的網絡請求框架有：android

  • Android-Async-Http
  • Volley
  • OkHttp

下面是簡單介紹：git

網絡請求加載 - 介紹

一圖讓你瞭解所有的網絡請求庫和他們之間的區別！github

網絡請求庫 - 對比

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

3. 使用介紹

使用 Retrofit 的步驟共有7個：json

步驟1： 添加Retrofit庫的依賴api

步驟2： 建立 接收服務器返回數據 的類bash

步驟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接口：採用 註解 描述網絡請求參數 和配置網絡請求參數
  1. 用 動態代理 動態 將該接口的註解「翻譯」成一個 Http 請求，最後再執行 Http 請求
  2. 注：接口中的每一個方法的參數都須要使用註解標註，不然會報錯

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「 ）
  • 具體整合的規則以下：

URL整合規則

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

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 = www.println.net/?cate=andro… = 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格式說明

  • 根據 金山詞霸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：github.com/Carson-Ho/R…

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. 總結

請點贊！由於你的鼓勵是我寫做的最大動力！

歡迎關注carson_ho的微信公衆號

示意圖

示意圖
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程