先扯兩句
好了，上一篇閑扯過(guò)后，算是將我為什么會(huì)把Retrofit說(shuō)出來(lái)了吧（雖然好像什么都沒(méi)說(shuō)），當(dāng)然還有其他框架，作為一個(gè)懶人，我這里就不加以闡述了，還是進(jìn)入整體，開(kāi)始進(jìn)入我們的使用的部分。
還是先上我的Git庫(kù)。
MyBaseApplication (https://github.com/BanShouWeng/MyBaseApplication)
并給大家展示個(gè)神器，叫Android知識(shí)點(diǎn)——目錄，好了，閑言少敘，下面進(jìn)入正題。
正文
這么快進(jìn)正文還真不太適應(yīng)，那就先感謝一波吧：
- 感謝依然范特稀西的Retrofit + RxJava ＋ OkHttp 讓網(wǎng)絡(luò)請(qǐng)求變的簡(jiǎn)單-基礎(chǔ)篇幫了個(gè)大忙；
- 感謝依然范特稀西的Retrofit + RxJava ＋ OkHttp 讓網(wǎng)絡(luò)請(qǐng)求變的簡(jiǎn)單-封裝篇幫了個(gè)大忙；
- 感謝tough1985的RxJava 與 Retrofit 結(jié)合的最佳實(shí)踐幫了個(gè)大忙
- 感謝張鴻洋的Retrofit2 完全解析 探索與okhttp之間的關(guān)系幫了個(gè)大忙
- Retrofit官網(wǎng)
- 感謝扔物線的 給 Android 開(kāi)發(fā)者的 RxJava 詳解幫了個(gè)大忙
感謝了這么多，其實(shí)大家如果把上面這些都看過(guò)了，一定會(huì)比我使用的好，而我這里也只是說(shuō)一下自己的所得罷了，歡迎大家一起分享，指點(diǎn)。
正文的正文
按照我的理解，其實(shí)看起來(lái)用的東西不少，可是真的用起來(lái)，還是不那么費(fèi)力的，我們就從基礎(chǔ)開(kāi)始，一步一步進(jìn)行吧（因?yàn)閰⒖剂松鲜龅奈恼?，所以也就使用了豆瓣Top250的接口）。
1、導(dǎo)包
既然想要使用，那么第一步自然就是需要將包導(dǎo)入進(jìn)來(lái)，導(dǎo)包的方法可以參見(jiàn)我之前的博客[android開(kāi)發(fā)相關(guān)——ButterKnife以及Android ButterKnife Zelezny]](http://www.itdecent.cn/p/bd3dcaf987bf)，與導(dǎo)入ButterKnife的方法相同，需要導(dǎo)入的包如下：
//retrofit
compile 'com.squareup.retrofit2:retrofit:2.3.0'
//rxjava
compile 'io.reactivex.rxjava2:rxjava:2.1.1'
//rxandroid
compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
//配合Rxjava 使用
compile 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'
//轉(zhuǎn)換器 將結(jié)果通過(guò)gson將json串轉(zhuǎn)換為model
compile 'com.squareup.retrofit2:converter-gson:2.3.0'
//GSON庫(kù)
compile 'com.google.code.gson:gson:2.8.1'
其中，gson庫(kù)，我前期測(cè)試了，可以不添加不過(guò)也算是常用庫(kù)，即便這部分沒(méi)有用到，但是后續(xù)的部分也或多或少會(huì)使用到，所以也添加了進(jìn)來(lái)。
轉(zhuǎn)換器部分，這里使用的就是gson，不過(guò)實(shí)際上retrofit2提供的轉(zhuǎn)換器遠(yuǎn)遠(yuǎn)不止gson一種：
上圖也僅僅只是其中一部分而已，不過(guò)在我們開(kāi)發(fā)中，基本的掌握gson即可，這里也就使用gson舉例了。
2、基礎(chǔ)使用
至于方法，大家看了如果看了上面的博客也就知道了，我也就不多賣(mài)關(guān)子，直接將代碼貼出來(lái)了
//請(qǐng)求接口
public interface MovieService {
@GET("top250")
Call<ResponseBody> getTopMovie(@Query("start") int start, @Query("count") int count);
}
//進(jìn)行網(wǎng)絡(luò)請(qǐng)求
private void getMovie() {
String baseUrl = "https://api.douban.com/v2/movie/";
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build();
MovieService movieService = retrofit.create(MovieService.class);
Call<ResponseBody> call = movieService.getTopMovie(0, 2);
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
try {
Log.i("response", response.body().string());
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
}
});
}
關(guān)于接口的解釋，我也就直接引用了：
說(shuō)明：定義了一個(gè)方法getTopMovie，使用get請(qǐng)求方式，加上@GET 標(biāo)簽，標(biāo)簽后面是這個(gè)接口的 尾址top250，完整的地址應(yīng)該是 baseUrl+尾址，參數(shù) 使用@Query標(biāo)簽，如果參數(shù)多的話可以用@QueryMap標(biāo)簽，接收一個(gè)Map
而方法調(diào)用，我是將其暫時(shí)放在了所需要請(qǐng)求網(wǎng)絡(luò)的Activity中（下一篇封裝部分再做處理），其中Retrofit的創(chuàng)建就不用說(shuō)了，傳入的參數(shù)共有兩個(gè)：
- baseUrl，也就是上面引用部分中完整的地址的組成部分之一，也就是說(shuō)尾址是在接口中賦值，而baseUrl是在調(diào)用的方法中賦值，是分開(kāi)的，而在正常的工程中，baseUrl也就是不變的部分，而尾址則是由于訪問(wèn)功能不同而隨之改變的部分。例如我們?cè)L問(wèn)搜狗搜索的時(shí)候，可以看到地址為：“https://www.sogou.com/”，而當(dāng)我們搜索資料的時(shí)候，可以看到地址變成了：
“https://www.sogou.com/web?query=半壽翁&ie=utf8&_ast=1500538240&_asf=null&w=01029901&p=40040100&dp=1&cid=&s_from=result_up&sut=1976&sst0=1500538301206&lkt=0%2C0%2C0&sugsuv=005D6320652C48B859337925D211D527&sugtime=1500538301206”
這其中“https://www.sogou.com/” 就可以理解為baseUrl，而“web”則是尾址，而“?”后面的部分，則是我們要傳遞的參數(shù)，也就是上面MovieService接口的抽象方法中，“@Query”后面的部分，參數(shù)與參數(shù)之間使用“&”區(qū)分開(kāi)。而這里的baseUrl就是“https://api.douban.com/v2/movie/” - addConverterFactory：按照字面理解就可以——添加轉(zhuǎn)換工廠，也就是我們前面導(dǎo)入的gson轉(zhuǎn)換器（或者大家想要使用的其他轉(zhuǎn)換器）
其后就是我們前面創(chuàng)建的接口MovieService的實(shí)例化，再就是創(chuàng)建Call方法，然后是Call的異步中得到返回的參數(shù)，而異步訪問(wèn)的結(jié)果自然是兩個(gè)，也就是兩個(gè)回調(diào)方法，成功/失敗。
當(dāng)然，這些都不重要，按部就班就可以，我要說(shuō)的部分是在Call方法的所攜帶的泛型，因?yàn)槲覀兦懊媸褂昧薵son將json串轉(zhuǎn)換為model，那么這里自然就需要兩個(gè)元素，json和我們將要轉(zhuǎn)換成什么樣model模板。
而這個(gè)泛型就是一個(gè)模板，我們可以將想要其轉(zhuǎn)換的bean傳入其中（bean不理解的可以參見(jiàn)我的博客《一個(gè)Android工程的從零開(kāi)始》-1前期準(zhǔn)備），至于bean如何能更方便的創(chuàng)建出來(lái)，請(qǐng)參見(jiàn)我的另一篇博客Android開(kāi)發(fā)相關(guān)——Log日志輸出顯示不完整以及GsonFormat。
我的代碼中使用的bean對(duì)象是OkHttp中提供的類，算是一個(gè)萬(wàn)能對(duì)象，不過(guò)一般不使用它，而是使用我們針對(duì)每一個(gè)接口調(diào)用專門(mén)創(chuàng)建的bean對(duì)象，這里使用它主要還是為了獲取json串，也就是response.body().string()方法。
3、基礎(chǔ)使用（POST）
前面說(shuō)的內(nèi)容是GET，這里說(shuō)的是POST，新手的話可以放心，基礎(chǔ)使用到這就結(jié)束了，沒(méi)有第三種了，至于GET與POST之間有什么區(qū)別，請(qǐng)看鏈接淺談HTTP中Get與Post的區(qū)別。
關(guān)于我使用的時(shí)候發(fā)現(xiàn)的問(wèn)題，那就是之前的項(xiàng)目中，使用GET時(shí)，出現(xiàn)過(guò)一次問(wèn)題，那就是使用GET傳遞中文字符的時(shí)候，服務(wù)器接受到的卻是亂碼，但是使用POST卻沒(méi)問(wèn)題，網(wǎng)上查的解決方法鏈接如下Android編程向服務(wù)器發(fā)送請(qǐng)求時(shí)出現(xiàn)中文亂碼問(wèn)題的解決方法，不過(guò)我還沒(méi)有嘗試過(guò)，如果遇到相同問(wèn)題的可以嘗試一下。
好了，關(guān)于GET和POST相關(guān)的內(nèi)容就先到這里，下面還是進(jìn)入到正題。
//請(qǐng)求接口
public interface IpService {
@FormUrlEncoded
@POST("getIpInfo.php")
// 1.4.通過(guò)@Field來(lái)指定key，后面跟上value
// Observable<ResponseBody> postIP(@Field("ip") String ip);
Call<ResponseBody> postIP(@Field("ip") String ip);
}
//網(wǎng)絡(luò)請(qǐng)求
private void postIp() {
String baseUrl = "http://192.168.31.242:8080/springmvc_users/user/";
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.build();
IpService ipService = retrofit.create(IpService.class);
Call<ResponseBody> call = ipService.postIP("202.202.32.202");
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
try {
LogUtil.info("response", response.body().string());
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
}
});
}
從上面代碼可以看出，實(shí)際上POST與GET的代碼基本大同小異，不過(guò)若說(shuō)細(xì)節(jié)上的差別，就是我在Service中添加了一個(gè)@FormUrlEncoded，至于為什么添加它，官網(wǎng)中是這么說(shuō)的
Form-encoded data is sent when @FormUrlEncoded is present on the method. Each key-value pair is annotated with @Field containing the name and the object providing the value
以我粗淺的英文水平翻譯過(guò)來(lái)就是“當(dāng)@FormUrlEncoded這個(gè)方法被調(diào)用是將發(fā)送被按照鍵值對(duì)格式編碼的數(shù)據(jù)，其中鍵是@Field后包含的名字，而值是提供來(lái)的數(shù)據(jù)”
Call<ResponseBody> postIP(@Field("ip") String ip);
所以這段代碼中，@Field("ip")引號(hào)中的ip就是鍵，而后面String類型的ip就是值。
4、集成RxJava
上面的基礎(chǔ)使用部分已經(jīng)結(jié)束了，不過(guò)目測(cè)沒(méi)有使用到RxJava，不過(guò)既然題目中已經(jīng)說(shuō)明有它了，那怎么也不能不帶人家玩不是，下面就把RxJava集成進(jìn)來(lái)。
至于為什么使用RxJava，它好在哪，大家只能在前面感謝的第六篇文章中自行尋找答案了。
由于GET與POST集成方法相差不多，這里就使用GET舉例，POST的大家自行替換一下即可。
//請(qǐng)求接口
public interface Movie2Service {
@GET("top250")
Observable<ResponseBody> getTop250(@Query("start") int start, @Query("count")int count);
}
//進(jìn)行網(wǎng)絡(luò)請(qǐng)求
private void getMovie2() {
String baseUrl = "https://api.douban.com/v2/movie/";
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.build();
Movie2Service movieService = retrofit.create(Movie2Service.class);
movieService.getTopMovie(10, 10)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Observer<ResponseBody>() {
@Override
public void onSubscribe(@NonNull Disposable d) {
}
@Override
public void onNext(@NonNull ResponseBody responseBody) {
try {
String responseString = responseBody.string();
Log.i("responseString", responseString);
LogUtil.info("response", responseString);
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void onError(@NonNull Throwable e) {
}
@Override
public void onComplete() {
}
});
}
可以看到，其實(shí)只不過(guò)是將Call換成了Observable而已，而回調(diào)方法從簡(jiǎn)單的成功/失敗，變成了當(dāng)前的四個(gè)，其功能，我們可以看一下源碼：
public interface Observer<T> {
/**
* Provides the Observer with the means of cancelling (disposing) the
* connection (channel) with the Observable in both
* synchronous (from within {@link #onNext(Object)}) and asynchronous manner.
* @param d the Disposable instance whose {@link Disposable#dispose()} can
* be called anytime to cancel the connection
* @since 2.0
*/
void onSubscribe(@NonNull Disposable d);
/**
* Provides the Observer with a new item to observe.
* <p>
* The {@link Observable} may call this method 0 or more times.
* <p>
* The {@code Observable} will not call this method again after it calls either {@link #onComplete} or
* {@link #onError}.
*
* @param t
* the item emitted by the Observable
*/
void onNext(@NonNull T t);
/**
* Notifies the Observer that the {@link Observable} has experienced an error condition.
* <p>
* If the {@link Observable} calls this method, it will not thereafter call {@link #onNext} or
* {@link #onComplete}.
*
* @param e
* the exception encountered by the Observable
*/
void onError(@NonNull Throwable e);
/**
* Notifies the Observer that the {@link Observable} has finished sending push-based notifications.
* <p>
* The {@link Observable} will not call this method if it calls {@link #onError}.
*/
void onComplete();
}
每個(gè)方法都對(duì)應(yīng)有注釋，后兩個(gè)就不用看了，分別是失敗以及完成，其前兩個(gè)的功能則是onSubscribe以及onNext，onSubscribe的作用，是負(fù)責(zé)與觀察者（Observer）斷開(kāi)鏈接的，而onNext則是為觀察者提供一個(gè)新的item來(lái)觀察，翻譯成現(xiàn)行標(biāo)準(zhǔn)普通話就是，網(wǎng)絡(luò)請(qǐng)求完畢的數(shù)據(jù)回調(diào)方法。
所以需要注意的是，這里的網(wǎng)絡(luò)請(qǐng)求結(jié)束的回調(diào)是onNext，而不是onComplete，onComplete是成功發(fā)送了消息后更新觀察者的，具體功能在網(wǎng)絡(luò)訪問(wèn)部分用不上，這里大家只要記住onNext就可以了。
至此，關(guān)于三者的配合使用也就算完成了，不過(guò)很顯然，從篇幅上看就能知道，這只是最簡(jiǎn)單的應(yīng)用，Retrofit中還包括文件的上傳下載等，還有一些其他的注意點(diǎn)，作為一個(gè)小菜鳥(niǎo)，實(shí)在難以在短短的時(shí)間內(nèi)融會(huì)貫通，再通過(guò)本篇博客展示出來(lái)，所以這里強(qiáng)烈建議有求知欲的戰(zhàn)友們看一下張鴻洋的Retrofit2 完全解析 探索與okhttp之間的關(guān)系。
