OkHttp 3.x 原始碼解析之Interceptor 攔截器

Tamic發表於2017-11-14
HTTP原始碼

Tamic / 

開發者技術前線

OkHttp攔截器原理解析


在進行下文前，先說明一點，本文面向的是對Okhttp有一定基礎的讀者，Okhttp基礎使用請閱讀我的其他OKhttp+Retrofit+RxJava基礎用法的文章：


OKhttp核心架構


OkHttp 3.x 原始碼解析之Interceptor 攔截器

圖片來自於網路，文章由於我是通過其他平臺搬家過來的，時間久了我忘記是哪位作者畫的，如果作者看到請聯絡我，我加上來源。

Okhttp大致包含四層，應用層，協議層，連線層，會話層， 本系列只分析應用層，協議層。

攔截器

Java裡的攔截器是動態攔截Action呼叫的物件。它提供了一種機制可以使開發者可以定義在一個action執行的前後執行的程式碼，也可以在一個action執行前阻止其執行，同時也提供了一種可以提取action中可重用部分的方式。
在AOP（Aspect-Oriented Programming）中攔截器用於在某個方法或欄位被訪問之前，進行攔截然後在之前或之後加入某些操作。

過濾器

過濾器可以簡單理解為“取你所想取”，忽視掉那些你不想要的東西；攔截器可以簡單理解為“拒你所想拒”，關心你想要拒絕掉哪些東西，比如一個BBS論壇上攔截掉敏感詞彙。

  • 1.攔截器是基於java反射機制的，而過濾器是基於函式回撥的。
  • 2.過濾器依賴於servlet容器，而攔截器不依賴於servlet容器。
  • 3.攔截器只對action起作用，而過濾器幾乎可以對所有請求起作用。
  • 4.攔截器可以訪問action上下文、值棧裡的物件，而過濾器不能。
  • 5.在action的生命週期裡，攔截器可以多起呼叫，而過濾器只能在容器初始化時呼叫一次。

Android裡面過濾器大家用的已經無法再陌生了，Filter就是一個很好的列子，在清單檔案註冊Filter就可以過濾啟動某個元件的Action.

Okhttp攔截器因此應運而生，處理一次網路呼叫的Action攔截，做修改操作。

OKHTTP INTERCEPTOR

使用

okhttp攔截器的用法很簡單，構建OkHttpClient時候通過.addInterceptor（）就可以將攔截器加入到一次會話中。

OkHttpClient client = new OkHttpClient.Builder()
     .addInterceptor(new LoggingInterceptor())
     .build();123複製程式碼

攔截器

攔截器是Okhttp一種強大的機制，可以監視，重寫和重試每一次請求。下面示列了一個簡單的攔截器，用於記錄傳出的請求和傳入的響應。

class LoggingInterceptor implements Interceptor {
  @Override public Response intercept(Interceptor.Chain chain) throws IOException {
   Request request = chain.request();

   long t1 = System.nanoTime();
   logger.info(String.format("Sending request %s on %s%n%s",
   request.url(), chain.connection(), request.headers()));

   Response response = chain.proceed(request);

   long t2 = System.nanoTime();
    logger.info(String.format("Received response for %s in %.1fms%n%s",
   response.request().url(), (t2 - t1) / 1e6d, response.headers()));

return response;
  }
}複製程式碼

請求chain.proceed(request)是每個攔截器實現的關鍵部分。這個簡單的方法是所有HTTP產生請求的地方，生產滿足請求的響應。

攔截器可以自定義。假設你同時擁有一個壓縮攔截器和一個校驗攔截器：你需要確定資料是否已壓縮，然後進行校驗，或校驗然後壓縮。 OkHttp使用列表List來跟蹤攔截器，攔截器按順序有序的呼叫。

應用攔截器

攔截器可以被註冊為應用程式或網路攔截器。我們將使用LoggingInterceptor上面定義來顯示差異。

註冊一個應用程式通過呼叫攔截器addInterceptor()上OkHttpClient.Builder：

OkHttpClient client = new OkHttpClient.Builder()
      .addInterceptor(new LoggingInterceptor())
       .build();

Request request = new Request.Builder()
     .url("http://tamic.com/helloworld.txt")
     .header("User-Agent", "OkHttp Example")
      .build();

Response response = client.newCall(request).execute();
response.body().close();複製程式碼

URLhttp://tamic.com/helloworld.txt重定向到https://amic.com/helloworld.txt.txt，OkHttp自動跟隨此重定向。我們的應用攔截器被呼叫一次，返回的響應chain.proceed()具有重定向的響應：

