本文出處 :Tamic
文/ http://www.lxweimin.com/p/b1979c25634f
Rxjava +Rterofit 需要掌握的幾個技巧
RxJava入門和詳解請移步 比較有名的《RxJAVA詳解》，這里繼續前篇一系列的介紹一些容易忽略的技巧.
Retrofit+RxJava結合系列請閱讀：
取消訂閱
一般我們在視圖消亡后，無需RxJava再執行，可以直接取消訂閱
subscription.unsubscribe()
observable.unsubscribeOn(Schedulers.io());
可用在activity的 onDestroy(), Fragment的 onDestroyView()中調用
還有種場景是借助rxJava請求網絡數據，需要網絡返回后保存數據并更新UI，這種情況視圖已經消亡了必定會導致rxJava出錯，導致App閃退，這種我們可以判斷前的activity/view是否為空，并是否已showing，如果
兩者都不存在，即可無須更新UI。只處理保存數據即可。
訂閱問題
需要UI繪制后再進行訂閱的場景，防止阻塞UI，我們需要延遲訂閱執行。
立即訂閱;
observable
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(action);
延遲訂閱
observable.delay(2, TimeUnit.SECONDS)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(action);
基礎ApiService
通常我們寫接口會有以下定義，增加一個api就必須寫一個方法
public interface MyApi {
@GET("app.php")
Observable<SouguBean> getSougu(@Query("name") String name);
@GET("/getWeather")
Observable<ResponseBody> getWeather(@QueryMap Map<String, String> maps);
}
很多時候每新增一個接口就要寫一個api，是不是有很好的方法代替這種情況。
@GET()
<T> Observable<ResponseBody> get(
@Url String url,
@QueryMap Map<String, T> maps);
我們可以定義一個通用的getApi，將url動態傳入，返回Modle定義為ResponseBody， 并將實際參數定義為泛型，不管是更改url，還是服務端返回類型，包括參數個數都可以完美適配，這種方式技術不到位的千萬別用，因為Retrofit明確說明接口必須要給定明確類型，悠著點哈！
上層進行通用組裝時就可以這樣子:
public <T> T get(String url, Map<String, T> maps, BaseSubscriber<ResponseBody> subscriber) {
return (T) apiManager.get(url, maps)
.compose(schedulersTransformer)
.compose(handleErrTransformer())
.subscribe(subscriber);
}
看不懂？看不懂不算奇怪，源碼可以去文章末尾下載研究，這里只是列舉了一下。這種方式很適合從HttpClent遷移到Retrofit帶來接口適配問題，一用一個準啊…
基礎Subscriber
很多時候我們需要借用RxJava開啟多個observable去讀取網絡，這是我們對不同Subscriber處理起來比較麻煩，因此統一對Subscriber對網絡返回進行處理和， 有無網絡做判斷，甚至可以根據需求顯示加載進度等
構建抽象的BaseSubscribe類，只處理start()和onCompleted（） ，上層處理時只處理onError（）和onNext（）
/**
* BaseSubscriber
* Created by Tamic on 2016-7-15.
*/
public abstract class BaseSubscriber<T> extends Subscriber<T> {
private BaseActivity context;
public BaseSubscriber(BaseActivity context) {
this.context = context;
}
@Override
public void onStart() {
super.onStart();
if (!NetworkUtil.isNetworkAvailable(context)) {
Toast.makeText(context, "當前網絡不可用，請檢查網絡情況", Toast.LENGTH_SHORT).show();
// **一定要主動調用下面這一句**
onCompleted();
return;
}
// 顯示進度條
showLoadingProgress();
}
@Override
public void onCompleted() {
//關閉等待進度條
closeLoadingProgress();
}
}
這樣我們上層調用時只關心成功和失敗即可，無需再關心網絡情況
```
observable..subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new BaseSubscriber<ResponseBody>(MainActivity.this) {
@Override
public void onError(Throwable e) {
Toast.makeText(MainActivity.this, e.getMessage(), Toast.LENGTH_LONG).show();
}
@Override
public void onNext(ResponseBody responseBody) {
Toast.makeText(MainActivity.this, responseBody.toString(), Toast.LENGTH_LONG).show();
}
});
);
如果想對Error錯誤統一處理，也可以在BaseSubscriber處理onError(), 然后回調搭到callback上層，具體看自己項目情況而定，可以接著往下看
如果對成功結果進行處理，則可以將ResonseBody加入泛型<Response<T>> , Response一般是包含Code，MSg， Data的，在這里你可以根據判斷code來進行業務分發，代碼很簡單，具體看文章結尾源碼即可
如果你覺得目前的返回判斷麻煩，也可以定義Response基類
/**
* 網絡返回基類 支持泛型
* Created by Tamic on 2016-06-06.
*/
public class BaseResponse<T> {
private int code;
private String msg;
private T data;
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 T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
public boolean isOk() {
return code == 0;
}
}
這樣我們在onNext() 只需統一判斷狀態碼即可
@Override
public void onNext(BaseResponse<IpResult> responseBody) {
if (responseBody.isOk()) {
//這里這個ok不是http訪問的ok，
//是和服務器約定好的成功碼 有的人不喜歡可以不用加這個篩選， 也有的人喜歡將業務加到業務回調中，如果不是成功碼 也//不走錯誤回調，也不走成功回調，直走業務回調
IpResult ip = responseBody.getData();
Toast.makeText(MainActivity.this, ip.toString(), Toast.LENGTH_LONG).show();
}
}
錯誤結果問題
通過RXJva的 Func1來進行對原始的Throwable 進行包裝轉換
我們將原來Throwable 強轉成自定義的 ResponeThrowable；
private static class HttpResponseFunc《T》 implements Func1《Throwable, Observable《T》》 {
@Override public Observable<T> call(Throwable t) {
return Observable.error(ExceptionHandle.handleException(t));
}
}
ResponeThrowable
public static class ResponeThrowable extends Exception {
public int code;
public String message;
public ResponeThrowable(Throwable throwable, int code) {
super(throwable);
this.code = code;
}
}
我們已經處理好強轉工作后 繼續把 Func1加到Observable 中：
因此這樣用observable提供的onErrorResumeNext 則可以將你自定義的Func1 關聯到錯誤處理類中：
((Observable) observable).onErrorResumeNext(new HttpResponseFunc<T>());
很可能你感覺有點不理解，這前提你需要了解RxJava的轉義符和操 Observable.Transformer
還有Func1
這樣我們對服務器返回的錯誤狀態進行了自我的處理，再稍加翻譯下便可以達到用戶看懂的語言
這個類我參考一葉扁舟同學的案列，我再次做了改進：
ExceptionHandle 錯誤處理驅動
public class ExceptionHandle {
private static final int UNAUTHORIZED = 401;
private static final int FORBIDDEN = 403;
private static final int NOT_FOUND = 404;
private static final int REQUEST_TIMEOUT = 408;
private static final int INTERNAL_SERVER_ERROR = 500;
private static final int BAD_GATEWAY = 502;
private static final int SERVICE_UNAVAILABLE = 503;
private static final int GATEWAY_TIMEOUT = 504;
public static ResponeThrowable handleException(Throwable e) {
ResponeThrowable ex;
if (e instanceof HttpException) {
HttpException httpException = (HttpException) e;
ex = new ResponeThrowable(e, ERROR.HTTP_ERROR);
switch (httpException.code()) {
case UNAUTHORIZED:
case FORBIDDEN:
case NOT_FOUND:
case REQUEST_TIMEOUT:
case GATEWAY_TIMEOUT:
case INTERNAL_SERVER_ERROR:
case BAD_GATEWAY:
case SERVICE_UNAVAILABLE:
default:
ex.message = "網絡錯誤";
break;
}
return ex;
} else if (e instanceof ServerException) {
ServerException resultException = (ServerException) e;
ex = new ResponeThrowable(resultException, resultException.code);
ex.message = resultException.message;
return ex;
} else if (e instanceof JsonParseException
|| e instanceof JSONException
|| e instanceof ParseException) {
ex = new ResponeThrowable(e, ERROR.PARSE_ERROR);
ex.message = "解析錯誤";
return ex;
} else if (e instanceof ConnectException) {
ex = new ResponeThrowable(e, ERROR.NETWORD_ERROR);
ex.message = "連接失敗";
return ex;
} else if (e instanceof javax.net.ssl.SSLHandshakeException) {
ex = new ResponeThrowable(e, ERROR.SSL_ERROR);
ex.message = "證書驗證失敗";
return ex;
}
else {
ex = new ResponeThrowable(e, ERROR.UNKNOWN);
ex.message = "未知錯誤";
return ex;
}
}
/**
* 約定異常
*/
class ERROR {
/**
* 未知錯誤
*/
public static final int UNKNOWN = 1000;
/**
* 解析錯誤
*/
public static final int PARSE_ERROR = 1001;
/**
* 網絡錯誤
*/
public static final int NETWORD_ERROR = 1002;
/**
* 協議出錯
*/
public static final int HTTP_ERROR = 1003;
/**
* 證書出錯
*/
public static final int SSL_ERROR = 1005;
}
public static class ResponeThrowable extends Exception {
public int code;
public String message;
public ResponeThrowable(Throwable throwable, int code) {
super(throwable);
this.code = code;
}
}
public class ServerException extends RuntimeException {
public int code;
public String message;
}
}
接著可以在 BaseSubscriber<T>中處理異常拉
public abstract class BaseSubscriber<T> extends Subscriber<T> {
private Context context;
public BaseSubscriber(Context context) {
this.context = context;
}
@Override
public void onError(Throwable e) {
Log.e("Tamic", e.getMessage());
// todo error somthing
if(e instanceof ExceptionHandle.ResponeThrowable){
onError((ExceptionHandle.ResponeThrowable)e);
} else {
onError(new ExceptionHandle.ResponeThrowable(e, ExceptionHandle.ERROR.UNKNOWN));
}
}
}
最后上層調用就是這樣了：
RetrofitClient.getInstance(MainActivity.this).createBaseApi().getData(new BaseSubscriber<IpResult>(MainActivity.this) {
@Override
public void onError(ResponeThrowable e) {
// 處理翻譯后異常。
Log.e("Tamic", e.code + " "+ e.message);
Toast.makeText(MainActivity.this, e.message, Toast.LENGTH_LONG).show();
}
@Override
public void onNext(IpResult responseBody) {
Toast.makeText(MainActivity.this, responseBody.toString(), Toast.LENGTH_LONG).show();
}
}, "21.22.11.33");
值的注意的是上層使用BaseSubscriber 的實現類和子類即可，如果你想要重寫BaseSubscriber 的onStat（）和onCompleted() 也是可以的， 一般BaseSubscriber只處理公用的處理，或者進行下業務對返回格式檢查，具體成功
解析有他的子類（實現類）去做。
注意：如果你不想將業務分發加到錯誤回調中，也可以這樣做: 好比有的人喜歡將業務處理加到業務回調中，如果后臺返回的業務碼并不成功碼的情況下， 不想走錯誤回調，也不想走成功回調， 想走直走業務回調。
可以這樣處理：
在onNext() 中回調一個自定義的抽象的onBusiness(code, masg)，將他的子類去實現
@Override
public void onNext(BaseResponse<IpResult> responseBody) {
if (!responseBody.isOk()) {
//業務分發
onBusiness(responseBody.getCode, responseBody.getMsg)
} else {
// 成功回調
onNext(responseBody.getData())
}
}
緩存問題
公共緩存：
有時候需要在無網絡時增加緩存功能，因此給Retrofit加入基礎攔截器，來處理緩存問題
/**
* BaseInterceptor
* Created by Tamic on 2016-7-15.
*/
public class BaseInterceptor implements Interceptor{
private Map<String, String> headers;
private Context context;
public BaseInterceptor(Map<String, String> headers, Context context) {
this.headers = headers;
this.context = context;
}
@Override
public Response intercept(Chain chain) throws IOException {
Request.Builder builder = chain.request()
.newBuilder();
builder.cacheControl(CacheControl.FORCE_CACHE).url(chain.request().url())
.build();
if (!NetworkUtil.isNetworkAvailable(context)) {
((Activity)context).runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(context, "當前無網絡!", Toast.LENGTH_SHORT).show();
}
});
}
if (headers != null && headers.size() > 0) {
Set<String> keys = headers.keySet();
for (String headerKey : keys) {
builder.addHeader(headerKey, headers.get(headerKey)).build();
}
}
if (NetworkUtil.isNetworkAvailable(context)) {
int maxAge = 60; // read from cache for 60 s
builder
.removeHeader("Pragma")
.addHeader("Cache-Control", "public, max-age=" + maxAge)
.build();
} else {
int maxStale = 60 * 60 * 24 * 14; // tolerate 2-weeks stale
builder
.removeHeader("Pragma")
.addHeader("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
.build();
}
return chain.proceed(builder.build());
}
}
okHttpClient加入攔截器
okHttpClient = new OkHttpClient.Builder()
.addInterceptor(new BaseInterceptor(headers))
.addInterceptor(new CaheInterceptor(context))
.addNetworkInterceptor(new CaheInterceptor(context))
.build();
Retrofit 加入okhttpClient
retrofit = new Retrofit.Builder()
.client(okHttpClient)
.baseUrl(url)
.build();
單獨緩存：
如果你不想加入公共緩存，想單獨對某個api進行緩存，可用Headers來實現，那么可以這樣：
@Headers("Cache-Control : public, max-age = 3600")
@GET("service/getIpInfo.php")
Observable<BaseResponse<IpResult>> getData(@Query("ip") String ip);
值得注意的是 下面的兩句話也必須加入：
.addInterceptor(new CaheInterceptor(context))
.addNetworkInterceptor(new CaheInterceptor(context))
緩存路徑和默認大小
如果想更改okhttp的緩存路勁，可以設置cache的path路徑 ，姿勢如下
Cache cache = new Cache(httpCacheDirectory, 10 * 1024 * 1024);
第一個參數是路徑，第二個最大緩存大小
okHttpClient = new OkHttpClient.Builder()
.cache(cache)
.build();
這樣就加入自定義的Cache策略
自定義緩存
如果你不想用okhttp自帶的緩存策略，因為這需要服務端配合處理緩存請求頭，不然會拋出： HTTP 504 Unsatisfiable Request (only-if-cached)
除了以上修改 Request.cacheControl的方式實現緩存，也可以自定義一個Cahe策略用來實現本地硬緩存。
構建CaheManager，用Url對應Json實現，此類非常簡單，你可以自己實現，時間策略可自我加入擴展
在BaseSubscriber進行網絡判斷，加載緩存數據返回妥妥的；
@Override
public void onStart() {
super.onStart();
Toast.makeText(context, "http is start", Toast.LENGTH_SHORT).show();
// todo some common as show loadding and check netWork is NetworkAvailable
// if NetworkAvailable no ! must to call onCompleted
if (!NetworkUtil.isNetworkAvailable(context)) {
Toast.makeText(context, "無網絡", Toast.LENGTH_SHORT).show();
if (isNeedCahe) {
Toast.makeText(context, "無網絡，已智能讀取緩存！", Toast.LENGTH_SHORT).show();
IpResult ipResult = new Gson().fromJson(CaheManager.getjson(url), IpResult.class);
onNext((T) ipResult);
}
onCompleted();
}
}
總結
通過這次的整理，再進行RxJava和Retrofit中 ，所有坑直接添就行，接著上次的介紹，筆者進行新框架開發novate已快接近尾聲，估計本月就能和大家見面，敬請繼續關注！
Retrofit 2.0系列請閱讀
第一時間獲取技術文章請關注掃碼微信公眾號！
