基於RxJava2+Retrofit+RxCache的網絡請求封裝 | 掘金技術徵文

時間  2019-11-16
標籤 基於 rxjava2+retrofit+rxcache rxjava retrofit rxcache 網絡 請求 封裝 技術 徵文 欄目 Java 简体版
原文   原文鏈接

　　這套框架來源於現有項目，這幾天開了新項目正好用到順手就把這套框架抽出來了，也方便之後使用。目前網上對Rxjava2+Retrofit2的封裝真是太多了，可是大致思路都是同樣的，並且好多代碼都具備類似性，這套其實也不例外，你們可選擇性使用。
　　首先咱們先不說封裝思路，先說說這套框架都都具備哪些功能及如何使用；javascript

功能

1 使用RxCache緩存機制，可自定義緩存過時時間，及數據分頁緩存等功能。
2 統一的請求錯誤處理；
3 統一的網絡狀態判斷處理；
4 基於HttpLoggingInterceptor的請求日誌打印。java

　　以上就是這套框架能夠實現的功能，框架中並無像其餘的同樣封裝了ProgressBar
,由於每一個項目不一樣，ProgressBar的樣式需求並不同，就算同一個項目中下拉刷新和普通加載可能也不同，因此須要使用的小夥伴本身定義ProgressBar。
　　此外這套框架使用了RxCache實現緩存，而並非經過OKHttp緩存，因此這套框架對服務器沒有任何要求，不須要定義好Header之類的東西。若是你對RxCache不熟悉，能夠看看這篇文章，或者RxCache的官網。不知道這麼牛的框架爲啥start目前才1000多呢，不說廢話了，來看使用方式。react

使用方式

調用如下代碼完成網絡請求android

//聲明監聽
HttpSubscriber mHttpObserver =new HttpSubscriber(new OnResultCallBack<TestBean>() {
        @Override
        public void onSuccess(TestBean tb) {
        }
        @Override
        public void onError(int code,String errorMsg) {
        }
    });
//發起請求 
HttpManager.getInstance().getDatas(mHttpObserver,1,10,"json",true);

//取消請求
 mHttpObserver.unSubscribe();複製代碼

看起來是否是很簡單？git

下面來講說上面的代碼是如何完成網絡數據請求的。先來看看這個框架的結構github

僅僅只有七個類而已。json

簡單介紹一下個各種的職責
ApiResponse——封裝的返回數據模板（裏面的error_code，reason，result名稱須要你跟後臺的小夥伴對應好，一般狀況下error_code代碼狀態碼，reason爲成功或失敗的提示信息，result中爲具體的數據，因爲數據格式未知因此使用泛型表明）
ApiService——Retrofit的數據請求接口。注意一下每一個方法的返回值類型。（咱們真正須要的是TestBean中的數據它必須被ApiResponse包裝，最後返回Observable類型）
CacheProvider——RxCache的緩存接口，注意它的第一個參數類型必須和Retrofit數據請求接口的返回值類型同樣。
OnResultCallBack——請求成功或失敗的回調。
ApiException——公共的請求錯誤處理類。
HttpSubscriber——公共的請求訂閱者。
HttpManager——發起請求的管理類。api

首先是引入的各類庫文件緩存

//Rxjava2
compile 'io.reactivex.rxjava2:rxjava:2.0.7'
compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
//Retrofit2
compile 'com.squareup.retrofit2:retrofit:latest.release'
compile 'com.squareup.retrofit2:converter-gson:latest.release'
compile 'com.jakewharton.retrofit:retrofit2-rxjava2-adapter:1.0.0'
//RxCache
compile "com.github.VictorAlbertos.RxCache:runtime:1.8.0-2.x"
compile 'com.github.VictorAlbertos.Jolyglot:gson:0.0.3'
//Okhttp-interceptor
compile 'com.squareup.okhttp3:logging-interceptor:3.6.0'複製代碼

HttpManager的初始化服務器

public static HttpManager getInstance() {
    if (instance == null) {
        synchronized (HttpManager.class) {
            if (instance == null) {
                instance = new HttpManager();
            }
        }
    }
    return instance;
}複製代碼

單例模式的HttpManager，來看HttpManager的構造函數

