RxJava + Retrofit2 + OkHttp3 封裝及踩坑（續(xù)）

前一篇文章（也是我在簡書上的第一篇技術(shù)文章.）講了Android三劍客的基礎(chǔ)用法和簡單封裝，有一些封裝只是一筆帶過，還有些用法被遺漏沒講到的，所以在這篇里統(tǒng)一做下查漏補(bǔ)缺。

0x00 先做一下糾正：

https和失敗重連，OkHttp默認(rèn)是支持的，并不用手動(dòng)去設(shè)置（在OkHttpClient.Builder中已默認(rèn)設(shè)置），所以O(shè)kHttpClient.Builder的初始化可以簡化為：

// 創(chuàng)建OkHttpClient
OkHttpClient.Builder builder = new OkHttpClient.Builder()
        // 超時(shí)設(shè)置
        .connectTimeout(DEFAULT_CONNECT_TIMEOUT, TimeUnit.SECONDS)
        .readTimeout(DEFAULT_READ_TIMEOUT, TimeUnit.SECONDS)
        .writeTimeout(DEFAULT_WRITE_TIMEOUT, TimeUnit.SECONDS)
        // cookie管理
        .cookieJar(new PersistentCookieJar(new SetCookieCache(), new SharedPrefsCookiePersistor(App.getInstance())));

0x01 Cookie持久化管理

這部分主要參考了這篇文章。

  • 不帶持久化
builder.cookieJar(new CookieJar() {
        private final HashMap<HttpUrl, List<Cookie>> cookieStore = new HashMap<>();

        @Override
        public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
            cookieStore.put(url, cookies);
        }

        @Override
        public List<Cookie> loadForRequest(HttpUrl url) {
            List<Cookie> cookies = cookieStore.get(url);
            return cookies != null ? cookies : new ArrayList<Cookie>();
        }
    });

這種簡單的實(shí)現(xiàn)，每次重啟App都會需要重新登錄，不可取。

  • 帶持久化
CookieHandler cookieHandler = new CookieManager(
        new PersistentCookieStore(context), CookiePolicy.ACCEPT_ALL);
builder.cookieJar(new JavaNetCookieJar(cookieHandler));

這里出現(xiàn)了兩個(gè)類：JavaNetCookieJar和PersistentCookieStore

  • JavaNetCookieJar就是對CookieJar的封裝實(shí)現(xiàn)，里面實(shí)現(xiàn)了對Cookie持久化存儲和獲取的調(diào)用邏輯，OkHttp已經(jīng)幫我們實(shí)現(xiàn)了這個(gè)類，需要引入下面這個(gè)包:
compile 'com.squareup.okhttp3:okhttp-urlconnection:3.5.0'

  • PersistentCookieStore是具體實(shí)現(xiàn)Cookie持久化的類，使用的是SharedPreferences，具體代碼實(shí)現(xiàn)可參考這篇。
    當(dāng)然，如果你想通過數(shù)據(jù)庫實(shí)現(xiàn)持久化，也可以自己封裝一個(gè)類似的類去實(shí)現(xiàn)。

  • 再介紹一個(gè)封裝了Cookie持久化的第三方庫（推薦）

ClearableCookieJar cookieJar = new PersistentCookieJar(
        new SetCookieCache(), new SharedPrefsCookiePersistor(context));
builder.cookieJar(cookieJar);

需要引入下面這個(gè)包：

compile 'com.github.franmontiel:PersistentCookieJar:v1.0.0

0x02. 攔截器

  • addInterceptor和addNetworkInterceptor的區(qū)別
    前一篇文章有同學(xué)問到兩者的區(qū)別，okHttp官方對攔截器做了解釋，并給了一張圖，感覺挺一目了然的。

    Paste_Image.png
    Paste_Image.png

    兩種攔截器簡單來說就是調(diào)用時(shí)機(jī)的區(qū)別，應(yīng)用攔截器調(diào)用時(shí)機(jī)較早，也就是進(jìn)入chain.proceed的遞歸較早，相應(yīng)的完成遞歸得到response會較晚；而網(wǎng)絡(luò)攔截器則相反，request請求調(diào)用時(shí)機(jī)較晚，會較早完成chain.proceed遞歸調(diào)用，得到response的時(shí)機(jī)較早。
    簡單來說就是應(yīng)用攔截器較上層，而網(wǎng)絡(luò)攔截器較底層，所有攔截器就是一個(gè)由淺入深的遞歸調(diào)用。具體還是得看源碼。

  • Http Header
    可以通過這個(gè)攔截器為Request添加全局統(tǒng)一的Header。

/**
 * 網(wǎng)絡(luò)請求公共頭信息插入器
 *
 * Created by XiaoFeng on 17/1/18.
 */
public class HttpHeaderInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request original = chain.request();
        Request request = original.newBuilder()
                .header("User-Agent", "Android, xxx")
                .header("Accept", "application/json")
                .header("Content-type", "application/json")
                .method(original.method(), original.body())
                .build();
        return chain.proceed(request);
    }
}
  1. 公共參數(shù)
    主要參考這篇 
/**
 * 網(wǎng)絡(luò)請求公共參數(shù)插入器
 * <p>
 * Created by XiaoFeng on 2017/1/25.
 */
public class CommonParamsInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        if (request.method().equals("GET")) {
            HttpUrl httpUrl = request.url().newBuilder()
                    .addQueryParameter("version", "xxx")
                    .addQueryParameter("device", "Android")
                    .addQueryParameter("timestamp", String.valueOf(System.currentTimeMillis()))
                    .build();
            request = request.newBuilder().url(httpUrl).build();
        } else if (request.method().equals("POST")) {
            if (request.body() instanceof FormBody) {
                FormBody.Builder bodyBuilder = new FormBody.Builder();
                FormBody formBody = (FormBody) request.body();

                for (int i = 0; i < formBody.size(); i++) {
                    bodyBuilder.addEncoded(formBody.encodedName(i), formBody.encodedValue(i));
                }

                formBody = bodyBuilder
                        .addEncoded("version", "xxx")
                        .addEncoded("device", "Android")
                        .addEncoded("timestamp", String.valueOf(System.currentTimeMillis()))
                        .build();

                request = request.newBuilder().post(formBody).build();
            }
        }

        return chain.proceed(request);
    }
}
  1. 緩存策略
/**
 * 網(wǎng)絡(luò)請求緩存策略插入器
 *
 * Created by XiaoFeng on 17/1/17.
 */
public class HttpCacheInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        // 無網(wǎng)絡(luò)時(shí)，始終使用本地Cache
        if (!NetworkUtil.isNetworkConnected()) {
            request = request.newBuilder()
                    .cacheControl(CacheControl.FORCE_CACHE)
                    .build();
        }

        Response response = chain.proceed(request);
        if (NetworkUtil.isNetworkConnected()) {
            // 有網(wǎng)絡(luò)時(shí)，設(shè)置緩存過期時(shí)間0個(gè)小時(shí)
            int maxAge = 0;
            response.newBuilder()
                    .header("Cache-Control", "public, max-age=" + maxAge)
                    .removeHeader("Pragma") // 清除頭信息，因?yàn)榉?wù)器如果不支持，會返回一些干擾信息，不清除下面無法生效
                    .build();
        } else {
            // 無網(wǎng)絡(luò)時(shí)，設(shè)置緩存過期超時(shí)時(shí)間為4周
            int maxStale = 60 * 60 * 24 * 28;
            response.newBuilder()
                    .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
                    .removeHeader("Pragma")
                    .build();
        }
        return response;
    }
}
  1. 調(diào)試工具
    使用的是Facebook推出的一個(gè)集成到Chrome中的調(diào)試工具，需要引入下面兩個(gè)庫：
compile 'com.facebook.stetho:stetho:1.4.1'
compile 'com.facebook.stetho:stetho-okhttp3:1.4.1'

在Application中初始化就可以用了

Stetho.initializeWithDefaults(this);

如何調(diào)試？

  • 打開Chrome瀏覽器
  • 地址欄輸入chrome://inspect
  • 進(jìn)入頁面后，在左邊的DevTools -> Devices -> Remote Target下，可以找到你連接的手機(jī)設(shè)備，點(diǎn)開后就會出現(xiàn)調(diào)試頁面了，后面就自己研究吧，不光可以調(diào)試網(wǎng)絡(luò)請求，還可以查看手機(jī)中的數(shù)據(jù)庫和SharePreference等持久化文件，而且不用root，很強(qiáng)大！

0x03. FastJson解析庫封裝

網(wǎng)上很多介紹retrofit的文章，對網(wǎng)絡(luò)請求返回的結(jié)果，使用的都是默認(rèn)的Gson庫，雖然可以滿足大部分人的需求，但是有些對性能要求高一點(diǎn)的人，還是習(xí)慣使用FastJson庫做解析，這里就講講如何把默認(rèn)的Gson庫替換成FastJson庫。

