SpringBoot使用OkHttp完成高效网络请求详解

2025-03-28 15:50
文章标签 springboot okhttp 详解 高效 请求 网络 完成 使用 spring java

本文主要是介绍SpringBoot使用OkHttp完成高效网络请求详解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《SpringBoot使用OkHttp完成高效网络请求详解》OkHttp是一个高效的HTTP客户端,支持同步和异步请求,且具备自动处理cookie、缓存和连接池等高级功能,下面我们来看看SpringB...

一、OkHttp 简介

OkHttp 是一个高效的 HTTP 客户端，它支持同步和异步请求，且具备自动处理 cookie、缓存和连接池等高级功能javascript。

与 Java 原生的 HttpURLConnection 和 Apache 的 HttpClient 相比，OkHttp 的 API 设计更加人性化，使用起来也更加方便。

SpringBoot使用OkHttp完成高效网络请求详解

二、在 Spring Boot 中集成 OkHttp

首先，我们需要在 Spring Boot 项目中引入 OkHttp 的依赖。

在 pom.XML 文件中添加以下依赖：

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.9.3</version> <!-- 注意：版本号可能有所更新，请根据实际情况选择 -->
</dependency>

三、封装 OkHttp 客户端工具类

为了方便在项目中统一管理和使用 OkHttp 客户端，我们可以将其封装成一个工具类。

这个工具类将负责初始化 OkHttpClient 实例、构建请求、处理响应等任务。

3.1 初始化 OkHttpChina编程Client

在工具类中，我们使用单例模式来初始化 OkHttpClient 实例，并设置一些全局的配置，如连接超时、读写超时等。

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

import javax.net.ssl.SSLContext;
imppythonort 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 {
            SSLContChina编程extsslContext= 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 证书验证，这通常用于开发和测试环境。

在生产环境中，应该使用正确的证书验证机制。

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 同步与异步请求

最后，我们需要在工具类中提供同步和异步请求的方法。

这些方法将负责发送请求并处理响应。

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"请求失败，状态码：" + 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.appen编程d(response.body().string());
                } else {
                    buffer.append("请求失败，状态码：").append(response.code());
                }
            }
        });
        // 注意：这里返回的是一个空字符串或者是一个表示请求正在进行的提示
        // 因为异步请求是非阻塞的，所以不能直接返回最终的响应结果
        // 实际应用中，可以通过回调接口或者其他机制来处理异步请求的响应
    }
}

四、优化与扩展

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网络请求的资料请关注编程China编程(www.chinasem.cn)其它相关文章！

这篇关于SpringBoot使用OkHttp完成高效网络请求详解的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1153985。

相关文章

Linux下如何使用C++获取硬件信息

Linux下如何使用C++获取硬件信息

《Linux下如何使用C++获取硬件信息》这篇文章主要为大家详细介绍了如何使用C++实现获取CPU,主板,磁盘,BIOS信息等硬件信息,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录方法获取CPU信息：读取"/proc/cpuinfo"文件获取磁盘信息：读取"/proc/diskstats"文
阅读更多...
Java数组初始化的五种方式

Java数组初始化的五种方式

《Java数组初始化的五种方式》数组是Java中最基础且常用的数据结构之一,其初始化方式多样且各具特点,本文详细讲解Java数组初始化的五种方式,分析其适用场景、优劣势对比及注意事项,帮助避免常见陷阱... 目录1. 静态初始化：简洁但固定代码示例核心特点适用场景注意事项2. 动态初始化：灵活但需手动管理代
阅读更多...
Java使用SLF4J记录不同级别日志的示例详解

Java使用SLF4J记录不同级别日志的示例详解

《Java使用SLF4J记录不同级别日志的示例详解》SLF4J是一个简单的日志门面,它允许在运行时选择不同的日志实现,这篇文章主要为大家详细介绍了如何使用SLF4J记录不同级别日志,感兴趣的可以了解下... 目录一、SLF4J简介二、添加依赖三、配置Logback四、记录不同级别的日志五、总结一、SLF4J
阅读更多...
将Java项目提交到云服务器的流程步骤

将Java项目提交到云服务器的流程步骤

《将Java项目提交到云服务器的流程步骤》所谓将项目提交到云服务器即将你的项目打成一个jar包然后提交到云服务器即可,因此我们需要准备服务器环境为：Linux+JDK+MariDB（MySQL）+Gi... 目录1. 安装 jdk1.1 查看 jdk 版本1.2 下载 jdk2. 安装 mariadb(my
阅读更多...
使用Python实现一个优雅的异步定时器

使用Python实现一个优雅的异步定时器

《使用Python实现一个优雅的异步定时器》在Python中实现定时器功能是一个常见需求,尤其是在需要周期性执行任务的场景下,本文给大家介绍了基于asyncio和threading模块,可扩展的异步定... 目录需求背景代码1. 单例事件循环的实现2. 事件循环的运行与关闭3. 定时器核心逻辑4. 启动与停
阅读更多...
如何使用Nginx配置将80端口重定向到443端口

如何使用Nginx配置将80端口重定向到443端口

《如何使用Nginx配置将80端口重定向到443端口》这篇文章主要为大家详细介绍了如何将Nginx配置为将HTTP（80端口）请求重定向到HTTPS（443端口）,文中的示例代码讲解详细,有需要的小伙... 目录1. 创建或编辑Nginx配置文件2. 配置HTTP重定向到HTTPS3. 配置HTTPS服务器
阅读更多...
SpringBoot中配置Redis连接池的完整指南

SpringBoot中配置Redis连接池的完整指南

《SpringBoot中配置Redis连接池的完整指南》这篇文章主要为大家详细介绍了SpringBoot中配置Redis连接池的完整指南,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以... 目录一、添加依赖二、配置 Redis 连接池三、测试 Redis 操作四、完整示例代码（一）pom.
阅读更多...
Java 正则表达式URL 匹配与源码全解析

Java 正则表达式URL 匹配与源码全解析

《Java正则表达式URL匹配与源码全解析》在Web应用开发中,我们经常需要对URL进行格式验证,今天我们结合Java的Pattern和Matcher类,深入理解正则表达式在实际应用中... 目录1.正则表达式分解：2. 添加域名匹配 (2)3. 添加路径和查询参数匹配 (3) 4. 最终优化版本5.设计思
阅读更多...
Java使用ANTLR4对Lua脚本语法校验详解

Java使用ANTLR4对Lua脚本语法校验详解

《Java使用ANTLR4对Lua脚本语法校验详解》ANTLR是一个强大的解析器生成器,用于读取、处理、执行或翻译结构化文本或二进制文件,下面就跟随小编一起看看Java如何使用ANTLR4对Lua脚本... 目录什么是ANTLR？第一个例子ANTLR4 的工作流程Lua脚本语法校验准备一个Lua Gramm
阅读更多...
Java字符串操作技巧之语法、示例与应用场景分析

Java字符串操作技巧之语法、示例与应用场景分析

《Java字符串操作技巧之语法、示例与应用场景分析》在Java算法题和日常开发中,字符串处理是必备的核心技能,本文全面梳理Java中字符串的常用操作语法,结合代码示例、应用场景和避坑指南,可快速掌握字... 目录引言1. 基础操作1.1 创建字符串1.2 获取长度1.3 访问字符2. 字符串处理2.1 子字
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2