前言
之前做網路請求,用的是android-async-http,基於HttpClient 的,雖然早已淘汰,但一直懶得換,前一段時間看了stormzhang的《2016 Android Top 10 Library》文章,提到RxJava+Retrofit 是完美搭配,所以下定決定重構一下現在的專案
網上查了一些資料,遇到了一些小坎坷,終於搞定了,因為網上查到的一些文章大多都是半年以前的,而我使用的都是最新的庫,遇到了一些新的問題,所以感覺有必要寫篇文章幫助後人少走一些彎路
本文預設讀者對RxJava和Retrofit 已經有了一定的瞭解,若對RxJava和Retrofit 還不瞭解,請先查閱相關資料
##使用
1、新增依賴庫
compile "io.reactivex.rxjava2:rxjava:2.1.1"
compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
compile 'com.squareup.retrofit2:retrofit:2.3.0'
compile 'com.squareup.retrofit2:converter-gson:2.3.0'
compile 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'複製程式碼
converter-gson是Retrofit到Gson進行轉換的庫,adapter-rxjava2是Retrofit到RxJava進行轉換的庫
這裡我是採用Google Gson進行資料解析的,如果你使用的是Jackson,替換為如下依賴即可
compile 'com.squareup.retrofit2:converter-jackson:2.3.0'複製程式碼
如果需要新增HttpLoggingInterceptor進行除錯,新增如下依賴
compile 'com.squareup.okhttp3:logging-interceptor:3.8.1'複製程式碼
2、寫一個Service
public interface RetrofitService {
@FormUrlEncoded
@POST("account/login")
Observable<BaseEntity<UserInfo>> login(
@Field("userId") String userId,
@Field("password") String password
);
@GET("video/getUrl")
Observable<BaseEntity<VideoUrl>> getVideoUrl(
@Query("id") long id
);
@FormUrlEncoded
@POST("user/addVideo")
Observable<BaseEntity<Boolean>> addVideo(
@FieldMap Map<String, Object> map
);
}複製程式碼
相對於單獨使用Retrofit,該處返回的是Observable物件
3、通常伺服器端會返回統一的資料格式,這裡我們寫一個BaseEntity
public class BaseEntity<E> {
@SerializedName("code")
private int code;
@SerializedName("msg")
private String msg;
@SerializedName("data")
private E data;
public boolean isSuccess() {
return code == 0;
}
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public E getData() {
return data;
}
public void setData(E data) {
this.data = data;
}
}複製程式碼
4、然後我們可以封裝一個RetrofitFactory
public class RetrofitFactory {
private static final String BASE_URL = "http://api.baidu.com/";
private static final long TIMEOUT = 30;
// Retrofit是基於OkHttpClient的,可以建立一個OkHttpClient進行一些配置
private static OkHttpClient httpClient = new OkHttpClient.Builder()
// 新增通用的Header
.addInterceptor(new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Request.Builder builder = chain.request().newBuilder();
builder.addHeader("token", "123");
return chain.proceed(builder.build());
}
})
/*
這裡可以新增一個HttpLoggingInterceptor,因為Retrofit封裝好了從Http請求到解析,
出了bug很難找出來問題,新增HttpLoggingInterceptor攔截器方便除錯介面
*/
.addInterceptor(new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
@Override
public void log(String message) {
}
}).setLevel(HttpLoggingInterceptor.Level.BASIC))
.connectTimeout(TIMEOUT, TimeUnit.SECONDS)
.readTimeout(TIMEOUT, TimeUnit.SECONDS)
.build();
private static RetrofitService retrofitService = new Retrofit.Builder()
.baseUrl(BASE_URL)
// 新增Gson轉換器
.addConverterFactory(GsonConverterFactory.create(buildGson()))
// 新增Retrofit到RxJava的轉換器
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.client(httpClient)
.build()
.create(RetrofitService.class);
public static RetrofitService getInstance() {
return retrofitService;
}
private static Gson buildGson() {
return new GsonBuilder()
.serializeNulls()
.setFieldNamingPolicy(FieldNamingPolicy.IDENTITY)
// 此處可以新增Gson 自定義TypeAdapter
.registerTypeAdapter(UserInfo.class, new UserInfoTypeAdapter())
.create();
}
}複製程式碼
5、通常我們會在IO執行緒進行請求,在主執行緒進行回撥
public class RxSchedulers {
public static <T> ObservableTransformer<T, T> compose() {
return new ObservableTransformer<T, T>() {
@Override
public ObservableSource<T> apply(Observable<T> observable) {
return observable
.subscribeOn(Schedulers.io())
.doOnSubscribe(new Consumer<Disposable>() {
@Override
public void accept(Disposable disposable) throws Exception {
if (!Utils.isNetworkConnected()) {
Toast.makeText(context, R.string.toast_network_error, Toast.LENGTH_SHORT).show();
}
}
})
.observeOn(AndroidSchedulers.mainThread());
}
};
}
}複製程式碼
這裡我們可以新增一個通用的網路連線判斷
6、RxJava Observable 訂閱需要傳入一個Observer物件,此處封裝一個BaseObserver
public abstract class BaseObserver<T> implements Observer<BaseEntity<T>> {
private static final String TAG = "BaseObserver";
private Context mContext;
protected BaseObserver(Context context) {
this.mContext = context.getApplicationContext();
}
@Override
public void onSubscribe(Disposable d) {
}
@Override
public void onNext(BaseEntity<T> value) {
if (value.isSuccess()) {
T t = value.getData();
onHandleSuccess(t);
} else {
onHandleError(value.getMsg());
}
}
@Override
public void onError(Throwable e) {
Log.e(TAG, "error:" + e.toString());
}
@Override
public void onComplete() {
Log.d(TAG, "onComplete");
}
protected abstract void onHandleSuccess(T t);
protected void onHandleError(String msg) {
Toast.makeText(mContext, msg, Toast.LENGTH_SHORT).show();
}
}複製程式碼
7、呼叫
private void login(String userId, String password) {
Observable<BaseEntity<UserInfo>> observable = RetrofitFactory.getInstance().login(userId, password);
observable.compose(RxSchedulers.compose()).subscribe(new BaseObserver<UserInfo>(context) {
@Override
protected void onHandleSuccess(UserInfo userInfo) {
// 儲存使用者資訊等操作
}
});
}複製程式碼
RxJava生命週期管理
可以用RxLifecycle來管理RxJava的生命週期
RxLifecycle:github.com/trello/RxLi…
小結
重構之後發現Retrofit搭配RxJava之後,絕對是最好用的網路請求庫,沒有之一
如有問題,歡迎留言指正
Demo地址:github.com/jaycee88/Rx…