Retrofit+Rxjava網(wǎng)絡(luò)層的優(yōu)雅封裝

想必Retrofit+Rxjava的使用，如今已經(jīng)非常的普及了吧。在此介紹一種比較優(yōu)雅的有關(guān)Retrofit+Rxjava封裝的方法。參考github項(xiàng)目XDroidMvp

原本的步驟應(yīng)該是這樣，首先要?jiǎng)?chuàng)建OKHttpClient ，在其中添加一些攔截和超時(shí)處理，然后創(chuàng)建Retrofit對(duì)象并注入OKHttpClient對(duì)象，再獲取接口實(shí)例Observable對(duì)象，然后綁定生命周期（防止內(nèi)存泄漏）并訂閱觀察者Subscriber處理返回信息。

那現(xiàn)在應(yīng)該如何封裝，才能比較優(yōu)雅，并且能夠盡量的解耦呢？

  • 1、提出Retrofits實(shí)現(xiàn)類，提供設(shè)置超時(shí)時(shí)間、添加攔截等處理的接口

首先應(yīng)該將Retrofit這一塊提出來(lái)，而創(chuàng)建Retrofit需要注入OKHttpClient，其中有很多與業(yè)務(wù)相關(guān)的處理，比如需要設(shè)置超時(shí)時(shí)間，攔截頭部添加Header等等。那么這一塊就可以寫一個(gè)接口回調(diào)，在外部實(shí)現(xiàn)后注入?？匆幌逻@一塊的代碼吧

public class NetMgr {
    private final long connectTimeoutMills = 10 * 1000L;
    private final long readTimeoutMills = 10 * 1000L;
    private NetProvider sProvider = null;
    private static NetMgr instance;
    private Map<String, NetProvider> providerMap = new HashMap<>();
    private Map<String, Retrofit> retrofitMap = new HashMap<>();
    private Map<String, OkHttpClient> clientMap = new HashMap<>();


    public static NetMgr getInstance() {
        if (instance == null) {
            synchronized (NetMgr.class) {
                if (instance == null) {
                    instance = new NetMgr();
                }
            }
        }
        return instance;
    }


    public <S> S get(String baseUrl, Class<S> service) {
        return getInstance().getRetrofit(baseUrl).create(service);
    }

    public void registerProvider(NetProvider provider) {
        this.sProvider = provider;
    }

    public void registerProvider(String baseUrl, NetProvider provider) {
        getInstance().providerMap.put(baseUrl, provider);
    }

    public NetProvider getCommonProvider() {
        return sProvider;
    }

    public void clearCache() {
        getInstance().retrofitMap.clear();
        getInstance().clientMap.clear();
    }

    public Retrofit getRetrofit(String baseUrl) {
        return getRetrofit(baseUrl, null);
    }

    public Retrofit getRetrofit(String baseUrl, NetProvider provider) {
        if (empty(baseUrl)) {
            throw new IllegalStateException("baseUrl can not be null");
        }
        if (retrofitMap.get(baseUrl) != null) {
            return retrofitMap.get(baseUrl);
        }

        if (provider == null) {
            provider = providerMap.get(baseUrl);
            if (provider == null) {
                provider = sProvider;
            }
        }
        checkProvider(provider);

        Gson gson = new GsonBuilder()
                .setDateFormat("yyyy-MM-dd HH:mm:ss")
                .create();

        Retrofit.Builder builder = new Retrofit.Builder()
                .baseUrl(baseUrl)
                .client(getClient(baseUrl, provider))
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .addConverterFactory(GsonConverterFactory.create(gson));

        Retrofit retrofit = builder.build();
        retrofitMap.put(baseUrl, retrofit);
        providerMap.put(baseUrl, provider);

        return retrofit;
    }

    private boolean empty(String baseUrl) {
        return baseUrl == null || baseUrl.isEmpty();
    }

    private OkHttpClient getClient(String baseUrl, NetProvider provider) {
        if (empty(baseUrl)) {
            throw new IllegalStateException("baseUrl can not be null");
        }
        if (clientMap.get(baseUrl) != null) {
            return clientMap.get(baseUrl);
        }

        checkProvider(provider);

        OkHttpClient.Builder builder = new OkHttpClient.Builder();

        builder.connectTimeout(provider.configConnectTimeoutSecs() != 0
                ? provider.configConnectTimeoutSecs()
                : connectTimeoutMills, TimeUnit.SECONDS);
        builder.readTimeout(provider.configReadTimeoutSecs() != 0
                ? provider.configReadTimeoutSecs() : readTimeoutMills, TimeUnit.SECONDS);

        builder.writeTimeout(provider.configWriteTimeoutSecs() != 0
                ? provider.configReadTimeoutSecs() : readTimeoutMills, TimeUnit.SECONDS);
        CookieJar cookieJar = provider.configCookie();
        if (cookieJar != null) {
            builder.cookieJar(cookieJar);
        }
        provider.configHttps(builder);

        RequestHandler handler = provider.configHandler();
        if (handler != null) {
            builder.addInterceptor(new NetInterceptor(handler));
        }

        Interceptor[] interceptors = provider.configInterceptors();
        if (!empty(interceptors)) {
            for (Interceptor interceptor : interceptors) {
                builder.addInterceptor(interceptor);
            }
        }

        if (provider.configLogEnable()) {
            HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
            loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
            builder.addInterceptor(loggingInterceptor);
        }

        OkHttpClient client = builder.build();
        clientMap.put(baseUrl, client);
        providerMap.put(baseUrl, provider);

        return client;
    }

    private boolean empty(Interceptor[] interceptors) {
        return interceptors == null || interceptors.length == 0;
    }

    private void checkProvider(NetProvider provider) {
        if (provider == null) {
            throw new IllegalStateException("must register provider first");
        }
    }

