RxRetroHttp，爲多套API請求適配而生

前言

"後端更新換代，新接口返回全用新的規則，老接口不變！"。。。WTF！

「咱們的這幾個網站，要作一個統一的App，後端都是現成的，這是API文檔。」。。。幾個網站的API規範和請求Host地址竟然徹底不同？。。。WTF！

。。。千萬只草泥馬呼嘯而過。。。實時切換BaseUrl？Retrofit註解全加上@Url？。。。無奈。。。

雖說如今已經有不少Http請求框架了，也有不少針對RxJava+Retrofit的二次封裝，其中也不乏不少動態替換BaseUrl的框架。可是若是須要更好的處理除了BaseUrl以外需求，好比針對各套API規則，不一樣的攔截處理、不一樣的返回異常邏輯處理等等，大多沒有給予解決方案。所以，RxRetroHttp應運而生。

Github地址：https://github.com/BakerJQ/Rx...

總覽

咱們先來看看，RxRetroHttp是經過什麼方式處理這種狀況的。

初始化

首先，大多庫的必備階段：初始化。咱們先來看看初始化的代碼，在Application的onCreate中執行

RxRetroHttp.init(this)
           .setBaseUrl("http://api1.com/")
           .setApiResultClass(Api1Result.class)
           .generateRetroClient()

這樣，初始化就作完了。。。此處應有掌聲。。。

「我掌你大爺！！！說好的處理多套API規則呢！！！」

額咳。。。客觀莫急。。。待我徐徐道來

經過剛剛的初始化，你已經設置了App中主API請求的基本配置。若是你的App中，就像前言裏描述的那樣，須要對接多套API規則，那麼在初始化以後，再加入以下代碼

RxRetroHttp.getInstance()
           .setBaseUrl("https://api2.com/")
           .setApiResultClass(Api2Result.class)
           .generateRetroClient("API2")

相信你們已經看出區別了吧，沒錯，就是在generateRetroClient這個方法中，加入了一個Tag，而這個Tag，就是處理多套API請求的關鍵。

在setApiResultClass方法中，傳入的就是對於API規範的基類，具體狀況會在後面講到。

調用

初始化完成後，如何調用呢

RxRetroHttp.create(Api2Service.class).getApi2Info()

咱們能夠看到，這就是Retrofit風格的調用方式。

在這裏，Api2Service也就是Retrofit風格的ApiService，可是也略有不一樣

@RetroTag("API2")
public interface Api2Service {
    @GET("test/info")
    Observable<Api2Info> getApi2Info();
}

咱們看看不一樣在哪，下面是純Retrofit的書寫方式

public interface Api2Service {
    @GET("test/info")
    Observable<Api2Result<Api2Info>> getApi2Info();
}

沒錯，區別就在於：

一、省去了基類的這一層包裹。這麼作的緣由是，我的認爲，在ApiService這一層，每一個接口定義都須要設置ApiResult包裹是不人性的，哈哈哈。

二、RetroTag接口，用於指示Tag，固然這是對於初始化時設置了Tag的API請求。

固然，若是你仍是但願以基類包裹的方式，也是能夠的，那就是在初始化的時候，不調用setApiResultClass方法就好了。

另外，若是你不想增長RetroTag註解，也是能夠的，那在調用的時候，就須要調用另外一個方法，放入Tag，以下：

RxRetroHttp.create(Api2Service.class, "API2").getApi2Info()

ApiResult

如今，咱們來看看ApiResult。

在setApiResultClass方法中傳入的，是實現了IApiResult接口的請求返回基類，簡單的樣例代碼以下

public class Api2Result<T> implements IApiResult<T> {
    private int code;
    private String msg;
    private T result;
    
    @Override
    public boolean isSuccess(){
        return code == 1;
    }
    
    @Override
    public T getData(){
        return result;
    }
    
    @Override
    public String getResultMsg(){
        return msg;
    }
    
    @Override
    public String getResultCode(){
        return String.valueOf(code);
    }
    
    @Override
    public String getDataField(){
        return "result";
    }
}

其對應的返回json以下

{
    code: 1,
    msg: "請求成功",
    result: {
        ...
    }
}

這是一個較爲經常使用的API返回格式，而咱們所要作的，就是實現幾個基本方法，其中，isSuccess()返回的是請求成功的判斷，getData()返回的是請求到的具體數據，getResultMsg()返回的是API請求信息，getResultCode()表示返回碼，getDataField()返回的是json數據中表示具體數據的字段（在上面的json例子中，就是「result」）。

更多配置

Http請求不可能沒有相關的配置，而本框架並無爲你們內置不少配置方法，緣由是，我認爲這並非本框架的主要功能。固然，你們也是能夠進行自定義配置的，配置方式以下：

RxRetroHttp.init(this).setXXX().setXXX();
Retrofit.Builder retrofitBuilder = RxRetroHttp.getRetrofitBuilder();
retrofitBuilder.setXXX().setXXX();
OkHttpClient.Builder okHttpBuilder = RxRetroHttp.getOkHttpClientBuilder();
okHttpBuilder.setXXX().setXXX();
RxRetroHttp.getInstance().generateRetroClient();
//RxRetroHttp.getInstance().generateRetroClient("YourTag")

固然各套API請求之間的配置也是隔離的。框架也提供了一些簡單的快捷配置方法，好比addInterceptor、addNetworkInterceptor等，更多的配置能夠經過上述方式，獲取retrofitBuilder和okHttpBuilder來配置。

總結

經過Tag的方式或許不是最好的方式，我也會繼續嘗試其餘的方式，以對比便利性，若是你們有更好的方案提議，也但願可以經過提issuer的方式告訴我，感謝你們。

更具體的使用方式，歡迎來GitHub倉庫裏的Demo查看，也歡迎和感謝各位Star支持。

再次貼一下Github地址：https://github.com/BakerJQ/Rx...