SpringBoot使用OkHttp完成高效網絡請求詳解

更新時間：2025年03月28日 10:55:45 作者：小馬不敲代碼

OkHttp 是一個高效的 HTTP 客戶端,支持同步和異步請求,且具備自動處理 cookie、緩存和連接池等高級功能,下面我們來看看SpringBoot如何利用 OkHttp 完成高效網絡請求吧

一、OkHttp 簡介

OkHttp 是一個高效的 HTTP 客戶端，它支持同步和異步請求，且具備自動處理 cookie、緩存和連接池等高級功能。

與 Java 原生的 HttpURLConnection 和 Apache 的 HttpClient 相比，OkHttp 的 API 設計更加人性化，使用起來也更加方便。

二、在 Spring Boot 中集成 OkHttp

首先，我們需要在 Spring Boot 項目中引入 OkHttp 的依賴。

在 pom.xml 文件中添加以下依賴：

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.9.3</version> <!-- 注意：版本號可能有所更新，請根據實際情況選擇 -->
</dependency>

三、封裝 OkHttp 客戶端工具類

為了方便在項目中統(tǒng)一管理和使用 OkHttp 客戶端，我們可以將其封裝成一個工具類。

這個工具類將負責初始化 OkHttpClient 實例、構建請求、處理響應等任務。

3.1 初始化 OkHttpClient

在工具類中，我們使用單例模式來初始化 OkHttpClient 實例，并設置一些全局的配置，如連接超時、讀寫超時等。

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.ResponseBody;
import okio.Buffer;

import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;
import java.io.IOException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.concurrent.TimeUnit;

public class OkHttpUtil {
    
    private static final OkHttpClient OK_HTTP_CLIENT;

    static {
        TrustManager[] trustManagers = newTrustManager[]{
                newX509TrustManager() {
                    @Override
                    publicvoidcheckClientTrusted(X509Certificate[] chain, String authType)throws CertificateException {
                    }

                    @Override
                    publicvoidcheckServerTrusted(X509Certificate[] chain, String authType)throws CertificateException {
                    }

                    @Override
                    public X509Certificate[] getAcceptedIssuers() {
                        returnnewX509Certificate[]{};
                    }
                }
        };

        try {
            SSLContextsslContext= SSLContext.getInstance("SSL");
            sslContext.init(null, trustManagers, newjava.security.SecureRandom());

            OK_HTTP_CLIENT = newOkHttpClient.Builder()
                    .connectTimeout(15, TimeUnit.SECONDS)
                    .writeTimeout(20, TimeUnit.SECONDS)
                    .readTimeout(20, TimeUnit.SECONDS)
                    .sslSocketFactory(sslContext.getSocketFactory(), (X509TrustManager) trustManagers[0])
                    .hostnameVerifier((hostname, session) -> true)
                    .build();
        } catch (Exception e) {
            thrownewRuntimeException(e);
        }
    }

    // 省略其他方法...
}

在這里，我們使用了自定義的 TrustManager 來忽略 SSL 證書驗證，這通常用于開發(fā)和測試環(huán)境。

在生產環(huán)境中，應該使用正確的證書驗證機制。

3.2 構建請求

接下來，我們需要在工具類中提供構建請求的方法。

這些方法將允許用戶設置請求的 URL、參數、頭部等信息。

import okhttp3.FormBody;
import okhttp3.MediaType;
import okhttp3.Request;
import okhttp3.RequestBody;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Objects;

public class OkHttpUtil {
    
    // ... 省略其他代碼

    private String url;
    private Map<String, String> headers = newLinkedHashMap<>();
    private Map<String, Object> params = newLinkedHashMap<>();
    private Request.Builder requestBuilder;

    privat eOkHttpUtil() {
        // 可以在這里添加一些全局的請求頭部，比如 User-Agent
        this.headers.put("User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36");
    }

    public static OkHttpUtil builder() {
        returnnewOkHttpUtil();
    }

    public OkHttpUtil url(String url) {
        this.url = url;
        returnthis;
    }

    public OkHttpUtil addParam(String key, String value) {
        this.params.put(key, value);
        returnthis;
    }

    public OkHttpUtil addHeader(String key, String value) {
        this.headers.put(key, value);
        returnthis;
    }

    public OkHttpUtil initGet() {
        this.requestBuilder = newRequest.Builder().get();
        StringBuilder urlBuilder=newStringBuilder(this.url);
        if (!this.params.isEmpty()) {
            urlBuilder.append("?");
            this.params.forEach((k, v) -> urlBuilder.append(k).append("=").append(v).append("&"));
            urlBuilder.deleteCharAt(urlBuilder.length() - 1);
        }
        this.requestBuilder.url(urlBuilder.toString());
        returnthis;
    }

