說明:該文章轉載於https://www.jianshu.com/p/a3e162261ab6 前言 在Andrroid開發中,網路請求十分常用 而在Android網路請求庫中,Retrofit是當下最熱的一個網路請求庫 image image 今天,我將獻上一份非常詳細Retrofit v2.0的 ...
說明:該文章轉載於https://www.jianshu.com/p/a3e162261ab6
前言
- 在
Andrroid
開發中,網路請求十分常用 - 而在
Android
網路請求庫中,Retrofit
是當下最熱的一個網路請求庫
- 今天,我將獻上一份非常詳細
Retrofit v2.0
的使用教程,希望你們會喜歡。
如果對
Retrofit v2.0
的源碼感興趣,可看文章:Android:手把手帶你深入剖析 Retrofit 2.0 源碼
目錄
image1. 簡介
image特別註意:
- 準確來說,Retrofit 是一個 RESTful 的 HTTP 網路請求框架的封裝。
- 原因:網路請求的工作本質上是
OkHttp
完成,而 Retrofit 僅負責 網路請求介面的封裝
- App應用程式通過 Retrofit 請求網路,實際上是使用 Retrofit 介面層封裝請求參數、Header、Url 等信息,之後由 OkHttp 完成後續的請求操作
- 在服務端返回數據之後,OkHttp 將原始的結果交給 Retrofit,Retrofit根據用戶的需求對結果進行解析
2. 與其他開源請求庫對比
除了Retrofit,如今Android中主流的網路請求框架有:
- Android-Async-Http
- Volley
- OkHttp
下麵是簡單介紹:
image一圖讓你瞭解全部的網路請求庫和他們之間的區別!
image附:各個主流網路請求庫的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 網路請求介面 的註解類型。
註解類型
image註解說明
第一類:網路請求方法
image詳細說明:
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 不會做處理,所以要自行保證準確
}
第二類:標記
imagea. @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);
第三類:網路請求參數
image詳細說明
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}提供
}
彙總
image步驟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 發送網路請求
image採用
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:查詢內容
image
- 根據 金山詞霸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'
運行結果
imageDemo地址
Carson_Ho的Github:https://github.com/Carson-Ho/RetrofitDemo
4.2 實例2
- 實現的功能:將 英文 翻譯成 中文
- 實現方法:採用
Post方法
對 有道API 發送網路請求
image採用
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
image
- 根據 有道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'
運行結果
imageDemo地址
Carson_Ho的Github:https://github.com/Carson-Ho/RetrofitDemo
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();