    public Map<String, Retrofit> getRetrofitMap() {
        return retrofitMap;
    }

    public Map<String, OkHttpClient> getClientMap() {
        return clientMap;
    }

}
  • 2、實(shí)現(xiàn)NetProvider接口并注入

NetMgr就是一個(gè)Retrofit的實(shí)現(xiàn)類，然后NetProvider是一個(gè)接口，需要在外部去實(shí)現(xiàn)，然后注入。再看一下NetProvider的實(shí)現(xiàn)類BaseNetProvider

public class BaseNetProvider implements NetProvider {

    private static final long CONNECT_TIME_OUT = 30;
    private static final long READ_TIME_OUT = 180;
    private static final long WRITE_TIME_OUT = 30;


    @Override
    public Interceptor[] configInterceptors() {
        return null;
    }

    @Override
    public void configHttps(OkHttpClient.Builder builder) {

    }

    @Override
    public CookieJar configCookie() {
        return null;
    }

    @Override
    public RequestHandler configHandler() {

        return new HeaderHandler();
    }

    @Override
    public long configConnectTimeoutSecs() {
        return CONNECT_TIME_OUT;
    }

    @Override
    public long configReadTimeoutSecs() {
        return READ_TIME_OUT;
    }

    @Override
    public long configWriteTimeoutSecs() {
        return WRITE_TIME_OUT;
    }

    @Override
    public boolean configLogEnable() {
        return BuildConfig.DEBUG;
    }


    private class HeaderHandler implements RequestHandler {

        @Override
        public Request onBeforeRequest(Request request, Interceptor.Chain chain) {
            return chain.request().newBuilder()
                    .addHeader("X-Auth-Token", Constant.accessToken)
                    .addHeader("Authorization", "")
                    .build();
        }

        @Override
        public Response onAfterRequest(Response response, Interceptor.Chain chain)
                throws IOException {
            ApiException e = null;
            if (401 == response.code()) {
                throw new ApiException("登錄已過(guò)期,請(qǐng)重新登錄!");
            } else if (403 == response.code()) {
                throw new ApiException("禁止訪問(wèn)!");
            } else if (404 == response.code()) {
                throw new ApiException("鏈接錯(cuò)誤");
            } else if (503 == response.code()) {
                throw new ApiException("服務(wù)器升級(jí)中!");
            } else if (500 == response.code()) {
                throw new ApiException("服務(wù)器內(nèi)部錯(cuò)誤!");
            }
            return response;
        }
    }

在BaseNetProvider中實(shí)現(xiàn)了連接、讀、寫超時(shí)的時(shí)間處理，與請(qǐng)求和返回?cái)?shù)據(jù)的請(qǐng)求頭部處理。然后需要在Application中去注入BaseNetProvider

NetMgr.getInstance().registerProvider(new BaseNetProvider());
  • 3、Observable實(shí)現(xiàn)

首先實(shí)現(xiàn)一個(gè)UseCase的基類，處理公共的使用方法。通過(guò)調(diào)用NetMgr.getInstance().getRetrofit(BuildConfig.BaseUrl).create(getType())來(lái)獲取ApiService的實(shí)例，然后提供了指定線程的基類方法。至于PagingReq是一個(gè)分頁(yè)模型，方便分頁(yè)接口的使用。

public abstract class UseCase<T> {
    //用于分頁(yè)請(qǐng)求 
    protected PagingReq pagingReq = new PagingReq();

    protected T ApiClient() {
        return NetMgr.getInstance().getRetrofit(BuildConfig.BaseUrl).create(getType());
    }
  
    //指定觀察者與被觀察者線程
    protected <T> Observable.Transformer<T, T> normalSchedulers() {
        return new Observable.Transformer<T, T>() {
            @Override
            public Observable<T> call(Observable<T> source) {
                return source.onTerminateDetach().subscribeOn(Schedulers.io())
                        .observeOn(AndroidSchedulers.mainThread());
            }
        };
    }

    private Class<T> getType() {
        Class<T> entityClass = null;
        Type t = getClass().getGenericSuperclass();
        Type[] p = ((ParameterizedType) t).getActualTypeArguments();
        entityClass = (Class<T>) p[0];
        return entityClass;
    }
}

此處實(shí)現(xiàn)一個(gè)簡(jiǎn)單的獲取城市信息的接口。 首先定義接口ApiService，然后實(shí)現(xiàn)獲取Observable的方法

public class GetCitiesCase extends UseCase<GetCitiesCase.Api> {
    interface Api {
        @GET("api/china/")
        Observable<List<City>> getCitiesCase();
    }


    public Observable<List<City>> getCities() {
        return ApiClient().getCitiesCase()
                .compose(this.<List<City>>normalSchedulers());
    }

}
  • 使用時(shí)調(diào)用
 new GetCitiesCase().getCities()
                .compose(this.<List<City>>bindToLifecycle())
                .subscribe(new BaseSubscriber<List<City>>() {
                    @Override
                    public void onError(Throwable e) {
                        Toast.makeText(MainActivity.this, e.getMessage(), Toast.LENGTH_SHORT).show();
                    }

                    @Override
                    public void onNext(List<City> o) {
                        getCitiesTv.setText("");
                        if (o != null && o.size() != 0) {
                            for (City city : o) {
                                getCitiesTv.setText(getCitiesTv.getText().toString() + city.id.intValue() + "  " + city.name + "\n");
                            }
                        }
                    }
                });

調(diào)用就很簡(jiǎn)單了，只需綁定生命周期（防止內(nèi)存泄漏），然后訂閱Subscriber，處理成功或失敗后的返回。

附上github鏈接，多多Star噢(～￣▽￣)～

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容