    public OkHttpUtil initPost(boolean isJson) {
        RequestBody requestBody;
        if (isJson) {
            Stringjson="";
            if (!this.params.isEmpty()) {
                // 這里需要使用合適的 JSON 庫將 Map 轉換為 JSON 字符串
                // 例如：json = JSON.toJSONString(this.params);
                // 注意：實際代碼中需要引入 JSON 庫，并處理相關的依賴和異常
                // 為簡化示例，這里省略了 JSON 轉換的代碼
            }
            requestBody = RequestBody.create(json, MediaType.parse("application/json; charset=utf-8"));
        } else {
            FormBody.Builder formBuilder=newFormBody.Builder();
            this.params.forEach((k, v) -> formBuilder.add(k, v.toString()));
            requestBody = formBuilder.build();
        }
        this.requestBuilder = newRequest.Builder().post(requestBody).url(this.url);
        returnthis;
    }

    // ... 省略其他方法...
}

3.3 同步與異步請求

最后，我們需要在工具類中提供同步和異步請求的方法。

這些方法將負責發(fā)送請求并處理響應。

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.Response;

public class OkHttpUtil {
    
    // ... 省略其他代碼

    public String sync() {
        try {
            Request request=this.requestBuilder.build();
            this.headers.forEach(request::addHeader);
            Response response= OK_HTTP_CLIENT.newCall(request).execute();
            if (response.isSuccessful()) {
                return response.body().string();
            } else {
                return"請求失敗，狀態(tài)碼：" + response.code();
            }
        } catch (IOException e) {
            e.printStackTrace();
            return"請求失敗，異常：" + e.getMessage();
        }
    }

    public String async() {
        final StringBuffer buffer=newStringBuffer();
        Request request=this.requestBuilder.build();
        this.headers.forEach(request::addHeader);
        OK_HTTP_CLIENT.newCall(request).enqueue(newCallback() {
            @Override
            public void onFailure(Call call, IOException e) {
                buffer.append("請求出錯：").append(e.getMessage());
            }

            @Override
            public void onResponse(Call call, Response response)throws IOException {
                if (response.isSuccessful()) {
                    buffer.append(response.body().string());
                } else {
                    buffer.append("請求失敗，狀態(tài)碼：").append(response.code());
                }
            }
        });
        // 注意：這里返回的是一個空字符串或者是一個表示請求正在進行的提示
        // 因為異步請求是非阻塞的，所以不能直接返回最終的響應結果
        // 實際應用中，可以通過回調接口或者其他機制來處理異步請求的響應
    }
}

四、優(yōu)化與擴展

4.1 添加請求頭

在工具類中添加方法，支持自定義請求頭：

public OkHttpUtil addHeader(String key, String value) {
    okHttpClient = okHttpClient.newBuilder()
            .addInterceptor(chain -> {
                Requestoriginal= chain.request();
                RequestnewRequest= original.newBuilder()
                        .header(key, value)
                        .build();
                return chain.proceed(newRequest);
            })
            .build();
    returnthis;
}

4.2 處理 HTTPS 請求

如果需要支持 HTTPS 請求，可以在工具類中添加 SSL 配置：

private static SSLSocketFactory createSSLSocketFactory() {
    try {
        SSLContextsslContext= SSLContext.getInstance("SSL");
        sslContext.init(null, newTrustManager[]{newX509TrustManager() {
            @Override
            publicvoidcheckClientTrusted(X509Certificate[] chain, String authType) {}

            @Override
            publicvoidcheckServerTrusted(X509Certificate[] chain, String authType) {}

            @Override
            public X509Certificate[] getAcceptedIssuers() {
                returnnewX509Certificate[]{};
            }
        }}, newSecureRandom());
        return sslContext.getSocketFactory();
    } catch (Exception e) {
        thrownewRuntimeException(e);
    }
}

然后在初始化 OkHttpClient 時使用：

okHttpClient = new OkHttpClient.Builder()
        .sslSocketFactory(createSSLSocketFactory(), newX509TrustManager() {
            @Override
            publicvoidcheckClientTrusted(X509Certificate[] chain, String authType) {}

            @Override
            publicvoidcheckServerTrusted(X509Certificate[] chain, String authType) {}

            @Override
            public X509Certificate[] getAcceptedIssuers() {
                returnnewX509Certificate[]{};
            }
        })
        .build();

以上就是SpringBoot使用OkHttp完成高效網絡請求詳解的詳細內容，更多關于SpringBoot OkHttp網絡請求的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: