Retrofit使用教程:組合RxJava簡易封裝使用

本文將圍繞Retrofit的組裝請求管理器、發起請求、請求響應的封裝進行介紹。
以獲取手機號碼歸屬地的整個流程為例:

Get請求

請求API類,這個類等待Retrofit通過動態代理的方式將這個接口的方法以及對應得注解生成一個http請求,在把這個http請求交給OkHttp處理。

public interface HttpService {
    @GET(GlobalVar.NetPorts.WEATHER)
    Observable <HttpResult<PhoneLocalBean>> queryWeather(@QueryMap Map<String, String> options);
}

請求管理器

創建一個請求管理器用來配置Retrofit與OkHttp的基本屬性。

public class HttpManager {

    public static final String SERVER = GlobalVar.SERVER; //服務器根地址
    private HttpService mHttpService;
    private Retrofit mAdapter;
    private static HttpManager instance;

    private HttpManager() {
        mAdapter = new Retrofit.Builder().baseUrl(SERVER).addConverterFactory(ScalarsConverterFactory.create()).addConverterFactory(GsonDConverterFactory.create()).addCallAdapterFactory(RxJavaCallAdapterFactory.create()).client(getBuilder().build()).build();
    }

    public static HttpManager getInstance() {
        if (instance == null) {
            instance = new HttpManager();
        }
        return instance;
    }

    public HttpService sendRequest() {
        if (mHttpService == null) {
            mHttpService = mAdapter.create(HttpService.class);
        }
        return mHttpService;
    }

    private OkHttpClient.Builder getBuilder() {
        //這里的存儲位置只是簡單獲取,根據實際需要修改
        File cacheFile = new File(BaseApplication.getContext().getCacheDir().getAbsolutePath(), "ShopHttpCache");
        Cache cache = new Cache(cacheFile, 1024 * 1024 * 100);

        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        builder.addInterceptor(new HttpCacheInterceptor());
        builder.cache(cache);
        builder.readTimeout(GlobalVar.READ_TIMEOUT, TimeUnit.SECONDS);
        builder.connectTimeout(GlobalVar.CONNECT_TIMEOUT, TimeUnit.SECONDS);
        builder.writeTimeout(GlobalVar.WRITE_TIMEOUT, TimeUnit.SECONDS);
        builder.retryOnConnectionFailure(true);
        return builder;
    }
}

請求攔截器

用于對請求的發起與響應的攔截,這里我們可以增加統一的Header,客戶端與服務端的加密驗證也可以放在這里,網絡緩存等等。

public class HttpCacheInterceptor implements Interceptor {

    private static final String TAG = "HttpManager";

    @Override public Response intercept(Chain chain) throws IOException {
        Request original = chain.request();
        Request.Builder requestBuilder = original.newBuilder().method(original.method(), original.body());

        Headers.Builder hb = new Headers.Builder();
        addHeader(hb);
        if (!NetUtils.isConnected(BaseApplication.getContext())) {
            //網絡不可用
            requestBuilder.cacheControl(CacheControl.FORCE_CACHE);
        } else { 
            requestBuilder.cacheControl(CacheControl.FORCE_NETWORK);
        }
        Request request = requestBuilder.headers(hb.build()).build();
        Log.d(TAG, "地址:" + request.url());

        try {
            Response response = chain.proceed(request);
            String cookie = response.headers().get("Set-Cookie");

            if (NetUtils.isConnected(BaseApplication.getContext())) { //如果網絡可用
                int maxAge = 60 * 3;
                response = response.newBuilder().removeHeader("Pragma").header("Cache-Control", "public, max-age=" + maxAge).build();
            } else {
                int maxStale = 60 * 60 * 24;
                response = response.newBuilder().removeHeader("Pragma").header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale).build();
            }
            return response;
        } catch(Exception err) {
            Log.e("HttpManager", "http=============" + err.getLocalizedMessage());
        }
        return null;
    }

    private void addHeader(Headers.Builder header) {
        header.add("apikey", "8ca4b101096587f725ff69a07ff4d188");
    }
}

發起請求

這里的addMainSubscription用于簡化書寫并統一管理發起的訂閱,當Activity退出時統一取消訂閱。

@Override
public void queryWeather(String phone) {
    Map < String, String > options = new HashMap < >();
    options.put("phone", phone);
    addMainSubscription(HttpManager.getInstance().sendRequest().queryWeather(options), new HttpResultCallBack<PhoneLocalBean> () {

        @Override public void onResponse(PhoneLocalBean bean, int status) {
            if (bean != null) {
                mView.onUserLoadCompleted(bean);
            } else {
                mView.onUserLoadError();
            }
        }

        @Override public void onErr(String err, int status) {
            mView.showToast(err);
            mView.onUserLoadError();
        }
    });
}

自定義請求響應回調

對響應數據成功失敗的封裝,而一般的數據返回格式基本分為:
1、狀態碼
2、提示信息
3、具體數據內容
具體數據體可以是集合也可以是對象,所以使用了泛型HttpResult<M>統一處理。這里定義的M一方面是告訴GSON我的子數據格式是什么,另一方面用于回調方法中返回對應得數據類型。

public abstract class HttpResultCallBack<M> extends Subscriber <HttpResult<M>> {

    public abstract void onResponse(M m, int status);
    public abstract void onErr(String msg, int status);

    @Override public void onCompleted() {}

    @Override public void onError(Throwable e) {
        if (e != null) {
            if (e instanceof ResultException) {
                ResultException err = (ResultException) e;
                onErr(err.getErrMsg(), GlobalVar.RESULT_UNLOGIN);
            } else {
                onErr("網絡異常,請檢查網絡", GlobalVar.RESULT_UNLOGIN);
                Log.d("HttpManager", "解析失敗==:" + e.getMessage());
            }
        }
        onCompleted();
    }

    private void onHttpFail(String msg, int status) {
        onErr(msg, status);
    }

    @Override public void onNext(HttpResult < M > result) {
        String jsonResponse = new Gson().toJson(result);
        Log.d("HttpManager", "返回ok==:" + jsonResponse);
        if (result.getErrNum() == GlobalVar.RESULT_OK) {
            onResponse(result.getRetData(), GlobalVar.RESULT_OK);
        } else {
            onHttpFail(result.getErrMsg(), GlobalVar.RESULT_UNLOGIN);
        }
    }
}

結語

這里的代碼都是結合具體項目來寫的,雖然是抽出來的精簡版但更容易讀懂。我覺得直接看代碼更容易理解一段代碼的思想,所以大多都是以代碼為主注釋為輔。最后有哪些不足的地方也謝謝大家指出來~。

github源碼下載

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,646評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,595評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,560評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,035評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,814評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,224評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,301評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,444評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,988評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,804評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,998評論 1 370
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,544評論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,237評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,665評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,927評論 1 287
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,706評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,993評論 2 374

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,662評論 25 708
  • 又是一年中秋佳節,祝各位中秋節快樂。 今天我們來聊聊這個最近很火的網絡請求庫retrofit,在此基礎上會延伸出一...
    涅槃1992閱讀 7,806評論 13 133
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,785評論 18 139
  • 整體Retrofit內容如下: 1、Retrofit解析1之前哨站——理解RESTful2、Retrofit解析2...
    隔壁老李頭閱讀 15,116評論 4 39
  • 傳說這條小路 曾有一位女子走過 我想踏著她的印子 尋她的芳香 明月高懸 樹影斑駁 路上只我一個 月光瀉著我 如一位...
    馬人言閱讀 173評論 0 2