快捷導(dǎo)航

SpringBoot使用OkHttp完成高效網(wǎng)絡(luò)請(qǐng)求詳解

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

OkHttp 是一個(gè)高效的 HTTP 客戶(hù)端,支持同步和異步請(qǐng)求,且具備自動(dòng)處理 cookie、緩存和連接池等高級(jí)功能,下面我們來(lái)看看SpringBoot如何利用 OkHttp 完成高效網(wǎng)絡(luò)請(qǐng)求吧

一、OkHttp 簡(jiǎn)介

OkHttp 是一個(gè)高效的 HTTP 客戶(hù)端，它支持同步和異步請(qǐng)求，且具備自動(dòng)處理 cookie、緩存和連接池等高級(jí)功能。

與 Java 原生的 HttpURLConnection 和 Apache 的 HttpClient 相比，OkHttp 的 API 設(shè)計(jì)更加人性化，使用起來(lái)也更加方便。

二、在 Spring Boot 中集成 OkHttp

首先，我們需要在 Spring Boot 項(xiàng)目中引入 OkHttp 的依賴(lài)。

在 pom.xml 文件中添加以下依賴(lài)：

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.9.3</version> <!-- 注意：版本號(hào)可能有所更新，請(qǐng)根據(jù)實(shí)際情況選擇 -->
</dependency>

三、封裝 OkHttp 客戶(hù)端工具類(lèi)

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

這個(gè)工具類(lèi)將負(fù)責(zé)初始化 OkHttpClient 實(shí)例、構(gòu)建請(qǐng)求、處理響應(yīng)等任務(wù)。

3.1 初始化 OkHttpClient

在工具類(lèi)中，我們使用單例模式來(lái)初始化 OkHttpClient 實(shí)例，并設(shè)置一些全局的配置，如連接超時(shí)、讀寫(xiě)超時(shí)等。

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 來(lái)忽略 SSL 證書(shū)驗(yàn)證，這通常用于開(kāi)發(fā)和測(cè)試環(huán)境。

在生產(chǎn)環(huán)境中，應(yīng)該使用正確的證書(shū)驗(yàn)證機(jī)制。

3.2 構(gòu)建請(qǐng)求

接下來(lái)，我們需要在工具類(lèi)中提供構(gòu)建請(qǐng)求的方法。

這些方法將允許用戶(hù)設(shè)置請(qǐng)求的 URL、參數(shù)、頭部等信息。

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() {
        // 可以在這里添加一些全局的請(qǐng)求頭部，比如 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 庫(kù)將 Map 轉(zhuǎn)換為 JSON 字符串
                // 例如：json = JSON.toJSONString(this.params);
                // 注意：實(shí)際代碼中需要引入 JSON 庫(kù)，并處理相關(guān)的依賴(lài)和異常
                // 為簡(jiǎn)化示例，這里省略了 JSON 轉(zhuǎn)換的代碼
            }
            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 同步與異步請(qǐng)求

最后，我們需要在工具類(lèi)中提供同步和異步請(qǐng)求的方法。

這些方法將負(fù)責(zé)發(fā)送請(qǐng)求并處理響應(yīng)。

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"請(qǐng)求失敗，狀態(tài)碼：" + response.code();
            }
        } catch (IOException e) {
            e.printStackTrace();
            return"請(qǐng)求失敗，異常：" + 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("請(qǐng)求出錯(cuò)：").append(e.getMessage());
            }

            @Override
            public void onResponse(Call call, Response response)throws IOException {
                if (response.isSuccessful()) {
                    buffer.append(response.body().string());
                } else {
                    buffer.append("請(qǐng)求失敗，狀態(tài)碼：").append(response.code());
                }
            }
        });
        // 注意：這里返回的是一個(gè)空字符串或者是一個(gè)表示請(qǐng)求正在進(jìn)行的提示
        // 因?yàn)楫惒秸?qǐng)求是非阻塞的，所以不能直接返回最終的響應(yīng)結(jié)果
        // 實(shí)際應(yīng)用中，可以通過(guò)回調(diào)接口或者其他機(jī)制來(lái)處理異步請(qǐng)求的響應(yīng)
    }
}

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

4.1 添加請(qǐng)求頭

在工具類(lèi)中添加方法，支持自定義請(qǐng)求頭：

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 請(qǐng)求

如果需要支持 HTTPS 請(qǐng)求，可以在工具類(lèi)中添加 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 時(shí)使用：

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完成高效網(wǎng)絡(luò)請(qǐng)求詳解的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot OkHttp網(wǎng)絡(luò)請(qǐng)求的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: