先扯兩句
好了,上一篇閒扯過後,算是將我爲什麼會把Retrofit說出來了吧(雖然好像什麼都沒說),當然還有其他框架,作爲一個懶人,我這裏就不加以闡述了,還是進入整體,開始進入我們的使用的部分。
還是先上我的Git庫
MyBaseApplication (https://github.com/BanShouWeng/MyBaseApplication)
並給大家展示個神器,叫Android知識點——目錄,好了,閒言少敘,下面進入正題。
正文
這麼快進正文還真不太適應,那就先感謝一波吧:
- 感謝依然範特稀西的Retrofit + RxJava + OkHttp 讓網絡請求變的簡單-基礎篇幫了個大忙;
- 感謝依然範特稀西的Retrofit + RxJava + OkHttp 讓網絡請求變的簡單-封裝篇幫了個大忙;
- 感謝tough1985的RxJava 與 Retrofit 結合的最佳實踐幫了個大忙
- 感謝張鴻洋的Retrofit2 完全解析 探索與okhttp之間的關係幫了個大忙
- Retrofit官網
- 感謝扔物線的 給 Android 開發者的 RxJava 詳解幫了個大忙
感謝了這麼多,其實大家如果把上面這些都看過了,一定會比我使用的好,而我這裏也只是說一下自己的所得罷了,歡迎大家一起分享,指點。
正文的正文
按照我的理解,其實看起來用的東西不少,可是真的用起來,還是不那麼費力的,我們就從基礎開始,一步一步進行吧(因爲參考了上述的文章,所以也就使用了豆瓣Top250的接口)。
1、導包
既然想要使用,那麼第一步自然就是需要將包導入進來,導包的方法可以參見我之前的博客[android開發相關——ButterKnife以及Android ButterKnife Zelezny]](http://blog.csdn.net/u010513377/article/details/75022649),與導入ButterKnife的方法相同,需要導入的包如下:
//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'
//轉換器 將結果通過gson將json串轉換爲model
compile 'com.squareup.retrofit2:converter-gson:2.3.0'
//GSON庫
compile 'com.google.code.gson:gson:2.8.1'
其中,gson庫,我前期測試了,可以不添加不過也算是常用庫,即便這部分沒有用到,但是後續的部分也或多或少會使用到,所以也添加了進來。
轉換器部分,這裏使用的就是gson,不過實際上retrofit2提供的轉換器遠遠不止gson一種:
上圖也僅僅只是其中一部分而已,不過在我們開發中,基本的掌握gson即可,這裏也就使用gson舉例了。
2、基礎使用(GET)
至於方法,大家看了如果看了上面的博客也就知道了,我也就不多賣關子,直接將代碼貼出來了
//請求接口
public interface MovieService {
@GET("top250")
Call<ResponseBody> getTopMovie(@Query("start") int start, @Query("count") int count);
}
//進行網絡請求
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) {
}
});
}
關於接口的解釋,我也就直接引用了:
說明:定義了一個方法getTopMovie,使用get請求方式,加上@GET 標籤,標籤後面是這個接口的 尾址top250,完整的地址應該是 baseUrl+尾址,參數 使用@Query標籤,如果參數多的話可以用@QueryMap標籤,接收一個Map
而方法調用,我是將其暫時放在了所需要請求網絡的Activity中(下一篇封裝部分再做處理),其中Retrofit的創建就不用說了,傳入的參數共有兩個:
- baseUrl,也就是上面引用部分中完整的地址的組成部分之一,也就是說尾址是在接口中賦值,而baseUrl是在調用的方法中賦值,是分開的,而在正常的工程中,baseUrl也就是不變的部分,而尾址則是由於訪問功能不同而隨之改變的部分。例如我們訪問搜狗搜索的時候,可以看到地址爲:“https://www.sogou.com/”,而當我們搜索資料的時候,可以看到地址變成了:
“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”則是尾址,而“?”後面的部分,則是我們要傳遞的參數,也就是上面MovieService接口的抽象方法中,“@Query”後面的部分,參數與參數之間使用“&”區分開。而這裏的baseUrl就是“https://api.douban.com/v2/movie/” - addConverterFactory:按照字面理解就可以——添加轉換工廠,也就是我們前面導入的gson轉換器(或者大家想要使用的其他轉換器)
其後就是我們前面創建的接口MovieService的實例化,再就是創建Call方法,然後是Call的異步中得到返回的參數,而異步訪問的結果自然是兩個,也就是兩個回調方法,成功/失敗。
當然,這些都不重要,按部就班就可以,我要說的部分是在Call方法的所攜帶的泛型,因爲我們前面使用了gson將json串轉換爲model,那麼這裏自然就需要兩個元素,json和我們將要轉換成什麼樣model模板。
而這個泛型就是一個模板,我們可以將想要其轉換的bean傳入其中(bean不理解的可以參見我的博客《一個Android工程的從零開始》-1前期準備),至於bean如何能更方便的創建出來,請參見我的另一篇博客Android開發相關——Log日誌輸出顯示不完整以及GsonFormat。
我的代碼中使用的bean對象是OkHttp中提供的類,算是一個萬能對象,不過一般不使用它,而是使用我們針對每一個接口調用專門創建的bean對象,這裏使用它主要還是爲了獲取json串,也就是response.body().string()方法。
3、基礎使用(POST)
前面說的內容是GET,這裏說的是POST,新手的話可以放心,基礎使用到這就結束了,沒有第三種了,至於GET與POST之間有什麼區別,請看鏈接淺談HTTP中Get與Post的區別。
關於我使用的時候發現的問題,那就是之前的項目中,使用GET時,出現過一次問題,那就是使用GET傳遞中文字符的時候,服務器接受到的卻是亂碼,但是使用POST卻沒問題,網上查的解決方法鏈接如下Android編程向服務器發送請求時出現中文亂碼問題的解決方法,不過我還沒有嘗試過,如果遇到相同問題的可以嘗試一下。
好了,關於GET和POST相關的內容就先到這裏,下面還是進入到正題。
//請求接口
public interface IpService {
@FormUrlEncoded
@POST("getIpInfo.php")
// 1.4.通過@Field來指定key,後面跟上value
// Observable<ResponseBody> postIP(@Field("ip") String ip);
Call<ResponseBody> postIP(@Field("ip") String ip);
}
//網絡請求
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) {
}
});
}
從上面代碼可以看出,實際上POST與GET的代碼基本大同小異,不過若說細節上的差別,就是我在Service中添加了一個@FormUrlEncoded,至於爲什麼添加它,官網中是這麼說的
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
以我粗淺的英文水平翻譯過來就是“當@FormUrlEncoded這個方法被調用是將發送被按照鍵值對格式編碼的數據,其中鍵是@Field後包含的名字,而值是提供來的數據”
Call<ResponseBody> postIP(@Field("ip") String ip);
所以這段代碼中,@Field(“ip”)引號中的ip就是鍵,而後面String類型的ip就是值。
4、集成RxJava
上面的基礎使用部分已經結束了,不過目測沒有使用到RxJava,不過既然題目中已經說明有它了,那怎麼也不能不帶人家玩不是,下面就把RxJava集成進來。
至於爲什麼使用RxJava,它好在哪,大家只能在前面感謝的第六篇文章中自行尋找答案了。
由於GET與POST集成方法相差不多,這裏就使用GET舉例,POST的大家自行替換一下即可。
//請求接口
public interface Movie2Service {
@GET("top250")
Observable<ResponseBody> getTop250(@Query("start") int start, @Query("count")int count);
}
//進行網絡請求
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() {
}
});
}
可以看到,其實只不過是將Call換成了Observable而已,而回調方法從簡單的成功/失敗,變成了當前的四個,其功能,我們可以看一下源碼:
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();
}
每個方法都對應有註釋,後兩個就不用看了,分別是失敗以及完成,其前兩個的功能則是onSubscribe以及onNext,onSubscribe的作用,是負責與觀察者(Observer)斷開鏈接的,而onNext則是爲觀察者提供一個新的item來觀察,翻譯成現行標準普通話就是,網絡請求完畢的數據回調方法。
所以需要注意的是,這裏的網絡請求結束的回調是onNext,而不是onComplete,onComplete是成功發送了消息後更新觀察者的,具體功能在網絡訪問部分用不上,這裏大家只要記住onNext就可以了。
至此,關於三者的配合使用也就算完成了,不過很顯然,從篇幅上看就能知道,這只是最簡單的應用,Retrofit中還包括文件的上傳下載等,還有一些其他的注意點,作爲一個小菜鳥,實在難以在短短的時間內融會貫通,再通過本篇博客展示出來,所以這裏強烈建議有求知慾的戰友們看一下張鴻洋的Retrofit2 完全解析 探索與okhttp之間的關係。