什么是Retrofit？
Retrofit是Android和Java上的一個(gè)類型安全的REST客戶端敞贡。
Retrofit將REST API抽象成Java接口，使用注解來描述每個(gè)API地址和請(qǐng)求摄职，支持URL參數(shù)替換(包括查詢參數(shù)和路徑參數(shù))誊役，以及表單編碼和多部分請(qǐng)求功能。支持GET谷市，POST蛔垢，PUT，PATCH迫悠，DELETE等HTTP請(qǐng)求方法啦桌。
Retrofit的GitHub地址：
https://github.com/square/retrofit
為什么使用Retrofit？
在處理HTTP請(qǐng)求時(shí)及皂，總會(huì)因?yàn)椴煌瑘?chǎng)景或者邊界情況而難以處理甫男。你需要考慮網(wǎng)絡(luò)狀態(tài)，需要在請(qǐng)求失敗后重試验烧，需要處理HTTPS問題等等板驳，這些事情會(huì)讓你很頭疼，而Retrofit則可以將你從這些頭疼的事情中解放出來碍拆。
當(dāng)然若治，也有其他的庫(kù)，像android-async-http和Volley感混，那為什么是Retrofit端幼？首先，Retrofit功能強(qiáng)大而且可靈活配置弧满，至于如何強(qiáng)大靈活婆跑，我們會(huì)慢慢探究。其次庭呜，Retrofit是square推出的滑进，是Jack Wharton主導(dǎo)的(額......)犀忱。
Retrofit與OkHttp的關(guān)系
OkHttp是一個(gè)純凈的HTTP/SPDY客戶端，負(fù)責(zé)底層網(wǎng)絡(luò)操作扶关，緩存阴汇，請(qǐng)求和響應(yīng)操作等等；而Retrofit是一個(gè)基于OkHttp的更高層的REST抽象节槐。
在Retrofit2之前搀庶，OkHttp是可選的一個(gè)客戶端。而在Retrofit2中铜异，Retrofit與OkHttp強(qiáng)耦合哥倔，使得更好地利用OkHttp，包括使用OkHttp來解決一些棘手的問題熙掺。
什么？不知道OkHttp是啥咕宿，請(qǐng)參考：
《OkHttp之簡(jiǎn)介》
使用Retrofit
冠冕堂皇的話就不多扯币绩，還是看看如果引入以及使用Retrofit吧。
引入Retrofit
-
既然涉及到網(wǎng)絡(luò)操作府阀，那必須要在清單文件中添加網(wǎng)絡(luò)權(quán)限缆镣。好的，在AndroidManifest.xml中添加：
<uses-permission android:name="android.permission.INTERNET"/> -
添加Retrofit依賴：
compile 'com.squareup.retrofit2:retrofit:2.1.0' 添加響應(yīng)轉(zhuǎn)換器依賴试浙。Retrofit2默認(rèn)是不集成響應(yīng)轉(zhuǎn)換器的董瞻，因此，我們需要添加相關(guān)的依賴田巴。本文中使用Google的Gson來處理響應(yīng)數(shù)據(jù)：
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
經(jīng)過上面的三步钠糊，在項(xiàng)目中就可以使用Retrofit，那么如何使用呢壹哺？看下文見分曉抄伍。
使用Retrofit
我們已經(jīng)知道，Retrofit將API抽象成Java接口管宵，那么首先就先定義接口截珍，那么定義請(qǐng)求什么的接口呢？本文使用新浪微博開放API中的獲取廣場(chǎng)微博箩朴、好友微博及我的微博接口岗喉。具體的微博Api接口見http://open.weibo.com/wiki/2/statuses/public_timeline：
public interface WeiboService {
@GET("statuses/public_timeline.json")
Call<Timeline> timelineForPublic(@Query("access_token") String token);
@GET("statuses/friends_timeline.json")
Call<Timeline> timelineForFriend(@Query("access_token") String token);
@GET("statuses/user_timeline.json")
Call<Timeline> timelineForMine(@Query("access_token") String token);
}
上面我們定義了WeiboService接口，并且有三個(gè)方法timelineForPublic()炸庞、timelineForFriend()钱床、timelineForMine()
，方法和其參數(shù)上都有注解加以說明：
- 首先@GET表示當(dāng)方法調(diào)用時(shí)會(huì)執(zhí)行一個(gè)GET請(qǐng)求埠居。@GET后面緊跟著一個(gè)字符串诞丽，代表著API的端點(diǎn)url鲸拥。此外，端點(diǎn)url可以使用占位符定義僧免，但因不適合本例刑赶，暫且不談。
- 方法參數(shù)中用@Query對(duì)token進(jìn)行注解懂衩，則token將為以access_token為鍵作為請(qǐng)求的參數(shù)撞叨。
有了接口，還得有接口的實(shí)例才可以對(duì)其進(jìn)行調(diào)用浊洞。我們創(chuàng)建一個(gè)ServiceGenerator來實(shí)現(xiàn)根據(jù)接口返回其實(shí)例的功能牵敷。
public class ServiceGenerator {
private static final String BASE_URL = "https://api.weibo.com/2/";
private static Retrofit.Builder retrofitBuilder =
new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create());
private static OkHttpClient.Builder okHttpClientBuilder =
new OkHttpClient.Builder();
public static <T> T createService(Class<T> serviceClass) {
retrofitBuilder.client(okHttpClientBuilder.build());
Retrofit retrofit = retrofitBuilder.build();
return retrofit.create(serviceClass);
}
}
查看微博API列表可以得出其baseUrl為"https://api.weibo.com/2/"，使用Retrofit.Builder創(chuàng)建一個(gè)REST客戶端法希，設(shè)置Gson來處理響應(yīng)枷餐，以及OkHttp作為其client。
使用一個(gè)OkHttpClient實(shí)例可以重用已打開的套接字連接苫亦，這也是建議如此做的毛肋。這里ServiceGenerator通過用一個(gè)靜態(tài)的OkHttpClientBuilder字段來實(shí)現(xiàn)。
至此屋剑，我們創(chuàng)建了一個(gè)WeiboService定義了幾個(gè)方法润匙，這些方法返回Call<TimeLine>類型。而ServiceGenerator可以創(chuàng)建接口的實(shí)例唉匾，之后我們通過創(chuàng)建的接口實(shí)例調(diào)用相應(yīng)方法孕讳，就可以拿到Call<TimeLine>實(shí)例，將這個(gè)實(shí)例插入隊(duì)列巍膘，就可以在回調(diào)中獲取到響應(yīng)了厂财。
WeiboService weiboService = ServiceGenerator.createService(WeiboService.class);
Call<Timeline> call;
switch (mType) {
case Constants.TYPE_TIMELINE_PUBLIC:
call = weiboService.timelineForPublic(AccessTokenKeeper.readAccessToken(getContext()).getToken());
break;
case Constants.TYPE_TIMELINE_FRIEND:
call = weiboService.timelineForFriend(AccessTokenKeeper.readAccessToken(getContext()).getToken());
break;
case Constants.TYPE_TIMELINE_MINE:
call = weiboService.timelineForMine(AccessTokenKeeper.readAccessToken(getContext()).getToken());
break;
default:
call = weiboService.timelineForPublic(AccessTokenKeeper.readAccessToken(getContext()).getToken());
break;
}
call.enqueue(new Callback<Timeline>() {
@Override
public void onResponse(Call<Timeline> call, Response<Timeline> response) {
if (response.isSuccessful()) {
mAdapter.setData(response.body().getStatuses());
} else {
DebugLog.i(TAG, "request if failed");
}
}
@Override
public void onFailure(Call<Timeline> call, Throwable t) {
DebugLog.i(TAG, "error:" + t.getMessage());
}
});
在onResponse()回調(diào)中，將返回的微博列表設(shè)置到Adapter中峡懈，本文是通過RecyclerView簡(jiǎn)單地展示了每條微博的擁有者及文本內(nèi)容蟀苛。效果圖如下：
雖然很丑，但意義是使用Retrofit成功獲取到了數(shù)據(jù)逮诲，哈哈帜平。本文就介紹這么多，后續(xù)繼續(xù)介紹Retrofit各方面的使用梅鹦，敬請(qǐng)關(guān)注裆甩！
源碼地址：
https://github.com/FILWAndroid/DevJourney
關(guān)于源碼：
- 不只是本文涉及的代碼，會(huì)包含很多知識(shí)點(diǎn)的代碼齐唆，應(yīng)該都會(huì)在我的簡(jiǎn)書中進(jìn)行介紹嗤栓。
- 有可能代碼與本文中所貼出來的有差異，但應(yīng)該都是我覺得更好的方式吧。
- 新浪微博相關(guān)的代碼運(yùn)行顯示不出來結(jié)果茉帅，感興趣的可以參考新浪微博SDK叨叙，配置工程。
- 歡迎大家對(duì)我進(jìn)行批評(píng)教育堪澎。
參考鏈接：
https://github.com/square/retrofit
http://square.github.io/retrofit/
https://futurestud.io/blog/retrofit-getting-started-and-android-client
https://github.com/bkiers/retrofit-oauth
