背景
在之前的封裝1-5Rxjava+ReTrofit+okHttp深入淺出-終極封裝中我們都是通過傳統的GsonConverterFactory自動解析,這樣做確實很方便,用戶能直接獲取返回的對象,不用關心具體的轉換,但是:這隨之而來有很多的缺陷(雖然官網推薦這樣使用);
比如:無法使用其他第三發轉換框架;泛型無法中間傳遞,封裝無法統一處理緩存結果;回調信息無法統一處理;服務器返回格式不嚴謹null解析異常……….
所以我們在享受它遍歷的同時也被迫的要限制做很多的處理,限制我們的擴展!
本章就介紹如何放棄GsonConverterFactory,直接返回String,擴展我們的封裝!(封裝的整體思想和之前的封裝一樣,所以不會有大的改動!)
無須擔心,本篇封裝單獨作為一個項目和之前封裝分開,便于大家選擇!
效果
功能
完全具備和之前封裝一樣的功能,這里改用fastjson處理
1.Retrofit+Rxjava+okhttp基本使用方法
2.統一處理請求數據格式
3.統一的ProgressDialog和回調Subscriber處理
4.取消http請求
5.預處理http請求
6.返回數據的統一判斷
7.失敗后的retry處理
8.RxLifecycle管理生命周期,防止泄露
9.文件上傳下載(支持多文件,斷點續傳)
10.Cache數據持久化和數據庫(greenDao)兩種緩存機制
11.一對多回調接口處理
對比
話說沒有比較就沒有進步,所以大家比較下前后封裝的各自的優缺點,自行選擇合適自己的方案!
使用
Gson方案:
// 完美封裝簡化版
private void simpleDo() {
SubjectPostApi postEntity = new SubjectPostApi(simpleOnNextListener,this);
postEntity.setAll(true);
HttpManager manager = HttpManager.getInstance();
manager.doHttpDeal(postEntity);
}
// 回調一一對應
HttpOnNextListener simpleOnNextListener = new HttpOnNextListener<List<SubjectResulte>>() {
@Override
public void onNext(List<SubjectResulte> subjects) {
tvMsg.setText("網絡返回:\n" + subjects.toString());
}
@Override
public void onCacheNext(String cache) {
/*緩存回調*/
Gson gson=new Gson();
java.lang.reflect.Type type = new TypeToken<BaseResultEntity<List<SubjectResulte>>>() {}.getType();
BaseResultEntity resultEntity= gson.fromJson(cache, type);
tvMsg.setText("緩存返回:\n"+resultEntity.getData().toString() );
}
/*用戶主動調用,默認是不需要覆寫該方法*/
@Override
public void onError(Throwable e) {
super.onError(e);
tvMsg.setText("失敗:\n" + e.toString());
}
/*用戶主動調用,默認是不需要覆寫該方法*/
@Override
public void onCancel() {
super.onCancel();
tvMsg.setText("取消請求");
}
};
String方案
// 完美封裝簡化版
private void simpleDo() {
/*初始化數據*/
manager=new HttpManager(this,this);
postEntity = new SubjectPostApi();
postEntity.setAll(true);
manager.doHttpDeal(postEntity);
}
@Override
public void onNext(String resulte, String mothead) {
/*post返回處理*/
if(mothead.equals(postEntity.getMothed())){
List<SubjectResulte> subjectResulte= JSONObject.parseArray(resulte,SubjectResulte.class);
tvMsg.setText("post返回:\n"+subjectResulte.toString() );
}
/*上傳返回處理*/
if(mothead.equals(uplaodApi.getMothed())){
UploadResulte uploadResulte=JSONObject.parseObject(resulte,UploadResulte.class);
tvMsg.setText("上傳成功返回:\n"+uploadResulte.getHeadImgUrl());
Glide.with(MainActivity.this).load(uploadResulte.getHeadImgUrl()).skipMemoryCache(true).into(img);
}
}
@Override
public void onError(Throwable e) {
tvMsg.setText("失敗:\n" + e.toString());
}
Gson封裝方案中,我們采用了一一對應的返回原則,將所以的請求數據參數都放入到baseApi中,返回放入對應的HttpOnNextListener 中
String方案中我們則采用一對多原則,將回調和請求分開處理,公用一個回調,通過回調中的mothead來區分不同的接口,所以上述可以看見后者里面其實還處理了上傳的回調處理!
從封裝的用法上可以看出:
優點:String封裝更加的靈活,可以指定Gson轉換的第三方工具,統一的結果返回處理代碼更加的少(可以完美解決緩存無法統一回調的問題);
同樣也有缺點:String封裝無法自動解析結果類型,需要手動處理(我反而覺得這也是它的優點,更加的靈活,個人看法)
實現
由于是基于之前的封裝修改,所以前提是了解之前的封裝以后才能完全了解一下的修改實現思路RxJava+Retrofit+OkHttp深入淺出-終極封裝專欄
1.替換GsonConverterFactory
由于GsonConverterFactory會自動解析Gson,替換成直接返回String的ScalarsConverterFactory
導入相關包(為了區別-使用fastjson可自由擴展)
compile 'com.squareup.retrofit2:converter-scalars:+'
compile 'com.alibaba:fastjson:+'
替換
compile 'com.squareup.retrofit2:converter-gson:+'
compile 'com.google.code.gson:gson:+'
2.修改retrofit構建
ScalarsConverterFactory替換GsonConverterFactory
/*創建retrofit對象*/
Retrofit retrofit = new Retrofit.Builder()
.client(builder.build())
.addConverterFactory(ScalarsConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.baseUrl(basePar.getBaseUrl())
.build();
HttpService httpService = retrofit.create(HttpService.class);
替換
/*創建retrofit對象*/
Retrofit retrofit = new Retrofit.Builder()
.client(builder.build())
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.baseUrl(basePar.getBaseUrl())
.build();
HttpService httpService = retrofit.create(HttpService.class);
3.修改緩存記錄位置
由于之前是為了防止gson重復解析,將緩存放入到自定義CookieInterceptor中;既然現在不需要自動轉換,直接返回String,所以直接將緩存數據處理放入到ProgressSubscriber的onNext中處理;
修改1:去掉CookieInterceptor
//手動創建一個OkHttpClient并設置超時時間緩存等設置
OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.addInterceptor(new CacheInterceptor());
builder.addNetworkInterceptor(new CacheInterceptor());
替換
//手動創建一個OkHttpClient并設置超時時間緩存等設置
OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.addNetworkInterceptor(new CacheInterceptor());
builder.addInterceptor(new CookieInterceptor(basePar.isCache()));
修改2:實現緩存處理
在onNext中實現緩存處理
/**
* 將onNext方法中的返回結果交給Activity或Fragment自己處理
*
* @param t 創建Subscriber時的泛型類型
*/
@Override
public void onNext(T t) {
/*緩存處理*/
if(api.isCache()){
CookieResulte resulte= CookieDbUtil.getInstance().queryCookieBy(api.getUrl());
long time=System.currentTimeMillis();
/*保存和更新本地數據*/
if(resulte==null){
resulte =new CookieResulte(api.getUrl(),t.toString(),time);
CookieDbUtil.getInstance().saveCookie(resulte);
}else{
resulte.setResulte(t.toString());
resulte.setTime(time);
CookieDbUtil.getInstance().updateCookie(resulte);
}
}
if (mSubscriberOnNextListener.get() != null) {
mSubscriberOnNextListener.get().onNext((String) t,api.getMothed());
}
}
4.修改回調接口信息
由于現在通過String直接返回,所以可以將成功回調和緩存回調合并處理;另一方面沒有了泛型的限制,在回調時可以通過接口請求參數實現一對多回調處理;
/**
* 成功回調處理
* Created by WZG on 2016/7/16.
*/
public interface HttpOnNextListener {
/**
* 成功后回調方法
* @param resulte
* @param method
*/
void onNext(String resulte,String method);
/**
* 失敗或者錯誤方法
* 主動調用,更加靈活
* @param e
*/
void onError(Throwable e);
}
5.修改BaseApi
由于取消了泛型返回的機制,所以在Func1判斷時需要手動轉換數據;這里示例fastjeson用法轉換
@Override
public String call(T httpResult) {
BaseResultEntity baseResulte= JSONObject.parseObject(httpResult.toString(),BaseResultEntity.class);
if (baseResulte.getRet() == 0) {
throw new HttpTimeException(baseResulte.getMsg());
}
return baseResulte.getData();
}
替換
@Override
public T call(BaseResultEntity<T> httpResult) {
if (httpResult.getRet() == 0) {
throw new HttpTimeException(httpResult.getMsg());
}
return httpResult.getData();
}
6.修改結果基礎類BaseResultEntity
將泛型數據改成String數據類型
/**
* 回調信息統一封裝類
* Created by WZG on 2016/7/16.
*/
public class BaseResultEntity {
// 判斷標示
private int ret;
// 提示信息
private String msg;
//顯示數據(用戶需要關心的數據)
private String data;
}
替換
/**
* 回調信息統一封裝類
* Created by WZG on 2016/7/16.
*/
public class BaseResultEntity<T> {
// 判斷標示
private int ret;
// 提示信息
private String msg;
//顯示數據(用戶需要關心的數據)
private T data;
}
7.合并緩存和成功回到返回處理
由于取消泛型,緩存和成統一處理所以需要修改
/**
* 訂閱開始時調用
* 顯示ProgressDialog
*/
@Override
public void onStart() {
showProgressDialog();
/*緩存并且有網*/
if(api.isCache()&& AppUtil.isNetworkAvailable(MyApplication.app)){
/*獲取緩存數據*/
CookieResulte cookieResulte= CookieDbUtil.getInstance().queryCookieBy(api.getUrl());
if(cookieResulte!=null){
long time= (System.currentTimeMillis()-cookieResulte.getTime())/1000;
if(time< api.getCookieNetWorkTime()){
if( mSubscriberOnNextListener.get()!=null){
mSubscriberOnNextListener.get().onNext(cookieResulte.getResulte(),api.getMothed());
}
onCompleted();
unsubscribe();
}
}
}
}
替換
/**
* 訂閱開始時調用
* 顯示ProgressDialog
*/
@Override
public void onStart() {
showProgressDialog();
/*緩存并且有網*/
if(api.isCache()&& AppUtil.isNetworkAvailable(MyApplication.app)){
/*獲取緩存數據*/
CookieResulte cookieResulte= CookieDbUtil.getInstance().queryCookieBy(api.getUrl());
if(cookieResulte!=null){
long time= (System.currentTimeMillis()-cookieResulte.getTime())/1000;
if(time< api.getCookieNetWorkTime()){
if( mSubscriberOnNextListener.get()!=null){
mSubscriberOnNextListener.get().onCacheNext(cookieResulte.getResulte());
}
onCompleted();
unsubscribe();
}
}
}
}
8.修改一對多回調處理
沒有了泛型,可以修改HttpManager,采用動態創建,動態回調的方法解決多嵌套耦合的問題
修改1:去掉默認構造傳參
public BaseApi(HttpOnNextListener listener, RxAppCompatActivity rxAppCompatActivity) {
setListener(listener);
setRxAppCompatActivity(rxAppCompatActivity);
setShowProgress(true);
setCache(true);
}
修改2:添加HttpManager動態傳參
/**
* http交互處理類
* Created by WZG on 2016/7/16.
*/
public class HttpManager {
/*弱引用對象*/
private SoftReference<HttpOnNextListener> onNextListener;
private SoftReference<RxAppCompatActivity> appCompatActivity;
public HttpManager(HttpOnNextListener onNextListener, RxAppCompatActivity appCompatActivity) {
this.onNextListener=new SoftReference(onNextListener);
this.appCompatActivity=new SoftReference(appCompatActivity);
}
*******************
*******************
}
修改3:通過method動態判斷接口返回
public class MainActivity extends RxAppCompatActivity implements HttpOnNextListener{
@Override
public void onNext(String resulte, String method) {
/*post返回處理*/
if(method.equals(postEntity.getMothed())){
*******
}
/*上傳返回處理*/
if(method.equals(uplaodApi.getMothed())){
*********
}
}
@Override
public void onError(Throwable e) {
tvMsg.setText("失敗:\n" + e.toString());
}
}
大功告成!
下載模塊
由于下載模塊是獨立存在,所以基本沒有修改,唯一修改的地方就是將HttpDownManager中的GsonConverterFactory替換成ScalarsConverterFactory即可!
總結
通過自定義String類型的返回處理方式,有效的解決了之前Gson自動轉換的問題
1.一對一返回問題(代碼量多)
2.緩存回調無法和成功統一處理
3.無法指定gson轉換第三方庫
4.回調監聽的多嵌套(耦合度大)
5.解決服務器數據null異常
注意:這里只是給大家提供了一個不同的解決方案,Gson自動解析返回的方案也是有它的優點,可以大大的減少開發的工作量,優缺點也很明顯;孰好孰壞自行判斷,自行選擇適合自己的方案(個人偏向后者String返回,比較靈活)
源碼
源碼傳送門-String變種方案-Github
源碼傳送門-Gson方案-Github