ApiHolder多服務端接口適配(超簡單)

GithubLink 說個題外話：買個實物工具要錢，弄個軟件工具都是免費的！給個星鼓勵下嘛！

現狀

Android項目若是是多服務端接口時，通常怎麼弄呢？

方法1：服務器地址放在Header中

把服務器地址（或地址名，如：‘SERVER_HOST_A’）放在接口Header中，而後經過攔截器來動態修改請求地址而實現的。除了默認服務器的接口，其它都要加一個Header，有點麻煩。看起來也不爽，不簡潔。

interface ApiHeaderCase {
    /************************** server A ****************************/
    @Headers("host:$SERVER_HOST_A")
    @GET("user/loginWithScanCode")
    fun aMethod1(@Query("id") id: Int): Observable<ResponseBody>

    /************************** server B ****************************/
    @Headers("host:$SERVER_HOST_B")
    @GET("user/loginWithScanCode")
    fun bMethod1(@Query("id") id: Int): Observable<ResponseBody>
}
複製代碼

方法2：多套服務類，實例化爲多個對象，準確查找接口歸屬服務

定義多個類，每一個類定義一套服務接口。而後分別實例化爲多個對象，再使用準確的對象來調用接口。這種方法運行效率是最高的，可是在開發時，可能沒法快速知道接口歸屬與哪一個服務，須要查看代碼才能準確知曉，能夠說是少了代碼提示能力。

interface ApiA {
    @GET("user/loginWithScanCode")
    fun methodA(@Query("id") id: Int): Observable<ResponseBody>
}

interface ApiB {
    @GET("user/loginWithScanCode")
    fun methodB(@Query("id") id: Int): Observable<ResponseBody>
}
複製代碼

方法3：全寫在一塊兒，實例化爲多個對象，準確調用方法

把全部接口都寫在一個類中，而後根據服務地址分別實例化爲多個對象。再準確調用方法，爲了保證準確調用方法，能夠給每一個接口加個服務名的前綴，以減小方法調錯的問題。

interface ApiAllInOne {
    /************************** server A ****************************/
    @GET("user/loginWithScanCode")
    fun aMethod1(@Query("id") id: Int): Observable<ResponseBody>

    /************************** server B ****************************/
    @GET("user/loginWithScanCode")
    fun bMethod1(@Query("id") id: Int): Observable<ResponseBody>
}

const val SERVER_HOST_A = "https://www.a.com/"
const val SERVER_HOST_B = "https://www.b.com/"
fun getApi(retrofit: Retrofit, host: String): ApiAllInOne {
    return retrofit.newBuilder()
            .baseUrl(host).build()
            .create(ApiAllInOne::class.java)
}

fun showNomalUseCase(retrofit: Retrofit) {
    val apiA = getApi(retrofit, SERVER_HOST_A)//save as single instance for repeated usage
    apiA.aMethod1(1).subscribe()
    apiA.bMethod1(1).subscribe()//invalid usage, but no compile error

    val apiB = getApi(retrofit, SERVER_HOST_B)
    apiB.bMethod1(1).subscribe()
    apiB.aMethod1(1).subscribe()//invalid usage, but no compile error
}
複製代碼

有更簡單的方法嗎？

固然有了，並且超方便！

定義接口

（建議）在一個KT文件中定義全部接口，方便查找和維護。

interface ApiHolder : ApiA, ApiB

    @BaseUrl("https://www.a.com/")
    interface ApiA {
        @GET("user/loginWithScanCode")
        fun methodA(@Query("id") id: Int): Observable<ResponseBody>
    }

    @BaseUrl("https://www.b.com/")
    interface ApiB {
        @GET("user/loginWithScanCode")
        fun methodB(@Query("id") id: Int): Observable<ResponseBody>
    }
複製代碼

建工具類

通常都須要個工具類的，方便配置攔截器等。若是沒有自定義的需求，也能夠直接實例化來用。

能夠重寫invokeApi方法，全局給每一個Observable設定線程。

class ApiUtil : ApiHolderUtil<ApiHolder>(ApiHolder::class) {
    companion object {
        val apiUtil = ApiUtil()
        val api = apiUtil.api
    }

    override fun invokeApi(api: Any, method: Method, args: Array<*>?): Any {
        val observable = super.invokeApi(api, method, args) as Observable<*>
        return observable.subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
    }
}
複製代碼

動態更新服務地址

還能夠動態更新服務地址，好比實現測試服務和正式服務間切換。

//update api baseUrl when needed
    apiUtil.updateApi(ApiA::class, "https://www.a2.com/")
複製代碼

調用接口

api.methodA(1).subscribe()
    api.methodB(1).subscribe()
複製代碼

引入依賴

dependencies {
    implementation 'com.github.DonaldDu:ApiHolder:x.x.x'//JitPack version
}
複製代碼

該項目使用的三方庫

• OkHttp3
• Retrofit2
• rxjava3（能夠修改成rxjava2）

api 'com.squareup.okhttp3:okhttp:4.7.2'
    api "com.squareup.retrofit2:retrofit:2.9.0"
    api "com.squareup.retrofit2:converter-gson:2.9.0"
    api "com.squareup.retrofit2:adapter-rxjava3:2.9.0"
    api 'io.reactivex.rxjava3:rxandroid:3.0.0'
複製代碼

其它說明

rxjava3 ->rxjava2

能夠根據須要調整爲rxjava2，建議用最新的。

//重寫ApiHolderUtil以下方法，RxJava3CallAdapterFactory ->RxJava2CallAdapterFactory便可。
    protected open fun getRetrofit(client: OkHttpClient): Retrofit {
        return Retrofit.Builder()
                .validateEagerly(validateEagerly)
                .addConverterFactory(getGsonConverterFactory())
                .addCallAdapterFactory(RxJava3CallAdapterFactory.create())
                .baseUrl("http://www.demo.com/")
                .client(client)
                .build()
    }
複製代碼

Timeout

能夠給每套服務設置不一樣的超時

@BaseUrl("https://www.b.com/")
@Timeout(read = 100, timeUnit = TimeUnit.SECONDS)
interface ApiB {
    @GET("user/loginWithScanCode")
    fun methodB(@Query("id") id: Int): Observable<ResponseBody>
}
複製代碼

個人開源項目

• RxNet作網絡請求，簡潔得無法了
• DynamicServer動態配置服務（真香！）

最後

開源不易，寫文章更不易，勞煩你們給本文點個贊，能夠的話，再給個star，感激涕零