OkHttp(GitHub:https://github.com/square/okhttp) 的 Interceptor 就如同名稱「攔截器」一樣,攔截你的 Request 做一些你想做的事情再送出去。例如:
1.自動加上使用者目前使用的語言送出去取得對應語言的回傳內容。
2.將 Request 計算出這個 Request 的 sigunature 再附加上送出去。
在 okHttp 中分成 Application Interceptor 和 Network Interceptor 兩種。 Application Interceptor 是會可以被 cache 起來的。如官網的圖片:
攔截器是 OkHttp 提供的對 HTTP 要求和響應進行統一處理的強大機制。攔截器在實現和使用上類似於 Servlet 規範中的過濾器。多個攔截器可以連結起來,形成一個鏈條。攔截器會按照在鏈條上的順序依次執行。 攔截器在執行時,可以先對請求的 Request 對象進行修改;再得到響應的 Response 對象之後,可以進行修改之後再返回。
Interceptor 介面只包含一個方法 intercept,其參數是 Chain 對象。Chain 對象表示的是當前的攔截器鏈條。通過 Chain 的 request 方法可以擷取到當前的 Request 對象。在使用完 Request 對象之後,通過 Chain 對象的 proceed 方法來繼續攔截器鏈條的執行。當執行完成之後,可以對得到的 Response 對象進行額外的處理。
記錄請求和響應資訊的攔截器:
public class LoggingInterceptor implements Interceptor {public Response intercept(Chain chain) throws IOException { Request request = chain.request(); long t1 = System.nanoTime(); System.out.println(String.format("發送請求: [%s] %s%n%s", request.url(), chain.connection(), request.headers())); Response response = chain.proceed(request); long t2 = System.nanoTime(); System.out.println(String.format("接收響應: [%s] %.1fms%n%s", response.request().url(), (t2 - t1) / 1e6d, response.headers())); return response;}}
OkHttp 中的攔截器分成應用和網路攔截器兩種。應用攔截器對於每個 HTTP 響應都只會調用一次,可以通過不調用 Chain.proceed 方法來終止請求,也可以通過多次調用 Chain.proceed 方法來進行重試。網路攔截器對於調用執行中的自動重新導向和重試所產生的響應也會被調用,而如果響應來自緩衝,則不會被調用。
添加應用和網路攔截器
client.interceptors().add(new LoggingInterceptor()); //添加應用攔截器client.networkInterceptors().add(new LoggingInterceptor()); //添加網路攔截器
要做計算 Request 的 sigunature ,則使用方式如下:
public class ApiClient { Interceptor signedRequestInterceptor = new Interceptor() { @Override public Response intercept(Chain chain) throws IOException { Response response = null; try { Request originalRequest = chain.request(); Request signedRequest = SignRequestUtil.signRequest(originalRequest); response = chain.proceed(signedRequest); } catch (NoSuchAlgorithmException | InvalidKeyException e) { e.printStackTrace(); } return response; } }; OkHttpClient client = new OkHttpClient(); client.networkInterceptors().add(signedRequestInterceptor);}public class SignRequestUtil { public static Request signRequest(Request originalRequest) { Request.Builder requestBuilder = originalRequest.newBuilder(); // 在這做所有你需要做的事情,重新產生一個 Request 送出去。 return requestBuilder .headers(getSignedHeaders(originalRequest)) .build(); }}