INFO: Sending request www.publicobject.com/helloworld.… on null
User-Agent: OkHttp Example

INFO: Received response for tamic.com/helloworld.…t in 1179.7ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/plain
Content-Length: 1759
Connection: keep-alive

我們可以看到，被重定向是因為response.request().url()不同於request.url()。兩個日誌語句記錄兩個不同的URL。

網路攔截器

註冊網路攔截器和註冊應用攔截器非常相似的。是呼叫addNetworkInterceptor()而不是地呼叫addInterceptor();

   OkHttpClient client = new OkHttpClient.Builder()
            .addNetworkInterceptor(new LoggingInterceptor())
            .build();

     Request request = new Request.Builder()
          .url("http://www.tamicer.com/helloworld.txt")
          .header("User-Agent", "OkHttp Example")
          .build();

     Response response = client.newCall(request).execute();
              response.body().close();

複製程式碼

當我們執行這段程式碼時，攔截器執行兩次。一次為初始請求http://www.tamicer.com/helloworld.txt，另一個為重定向https:/http://www.tamicier.com/helloworld.txt。

INFO: Sending request http://www.tamicer.com/helloworld.txt/helloworld.txt on Connection{www.publicobject.com:80, proxy=DIRECT hostAddress=54.187.32.157 cipherSuite=none protocol=http/1.1}
User-Agent: OkHttp Example
Host: www.publicobject.com
Connection: Keep-Alive
Accept-Encoding: gzip
123456複製程式碼

INFO: Received response for www.tamicer.com/helloworld.… in 115.6ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/html
Content-Length: 193
Connection: keep-alive
Location: www.tamicer.com/helloworld.…

INFO: Sending request publicobject.com/helloworld.… on Connection{publicobject.com:443, proxy=DIRECT hostAddress=54.187.32.157 cipherSuite=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA protocol=http/1.1}
User-Agent: OkHttp Example
Host: publicobject.com
Connection: Keep-Alive
Accept-Encoding: gzip

INFO: Received response for publicobject.com/helloworld.… in 80.9ms
Server: nginx/1.4.6 (Ubuntu)
Content-Type: text/plain
Content-Length: 1759
Connection: keep-alive

網路請求還包含更多的資料，例如Accept-Encoding: gzip由OkHttp新增的Head來支援響應壓縮。網路攔截器Chain具有非空值Connection，可用於詢問用於連線到Web伺服器的IP地址和TLS配置。

在應用攔截器和網路攔截器之間如何進行選擇？

每個攔截器都有自己的相對優點。

應用攔截器

  • 不需要擔心中間響應，如重定向和重試。
  • 總是呼叫一次，即使從快取提供HTTP響應。
  • 遵守應用程式的原始意圖。不注意OkHttp注入的頭像If-None-Match。
  • 允許短路和不通話Chain.proceed()。
  • 允許重試並進行多次呼叫Chain.proceed()。

網路攔截器

  • 能夠對重定向和重試等中間響應進行操作。
  • 不呼叫快取的響應來短路網路。
  • 觀察資料，就像通過網路傳輸一樣。
  • 訪問Connection該請求。

重寫請求

攔截器可以新增，刪除或替換請求頭。還可以轉換具有一個請求的Body正文。例如，如果連線到已知支援它的Web伺服器，則可以使用應用程式攔截器新增請求體壓縮。

final class GzipRequestInterceptor implements Interceptor {
   @Override public Response intercept(Interceptor.Chain chain) throws IOException {
   Request originalRequest = chain.request();
   if (originalRequest.body() == null || originalRequest.header       ("Content-Encoding") != null) {
     return chain.proceed(originalRequest);
  }

  Request compressedRequest = originalRequest.newBuilder()
      .header("Content-Encoding", "gzip")
      .method(originalRequest.method(), gzip(originalRequest.body()))
      .build();
   return chain.proceed(compressedRequest);
 }

 private RequestBody gzip(final RequestBody body) {
    return new RequestBody() {
    @Override public MediaType contentType() {
       return body.contentType();
    }

     @Override public long contentLength() {
        return -1; 
        // We don't know the compressed length in advance!
     }

     @Override public void writeTo(BufferedSink sink) throws IOException {
       BufferedSink gzipSink = Okio.buffer(new GzipSink(sink));
       body.writeTo(gzipSink);
       gzipSink.close();
      }
    };
  }
}複製程式碼

重寫響應

當然攔截器可以重寫響應頭並轉換響應體。這通常比重寫請求頭更加有效果，因為他可以篡改網路伺服器的返回的原本的資料！

如果在棘手的情況，並準備應對伺服器返回的錯誤後果，重寫響應標頭是解決這個問題的有效方式。例如，可以修復伺服器配置錯誤的Cache-Control響應頭以啟用更好的響應快取：

private static final Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
   @Override public Response intercept(Interceptor.Chain chain) throws IOException {
  Response originalResponse = chain.proceed(chain.request());
   return originalResponse.newBuilder()
  .header("Cache-Control", "max-age=60")
  .build();
  }
};

複製程式碼

通常，這種方法彌補Web伺服器上的相應修復程式時效果最好！

工作原理

1 Interceptor程式碼本質：

攔截器原始碼：包含基礎的Request和Response 獲取介面，並有Connection介面

public interface Interceptor {
  Response intercept(Chain chain) throws IOException;

  interface Chain {
  Request request();

   Response proceed(Request request) throws IOException;

   /**
    * Returns the connection the request will be executed on. This is  only available in the chains
    * of network interceptors; for application interceptors this is  always null.
   */
  @Nullable Connection connection();
 }
}

複製程式碼

2 .Connection是神馬東西？

Connection是一次面向連線過程，這裡包含基礎的協議Protocol ， 通道Socket ， 路由Route， 和Handshake，

`public interface Connection {

  Route route();


  Socket socket();

  @Nullable Handshake handshake();

  Protocol protocol();
}複製程式碼

Handshake是ohkttp的握手機制，裡面包括了SSL驗證過程，這裡不做原始碼分析，這裡提供了基礎Https的認證的基礎根方法，本文不做探討。

Interceptor怎麼被呼叫：

發起請求

OkHttpClient mOkHttpClient = new OkHttpClient();
 Request request = new Request.Builder()
            .url("https://github.com/tamicer")
            .build();
//new call
Call call = mOkHttpClient.newCall(request); 複製程式碼

進行newCaLL

RealCall(OkHttpClient client, Request originalRequest, boolean forWebSocket) {
    final EventListener.Factory eventListenerFactory = client.eventListenerFactory();

    this.client = client;
    this.originalRequest = originalRequest;
    this.forWebSocket = forWebSocket;
    //這裡就是處理攔截器的地方！
    this.retryAndFollowUpInterceptor = new RetryAndFollowUpInterceptor(client, forWebSocket);

   // TODO(jwilson): this is unsafe publication and not threadsafe.
   this.eventListener = eventListenerFactory.create(this);
 }複製程式碼

處理請求攔截

@Override public Response intercept(Chain chain) throws IOException {
Request request = chain.request();

streamAllocation = new StreamAllocation(
    client.connectionPool(), createAddress(request.url()), callStackTrace);

int followUpCount = 0;
Response priorResponse = null;
while (true) {
  if (canceled) {
    streamAllocation.release();
    throw new IOException("Canceled");
  }

  Response response = null;
  boolean releaseConnection = true;
  try {

    //也就是這裡進行上層注入的攔截器進行攔截
    response = ((RealInterceptorChain) chain).proceed(request, streamAllocation, null, null);
    releaseConnection = false;
  } catch (RouteException e) {
    ......
    continue;
  } catch (IOException e) {
    // An attempt to communicate with a server failed. The request may have been sent.
    boolean requestSendStarted = !(e instanceof ConnectionShutdownException);
    if (!recover(e, requestSendStarted, request)) throw e;
    releaseConnection = false;
    continue;
  } finally {
    // We're throwing an unchecked exception. Release any resources.
    if (releaseConnection) {
      streamAllocation.streamFailed(null);
      streamAllocation.release();
    }
  }

  .......
}複製程式碼

Response proceed（）方法很簡單，內部使用集合進行遍歷，一個反射進行真實資料處理! 其通過內部的Response response = interceptor.intercept(next);
其實就回撥到了你實現的intercept(Chain chain)的介面，一次閉環結束！

處理返回攔截

使用者都知道我們每次進行一次請求都會呼叫call.execute() 方法，真正的response也在這裡開始，攔截器也從這個方法為導火索。

Override 
public Response execute() throws IOException {
  synchronized (this) {
  if (executed) throw new IllegalStateException("Already Executed");
  executed = true;
  }
captureCallStackTrace();
try {
  client.dispatcher().executed(this);
  //這裡 對返回的資料 處理攔截了
  Response result = getResponseWithInterceptorChain();
  if (result == null) throw new IOException("Canceled");
  return result;
} finally {
  client.dispatcher().finished(this);
}複製程式碼

}

如果到這一步你還未能猜出內部機制，這裡也不用我再介紹，通過處理請求攔截的介紹，你也應該明白了Okhttp內部進行攔截器集合迴圈遍歷來進行每一次請求攔截的具體處理。

到此明白Interceptor的工作原理後，我們就可以愉快的使用它來完成一些功能。

這裡我畫了一個圖 以便大家更容易理解整個過程，這裡只理解攔截機制，Okhttp原始碼流程最後一篇文章再統一分析。

這裡寫圖片描述

更多功能

增加同步cookie

Retrofit2.0 ，OkHttp3完美同步持久Cookie實現免登入(二)

實現OKhttp的Interceptor器，用來將本地的cookie追加到http請求頭中；採用rxJava的操作

public class AddCookiesInterceptor implements Interceptor {
    private Context context;
    private String lang;

    public AddCookiesInterceptor(Context context, String lang) {
        super();
        this.context = context;
        this.lang = lang;

    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        if (chain == null)
            Log.d("http", "Addchain == null");
        final Request.Builder builder = chain.request().newBuilder();
        SharedPreferences sharedPreferences = context.getSharedPreferences("cookie", Context.MODE_PRIVATE);
        Observable.just(sharedPreferences.getString("cookie", ""))
                .subscribe(new Action1<String>() {
                    @Override
                    public void call(String cookie) {
                        if (cookie.contains("lang=ch")){
                            cookie = cookie.replace("lang=ch","lang="+lang);
                        }
                        if (cookie.contains("lang=en")){
                            cookie = cookie.replace("lang=en","lang="+lang);
                        }
                        //新增cookie
       //                        Log.d("http", "AddCookiesInterceptor"+cookie);
                        builder.addHeader("cookie", cookie);
                    }
                });
        return chain.proceed(builder.build());
    }
}複製程式碼

實現Interceptor器，將Http返回的cookie儲存到本地

public class ReceivedCookiesInterceptor implements Interceptor {
    private Context context;
    SharedPreferences sharedPreferences;

    public ReceivedCookiesInterceptor(Context context) {
        super();
        this.context = context;
        sharedPreferences = context.getSharedPreferences("cookie", Context.MODE_PRIVATE);
    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        if (chain == null)
            Log.d("http", "Receivedchain == null");
        Response originalResponse = chain.proceed(chain.request());
        Log.d("http", "originalResponse" + originalResponse.toString());
        if (!originalResponse.headers("set-cookie").isEmpty()) {
            final StringBuffer cookieBuffer = new StringBuffer();
            Observable.from(originalResponse.headers("set-cookie"))
                    .map(new Func1<String, String>() {
                        @Override
                        public String call(String s) {
                            String[] cookieArray = s.split(";");
                            return cookieArray[0];
                        }
                    })
                    .subscribe(new Action1<String>() {
                        @Override
                        public void call(String cookie) {
                            cookieBuffer.append(cookie).append(";");
                        }
                    });
            SharedPreferences.Editor editor = sharedPreferences.edit();
            editor.putString("cookie", cookieBuffer.toString());
            Log.d("http", "ReceivedCookiesInterceptor" + cookieBuffer.toString());
            editor.commit();
        }

        return originalResponse;
    }
}

複製程式碼

修改請求頭


Retrofit，Okhttp對每個Request統一動態新增header和引數（五）

okHttpClient.interceptors().add(new Interceptor() {  
   @Override

public Response intercept(Interceptor.Chain chain) throws IOException {
       Request original = chain.request();

    // Request customization: add request headers
    Request.Builder requestBuilder = original.newBuilder()
   .addHeader("header-key", "value1")
   .addHeader("header-key", "value2");

    Request request = requestBuilder.build();
     return chain.proceed(request);
  }
});複製程式碼

實現快取

Rxjava +Retrofit 你需要掌握的幾個技巧，Retrofit快取，

相容的庫

OkHttp的攔截器 需要OkHttp 2.2或以上版本。但是，攔截器不支援OkUrlFactory，或者依賴Okhttp的其他庫，比如： Retrofit≤1.8和 Picasso≤2.4。

後話

下一篇我們開始解析Okhttp的另一個核心Dispatcher. 接著再介紹Cache，和Chain

參考資料

Okhttp官方GitHub Wiki以及APi文件

Tamic 部落格

第一時間獲取本人的技術文章請關注微信公眾號！

開發者技術前線

版權宣告：本文為博主原創文章，請尊重原創，轉載請標明地址。有問題請關注 [開發者技術前線] 諮詢


相關文章