RxJava2+Retrofit2+RxLifecycle3+OkHttp3網絡請求封裝（動態演示）

時間 2021-03-03

標籤 java json 緩存網絡 app 框架 ide 組件化 this 欄目 Java 简体版

原文原文鏈接

入職公司後，公司要求組件化開發，通過討論後我將網絡請求框架單獨進行了封裝，不過當時框架裏將經常使用的 util 和 ui 均放入到了共同的 Common 包下，致使裏面部分代碼耦合，後來爲了下降耦合性又將 Common 拆分爲了lib_common和lib_ui，可是 lib_ui 依賴了 lib_common，仍是致使部分代碼耦合，最新一期爲了下降組件之間的耦合性，因此單獨將 lib_common 中的網絡請求單獨拆分，而且我又作了新的封裝和完善，總之網絡框架通過3次大的改造後，使用已經很是穩定了。

使用步驟

1.在Application類中進行初始化操做java

 ApiConfig build = new ApiConfig.Builder()
                 .setBaseUrl(baseUrl)//BaseUrl，這個地方加入後項目中默認使用該url
                .setInvalidateToken(0)//Token失效碼
                .setSucceedCode(200)//成功返回碼
                .setFilter("com.mp5a5.quit.broadcastFilter")//失效廣播Filter設置
                //.setDefaultTimeout(2000)//響應時間，能夠不設置，默認爲2000毫秒
                //.setHeads(headMap)//動態添加的header，也能夠在其餘地方經過ApiConfig.setHeads()設置
                //.setOpenHttps(true)//開啓HTTPS驗證
                //.setSslSocketConfigure(sslSocketConfigure)//HTTPS認證配置
                .build();
 build.init(this);

2.定義接口json

 public interface NBAApiT {

    @GET("onebox/basketball/nba")
    Observable<NBAEntity> getNBAInfo(@QueryMap ArrayMap<String, Object> map);
}

3.建立請求實例緩存

單例模式建立Service，推薦使用這種
public class NbaService {

    private NBAApiT nbaApiT;

    private NbaService() {
        nbaApiT = RetrofitFactory.getInstance().create(NBAApiT.class);
    }

    public static NbaService getInstance() {
        return Nbaservice1Holder.S_INSTANCE;
    }

    private static class Nbaservice1Holder {
        private static final NbaService S_INSTANCE = new NbaService();
    }

    public Observable<NBAEntity> getNBAInfo(String key) {
        ArrayMap<String, Object> map = new ArrayMap<>();
        map.put("key", key);
        return nbaApiT.getNBAInfo(map);
    }

}

4.發送請求網絡

findViewById(R.id.btnNBA).setOnClickListener(v -> {
            NbaService.getInstance()
                    .getNBAInfo("6949e822e6844ae6453fca0cf83379d3")
                    .subscribeOn(Schedulers.io())
                    .observeOn(AndroidSchedulers.mainThread())
                    .compose(this.bindToLifecycle())
                    .subscribe(new BaseObserver<NBAEntity>(){

                        @Override
                        public void onSuccess(NBAEntity response) {
                            Toast.makeText(TestNBAActivity.this, response.result.title, Toast.LENGTH_SHORT).show();
                        }

                    });
        });

5.效果展現app

封裝思想

返回參數回調框架

因爲 JDK1.8 中接口能夠有默認不須要實現的方法，因此我採用了JDK1.8的新特新封裝了網絡請求返回參數的回調。這樣作的好處就是有些狀況下，咱們是隻須要處理成功的需求，可是失敗和錯誤咱們並非太關心，因此在觀察者類 BaseObserver 中我對失敗和錯誤作了統一的封裝，這樣咱們能夠不須要每次寫回調參數的時候，都去處理失敗和錯誤。大大的減輕了代碼量。ide

public interface OnBaseResponseListener {

      void onSuccess(R response);

      default void onFailing(R response) {}

      default void onError() {}

}

其中 onSuccess() 方法是必須實現的，onFailing(R response) 和 onError() 能夠不用實現，若是項目中想處理網絡請求失敗和錯誤，則須要重寫onFailing(R response) 和 onError()方法，若是用到了封裝的 loading 框和Toast，則須要 super.onFailing(response) 和 super.onError(e),不然則能夠不用 super。組件化

