OkHttp攔截器在Android網(wǎng)絡(luò)中的使用和工作原理

更新時間：2023年09月12日 08:52:19 作者：午后一小憩

當(dāng)涉及到Android應(yīng)用程序中的網(wǎng)絡(luò)請求處理時,OkHttp是一個非常強(qiáng)大和流行的工具,其中一個關(guān)鍵的功能是攔截器,在本文中,我們將深入研究OkHttp攔截器,了解其工作原理以及如何使用它們來優(yōu)化您的Android應(yīng)用程序,需要的朋友可以參考下

什么是OkHttp攔截器

OkHttp攔截器是一種機(jī)制，允許您在網(wǎng)絡(luò)請求和響應(yīng)的傳輸過程中執(zhí)行自定義操作。它們通常用于記錄請求日志、修改請求頭、緩存響應(yīng)或進(jìn)行身份驗證等操作。攔截器可以按照添加它們的順序依次執(zhí)行，從而形成一個攔截器鏈。

攔截器鏈

攔截器鏈?zhǔn)且粋€由多個攔截器組成的鏈條，每個攔截器在請求和響應(yīng)的傳輸過程中都有機(jī)會進(jìn)行操作。這些攔截器按照它們添加的順序執(zhí)行，因此順序很重要。以下是一個攔截器鏈的示意圖：

Request 1 -> Interceptor 1 -> Interceptor 2 -> ... -> Interceptor N -> Server
                            <-                <- ... <-                <-
Response 1 <- Interceptor 1 <- Interceptor 2 <- ... <- Interceptor N <- Server

OkHttp中攔截器的工作原理

OkHttp的核心組件是Interceptor接口和RealCall類。Interceptor接口定義了intercept()方法，它接收一個Chain對象作為參數(shù)，該對象用于執(zhí)行攔截器鏈上的操作。RealCall類用于實際執(zhí)行網(wǎng)絡(luò)請求并管理攔截器鏈的執(zhí)行。

創(chuàng)建OkHttpClient

首先，您需要創(chuàng)建一個OkHttpClient實例，該實例用于發(fā)起網(wǎng)絡(luò)請求，并配置攔截器鏈。

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

發(fā)起網(wǎng)絡(luò)請求

當(dāng)您調(diào)用client.newCall(request)來創(chuàng)建一個新的網(wǎng)絡(luò)請求時，OkHttp會創(chuàng)建一個RealCall對象，該對象代表了實際的網(wǎng)絡(luò)請求。接下來，RealCall會執(zhí)行攔截器鏈上的操作。

Request request = new Request.Builder()
    .url("https://example.com/api")
    .build();
Call call = client.newCall(request);
Response response = call.execute();

攔截器鏈執(zhí)行

攔截器鏈的執(zhí)行是在RealCall類中完成的，它遍歷攔截器列表并按照添加順序依次執(zhí)行。以下是相關(guān)源碼示例：

public Response getResponseWithInterceptorChain() throws IOException {
    // 創(chuàng)建一個初始的Interceptor.Chain
    List<Interceptor> interceptors = new ArrayList<>();
    interceptors.addAll(client.interceptors());
    interceptors.add(retryAndFollowUpInterceptor);
    interceptors.add(new BridgeInterceptor(client.cookieJar()));
    interceptors.add(new CacheInterceptor(client.internalCache()));
    interceptors.add(new ConnectInterceptor(client));
    interceptors.add(new CallServerInterceptor(false));
    Interceptor.Chain chain = new RealInterceptorChain(interceptors, null, null, 0, originalRequest, this, callStackTrace);
    // 依次執(zhí)行攔截器
    return chain.proceed(originalRequest);
}

Interceptor.Chain的實現(xiàn)

RealInterceptorChain類實現(xiàn)了Interceptor.Chain接口，它包含了當(dāng)前請求的信息，并負(fù)責(zé)執(zhí)行攔截器鏈上的操作。在proceed()方法中，它依次調(diào)用攔截器的intercept()方法，將請求傳遞給下一個攔截器，并最終返回響應(yīng)。

public Response proceed(Request request) throws IOException {
    // 執(zhí)行下一個攔截器或者發(fā)起網(wǎng)絡(luò)請求
    if (index >= interceptors.size()) throw new AssertionError();
    calls++;
    if (chain == null) throw new IllegalStateException("Check failed.");
    if (eventListener != null) {
        eventListener.callStart(this);
    }
    // 獲取當(dāng)前攔截器
    Interceptor interceptor = interceptors.get(index++);
    // 調(diào)用攔截器的intercept方法，將請求傳遞給下一個攔截器或者執(zhí)行網(wǎng)絡(luò)請求
    Response response = interceptor.intercept(this);
    if (eventListener != null) {
        eventListener.callEnd(this);
    }
    return response;
}

編寫自定義攔截器

要編寫自定義攔截器，首先需要實現(xiàn)Interceptor接口，并實現(xiàn)intercept()方法。這個方法接收一個Chain對象作為參數(shù)，允許您訪問和操作請求和響應(yīng)。

