前言

"后端更新?lián)Q代，新接口返回全用新的規(guī)則，老接口不變！"。。。WTF！

“我們的這幾個(gè)網(wǎng)站，要做一個(gè)統(tǒng)一的App，后端都是現(xiàn)成的，這是API文檔。”。。。幾個(gè)網(wǎng)站的API規(guī)范和請(qǐng)求Host地址居然完全不一樣？。。。WTF！

實(shí)時(shí)切換BaseUrl？Retrofit注解全加上@Url？。。。無(wú)奈。。。

雖然說(shuō)現(xiàn)在已經(jīng)有很多Http請(qǐng)求框架了，也有很多針對(duì)RxJava+Retrofit的二次封裝，其中也不乏很多動(dòng)態(tài)替換BaseUrl的框架。但是如果需要更好的處理除了BaseUrl之外需求，比如針對(duì)各套API規(guī)則，不同的攔截處理、不同的返回異常邏輯處理等等，大多沒(méi)有給予解決方案。因此，RxRetroHttp應(yīng)運(yùn)而生。

總覽

我們先來(lái)看看，RxRetroHttp是通過(guò)什么方式處理這種情況的。

初始化

首先，大多庫(kù)的必備階段：初始化。我們先來(lái)看看初始化的代碼，在Application的onCreate中執(zhí)行

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

這樣，初始化就做完了。。。此處應(yīng)有掌聲。。。

說(shuō)好的處理多套API規(guī)則呢?。?！”

額咳。。。客觀莫急。。。待我徐徐道來(lái)

通過(guò)剛剛的初始化，你已經(jīng)設(shè)置了App中主API請(qǐng)求的基本配置。如果你的App中，就像前言里描述的那樣，需要對(duì)接多套API規(guī)則，那么在初始化之后，再加入如下代碼

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

相信大家已經(jīng)看出區(qū)別了吧，沒(méi)錯(cuò)，就是在generateRetroClient這個(gè)方法中，加入了一個(gè)Tag，而這個(gè)Tag，就是處理多套API請(qǐng)求的關(guān)鍵。

在setApiResultClass方法中，傳入的就是對(duì)于API規(guī)范的基類，具體情況會(huì)在后面講到。

調(diào)用

初始化完成后，如何調(diào)用呢

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

我們可以看到，這就是Retrofit風(fēng)格的調(diào)用方式。

在這里，Api2Service也就是Retrofit風(fēng)格的ApiService，但是也略有不同

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

我們看看不同在哪，下面是純Retrofit的書寫方式

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

沒(méi)錯(cuò)，區(qū)別就在于：

1、省去了基類的這一層包裹。這么做的原因是，個(gè)人認(rèn)為，在ApiService這一層，每個(gè)接口定義都需要設(shè)置ApiResult包裹是不人性的，哈哈哈。

2、RetroTag接口，用于指示Tag，當(dāng)然這是對(duì)于初始化時(shí)設(shè)置了Tag的API請(qǐng)求。

當(dāng)然，如果你還是希望以基類包裹的方式，也是可以的，那就是在初始化的時(shí)候，不調(diào)用setApiResultClass方法就行了。

另外，如果你不想增加RetroTag注解，也是可以的，那在調(diào)用的時(shí)候，就需要調(diào)用另一個(gè)方法，放入Tag，如下：

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

ApiResult

現(xiàn)在，我們來(lái)看看ApiResult。

在setApiResultClass方法中傳入的，是實(shí)現(xiàn)了IApiResult接口的請(qǐng)求返回基類，簡(jiǎn)單的樣例代碼如下

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";
  }
}

其對(duì)應(yīng)的返回json如下

{
  code: 1,
  msg: "請(qǐng)求成功",
  result: {
    ...
  }
}

這是一個(gè)較為常用的API返回格式，而我們所要做的，就是實(shí)現(xiàn)幾個(gè)基本方法，其中，isSuccess()返回的是請(qǐng)求成功的判斷，getData()返回的是請(qǐng)求到的具體數(shù)據(jù)，getResultMsg()返回的是API請(qǐng)求信息，getResultCode()表示返回碼，getDataField()返回的是json數(shù)據(jù)中表示具體數(shù)據(jù)的字段（在上面的json例子中，就是“result”）。

更多配置

Http請(qǐng)求不可能沒(méi)有相關(guān)的配置，而本框架并沒(méi)有為大家內(nèi)置很多配置方法，原因是，我認(rèn)為這并不是本框架的主要功能。當(dāng)然，大家也是可以進(jìn)行自定義配置的，配置方式如下：

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")

當(dāng)然各套API請(qǐng)求之間的配置也是隔離的?？蚣芤蔡峁┝艘恍┖?jiǎn)單的快捷配置方法，比如addInterceptor、addNetworkInterceptor等，更多的配置可以通過(guò)上述方式，獲取retrofitBuilder和okHttpBuilder來(lái)配置。

通過(guò)Tag的方式或許不是最好的方式，我也會(huì)繼續(xù)嘗試其他的方式，以對(duì)比便利性，如果大家有更好的方案提議，也希望能夠留言告訴我，感謝大家。

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，謝謝大家對(duì)腳本之家的支持。如果你想了解更多相關(guān)內(nèi)容請(qǐng)查看下面相關(guān)鏈接

最新評(píng)論