首先，默認(rèn)Gson庫的設(shè)置是這樣的：

Retrofit retrofit = new Retrofit.Builder()
                .client(builder.build())
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .baseUrl(BASE_URL)
                .build();

用FastJson庫替換后是這樣的：

Retrofit retrofit = new Retrofit.Builder()
                .client(builder.build())
                .addConverterFactory(FastJsonConvertFactory.create())
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .baseUrl(BASE_URL)
                .build();

是不是很像，沒錯(cuò)，就是把ConverterFactory替換了一下而已。

至于FastJsonConvertFactory的實(shí)現(xiàn)，其實(shí)就是仿造GsonConverterFactory的源碼來寫的，并不復(fù)雜。

主要有三個(gè)類：

  1. 工廠類：FastJsonConvertFactory，里面就是分別創(chuàng)建了Request和Response的轉(zhuǎn)換類。
/**
 *
 * Created by XiaoFeng on 2017/1/17.
 */
public class FastJsonConvertFactory extends Converter.Factory {
    public static FastJsonConvertFactory create() {
        return new FastJsonConvertFactory();
    }

    @Override
    public Converter<?, RequestBody> requestBodyConverter(Type type, Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
        return new FastJsonRequestConverter<>();
    }

    @Override
    public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
        return new FastJsonResponseConverter<>(type);
    }
}
  1. Request轉(zhuǎn)換類：FastJsonRequestConverter
/**
 *
 * Created by XiaoFeng on 2017/1/17.
 */
public class FastJsonRequestConverter<T> implements Converter<T, RequestBody> {
    private static final MediaType MEDIA_TYPE = MediaType.parse("application/json; charset=UTF-8");
    private static final Charset UTF_8 = Charset.forName("UTF-8");

    @Override
    public RequestBody convert(T value) throws IOException {
        return RequestBody.create(MEDIA_TYPE, JSON.toJSONBytes(value));
    }
}
  1. Response轉(zhuǎn)換類：FastJsonResponseConverter
/**
 *
 * Created by XiaoFeng on 2017/1/17.
 */
public class FastJsonResponseConverter<T> implements Converter<ResponseBody, T> {
    private final Type type;

    public FastJsonResponseConverter(Type type) {
        this.type = type;
    }

    @Override
    public T convert(ResponseBody value) throws IOException {
        BufferedSource buffer = Okio.buffer(value.source());
        String s = buffer.readUtf8();
        buffer.close();
        return JSON.parseObject(s, type);
    }
}

是不是很簡單，如果想再換成別的第三方j(luò)son解析庫，照著這個(gè)寫就可以了。

0x04. 生命周期

上一篇中還有同學(xué)提到RxJava的生命周期管理，防止內(nèi)存泄漏，這個(gè)可以直接使用第三方庫，參考這篇。
一般引用下面兩個(gè)庫就夠了：

compile 'com.trello:rxlifecycle:1.0'
compile 'com.trello:rxlifecycle-components:1.0'

有兩種使用方式：
1. 自動(dòng)取消訂閱，使用bindToLifecycle。
需要繼承至RxActivity或者RxFragment等基類。

@Override
protected void onStart() {
    super.onStart();
    // Using automatic unsubscription, this should determine that the correct time to
    // unsubscribe is onStop (the opposite of onStart).
    Observable.interval(1, TimeUnit.SECONDS)
            .doOnUnsubscribe(new Action0() {
                @Override
                public void call() {
                    Log.i(TAG, "Unsubscribing subscription from onStart()");
                }
            })
            // 因?yàn)閎indToLifecycle是在onStart的時(shí)候調(diào)用，所以在onStop的時(shí)候自動(dòng)取消訂閱
            .compose(this.<Long>bindToLifecycle())
            .subscribe(new Action1<Long>() {
                @Override
                public void call(Long num) {
                    Log.i(TAG, "Started in onStart(), running until in onStop(): " + num);
                }
            });
}

從下面這段核心函數(shù)可以看清自動(dòng)取消訂閱的規(guī)則，就是在哪個(gè)生命周期內(nèi)調(diào)用bindToLifecycle，就在與其對應(yīng)的結(jié)束生命周期函數(shù)調(diào)用時(shí)自動(dòng)取消訂閱。

private static final Func1<ActivityEvent, ActivityEvent> ACTIVITY_LIFECYCLE =
        new Func1<ActivityEvent, ActivityEvent>() {
            @Override
            public ActivityEvent call(ActivityEvent lastEvent) {
                switch (lastEvent) {
                    case CREATE:
                        return ActivityEvent.DESTROY;
                    case START:
                        return ActivityEvent.STOP;
                    case RESUME:
                        return ActivityEvent.PAUSE;
                    case PAUSE:
                        return ActivityEvent.STOP;
                    case STOP:
                        return ActivityEvent.DESTROY;
                    case DESTROY:
                        throw new OutsideLifecycleException("Cannot bind to Activity lifecycle when outside of it.");
                    default:
                        throw new UnsupportedOperationException("Binding to " + lastEvent + " not yet implemented");
                }
            }
        };

2. 手動(dòng)取消訂閱，使用bindUntilEvent。
需要繼承至RxActivity或者RxFragment等基類。

@Override
protected void onResume() {
    super.onResume();
    // `this.<Long>` is necessary if you're compiling on JDK7 or below.
    // If you're using JDK8+, then you can safely remove it.
    Observable.interval(1, TimeUnit.SECONDS)
            .doOnUnsubscribe(new Action0() {
                @Override
                public void call() {
                    Log.i(TAG, "Unsubscribing subscription from onResume()");
                }
            })
            // 手動(dòng)設(shè)置在Activity onDestroy的時(shí)候取消訂閱
            .compose(this.<Long>bindUntilEvent(ActivityEvent.DESTROY))
            .subscribe(new Action1<Long>() {
                @Override
                public void call(Long num) {
                    Log.i(TAG, "Started in onResume(), running until in onDestroy(): " + num);
                }
            });
}

3. 自定義RxActivity/RxFragment
直接繼承RxActivity/RxFragment有時(shí)會碰到問題，因?yàn)橛锌赡鼙旧硪呀?jīng)有一個(gè)基類需要繼承，java不能多繼承。不過不要慌，我們可以自定義一個(gè)自己的基類，實(shí)現(xiàn)方式參考RxActivity。

public abstract class RxActivity extends Activity implements LifecycleProvider<activityevent> {
    private final BehaviorSubject<activityevent> lifecycleSubject = BehaviorSubject.create();

    public RxActivity() {
    }

    @NonNull
    @CheckResult
    public final Observable<activityevent> lifecycle() {
        return this.lifecycleSubject.asObservable();
    }

    @NonNull
    @CheckResult
    public final <t> LifecycleTransformer<t> bindUntilEvent(@NonNull ActivityEvent event) {
        return RxLifecycle.bindUntilEvent(this.lifecycleSubject, event);
    }

    @NonNull
    @CheckResult
    public final <t> LifecycleTransformer<t> bindToLifecycle() {
        return RxLifecycleAndroid.bindActivity(this.lifecycleSubject);
    }

    @CallSuper
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        this.lifecycleSubject.onNext(ActivityEvent.CREATE);
    }

    @CallSuper
    protected void onStart() {
        super.onStart();
        this.lifecycleSubject.onNext(ActivityEvent.START);
    }

    @CallSuper
    protected void onResume() {
        super.onResume();
        this.lifecycleSubject.onNext(ActivityEvent.RESUME);
    }

    @CallSuper
    protected void onPause() {
        this.lifecycleSubject.onNext(ActivityEvent.PAUSE);
        super.onPause();
    }

    @CallSuper
    protected void onStop() {
        this.lifecycleSubject.onNext(ActivityEvent.STOP);
        super.onStop();
    }

    @CallSuper
    protected void onDestroy() {
        this.lifecycleSubject.onNext(ActivityEvent.DESTROY);
        super.onDestroy();
    }
}

突然發(fā)現(xiàn)寫文章真是一個(gè)知識梳理，自我學(xué)習(xí)的好方法，比沒有目的性的看很多技術(shù)文章有用很多倍，極力推薦有能力的同學(xué)都去嘗試寫屬于自己的技術(shù)博客。^ ^

參考：
https://gold.xitu.io/entry/572ed42ddf0eea0063186e1f
https://gist.github.com/franmontiel/ed12a2295566b7076161
https://gold.xitu.io/entry/5825300b2f301e005c47fac5
http://www.codexiu.cn/android/blog/39432/
http://androidxx.ren/forum.php?mod=viewthread&tid=19
https://gold.xitu.io/entry/58290ea2570c35005878ce8f

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

相關(guān)閱讀更多精彩內(nèi)容

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