public class CustomInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        // 在請求前執(zhí)行的代碼
        Request originalRequest = chain.request();
        // 可以修改請求
        Request modifiedRequest = originalRequest.newBuilder()
                .addHeader("Authorization", "Bearer YourAccessToken")
                .build();
        // 執(zhí)行請求
        Response response = chain.proceed(modifiedRequest);
        // 在響應(yīng)后執(zhí)行的代碼
        // 可以修改響應(yīng)
        return response;
    }
}

實際應(yīng)用示例

以下是一些實際運用示例，展示了如何使用OkHttp攔截器來實現(xiàn)不同的功能

日志記錄

這個攔截器用于記錄請求和響應(yīng)的詳細(xì)信息，有助于調(diào)試和排查問題。

public class LoggingInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        long startTime = System.nanoTime();
        Log.d("OkHttp", String.format("Sending request %s on %s%n%s",
            request.url(), chain.connection(), request.headers()));
        Response response = chain.proceed(request);
        long endTime = System.nanoTime();
        Log.d("OkHttp", String.format("Received response for %s in %.1fms%n%s",
            response.request().url(), (endTime - startTime) / 1e6d, response.headers()));
        return response;
    }
}

身份驗證

這個攔截器用于在每個請求中添加身份驗證標(biāo)頭，以確保請求是經(jīng)過身份驗證的。

public class AuthInterceptor implements Interceptor {
    private final String authToken;
    public AuthInterceptor(String authToken) {
        this.authToken = authToken;
    }
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request originalRequest = chain.request();
        // 添加身份驗證標(biāo)頭
        Request authenticatedRequest = originalRequest.newBuilder()
                .header("Authorization", "Bearer " + authToken)
                .build();
        return chain.proceed(authenticatedRequest);
    }
}

緩存

這個攔截器用于實現(xiàn)響應(yīng)緩存，以減少對服務(wù)器的請求。

public class CacheInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        // 在這里檢查是否有緩存可用，如果有，返回緩存的響應(yīng)
        Response response = chain.proceed(request);
        // 在這里將響應(yīng)緩存起來
        return response;
    }
}

請求重試

這個攔截器用于處理請求失敗時的重試邏輯。

public class RetryInterceptor implements Interceptor {
    private final int maxRetryCount;
    public RetryInterceptor(int maxRetryCount) {
        this.maxRetryCount = maxRetryCount;
    }
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        Response response = null;
        IOException lastException = null;
        for (int retryCount = 0; retryCount < maxRetryCount; retryCount++) {
            try {
                response = chain.proceed(request);
                if (response.isSuccessful()) {
                    return response;
                }
            } catch (IOException e) {
                lastException = e;
            }
        }
        // 如果達(dá)到最大重試次數(shù)仍然失敗，拋出異常
        throw lastException;
    }
}

自定義響應(yīng)處理

這個攔截器用于在接收到響應(yīng)后執(zhí)行自定義的響應(yīng)處理邏輯。

public class ResponseProcessingInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        Response response = chain.proceed(request);
        // 在這里對響應(yīng)進(jìn)行自定義處理
        return response;
    }
}

錯誤處理

這個攔截器用于處理一些常見的錯誤情況

public class ErrorHandlingInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        try {
            Response response = chain.proceed(request);
            // 檢查響應(yīng)是否成功
            if (!response.isSuccessful()) {
                // 在這里處理錯誤，可以拋出自定義異常
                throw new MyHttpException(response.code(), response.message());
            }
            return response;
        } catch (IOException e) {
            // 在這里處理網(wǎng)絡(luò)連接錯誤
            throw new MyNetworkException(e.getMessage(), e);
        }
    }
}

重定向請求

這個攔截器用于自定義重定向行為

public class RedirectInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        Response response = chain.proceed(request);
        // 檢查是否是重定向響應(yīng)
        if (response.isRedirect()) {
            String newUrl = response.header("Location");
            if (newUrl != null) {
                // 構(gòu)建新的請求并繼續(xù)
                Request newRequest = request.newBuilder()
                        .url(newUrl)
                        .build();
                response = chain.proceed(newRequest);
            }
        }
        return response;
    }
}

結(jié)論

OkHttp攔截器是Android應(yīng)用程序中處理網(wǎng)絡(luò)請求的有力工具。通過創(chuàng)建自定義攔截器，您可以在請求和響應(yīng)的傳輸過程中執(zhí)行各種操作，以優(yōu)化您的應(yīng)用程序。無論是日志記錄、身份驗證、緩存還是其他操作，攔截器都可以幫助您更好地控制和定制網(wǎng)絡(luò)請求流程。

以上就是OkHttp攔截器在Android網(wǎng)絡(luò)中的使用和工作原理的詳細(xì)內(nèi)容，更多關(guān)于OkHttp攔截器在Android中的使用的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: