retrofit 英文名字是改裝的意思岸售，也就是說(shuō)他是對(duì)網(wǎng)絡(luò)請(qǐng)求的一種改裝旗吁，他不負(fù)責(zé)進(jìn)行網(wǎng)絡(luò)請(qǐng)求痊臭，他是對(duì)請(qǐng)求方式的一種封裝哮肚。真正進(jìn)行網(wǎng)絡(luò)請(qǐng)求的是okhttp。
博客園地址
以下所有內(nèi)容在Android Studio已經(jīng)導(dǎo)入retrofit為基礎(chǔ)广匙。導(dǎo)入方式如下：
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.retrofit2:converter-scalars:2.1.0'
利用Retrofit進(jìn)行簡(jiǎn)單的GET請(qǐng)求
retrofit在構(gòu)建請(qǐng)求方式之前允趟，需要構(gòu)建一個(gè)接口方法，通過(guò)這個(gè)接口方法的返回值鸦致，來(lái)進(jìn)行網(wǎng)絡(luò)請(qǐng)求潮剪。
下面，來(lái)通過(guò)一些簡(jiǎn)單的例子了解GET請(qǐng)求分唾。
實(shí)驗(yàn)一：對(duì)一個(gè)簡(jiǎn)單的html頁(yè)面進(jìn)行GET請(qǐng)求
我們要獲取百度頁(yè)面的HTML抗碰。首先構(gòu)建如下接口：
public interface HtmlService {
@GET("/")
Call<String> getHtml();
}
注意，GET注解中的參數(shù)鳍寂，和方法中的參數(shù)至少要加一個(gè)改含，否則會(huì)報(bào)錯(cuò)。由于迄汛，我們只需要請(qǐng)求www.baidu.com,所以get這里不需要加參數(shù)捍壤，就是/
然后，我們通過(guò)如下步驟鞍爱，來(lái)進(jìn)行網(wǎng)絡(luò)請(qǐng)求鹃觉。
在我們需要進(jìn)行網(wǎng)絡(luò)請(qǐng)求的類中，通過(guò)以下的步驟睹逃，進(jìn)行網(wǎng)絡(luò)請(qǐng)求：
- 構(gòu)建retrofit對(duì)象盗扇。
- 動(dòng)態(tài)代理生成接口的對(duì)象祷肯。
- 通過(guò)接口的方法，得到要請(qǐng)求的API的調(diào)用疗隶。
- 通過(guò)同步/異步的方式佑笋，得到response。
- 根據(jù)需要斑鼻，處理response蒋纬。
第一步
Retrofit retrofit = new Retrofit.Builder(). addConverterFactory(ScalarsConverterFactory.create()).
baseUrl("https://www.baidu.com").
build();
通過(guò)以上代碼，可以簡(jiǎn)單的構(gòu)建一個(gè)retrofit對(duì)象坚弱，addConverterFactory是對(duì)response進(jìn)行解析蜀备，里面添加的參數(shù)是表示對(duì)response用String解析，然后添加一個(gè)基礎(chǔ)的URL荒叶，后續(xù)的參數(shù)則是通過(guò)上面我們定制的接口來(lái)添加碾阁，最后構(gòu)建一個(gè)完整的URL。
第二步
HtmlService htmlService = retrofit.create(HtmlService.class);
通過(guò)動(dòng)態(tài)代理些楣，生成一個(gè)接口的對(duì)象脂凶。
第三步
Call<String> call = htmlService.getHtml();
通過(guò)接口的方法得到調(diào)用的對(duì)象。
第四步與第五步
異步方法得到response：
call.enqueue(new Callback<String>() {
@Override
public void onResponse(Call<String> call, Response<String> response) {
showText.append(response.body());
}
@Override
public void onFailure(Call<String> call, Throwable t) {
Toast.makeText(MainActivity.this,t.getMessage(),Toast.LENGTH_SHORT).show();
}
});
得到的response愁茁，通過(guò)response.body()得到響應(yīng)報(bào)文的body部分艰猬。
同步方法得到response：
new Thread(new Runnable() {
@Override
public void run() {
try {
final String str = call.execute().body();
handler.post(new Runnable() {
@Override
public void run() {
showText.append(str);
}
});
} catch (IOException e) {
e.printStackTrace();
}
}
}).start();
實(shí)驗(yàn)二：對(duì)一個(gè)返回JSON格式的API進(jìn)行GET請(qǐng)求
通過(guò)GET請(qǐng)求GankIO的api得到Json：
首先，我們也是通過(guò)接口埋市，構(gòu)建一個(gè)接口方法：
@GET("content/{number}/{page}")
Call<HistoryBean> getHistoryData(@Path("number") String number,@Path("page") String page);
這里，方法里面?zhèn)魅氲膮?shù)會(huì)放到@GET的注解里面命贴。
然后道宅，重新構(gòu)建一個(gè)retrofit對(duì)象：
Retrofit retrofit = new Retrofit.Builder().
addConverterFactory(GsonConverterFactory.create()).
baseUrl("http://gank.io/api/history/").
build();
這里面添加的解析器是GsonConverterFactory，表示對(duì)response中body提供對(duì)象解析胸蛛。然后的方法和上面類似：
HtmlService htmlService = retrofit.create(HtmlService.class);
call = htmlService.getHistoryData("2", "1");
call.enqueue(new Callback<HistoryBean>() {
@Override
public void onResponse(Call<HistoryBean> call, Response<HistoryBean> response) {
HistoryBean hb = response.body();
if(hb == null) return;
showText.append(hb.isError() + "");
for(HistoryBean.ResultsBean rb : hb.getResults()){
showText.append(rb.getTitle() + "/n");
}
}
@Override
public void onFailure(Call<HistoryBean> call, Throwable t) {
}
});
上面的方法是異步得到的污茵，同步的方法和上面類似，就不多說(shuō)了葬项。
實(shí)驗(yàn)三：添加一個(gè)請(qǐng)求參數(shù)構(gòu)建GET請(qǐng)求
上面的GET方法是沒(méi)有查詢參數(shù)的泞当，下面對(duì)一個(gè)有查詢參數(shù)的api，進(jìn)行GET請(qǐng)求,這里我們利用豆瓣的搜索圖書(shū)的API
這個(gè)API接受4個(gè)搜索參數(shù)民珍，具體如下：
| 參數(shù) | 意義 | 備注 |
|---|---|---|
| q | 查詢關(guān)鍵字 | q與tag必傳其一 |
| tag | 查詢的tag | q與tag必傳其一 |
| start | 取結(jié)果的offset | 默認(rèn)為0 |
| count | 取結(jié)果的條數(shù) | 默認(rèn)為20 |
首先襟士，我們也是構(gòu)建一個(gè)請(qǐng)求接口的方法：
@GET("book/search")
Call<BookBean> queryBookInfo(@Query("q") String name);
在這里面，我們用到了一個(gè)新的注解參數(shù)@Query 這個(gè)參數(shù)表示請(qǐng)求參數(shù)會(huì)以鍵值對(duì)的形式拼接在URL后面嚷量。
這樣的方式陋桂，有一種局限性，因?yàn)橐诿總€(gè)GET接口方法里面寫(xiě)入鍵值對(duì)信息蝶溶，如果嗜历，有些鍵值對(duì)信息是每個(gè)GET方法都需要的，我們就會(huì)通過(guò)一個(gè)攔截器的形式，統(tǒng)一在請(qǐng)求的時(shí)候加上梨州。步驟如下：
- 自定義一個(gè)攔截器實(shí)現(xiàn)
Interceptor痕囱。 - 創(chuàng)建retrofit的客戶端（上面的代碼都是默認(rèn)的客戶端），加上這個(gè)攔截器暴匠。
第一步
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);
}
}
第二步
OkHttpClient.Builder httpClientBuilder = new OkHttpClient.Builder().
addInterceptor(new CustomInterceptor()).
connectTimeout(1000, TimeUnit.MILLISECONDS);
Retrofit retrofit = new Retrofit.Builder().
client(httpClientBuilder.build()).
addConverterFactory(GsonConverterFactory.create()).
baseUrl("https://api.douban.com/v2/").
build();
HtmlService htmlService = retrofit.create(HtmlService.class);
call = htmlService.queryBookInfo("第一行代碼");
后續(xù)的異步請(qǐng)求基本一致鞍恢，就不細(xì)說(shuō)了。
實(shí)驗(yàn)四：添加多種請(qǐng)求參數(shù)構(gòu)建GET請(qǐng)求
實(shí)驗(yàn)三的部分巷查，講了對(duì)一個(gè)查詢參數(shù)和一個(gè)共有的查詢參數(shù)的GET請(qǐng)求構(gòu)建方法有序，下面多個(gè)查詢參數(shù)的GET請(qǐng)求，看看是否有簡(jiǎn)單的方式岛请，因?yàn)椴幌朐谝粋€(gè)方法里旭寿，傳入4個(gè)以上的參數(shù)。
請(qǐng)求的API還是上邊的豆瓣的搜索API崇败，他正好有4個(gè)請(qǐng)求參數(shù)
下面盅称，看如下構(gòu)建方式：
@GET("book/search")
Call<BookBean> queryBookInfo(@QueryMap Map<String,String> options);
然后，將請(qǐng)求參數(shù)通過(guò)鍵值對(duì)的形式保存到Map里：
Map<String,String> options = new HashMap<>();
options.put("q","第一行代碼");
options.put("start","0");
options.put("count","1");
call = htmlService.queryBookInfo(options);
在上面的情況下后室，有多種鍵值對(duì)缩膝，每一種key對(duì)應(yīng)的value都是唯一的，retrofit也支持相同的key岸霹，卻有多種value的形式疾层。方式如下：
@GET("book/search")
Call<BookBean> queryBookInfo(@Query("key") List<String> value);
然后，將value的集合傳入方法中贡避，后續(xù)的步驟不變痛黎，就不多數(shù)。
利用Retrofit進(jìn)行簡(jiǎn)單的POST請(qǐng)求
利用retorfit進(jìn)行post請(qǐng)求與進(jìn)行g(shù)et請(qǐng)求沒(méi)有太多的區(qū)別刮吧。主要的區(qū)別就在構(gòu)建接口方法上面湖饱，有一些不同，下面通過(guò)一些實(shí)驗(yàn)來(lái)看一下具體的區(qū)別杀捻。
實(shí)驗(yàn)一：將少數(shù)參數(shù)放到請(qǐng)求體中進(jìn)行POST請(qǐng)求
下面的POST方法API是我自己寫(xiě)的后臺(tái)來(lái)接受簡(jiǎn)單的POST井厌，就不放出來(lái)了。
首先致讥，也是構(gòu)建一個(gè)接口方法：
@FormUrlEncoded
@POST("login")
Call<String> doLogin(@Field("name")String name,@Field("password") String password);
第一個(gè)注解仅仆，表示自動(dòng)將請(qǐng)求參數(shù)的類型調(diào)整為application/x-www-form-urlencoded ，如果方法參數(shù)的注解用了@Field 就一定要用@FormUrlEncoded拄踪。POST注解里面依舊放的是API蝇恶，方法參數(shù)通過(guò)@Field將請(qǐng)求參數(shù)放置在請(qǐng)求體中。
后續(xù)創(chuàng)建retrofit對(duì)象，創(chuàng)建call對(duì)象，發(fā)起請(qǐng)求，都是和GET方法一樣匈织，就不多說(shuō)了贿衍。
實(shí)驗(yàn)二：將多個(gè)參數(shù)放到請(qǐng)求體中進(jìn)行POST請(qǐng)求
這個(gè)只不過(guò)構(gòu)建接口方法的時(shí)候授舟，有所區(qū)別，其他步驟和多種參數(shù)進(jìn)行GET請(qǐng)求一樣贸辈。
@FormUrlEncoded
@POST("login")
Call<String> doLogin(@FieldMap Map<String,String> fields);
將多個(gè)請(qǐng)求參數(shù)保存到Map中释树，傳入方法中，沒(méi)什么好說(shuō)的擎淤。
實(shí)驗(yàn)三：利用POST進(jìn)行文件上傳
同樣構(gòu)建一個(gè)接口方法：
@Multipart
@POST("upload")
Call<ResponseBody> uploadFile(@Part("description") RequestBody description,
@Part MultipartBody.Part file);
這里的POST修飾注解就換成了@Multipart ,在方法參數(shù)里面奢啥，通過(guò)@Part注解來(lái)修飾參數(shù)。
我們說(shuō)一下具體怎么構(gòu)建這些方法的參數(shù)嘴拢。
首先桩盲，構(gòu)建一個(gè)RequestBody對(duì)象的description，構(gòu)建方式如下：
RequestBody description = RequestBody.create(MediaType.parse("multipart/form-data"), "這是一個(gè)文件");
然后席吴，構(gòu)建一個(gè)MultipartBody.Part對(duì)象的file赌结，不過(guò)在構(gòu)建之前，先要?jiǎng)?chuàng)建一個(gè)RequestBody對(duì)象孝冒，通過(guò)這個(gè)對(duì)象才能創(chuàng)建一個(gè)MultipartBody.Part對(duì)象柬姚。代碼如下：
RequestBody requestBody = RequestBody.create(MediaType.parse("multipart/form-data"),file);
MultipartBody.Part body = MultipartBody.Part.createFormData("file",file.getName(),requestBody);
然后和其他方法一樣，利用這些對(duì)象庄涡，生成call量承，然后進(jìn)行網(wǎng)絡(luò)請(qǐng)求。
call = service.uploadFile(description,body);
當(dāng)然穴店，retrofit支持多種上傳圖片的方式宴合，其構(gòu)建方式如下：
// 上傳多個(gè)文件
@Multipart
@POST("upload")
Call<ResponseBody> uploadMultipleFiles(
@Part("description") RequestBody description,
@Part MultipartBody.Part file1,
@Part MultipartBody.Part file2);
以上這些實(shí)驗(yàn)就是利用Retrofit實(shí)現(xiàn)簡(jiǎn)單POST 請(qǐng)求。
添加HEADER
我們?cè)谶M(jìn)行復(fù)雜的網(wǎng)絡(luò)請(qǐng)求的時(shí)候迹鹅，通常要對(duì)請(qǐng)求添加頭部，retrofit提供了多種添加方式贞言，可以分為如下兩種：
- 靜態(tài)添加頭部
- 動(dòng)態(tài)添加頭部
靜態(tài)添加頭部
靜態(tài)添加頭部斜棚，則每次請(qǐng)求的時(shí)候，頭部的信息都是固定的该窗，不可以更改的弟蚀。添加靜態(tài)頭部的方式也有多種，方法如下：
- 在接口中添加酗失。
- 通過(guò)攔截器添加义钉。
下面，我們分別說(shuō)一說(shuō)每一種规肴。
在接口中添加
還是以上文寫(xiě)到的接口為例捶闸，添加Cache-Control,User-Agent請(qǐng)求頭部夜畴。
@Headers({
"Cache-Control: max-age=640000",
"User-Agent: app-name"
})
通過(guò)攔截器添加
和上面統(tǒng)一處理GET參數(shù)的定制器一樣，同樣實(shí)現(xiàn)Interceptor,代碼如下：
public class RequestInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request original = chain.request();
Request request = original.newBuilder()
.header("User-Agent", "app-name")
.header("Cache-Control", "max-age=640000")
.method(original.method(), original.body())
.build();
return chain.proceed(request);
}
}
然后删壮，在創(chuàng)建okHttp的客戶端時(shí),把攔截器加進(jìn)去贪绘，創(chuàng)建retrofit對(duì)象時(shí)，指定該客戶端即可央碟。
OkHttpClient.Builder httpClientBuilder = new OkHttpClient.Builder().
addInterceptor(new CustomInterceptor()).
addInterceptor(new RequestInterceptor()).
connectTimeout(1000, TimeUnit.MILLISECONDS);
動(dòng)態(tài)添加頭部
動(dòng)態(tài)添加的好處税灌，就在于不同的請(qǐng)求會(huì)有不同的請(qǐng)求頭部，那么可想而知亿虽，其添加的部分就是在接口方法里面菱涤。
@GET("{number}/{page}")
Call<HistoryBean> getHistoryData(@Header("Content-Range") String contentRange ,@Path("number") String number, @Path("page") String page);
后續(xù)的使用都是一樣的，沒(méi)什么好說(shuō)的洛勉。
設(shè)置網(wǎng)絡(luò)請(qǐng)求日志
retrofit提供了對(duì)網(wǎng)絡(luò)請(qǐng)求的過(guò)程進(jìn)行打印的日志的插件粘秆，需要單獨(dú)的導(dǎo)入，其方式如下：
compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'
通過(guò)上面的導(dǎo)入代碼坯认，可以看出這個(gè)日志插件是okHttp特有的翻擒，這也可以證明，retrofit只是封裝了請(qǐng)求的方式牛哺，真正請(qǐng)求的還是通過(guò)okHttp陋气。那么我們也可以猜出，其設(shè)置的方式必然也是通過(guò)攔截器引润，放進(jìn)okHttp的客戶端里面巩趁。具體的代碼如下：
HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
OkHttpClient.Builder httpClientBuilder = new OkHttpClient.Builder().
addInterceptor(new CustomInterceptor()).
addInterceptor(new RequestInterceptor()).
addInterceptor(httpLoggingInterceptor).
connectTimeout(1000, TimeUnit.MILLISECONDS);
注意上面的代碼，在設(shè)置請(qǐng)求級(jí)別上面設(shè)置為body淳附，下面說(shuō)一下具體的級(jí)別以及其內(nèi)涵：
-
NONE: 沒(méi)有任何日志信息议慰。 -
Basic: 打印請(qǐng)求類型，URL奴曙，請(qǐng)求體大小别凹，返回值狀態(tài)以及返回值的大小。 -
Headers: 打印返回請(qǐng)求和返回值的頭部信息洽糟，請(qǐng)求類型炉菲，URL以及返回值狀態(tài)碼 -
Body: 打印請(qǐng)求和返回值的頭部和body信息。
總結(jié)
上面就是簡(jiǎn)單的retrofit的使用坤溃，關(guān)于利用retrofit結(jié)合其他部分如Rx拍霜，okHttp等等，或者利用retrofit實(shí)現(xiàn)多種文件上傳薪介，下載功能祠饺，保存cookie等等功能，可以期待后續(xù)的文章汁政。