private HttpManager() {
    HttpLoggingInterceptor.Level level= HttpLoggingInterceptor.Level.BODY;
    HttpLoggingInterceptor loggingInterceptor=new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
        @Override
        public void log(String message) {
            Log.i("HttpManager",message);
        }
    });
    loggingInterceptor.setLevel(level);
    OkHttpClient.Builder builder = new OkHttpClient.Builder();
    builder.connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
            .retryOnConnectionFailure(true)
            .addInterceptor(loggingInterceptor);
    OkHttpClient okHttpClient = builder.build();

    mRetrofit = new Retrofit.Builder()
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
            .baseUrl(Constant.BASE_URL)
            .client(okHttpClient)
            .build();

    cacheProvider = new RxCache.Builder()
            .persistence(mContext.getFilesDir(), new GsonSpeaker())
            .using(CacheProvider.class);

    mApiService = mRetrofit.create(ApiService.class);
}複製代碼

在構造函數中，首先咱們經過HttpLoggingInterceptor設置了攔截器，並經過addInterceptor方法設置給 OkHttpClient.Builder。而後是構建OkHttpClient.Builder及okHttpClient ，再而後是Retrofit的初始化。
下面接着是RxCache的初始化，並在其中設置了緩存目錄，mContext爲ApplicationContext，由init方法傳入。

public class App extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        HttpManager.init(this);//不作任何操做僅僅是緩存一下Application引用
    }
}複製代碼

那麼HttpManager是如何完成一個網絡請求的呢？

1 ApiService中聲明請求接口

@FormUrlEncoded
@POST("query?key=7c2d1da3b8634a2b9fe8848c3a9edcba")
Observable<ApiResponse<TestBean>> getDatas(@Field("pno") int pno, @Field("ps") int ps, @Field("dtype") String dtype);複製代碼

2CacheProvider中聲明緩存接口（若是須要緩存就寫）

@LifeCache(duration = 5, timeUnit = TimeUnit.MINUTES)
Observable<ApiResponse<TestBean>> getDatas(Observable<ApiResponse<TestBean>> oRepos, EvictProvider evictDynamicKey);複製代碼

注意看註解，能夠自定義緩存過時時間。（EvictProvider 參數是設置是否須要對請求的數據進行緩存，具體能夠看這裏）同時，第一個參數必定要是Observable > 咱們在ApiService中聲明好的getDatas方法的返回值。
3 HttpManager聲明對應的請求方法
方法有兩種，帶緩存的方式 

public void getDatasWithCache(Observer<TestBean> subscriber, int pno, int ps, String dtype, boolean update) {
    toSubscribe(cacheProvider.getDatas(mApiService.getDatas(pno, ps,dtype),new EvictProvider(update)), subscriber);
}複製代碼

不帶緩存的方式

public void getDatasNoCache(Observer<TestBean> subscriber, int pno, int ps, String dtype) {
    toSubscribe(mApiService.getDatas(pno, ps,dtype), subscriber);
}複製代碼

看到沒不帶緩存的方法只是沒有用cacheProvider.getDatas（）方法包裹，同時少了一個控制是否更新的參數update。
再來看一下toSubscribe（）方法的實現

private <T> void toSubscribe(Observable<ApiResponse<T>> o, Observer<T> s) {
    o.subscribeOn(Schedulers.io())
            .map(new Function<ApiResponse<T>, T>() {
                @Override
                public T apply(@NonNull ApiResponse<T> response) throws Exception {
                    int code=Integer.parseInt(response.getCode());
                    if (code!=Constant.SUCCESS_CODE) {
                        throw new ApiException(code, response.getMsg());
                    } else {
                        return response.getDatas();
                    }
                }
            })
            .unsubscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(s);
}複製代碼

藉助Rxjava的map方法完成數據的進一步轉換，注意SUCCESS_CODE，這個值是數據返回成功時的狀態碼，須要你和後臺小夥伴定義好，通常狀況下都爲0。若是code！=SUCCESS_CODE，那麼出錯返回的code的和message都會拋給ApiException，在ApiException中的getApiExceptionMessage方法你能夠根據具體code從新定義不一樣的message，或者使用傳入進來的message，一般狀況下這個類不須要修改，若是須要客戶端根據code自定義message那麼就按照上面所的方式修改便可。最後全部的message都會拋給HttpSubscriber的onError方法

