2. 程式人生 > >OkHttp3.0(結合Retrofit2/Rxjava)利用攔截器實現全域性超時自動登入、新增統一引數

OkHttp3.0(結合Retrofit2/Rxjava)利用攔截器實現全域性超時自動登入、新增統一引數

阿新 • • 發佈：2019-02-19

應用場景：1.服務端為了統計各個平臺、版本的使用情況，有時在介面中要求傳遞統一的諸如version(客戶端版本)、os(客戶端平臺android/iOS)、userId等引數，這時如果在介面中一一新增就比較繁瑣了，考慮做全域性處理；另外，一次登入成功後，登入狀態都是有時效的，所以在發生登入失效後，需要自動重新重新整理登入狀態，而且一般情況下，單個請求在發出前是沒法判斷是否已經登入超時的，所以就需要一個全域性的處理方案。

其實這個與Retrofit2/Rxjava貌似沒有關係，之所以標題裡提到這個，是因為我的專案是結合這倆庫用的，我在搜尋這類問題的解決方法時就是從Retrofit2/Rxjava的retryWhen方法下手的，後來發現直接在OkHttpClient新增攔截器，即可實現想要的效果，而且是全域性性的，這應該是這類問題的最簡單解決方式了。

主要程式碼如下：
Network.java

import android.text.TextUtils;
import android.util.Log;

import com.google.gson.Gson;
import com.google.gson.JsonObject;

import org.greenrobot.eventbus.EventBus;
import org.json.JSONException;
import org.json.JSONObject;

import java.io.IOException;
import java.nio.charset.Charset;
import
 
 java.util.ArrayList;
import java.util.List;

import okhttp3.Cookie;
import okhttp3.CookieJar;
import okhttp3.FormBody;
import okhttp3.HttpUrl;
import okhttp3.Interceptor;
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import
 
 okhttp3.ResponseBody;
import okhttp3.logging.HttpLoggingInterceptor;
import okio.BufferedSource;
import retrofit2.Call;
import retrofit2.CallAdapter;
import retrofit2.Converter;
import retrofit2.Retrofit;
import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory;
import retrofit2.converter.gson.GsonConverterFactory;

public class Network {

    private static final String TAG = "Network";

    private static APIService apis;
    private static ReLoginService reLoginService;

    private static Converter.Factory mExtraGsonConverterFactory = ExtraGsonConverterFactory.create();
    private static CallAdapter.Factory rxJavaCallAdapterFactory = RxJavaCallAdapterFactory.create();

