本文已獨家授權 code小生公眾號發(fā)布！

入職公司后，公司要求組件化開發(fā)，經(jīng)過討論后我將網(wǎng)絡請求框架單獨進行了封裝，不過當時框架里將常用的util和ui均放入到了共同的Common包下，導致里面部分代碼耦合，后來為了降低耦合性又將Common拆分為了lib_common和lib_ui，但是lib_ui依賴了lib_common，還是導致部分代碼耦合，最新一期為了降低組件之間的耦合性，所以單獨將lib_common中的網(wǎng)絡請求單獨拆分，并且我又做了新的封裝和完善，總之網(wǎng)絡框架經(jīng)過3次大的改造后，使用已經(jīng)非常穩(wěn)定了。

使用步驟

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

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)//動態(tài)添加的header，也可以在其他地方通過ApiConfig.setHeads()設置
               //.setOpenHttps(true)//開啟HTTPS驗證
               //.setSslSocketConfigure(sslSocketConfigure)//HTTPS認證配置
               .build();
build.init(this);

2.定義接口

public interface NBAApiT {

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

3.創(chuàng)建請求實例

單例模式創(chuàng)建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.發(fā)送請求

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.效果展示

show.gif

封裝思想

返回參數(shù)回調

由于JDK1.8中接口可以有默認不需要實現(xiàn)的方法，所以我采用了JDK1.8的新特新封裝了網(wǎng)絡請求返回參數(shù)的回調。這樣做的好處就是有些情況下，我們是只需要處理成功的需求，但是失敗和錯誤我們并不是太關心，所以在觀察者類BaseObserver中我對失敗和錯誤做了統(tǒng)一的封裝，這樣我們可以不需要每次寫回調參數(shù)的時候，都去處理失敗和錯誤。大大的減輕了代碼量。

public interface OnBaseResponseListener {

      void onSuccess(R response);
    
      default void onFailing(R response) {}
    
      default void onError() {}

}

其中onSuccess()方法是必須實現(xiàn)的，onFailing(R response)和onError()可以不用實現(xiàn)，如果項目中想處理網(wǎng)絡請求失敗和錯誤，則需要重寫onFailing(R response)和onError()方法，如果用到了封裝的loading框和Toast，則需要super.onFailing(response)和super.onError(e),否則則可以不用super。這個類可以用于比如MVP中M層的返回參數(shù)回調等。

網(wǎng)絡請求返回的實體類Bean

這個類是所有用到網(wǎng)絡請求實體類的父類，根據(jù)這個類中的code,我們在觀察者類BaseObserver中判斷網(wǎng)絡請求是成功還是失敗或者token失效。

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 boolean tokenInvalid() {
        return ApiConfig.getInvalidateToken() == code;
    }

}

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

public class NBAEntity extends BaseResponseEntity {


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

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

    @Override
    public boolean tokenInvalid() {
        return ApiConfig.getInvalidateToken() == code;
    }

    public static class ResultBean {
      public String title;
      }
}

由于我的項目返回的error_code碼這個字段并不是BaseResponseEntity中的code，所以可以采用起別名的方式，然后重寫getMsg()、setMsg(String msg)success()和tokenInvalid()方法。

   @SerializedName("error_code")
    private int code;

    @SerializedName("reason")
    private String msg;

    @Nullable
    @Override
    public String getMsg() {
        return msg;
    }

    @Override
    public void setMsg(String msg) {
        this.msg = msg;
    }

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

    @Override
    public boolean tokenInvalid() {
        return ApiConfig.getInvalidateToken() == code;
    }
//如果是kotlin也則使用@SerializedName("value")然后選擇重寫code和msg
    data class NBAKTEntity(
    @SerializedName("error_code") override var code: Int, 
    @SerializedName("reason") override var msg: String, 
    var result: ResultEntity?) :  BaseResponseEntity<NBAKTEntity>()

這樣就可以解決公司返回的code碼字段和我封裝的字段不相同的問題，當然每個bean都寫這段代碼顯然不是特別友好，所以你可以再封裝一個bean繼承自BaseResponseEntity，然后給code起別名就可以了，那樣項目中的其他的bean只需要繼承你自己封裝的bean。

網(wǎng)絡狀態(tài)的封裝類BaseObserver

這個類繼承自rxjava中的觀察者類Observer，這個類中我在onNext()方法中對返回參數(shù)進行判斷，如果code是成功的code碼表示本次網(wǎng)絡請求是成功的，如果code不是成功的code碼，那代表網(wǎng)絡請求是失敗的，對失敗做了統(tǒng)一封裝處理，如果返回的code值為token失效，這樣我發(fā)送了一條動態(tài)廣播，在自己的項目中，你只要在activity中的基類中接收該動態(tài)廣播，然后做退出登錄、清空數(shù)據(jù)等操作，同樣在onError()方法中，我對錯誤做了處理。在上面我已經(jīng)提示過了，失敗onFailing(response)和錯誤onError(Throwable e)方法可以不用實現(xiàn)的。因為我在這個類已經(jīng)做了統(tǒng)一處理。

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失效捕捉，發(fā)送廣播，在項目中接收該動態(tài)廣播然后做退出登錄等一些列操作
            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

這個類是對所有初始化參數(shù)進行配置的地方，比如返回碼code，BaseUrl，失效InvalidateToken，請求頭Heads，是否開啟https認證等的一系配置。可以在項目的application中對自己需要的參數(shù)進行配置，這樣項目中只需寫請求相關的代碼，而不需要處理請求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);
        }
    }
}

由于本人技術能力有限，可能存在一些問題歡迎大家指正。

代碼傳送門：https://github.com/Mp5A5/HttpRequest 歡迎大家fork或者star。