@Override
public void onError(Throwable e) {
    if (e instanceof CompositeException) {
        CompositeException compositeE=(CompositeException)e;
        for (Throwable throwable : compositeE.getExceptions()) {
            if (throwable instanceof SocketTimeoutException) {
                mOnResultListener.onError(ApiException.Code_TimeOut,ApiException.SOCKET_TIMEOUT_EXCEPTION);
            } else if (throwable instanceof ConnectException) {
                mOnResultListener.onError(ApiException.Code_UnConnected,ApiException.CONNECT_EXCEPTION);
            } else if (throwable instanceof UnknownHostException) {
                mOnResultListener.onError(ApiException.Code_UnConnected,ApiException.CONNECT_EXCEPTION);
            } else if (throwable instanceof RxCacheException) {
                //緩存異常暫時不作處理
            }  else if (throwable instanceof MalformedJsonException) {
                mOnResultListener.onError(ApiException.Code_MalformedJson,ApiException.MALFORMED_JSON_EXCEPTION);
            }
        }
    }else {
        String msg = e.getMessage();
        int code;
        if (msg.contains("#")) {
            code = Integer.parseInt(msg.split("#")[0]);
            mOnResultListener.onError(code, msg.split("#")[1]);
        } else {
            code = ApiException.Code_Default;
            mOnResultListener.onError(code, msg);
        }
    }
}複製代碼

在這個方法中也統一處理了網絡問題。注意看不一樣的網絡狀態返回的狀態碼是不同的。

SocketTimeoutException 網絡超時 1000
ConnectException 連接異常 1001
UnknownHostException Host異常 1001
MalformedJsonException 解析異常 1020
其餘錯誤信息返回來自服務器的error code，這裏的"#"是在ApiException中的getApiExceptionMessage()方法拼接的。
最終執行到

mHttpObserver =new HttpSubscriber(new OnResultCallBack<TestBean>() {
        @Override
        public void onSuccess(TestBean tb) {
        }
        @Override
        public void onError(int code,String errorMsg) {
        }
    });複製代碼

中的onError方法，在這裏咱們根據不一樣的code展現不一樣的界面便可（例如常見的網絡錯誤界面），或者經過Toast等其餘方式給用戶提示。
再回到toSubscribe方法，若是數據返回成功了，即code==SUCCESS_CODE，那麼數據會返回給HttpSubscriber的onNext方法

@Override
public void onNext(T t) {
    if (mOnResultListener != null) {
        mOnResultListener.onSuccess(t);
    }
}複製代碼

onNext中調用OnResultCallBack的onSuccess方法，把數據傳遞到

mHttpObserver =new HttpSubscriber(new OnResultCallBack<TestBean>() {
        @Override
        public void onSuccess(TestBean tb) {
        }
        @Override
        public void onError(int code,String errorMsg) {
        }
    });複製代碼

中的onSuccess中，在這裏咱們把數據展現給用戶便可。
HttpSubscriber的另外一項任務就是取消數據請求操做。
在onSubscribe中經過一個全局的mDisposable記錄當前的Disposable

@Override
public void onSubscribe(Disposable d) {
    mDisposable = d;
}複製代碼

在須要取消的地方調用unSubscribe()便可

public void unSubscribe() {
    if (mDisposable != null && !mDisposable.isDisposed()) {
        mDisposable.dispose();
    }
}複製代碼

下面運行一下程序

mHttpObserver =new HttpSubscriber(new OnResultCallBack<TestBean>() {
        @Override
        public void onSuccess(TestBean tb) {
            for (TestBean.ListBean bean : tb.getList()) {
                result+=bean.toString();
            }
            resultTv.setText(result);
        }
        @Override
        public void onError(int code,String errorMsg) {
            resultTv.setText("onError: code:"+code+" errorMsg:"+errorMsg );
        }
    });複製代碼

這裏成功後經過TextView顯示一下數據，失敗時也顯示一下錯誤信息和code；
首先是不使用緩存

HttpManager.getInstance().getDatasNoCache(mHttpObserver,1,10,"json");複製代碼


數據請求成功，再來測試斷網狀況


斷網後返回了錯誤碼1003。
下面測試緩存

設置一個5分鐘的緩存

@LifeCache(duration = 5, timeUnit = TimeUnit.MINUTES)
Observable<ApiResponse<TestBean>> getDatas(Observable<ApiResponse<TestBean>> oRepos, EvictProvider evictDynamicKey);

 HttpManager.getInstance().getDatasWithCache(mHttpObserver,1,10,"json",false);複製代碼

能夠看到第一次請求產生了網絡流量，說明數據來自網絡，然後的幾回請求均沒有產生流量，說明數據來自本地緩存。
好了這套框架就介紹到這裏吧，有須要的能夠在這裏下載
github.com/shiweibsw/E…

如何使用？

1 build.gradle中導入插件
2 將http包下全部內容拷貝到你的工程便可。

下一步的計劃

1 retrofit 接口類封裝基本的get和post請求；
2 支持以插件的形式導入工程。

掘金技術徵文juejin.im/post/58d8e9…

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程