RxRetroHttp爲多套API請求適配而生

今天小編就爲大家分享一篇關於RxRetroHttp爲多套API請求適配而生,小編覺得內容挺不錯的,現在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧

前言

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

“我們的這幾個網站,要做一個統一的App,後端都是現成的,這是API文檔。”。。。幾個網站的API規範和請求Host地址居然完全不一樣?。。。WTF!

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

雖然說現在已經有很多Http請求框架了,也有很多針對RxJava+Retrofit的二次封裝,其中也不乏很多動態替換BaseUrl的框架。但是如果需要更好的處理除了BaseUrl之外需求,比如針對各套API規則,不同的攔截處理、不同的返回異常邏輯處理等等,大多沒有給予解決方案。因此,RxRetroHttp應運而生。

總覽

我們先來看看,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();
}

沒錯,區別就在於:

1、省去了基類的這一層包裹。這麼做的原因是,個人認爲,在ApiService這一層,每個接口定義都需要設置ApiResult包裹是不人性的,哈哈哈。

2、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的方式或許不是最好的方式,我也會繼續嘗試其他的方式,以對比便利性,如果大家有更好的方案提議,也希望能夠留言告訴我,感謝大家。

總結

以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,謝謝大家對神馬文庫的支持。如果你想了解更多相關內容請查看下面相關鏈接

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章