網絡請求返回的實體類Bean

這個類是全部用到網絡請求實體類的父類，根據這個類中的code,咱們在觀察者類BaseObserver 中判斷網絡請求是成功仍是失敗或者token失效。ui

public class BaseResponseEntity implements Serializable {

  private static final long serialVersionUID = 1L;

  public int code;

  public String msg;

  public boolean success() {
    return ApiConfig.getSucceedCode() == code;
  }

  public int getTokenInvalid() {
    return ApiConfig.getInvalidateToken();
  }

}

例如這個請求NBA返回的實體類，咱們只須要繼承自 BaseResponseEntity。this

public class NBAEntity extends BaseResponseEntity {

    @SerializedName("error_code")
    public int code;
    public String reason;
    public ResultBean result;

    public static class ResultBean {
      public String title;
      }
}

因爲個人項目返回的 code 碼這個字段並非 BaseResponseEntity 中的 code，因此能夠採用起別名的方式，

    @SerializedName("error_code")
    public int code;

這樣就能夠解決公司返回的code碼字段和我封裝的字段不相同的問題，固然每一個bean都寫這段代碼顯然不是特別友好，因此你能夠再封裝一個bean繼承自BaseResponseEntity，而後給code起別名就能夠了，那樣項目中的其餘的bean只須要繼承你本身封裝的bean。

網絡狀態的封裝類BaseObserver

這個類繼承自rxjava中的觀察者類Observer，這個類中我在onNext()方法中對返回參數進行判斷，若是code是成功的code碼錶示本次網絡請求是成功的，若是code不是成功的code碼，那表明網絡請求是失敗的，對失敗作了統一封裝處理，若是返回的code值爲token失效，這樣我發送了一條動態廣播，在本身的項目中，你只要在activity中的基類中接收該動態廣播，而後作退出登陸、清空數據等操做，一樣在onError()方法中，我對錯誤作了處理。在上面我已經提示過了，失敗onFailing(response)和錯誤onError(Throwable e)方法能夠不用實現的。由於我在這個類已經作了統一處理。

public abstract class BaseObserver<T extends BaseResponseEntity> implements Observer<T> {

    、、、