    public static APIService getAPIService() {
        if (apis == null) {
            // TODO 最後關閉日誌
            HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
            loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

            // OkHttp3.0的使用方式
            OkHttpClient okHttpClient = new OkHttpClient.Builder()
                    .retryOnConnectionFailure(true)
                    .addInterceptor(new Interceptor() {
                        @Override
                        public Response intercept(Chain chain) throws IOException {
                            Request original = chain.request();
                            Request.Builder requestBuilder = original.newBuilder();
                            if (original.body() instanceof FormBody) {
                                FormBody.Builder newFormBody = new FormBody.Builder();
                                FormBody oldFormBody = (FormBody) original.body();
                                for (int i = 0; i < oldFormBody.size(); i++) {
                                    newFormBody.addEncoded(oldFormBody.encodedName(i), oldFormBody.encodedValue(i));
                                }
                                newFormBody.add("os", "android");
                                requestBuilder.method(original.method(), newFormBody.build());
                            } else if (original.body() instanceof MultipartBody) {
                                MultipartBody.Builder newFormBody = new MultipartBody.Builder();
                                // 預設是multipart/mixed，大坑【主要是我們php後臺接收時頭資訊要求嚴格】
                                newFormBody.setType(MediaType.parse("multipart/form-data"));
                                MultipartBody oldFormBody = (MultipartBody) original.body();
                                for (int i = 0; i < oldFormBody.size(); i++) {
                                    newFormBody.addPart(oldFormBody.part(i));
                                }
                                newFormBody.addFormDataPart("os", "android");
                                requestBuilder.method(original.method(), newFormBody.build());
                            } else if (TextUtils.equals(original.method(), "POST")) {
                                FormBody.Builder newFormBody = new FormBody.Builder();
                                newFormBody.add("os", "android");
                                requestBuilder.method(original.method(), newFormBody.build());
                            }

                            Request request = requestBuilder.build();
                            return chain.proceed(request);
                        }
                    })
                    .addInterceptor(new Interceptor() {
                        @Override
                        public Response intercept(final Chain chain) throws IOException {
                            // 原始請求
                            Request request = chain.request();
                            Response response = chain.proceed(request);
                            ResponseBody responseBody = response.body();
                            BufferedSource source = responseBody.source();
                            source.request(Long.MAX_VALUE);
                            String respString = source.buffer().clone().readString(Charset.defaultCharset());
                            Log.d(TAG, "--->返回報文，respString = " + respString);
                            // TODO 這裡判斷是否是登入超時的情況
                            JSONObject j = null;
                            try {
                                j = new JSONObject(respString);
                            } catch (JSONException e) {
                                e.printStackTrace();
                            }
                            // 這裡與後臺約定的狀態碼700表示登入超時【後臺是java，客戶端自己維護cookie，沒有token機制。但此處如果重新整理token，方法也一樣】
                            if (j!= null && j.optInt("status") == 700) {
                                Log.d(TAG, "--->登入失效，自動重新登入");
                                // TODO 本地獲取到之前的user資訊
                                UserInfo  user = SysApplication.getInstance().getDB().getCurrentUser();
                                if (user == null) {
                                    Log.d(TAG, "--->使用者為空需要使用者主動去登入");
                                    // 扔出需要手動重新登入的異常（BaseSubscriber裡處理）
                                    throw new ExtraApiException(700, "請登入");
                                }
                                String phoneNum = user.getPhoneNum();
                                String password = user.getPass();
                                Call<JsonObject> call = getReloginService().reLogin(phoneNum, password);
                                JsonObject json = call.execute().body();
                                // 判斷是否登入成功了
                                if (json.get("status").getAsInt() == 200) {
                                    // TODO 登入成功後，根據需要儲存使用者資訊、會話資訊等
                                    // 最重要的是將當前請求重新執行一遍!!!
                                    response = chain.proceed(request);
                                    Log.d(TAG, "--->完成二次請求");
                                } else {
                                    Log.d(TAG, "--->自動登入失敗");
                                    // TODO 扔出需要手動重新登入的異常（BaseSubscriber裡處理，此時已經是自動重新登入也不行，如密碼在其他終端修改了之類的）
                                    throw new ExtraApiException(700, "請重新登入");
                                }
                            }
                            return response;
                        }
                    })
                    .cookieJar(new CookieJar() {
                        List<Cookie> cookies;
                        @Override
                        public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
                             // TODO 根據實際後臺返回資訊，儲存cookies
                        }

                        @Override
                        public List<Cookie> loadForRequest(HttpUrl url) {

                            return cookies;
                        }
                    })
                    .addInterceptor(loggingInterceptor)
                    .build();

            Retrofit retrofit = new Retrofit.Builder()
                    .baseUrl(Constant.HOST_APP)
                    .addConverterFactory(mExtraGsonConverterFactory)
                    .addCallAdapterFactory(rxJavaCallAdapterFactory)
                    .client(okHttpClient)
                    .build();
            apis = retrofit.create(APIService.class);
        }
        return apis;
    }


    // 重新登入之所以單獨寫在一個interface中，是因為其他所有方法都採用了自定義Gson解析器，在解析器裡就處理了最外層的status，只獲取有效資訊
    // 重新登入時，需要自己重新處理，並儲存cookie等資訊
    public static ReLoginService getReloginService() {
        if (reLoginService == null) {
            // TODO 最後關閉日誌
            HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
            loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

            // OkHttp3.0的使用方式
            OkHttpClient okHttpClient = new OkHttpClient.Builder()
                    .addInterceptor(loggingInterceptor)
                    .cookieJar(new CookieJar() {
                        @Override
                        public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
                            // TODO
                        }

                        @Override
                        public List<Cookie> loadForRequest(HttpUrl url) {
                            return new ArrayList<>();
                        }
                    })
                    .build();

            Retrofit retrofit = new Retrofit.Builder()
                    .baseUrl(Constant.HOST_APP)
                    .addConverterFactory(GsonConverterFactory.create())
                    .client(okHttpClient)
                    .build();
            reLoginService = retrofit.create(ReLoginService.class);
        }
        return reLoginService;

    }
}

ExtraGsonResponseBodyConverter.java這個是自定義解析器，作用是去除服務端返回的最外層資訊，只保留內部有效資訊體。另外可以統一處理返回的status，丟擲自定義異常，然後在全域性統一的Subscriber中onError處理。

import android.text.TextUtils;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.nio.charset.Charset;

import okhttp3.MediaType;
import okhttp3.ResponseBody;
import retrofit2.Converter;

import static okhttp3.internal.Util.UTF_8;

final class ExtraGsonResponseBodyConverter<T> implements Converter<ResponseBody, T> {
    private final Gson gson;
    private final TypeAdapter<T> adapter;

    ExtraGsonResponseBodyConverter(Gson gson, TypeAdapter<T> adapter) {
        this.gson = gson;
        this.adapter = adapter;
    }

    @Override
    public T convert(ResponseBody value) throws IOException {
        try {
            JSONObject response = new JSONObject(value.string());


            // 結果狀態不對的，統一丟擲異常，進入Subscriber的onError回撥函式
            if (response.optInt("status") != 200) {
                value.close();
                throw new ExtraApiException(response.optInt("status"), response.optString("message"));
            }

            // 後臺返回不統一、不規範，客戶端來背鍋處理……
            String info = response.optString("json");
            if (TextUtils.isEmpty(info)) {
                info = response.optString("resultList");
            }
            if (TextUtils.isEmpty(info) || TextUtils.equals(info.toLowerCase(), "null")) {
                info = "{}";
            }

            MediaType contentType = value.contentType();
            Charset charset = contentType != null ? contentType.charset(UTF_8) : UTF_8;


            InputStream inputStream = new ByteArrayInputStream(info.getBytes());
            Reader reader = new InputStreamReader(inputStream, charset);
            JsonReader jsonReader = gson.newJsonReader(reader);

            return adapter.read(jsonReader);
        } catch (JSONException e) {
            throw new IOException();
        } finally {
            value.close();
        }
    }
}

ReLoginService.java用於單獨進行重新登入請求，保留了服務端返回的所有資訊體。

import com.google.gson.JsonObject;

import retrofit2.Call;
import retrofit2.http.Field;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.POST;


public interface ReLoginService {

    /**
     * 登入
     *
     * @param name 使用者名稱
     * @param pass ，密碼
     */
    @FormUrlEncoded
    @POST("msLogin")
    Call<JsonObject> reLogin(
            @Field("name") String name,
            @Field("pass") String pass
    );
}

至此，問題解決，主要思路就是，利用OkHttpClient的OkHttpClient方法：

  • 將原有請求重新組裝
  • 將響應資訊預處理，如果對應的是登入失效，則進行重新登入，若登入成功就再次執行原請求；如登入不成功，則提示使用者自己去登入

此外，還有幾點說明：

  • 自定義ConverterFactory有利於將返回資訊中的無效資訊或過多層級統一處理掉，簡化單個請求成功後的處理邏輯
  • 自定義Exception有利於在全域性統一的Subscriber（結合RxJava）中處理異常
  • 用於輔助檢視請求資訊的HttpLoggingInterceptor，要到最後進行addInterceptor，不然你之前做的處理（cookie、新增的引數）可能看在日誌裡就看不到了

相關推薦

OkHttp3.0(結合Retrofit2/Rxjava)利用攔截器實現全域性超時自動登入、新增統一引數

應用場景：1.服務端為了統計各個平臺、版本的使用情況，有時在介面中要求傳遞統一的諸如version(客戶端版本)、os(客戶端平臺android/iOS)、userId等引數，這時如果在介面中一一新增就比較繁瑣了，考慮做全域性處理；另外，一次登入成功後，

學習淘淘商城第一百零三課（利用攔截器實現登入功能及訂單確認頁面展示）

        我們上節課一起搭建了訂單的服務工程和web工程，我們參考京東可以知道，京東在沒有登入時就可以使用購物車，但是當要真正付款的時候，一定是要求登入的。也就是說由購物車列表頁面直接跳轉到登入頁面去登入。這顯然用到了攔截器的功能，這節課我們便一起實現登入功能。  

註解+aop/攔截器實現防重複點選、機刷

攔截器實現 package com.qccr.cashcow.web.interceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpSer

利用expect + sftp 實現遠端主機自動登入及下載

利用expect + sftp 實現遠端主機自動登入及下載： (ssh是一樣的) #!/usr/bin/expect -f ## Create by Cyril. ## "Usage:./downFilesFromStation USER PWD RemoteIP SourcePat

十一、利用攔截器統計action執行時間

err cep time exceptio execute method current result ack 1.新建login.jsp <body> <a href="HelloAction.action">點擊統計action執行時間

OkHttp3.0解析——談談內部任務分發器dispatcher

前言 OkHttp之所以能夠高效處理任務的一個很重要原因在於其內部維護了三個任務佇列(readyAsyncCalls、runningAsyncCalls、runningSyncCalls)和一個執行緒池(ThreadPoolExecutor)。這四個東西由內部的任務分發器dispathcer來進行調控處理，

Spring RestTemplate 利用攔截器列印請求引數和返回狀態

  最近在專案中遇到用RestTemplate請求另外一個服務介面，發現總是報400返回。或許由於對400錯誤不是很瞭解，除錯了很久。但是過了好一段時間，發現自己進展不大，由此，諮詢下了經驗豐富的人，也解決了RestTemplate請求另外服務介面的方法。    很多人都基

利用Mybatis攔截器實現分頁查詢

手寫Mybatis攔截器 版本 Spring Boot 2.0.3.RELEASE Mybatis自定義攔截器 如果有閱讀過我之前一篇部落格 Hibernate 重新整理上下文 的朋友應該還記得 Hibernate 的上下文中可以新增自定義的事件監聽器。當初是為

SpringMVC利用攔截器防止SQL注入

引言 隨著網際網路的發展，人們在享受網際網路帶來的便捷的服務的時候，也面臨著個人的隱私洩漏的問題。小到一個擁有使用者系統的小型論壇，大到各個大型的銀行機構，網際網路安全問題都顯得格外重要。而這些網站的背後，則是支撐整個服務的核心資料庫。可以說資料庫就是這些服務的命脈，沒有資料庫，也就無從談起這些服務了。 對於

SpringMVC利用攔截器攔截自定義註解

前幾篇文章裡寫了關於token的個人思考，那麼具體在程式碼中要怎麼實現攔截token，今天寫了一段程式碼，記錄一下 框架：SpringMVC Spring 執行環境:tomcat8 說一下思路： 1.自定一個註解，然後註解在我的Controller方法上 2.實現Sprin

springboot2.0版本配置自定義攔截器 WebMvcConfigurationSupport WebMvcConfigurer WebMvcConfigurerAdapter的坑

專案中想新增自定義的攔截器，一開始通過配置繼承WebMvcConfigurerAdapter如： @Configuration public class WebConfig extends WebMvcConfigurerAdapter {

升級okhttp3.0+和retrofit2.0+的過程以及遇到的坑

包名變化 okhttp3.0之前是：com.squareup.okhttp.*， 而到3.0之後變成：okhttp3.* retrofit2.0之前：retrofit.* retrofit2.0之後：retrofit2.* 都在末尾增加了版本號，顯示的更專業，但是這也給

Vue2.0 axios前後端登陸攔截器

vue更新到2.0之後，作者就宣告不再對vue-resource更新，而是推薦使用axios。前段時間第一次在專案裡用到vue，關於登陸問題，這裡寫一下心得。 首先後端： import org.springframework.web.servlet.ha

Spring中利用攔截器控制登入及頁面跳轉

一、問題簡要描述： 在做web開發的時候往往會遇到這種情況，使用者在沒登入的情況下訪問一些需要身份驗證的頁面，系統會自動幫使用者跳轉到登入頁面，使用者登入成功後，不會返回一個固定的頁面，系統會跳轉到使用者之前訪問的頁面，使用者可以繼續進行剛才的操作。或者是session裡面

AOP框架Dora.Interception 3.0 [4]: 基於特性的攔截器註冊

按照單一職責的原則，攔截器只負責需要的攔截操作的執行，至於它採用何種方式應用到目標方法上，以及它在整個攔截器管道中的位置則屬於“攔截器註冊”的範疇。Dora.Interception提供了幾種典型的註冊方法，使用者也可以根據自己的需求實現自己的註冊方式。一、IInterceptorPr

EF Core3.0+ 通過攔截器實現讀寫分離與SQL日誌記錄

前言 本文主要是講解EF Core3.0+ 通過攔截器實現讀寫分離與SQL日誌記錄 注意攔截器只有EF Core3.0+ 支援,2.1請考慮上下文工廠的形式實現. 說點題外話.. 一晃又大半年沒更新技術部落格..唉,去年一年發生了太多事情..博主真的 一言難盡.. 有興趣的可以去看看:記錄一下,也許是轉折,也

Angularjs註入攔截器實現Loading效果

loading mark func code hid js註入 如果 date() osi angularjs作為一個全ajax的框架，對於請求，如果頁面上不做任何操作的話，在結果煩回來之前，頁面是沒有任何響應的，不像普通的HTTP請求，會有進度條之類。 什麽是攔截器？

myBatis學習筆記（10）——使用攔截器實現分頁查詢

條件 iba execute rri itl alias property gen func 1. Page package com.sm.model; import java.util.List; public class Page<T&g

通過spring抽象路由數據源+MyBatis攔截器實現數據庫自動讀寫分離

註入 兩個 -- 事情 rem 使用註解 connect key值 -m 前言 之前使用的讀寫分離的方案是在mybatis中配置兩個數據源，然後生成兩個不同的SqlSessionTemplate然後手動去識別執行sql語句是操作主庫還是從庫。如下圖所示： 好處是，你

springboot攔截器實現

list not boolean ret pac req webapp turn esc package webapp.dao.bcf; import org.springframework.context.annotation.Configuration; impor