一、概述
Retrofit是Square公司開(kāi)發(fā)的一個(gè)類型安全的Java和Android 的REST客戶端庫(kù)方篮。來(lái)自官網(wǎng)的介紹：
A type-safe HTTP client for Android and Java
- Rest API是一種軟件設(shè)計(jì)風(fēng)格励负，服務(wù)器作為資源存放地继榆≈樱客戶端去請(qǐng)求GET,PUT, POST,DELETE資源集币。并且是無(wú)狀態(tài)的鞠苟，沒(méi)有session的參與。關(guān)于REST的介紹可以參考維基百科
- retrofit模型如下：(來(lái)自如何使用Retrofit寫一個(gè)Android的REST客戶端的小教程)
retrofit模型
- POJO或模型實(shí)體類 : 從服務(wù)器獲取的JSON數(shù)據(jù)將被填充到這種類的實(shí)例中吃既。
- 接口 : 我們需要?jiǎng)?chuàng)建一個(gè)接口來(lái)管理像GET,POST...等請(qǐng)求的URL鹦倚，這是一個(gè)服務(wù)類冀惭。
- RestAdapter類 : 這是一個(gè)REST客戶端(RestClient)類，retrofit中默認(rèn)用的是Gson來(lái)解析JSON數(shù)據(jù)捐友，你也可以設(shè)置自己的JSON解析器溃槐。
二昏滴、原理
在發(fā)起請(qǐng)求時(shí)，整個(gè)框架主要通過(guò)Call來(lái)封裝每一次的請(qǐng)求拂共。
調(diào)用同步方法時(shí)姻几，會(huì)使用應(yīng)用線程來(lái)發(fā)送請(qǐng)求蛇捌；
調(diào)用異步方法時(shí)會(huì)通過(guò) OkHttp 的 Dispatcher 提供的線程來(lái)執(zhí)行請(qǐng)求。
Dispatcher：Dispatcher內(nèi)部實(shí)現(xiàn)了懶加載無(wú)邊界限制的線程池方式俭驮，同時(shí)該線程池采用了SynchronousQueue這種阻塞隊(duì)列春贸。SynchronousQueue每個(gè)插入操作必須等待另一個(gè)線程的移除操作遗遵，同樣任何一個(gè)移除操作都等待另一個(gè)線程的插入操作逸嘀。顯然這是一種快速傳遞元素的方式，也就是說(shuō)在這種情況下元素總是以最快的方式從插入者（生產(chǎn)者）傳遞給移除者（消費(fèi)者）屯蹦，這在多任務(wù)隊(duì)列中是最快處理任務(wù)的方式绳姨。
二阔挠、使用
-
添加依賴（gradle）或?qū)ar包
添加依賴
在modul的build文件下的dependencies中添加
compile 'com.squareup.retrofit2:retrofit:2.0.2'
compile 'com.squareup.retrofit2:converter-gson:2.0.2'
點(diǎn)擊Sync Now
（或）導(dǎo)jar包购撼，點(diǎn)擊下載
retrofit-2.0.0-beta2.jar| Retrofit庫(kù)
converter-gson-2.0.0-beta2_.jar | Gson解析庫(kù)
gson-2.4.jar | Gson解析庫(kù)
okhttp-2.5.0.jar | Okhttp請(qǐng)求庫(kù)
okio-1.6.0.jar | Okhttp請(qǐng)求庫(kù)
說(shuō)明：
Retrofit依賴于okhttp迂求，所以需要集成okhttp
API返回的數(shù)據(jù)為JSON格式，在此我使用的是Gson對(duì)返回?cái)?shù)據(jù)解析
-
添加權(quán)限
由于是網(wǎng)絡(luò)請(qǐng)求毫玖，需要在manifest中添加網(wǎng)絡(luò)請(qǐng)求的權(quán)限
<uses-permission android:name="android.permission.INTERNET"/>
-
創(chuàng)建實(shí)體類
這是使用Gson解析，需要?jiǎng)?chuàng)建一個(gè)POJO（Java對(duì)象）凌盯。服務(wù)器返回的JSON數(shù)據(jù)不能在Java里直接使用付枫，所以我們需要用模型類來(lái)做轉(zhuǎn)換。這里使用jsonschema2pojo（需翻墻）來(lái)創(chuàng)建POJO驰怎。
得到JSON數(shù)據(jù)如下：
JSON數(shù)據(jù)
復(fù)制JSON字符串到輸入框中阐滩，填寫報(bào)名、類名县忌，源代碼類型選擇JSON掂榔，注解類型選擇Gson，點(diǎn)擊Preview即可得到對(duì)應(yīng)的POJO症杏，如下圖
復(fù)制到j(luò)sonschema2pojo中
點(diǎn)擊preview，得到對(duì)應(yīng)的實(shí)體類厉颤。將其拷貝到自己的工程中即可饱溢。
得到的實(shí)體類
import com.google.gson.annotations.SerializedName;
@Generated("org.jsonschema2pojo")
可刪除
POJO的轉(zhuǎn)換推薦使用GsonFormat，用法不就不說(shuō)了走芋，自己去搜吧绩郎。簡(jiǎn)單易用
- 創(chuàng)建一個(gè)Retrofit 對(duì)象（核心用法一）
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create())//解析方法
//這里建議：- Base URL: 總是以/結(jié)尾潘鲫；- @Url: 不要以/開(kāi)頭
.baseUrl("http://www.wangyinews.com.cn/")
.build();
- 接口申明（核心用法二）
public interface NewsService {
/**
* 根據(jù)newsid獲取對(duì)應(yīng)的資訊數(shù)據(jù)
* 如果不需要轉(zhuǎn)換成Json數(shù)據(jù),可以用了ResponseBody;
* @param newsId
* @return call
*/
@GET("News/{newsId}")
Call<News> getNews(@Path("newsId") String newsId);
}
若需要重新定義接口地址可以使用@Url，例：
@GET
Call<List<CaigenActivitySubjectsBean>> getActivitySubjectsList(
@Url String url,
@QueryMap Map<String, String> map);
更多請(qǐng)求方法請(qǐng)參考：Retrofit網(wǎng)絡(luò)請(qǐng)求Service肋杖，@Path溉仑、@Query、@QueryMap
- 創(chuàng)建訪問(wèn)API的請(qǐng)求（核心用法三）
NewsService api = retrofit.create(NewsService .class);
Call<News> call = service.getNews("123456");
- 同步調(diào)用(核心用法四)
News news = call.execute();
- 異步調(diào)用（核心用法五）
call.enqueue(new Callback<News>(){
@Override
public void onResponse(Response<News> response) {
//成功返回?cái)?shù)據(jù)后在這里處理状植，使用response.body();獲取得到的結(jié)果
News news = response.body();
}
@Override
public voidonFailure(Throwable t) {
//請(qǐng)求失敗在這里處理
}
});
- 取消請(qǐng)求（核心用法六）
call.cancel();
完成以上步驟就可以實(shí)現(xiàn)一個(gè)簡(jiǎn)單的網(wǎng)絡(luò)請(qǐng)求了浊竟。
Tips:
當(dāng)返回結(jié)果錯(cuò)誤，調(diào)用response.errorBody().string();可以得到String類型的請(qǐng)求結(jié)果津畸，但再次調(diào)用response.errorBody().string();得到的結(jié)果為""振定。具體原因不明