    @Override
    public void onNext(T response) {

        if (response.success()) {
            try {
                onSuccess(response);
            } catch (Exception e) {
                e.printStackTrace();
            }
        } else if (response.getTokenInvalid() == response.code) {
            //token失效捕捉，發送廣播，在項目中接收該動態廣播而後作退出登陸等一些列操做
            Intent intent = new Intent();
            intent.setAction(ApiConfig.getQuitBroadcastReceiverFilter());
            intent.putExtra(TOKEN_INVALID_TAG, QUIT_APP);
            AppContextUtils.getContext().sendBroadcast(intent);

        } else {
            try {
                onFailing(response);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

    @Override
    public void onError(Throwable e) {

        if (e instanceof retrofit2.HttpException) {
            //HTTP錯誤
            onException(ExceptionReason.BAD_NETWORK);
        } else if (e instanceof ConnectException || e instanceof UnknownHostException) {
            //鏈接錯誤
            onException(ExceptionReason.CONNECT_ERROR);
        } else if (e instanceof InterruptedIOException) {
            //鏈接超時
            onException(ExceptionReason.CONNECT_TIMEOUT);
        } else if (e instanceof JsonParseException || e instanceof JSONException || e instanceof ParseException) {
            //解析錯誤
            onException(ExceptionReason.PARSE_ERROR);
        } else {
            //其餘錯誤
            onException(ExceptionReason.UNKNOWN_ERROR);
        }
    }

    、、、

    @Override
    public void onComplete() {
       、、、
    }

    public abstract void onSuccess(T response);

    public void onFailing(T response) {
        String message = response.msg;
        if (TextUtils.isEmpty(message)) {
            Toast.makeText(AppContextUtils.getContext(), RESPONSE_RETURN_ERROR, Toast.LENGTH_SHORT).show();
        } else {
            Toast.makeText(AppContextUtils.getContext(), message, Toast.LENGTH_SHORT).show();
        }
    }
    、、、

}

Retrofit 封裝 RetrofitFactory

這個類是配合okttp、Gson、攔截器等，對Retrofit進行的封裝。這裏對請求超時的時間，請求頭攔截器、請求緩存大小、日誌攔截器、https認證、返回json處理等、都在這個類作了處理，能夠說這個類是處理Retrofit的核心類。

public class RetrofitFactory {

    、、、

    private RetrofitFactory() {

        // 指定緩存路徑,緩存大小100Mb
        File cacheFile = new File(AppContextUtils.getContext().getCacheDir(), "HttpCache");
        Cache cache = new Cache(cacheFile, 1024 * 1024 * 100);

        OkHttpClient.Builder httpClientBuilder = new OkHttpClient().newBuilder()
                .readTimeout(ApiConfig.getDefaultTimeout(), TimeUnit.MILLISECONDS)
                .connectTimeout(ApiConfig.getDefaultTimeout(), TimeUnit.MILLISECONDS)
                .addInterceptor(HttpLoggerInterceptor.getLoggerInterceptor())
                .addInterceptor(new HttpHeaderInterceptor())
                .addNetworkInterceptor(new HttpCacheInterceptor())
                .cache(cache);

        if (ApiConfig.getOpenHttps()) {
            httpClientBuilder.sslSocketFactory(1 == ApiConfig.getSslSocketConfigure().getVerifyType() ?
                    SslSocketFactory.getSSLSocketFactory(ApiConfig.getSslSocketConfigure().getCertificateInputStream()) :
                    SslSocketFactory.getSSLSocketFactory(), new UnSafeTrustManager());
            httpClientBuilder.hostnameVerifier(new UnSafeHostnameVerify());
        }

        OkHttpClient httpClient = httpClientBuilder.build();

        Gson gson = new GsonBuilder()
                .setDateFormat("yyyy-MM-dd HH:mm:ss")
                .serializeNulls()
                .registerTypeAdapterFactory(new NullTypeAdapterFactory())
                .create();

        retrofit = new Retrofit.Builder()
                .client(httpClient)
                .addConverterFactory(GsonConverterFactory.create(gson))
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create());

        if (!TextUtils.isEmpty(ApiConfig.getBaseUrl())) {
            build = retrofit.baseUrl(ApiConfig.getBaseUrl()).build();
        }

    }

    、、、

    public <T> T create(Class<T> clazz) {
        checkNotNull(build, "BaseUrl not init,you should init first!");
        return build.create(clazz);
    }

    public <T> T create(String baseUrl, Class<T> clazz) {
        return retrofit.baseUrl(baseUrl).build().create(clazz);
    }

}

使用配置類ApiConfig

這個類是對全部初始化參數進行配置的地方，好比返回碼 code，BaseUrl，失效InvalidateToken，請求頭 Heads，是否開啓 https 認證等的一系配置。能夠在項目的 application 中對本身須要的參數進行配置，這樣項目中只需寫請求相關的代碼，而不須要處理請求baseUrl、返回code等繁瑣的任務。

public class ApiConfig implements Serializable {

    private static int mInvalidateToken;
    private static String mBaseUrl;
     、、、
    private ApiConfig(Builder builder) {
        mInvalidateToken = builder.invalidateToken;
        mBaseUrl = builder.baseUrl;
        、、、
    }

    public void init(Context appContext) {
        AppContextUtils.init(appContext);
    }

    public static int getInvalidateToken() {
        return mInvalidateToken;
    }

    public static String getBaseUrl() {
        return mBaseUrl;
    }

    、、、

    public static final class Builder  {

        private int invalidateToken;

        private String baseUrl;

        、、、

        public Builder setBaseUrl(String mBaseUrl) {
            this.baseUrl = mBaseUrl;
            return this;
        }

        public Builder setInvalidateToken(int invalidateToken) {
            this.invalidateToken = invalidateToken;
            return this;
        }

        、、、

        public ApiConfig build() {
            return new ApiConfig(this);
        }
    }
}

文章不易，若是你們喜歡這篇文章，或者對你有幫助但願你們多多，點贊，轉發，關注 哦。文章會持續更新的。絕對乾貨！！！