Spring boot 整合 Okhttp3 并封装请求工具

最新推荐文章于 2024-04-30 17:28:01 发布
最新推荐文章于 2024-04-30 17:28:01 发布
阅读量3.4k 收藏 12
点赞数 3
分类专栏： java通用工具方法 文章标签： java spring boot okhttp
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hongchen006/article/details/132577012
版权

一、 为什么要使用okHttp

OkHttp是一个高效、灵活、易于使用的HTTP客户端库，优势如下：

  1. 性能更高：OkHttp在网络请求处理上采用了异步模型，并将连接池、压缩、网络协议等多种技术应用到其中，从而提高了网络请求的效率和处理速度。

  2. 功能更强大：OkHttp支持HTTP/2协议，可以进行数据流复用以及服务器推送。同时，OkHttp还支持GZIP压缩、连接超时设置、缓存、重试等功能，提供了非常丰富的API接口，方便开发者进行扩展和个性化定制。

  3. 使用更简单：OkHttp具有良好的API设计，可以轻松地实现网络请求的发送和响应处理。其内置了许多预定义的请求类型，如Get, Post, Head, Put, Delete等，使得开发者可以快速地进行开发。

  4. 兼容性更好：OkHttp的代码精简，运行效率高，并且兼容Android平台和Java平台，可以在各种场景下进行使用。

OkHttp作为一款成熟、稳定、易用的HTTP客户端库，拥有较高的性能和多样化的功能，已被广泛应用于移动应用开发、Web服务端开发等领域。

二、 导入依赖

<!-- okhttp3 依赖 -->
<dependency>
	<groupId>com.squareup.okhttp3</groupId>
	<artifactId>okhttp</artifactId>
	<version>4.9.3</version>
</dependency>

三、 配置

  1. 使用okhttp3 是很简单的，但是需要配置连接池，缓存代理等
  2. 项目配置，application.yml 文件配置
ok:
  http:
    connect-timeout: 60
    read-timeout: 60
    write-timeout: 60
    # 连接池中整体的空闲连接的最大数量
    max-idle-connections: 200
    # 连接空闲时间最多为 300 秒
    keep-alive-duration: 300
  1. 添加 配置应用，连接池，缓存，代理等开启
import okhttp3.ConnectionPool;
import okhttp3.OkHttpClient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.concurrent.TimeUnit;

/**
 * @author luoqifeng
 */
@Configuration
public class OkHttpConfiguration {

    @Value("${ok.http.connect-timeout}")
    private Integer connectTimeout;
    @Value("${ok.http.read-timeout}")
    private Integer readTimeout;
    @Value("${ok.http.write-timeout}")
    private Integer writeTimeout;
    @Value("${ok.http.max-idle-connections}")
    private Integer maxIdleConnections;
    @Value("${ok.http.keep-alive-duration}")
    private Long keepAliveDuration;
    @Bean
    public OkHttpClient okHttpClient() {
        return new OkHttpClient.Builder()
                .sslSocketFactory(sslSocketFactory(), x509TrustManager())
                // 是否开启缓存
                .retryOnConnectionFailure(false)
                .connectionPool(pool())
                .connectTimeout(connectTimeout, TimeUnit.SECONDS)
                .readTimeout(readTimeout, TimeUnit.SECONDS)
                .writeTimeout(writeTimeout,TimeUnit.SECONDS)
                .hostnameVerifier((hostname, session) -> true)
                // 设置代理
                // .proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 8888)))
                // 拦截器
                // .addInterceptor()
                .build();
    }
    @Bean
    public X509TrustManager x509TrustManager() {
        return new X509TrustManager() {
            @Override
            public void checkClientTrusted(X509Certificate[] chain, String authType)
                    throws CertificateException {
            }
            @Override
            public void checkServerTrusted(X509Certificate[] chain, String authType)
                    throws CertificateException {
            }
            @Override
            public X509Certificate[] getAcceptedIssuers() {
                return new X509Certificate[0];
            }
        };
    }
    @Bean
    public SSLSocketFactory sslSocketFactory() {
        try {
            // 信任任何链接
            SSLContext sslContext = SSLContext.getInstance("TLS");
            sslContext.init(null, new TrustManager[]{x509TrustManager()}, new SecureRandom());
            return sslContext.getSocketFactory();
        } catch (NoSuchAlgorithmException | KeyManagementException e) {
            e.printStackTrace();
        }
        return null;
    }
    @Bean
    public ConnectionPool pool() {
        return new ConnectionPool(maxIdleConnections, keepAliveDuration, TimeUnit.SECONDS);
    }
}
  1. 配置创建工具类
package cn.wjj.wjjUtils.util;

import jakarta.annotation.PostConstruct;
import lombok.extern.slf4j.Slf4j;
import okhttp3.*;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.Map;

/**
 * @author luoqifeng
 */
@Slf4j
@Component
public class OkHttpClientUtil {
    private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
    private static final MediaType XML = MediaType.parse("application/xml; charset=utf-8");

    private static OkHttpClient okHttpClient;

    // 为使用静态调用异步注入
    @Autowired
    private OkHttpClient getOkHttpClient;
    @PostConstruct
    public void init() {
        okHttpClient = getOkHttpClient;
    }
    /**
     * get 请求
     * @param url  请求url地址
     * @return string
     * */
    public static String doGet(String url) {
        return doGet(url, null, null);
    }

    public static byte[] doGetByte(String url) {
        return doGetByte(url, null, null);
    }

    public static String doPost(String url) {
        return doPost(url, null, null);
    }
    /**
     * get 请求
     * @param url  请求url地址
     * @param params 请求参数 map
     * @return string
     * */
    public static String doGetToParams(String url, Map<String, String> params) {
        return doGet(url, params, null);
    }
    /**
     * get 请求
     * @param url  请求url地址
     * @param headers 请求头字段 {k1, v1 k2, v2, ...}
     * @return string
     * */
    public static String doGetToHeaders(String url, Map<String, String> headers) {
        return doGet(url, null, headers);
    }
    /**
     * get 请求
     * @param url  请求url地址
     * @param params 请求参数 map
     * @param headers 请求头字段 {k1, v1 k2, v2, ...}
     * @return string
     * */
    public static String doGet(String url, Map<String, String> params, Map<String, String> headers) {
        StringBuilder sb = new StringBuilder(url);
        if (params != null && params.keySet().size() > 0) {
            boolean firstFlag = true;
            for (String key : params.keySet()) {
                if (firstFlag) {
                    sb.append("?").append(key).append("=").append(params.get(key));
                    firstFlag = false;
                } else {
                    sb.append("&").append(key).append("=").append(params.get(key));
                }
            }
        }
        Request.Builder builder = new Request.Builder();
        if (headers != null && !headers.isEmpty()) {
            for (String header:headers.keySet()){
                builder.addHeader(header, headers.get(header));
            }
        }
        Request request = builder.url(sb.toString()).build();
        log.info("do get request and url[{}]", sb.toString());
        return executeBody(request);
    }

    public static byte[] doGetByte(String url, Map<String, String> params, Map<String, String> headers) {
        StringBuilder sb = new StringBuilder(url);
        if (params != null && params.keySet().size() > 0) {
            boolean firstFlag = true;
            for (String key : params.keySet()) {
                if (firstFlag) {
                    sb.append("?").append(key).append("=").append(params.get(key));
                    firstFlag = false;
                } else {
                    sb.append("&").append(key).append("=").append(params.get(key));
                }
            }
        }
        Request.Builder builder = new Request.Builder();
        if (headers != null && !headers.isEmpty()) {
            for (String header:headers.keySet()){
                builder.addHeader(header, headers.get(header));
            }
        }
        Request request = builder.url(sb.toString()).build();
        log.info("do get request and url[{}]", sb.toString());
        return executeByte(request);
    }
    /**
     * post 请求
     * @param url  请求url地址
     * @param params 请求参数 map
     * @return string
     */
    public static String doPostForm(String url, Map<String, String> params) {
        FormBody.Builder builder = new FormBody.Builder();
        if (params != null && params.keySet().size() > 0) {
            for (String key : params.keySet()) {
                builder.add(key, params.get(key));
            }
        }
        Request request = new Request.Builder().url(url).post(builder.build()).build();
        log.info("do post request and url[{}]", url);
        return execute(request);
    }

    /**
     * post 请求
     * @param url  请求url地址
     * @param params 请求参数 map
     * @param headers 请求头字段 {k1:v1, k2: v2, ...}
     * @return string
     */
    public static String doPost(String url, Map<String, String> params, Map<String, String> headers) {
        FormBody.Builder builder = new FormBody.Builder();
        if (params != null && params.keySet().size() > 0) {
            for (String key : params.keySet()) {
                builder.add(key, params.get(key));
            }
        }
        Request.Builder requestBuilder = new Request.Builder();
        if (headers != null && !headers.isEmpty()) {
            for (String header:headers.keySet()){
                requestBuilder.addHeader(header, headers.get(header));
            }
        }
        Request request = requestBuilder.url(url).post(builder.build()).build();
        log.info("do post request and url[{}]", url);
        return execute(request);
    }
    /**
     * post 请求, 请求数据为 json 的字符串
     * @param url  请求url地址
     * @param json  请求数据, json 字符串
     * @return string
     */
    public static String doPostJson(String url, String json) {
        log.info("do post request and url[{}]", url);
        return executePost(url, json, JSON);
    }
    /**
     * post 请求, 请求数据为 json 的字符串
     * @param url  请求url地址
     * @param json  请求数据, json 字符串
     * @param headers 请求头字段 {k1, v1 k2, v2, ...}
     * @return string
     */
    public static String doPostJson(String url, String json, Map<String, String> headers) {
        log.info("do post request and url[{}]", url);

        RequestBody requestBody = RequestBody.create(json, JSON);
        Request.Builder builder = new Request.Builder();
        if (headers != null && !headers.isEmpty()) {
            for (String header:headers.keySet()){
                builder.addHeader(header, headers.get(header));
            }
        }
        Request request = builder.url(url).post(requestBody).build();
        return execute(request);
    }
    /**
     * post 请求, 请求数据为 xml 的字符串
     * @param url  请求url地址
     * @param xml  请求数据, xml 字符串
     * @return string
     */
    public static String doPostXml(String url, String xml) {
        log.info("do post request and url[{}]", url);
        return executePost(url, xml, XML);
    }
    private static String executePost(String url, String data, MediaType contentType) {
        RequestBody requestBody = RequestBody.create(data ,contentType);
        Request request = new Request.Builder().url(url).post(requestBody).build();
        return execute(request);
    }
    private static String execute(Request request) {
        Response response = null;
        try {
            response = okHttpClient.newCall(request).execute();
            if (response.isSuccessful()) {
                return response.body().string();
            }
        } catch (Exception e) {
            log.error(ExceptionUtils.getStackTrace(e));
        } finally {
            if (response != null) {
                response.close();
            }
        }
        return "";
    }

    private static String executeBody(Request request) {
        Response response = null;
        try {
            response = okHttpClient.newCall(request).execute();
            if (response.body() != null) {
                return response.body().string();
            }
        } catch (Exception e) {
            log.error(ExceptionUtils.getStackTrace(e));
        } finally {
            if (response != null) {
                response.close();
            }
        }
        return "";
    }

    private static byte[] executeByte(Request request) {
        Response response = null;
        try {
            response = okHttpClient.newCall(request).execute();
            if (response.isSuccessful()) {
                return response.body().bytes();
            }
        } catch (Exception e) {
            log.error(ExceptionUtils.getStackTrace(e));
        } finally {
            if (response != null) {
                response.close();
            }
        }
        return null;
    }


}

四、 测试

/**
 * @author luoqifeng
 */
@RestController
@RequestMapping("test")
public class testController {
    
    @GetMapping("testOkhttp")
    public String testOkhttp(){
        String s = OkHttpClientUtil.doGet("https://www.baidu.com");
        return s;
    }
}

响应结果：
在这里插入图片描述
至此已经完成基本的Spring Boot整合 okhttp3 的示例。并使用okhttp3来发送HTTP请求，然后返回HTTP响应。

洛祁枫
关注
  • 3
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
OkHttp请求完美封装（并带工具类）
03-16
MD5、RSA、Base64Utils、DialogUtil、ZXingUtils、GlideUtil、、、工具类 自己总结了一些必备的工具类，可直接放入工程，简单调用 对OkHttp进行了封装，简单调用，便于操作 进行了post、get、文件上传等进行封装
SpringBoot 整合okHttp3 okhttp3用法 okhttp整合 okhttp用法 SpringBoot 整合okHttp3
半只
07-12 9166
ConnectionPool的构造函数接受三个参数：maxIdleConnections、keepAliveDuration和timeUnit，用于配置连接池的最大空闲连接数、连接保持时间以及时间单位。合理地设置连接池参数非常重要，以符合你的实际需求。可以根据并发请求的数量、目标服务器的负载能力以及网络环境等因素来调整连接池的大小和保持时间。连接池会自动管理和复用连接，适当地回收和关闭空闲的连接。这样可以避免频繁地创建和关闭连接，提高性能和效率，特别是在多次请求同一主机时。的官方文档或其他相关资料。
【Java工具类】OkHttp工具类
frcoder的博客
02-04 1326
【代码】【Java工具类】OkHttp工具类。
Okhttp3系列之(3) - SpringBoot下配置Okhttp3工具类
u010349272的博客
07-09 3430
1.添加pom.xml依赖 <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.6.0</version> </dependency> 2.封装工具类： import lombok.extern.slf4j.Slf4j; import okhttp3.*; impo
okhttp3工具类
06-06
简单进行了二次封装，优化了部分功能，代码量大大减少
okhttp-spring-boot：OkHttp的Spring Boot启动程序
01-29
Spring Boot Starters 可用的启动器 okhttp3-spring-boot-starter okhttp-spring-boot-starter （别名为okhttp3-spring-boot-starter ） 使用Gradle dependencies { compile " io.freefair.okhttp-spring-boot:okhttp3-spring-boot-starter: $v ersion " } 使用Maven < dependency> < groupId>io.freefair.okhttp-spring-boot</ groupId> < artifactId>okhttp3-spring-boot-starter</ artifactId> < version>${version}</ version> </ dependency>
己用Okhttp工具类
Choi晨的博客
02-20 1004
https工具类，可选。
okHttp工具类
zangduijian1898的博客
08-13 1838
OKhttp请求重试
OkHttp 工具类
一生编程，快乐编程
04-26 448
OkHttp依赖包： <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.8.1</version> ...
Java请求Http接口-OkHttp(超详细-附带工具类)
苍煜
08-17 6744
简介：OkHttp是一个默认有效的HTTP客户端，有效地执行HTTP可以加快您的负载并节省带宽，如果您的服务有多个IP地址，如果第一次连接失败，OkHttp将尝试备用地址。这对于IPv4 + IPv6和冗余数据中心中托管的服务是必需的。OkHttp启动具有现代TLS功能（SNI，ALPN）的新连接，并在握手失败时回退到TLS 1.0，OkHttp支持Android 2.3及更高版本。对于Java，最低要求是1.7。
基于RxJava + Retrofit + okHttp3封装的网络请求包
12-26
此网络请求封装基于 RxJava + Retrofit + okHttp3，里面包含使用文档。可适用于所有 json 数据返回的网络请求，包括多文件上传，默认适用Gson解析返回结果，支持自定义解析对象，支持自定义解析方式。
RxJava+Retrofit2+Okhttp3经典封装demo
08-04
RxJava+Retrofit2+Okhttp3主流网络框架相结合最简单易懂的demo 返回Object通用类型 回调CallbackListener重新封装
okhttp3封装工具
01-16
项目需导入okhttp-3.2.0.jar和okio-1.11.0.jar两个jar包才可运行 如果不导入okio-1.11.0.jar包则会抛异常
java方法重写（重点讲），方法重载
weixin_46281068的博客
04-27 931
一、方法重载定义：一个类中，出现多个方法的名称相同，但是它们的形参列表是不同的，那么这些方法就称为方法重载了。注意：一个类中，只要一些方法的名称相同、形参列表不同，那么它们就是方法重载了，其它的都不管（如:修饰符，返回值类型是否一样都无所谓）。形参列表不同指的是:形参的个数、类型、顺序不同，不关心形参的名称。应用场景：开发中我们经常需要为处理一类业务，提供多种解决方案，此时用方法重载来设计是很专业的。
Day25-Java基础之常用类1
m0_46053885的博客
04-27 880
同时我们发现Math类中的方法都是静态的，因此在使用的时候我们可以直接通过类名去调用。对于计算机而言，其实是没有数据类型的概念的，都是0101010101，数据类型是编程语言自己规定的，所以在实际存储的时候，先把具体的数字变成二进制，每32个bit为一组，存储在数组中。比较内存地址值一般情况下是没有意义的，我们希望比较的是对象的属性，如果两个对象的属性相同，我们认为就是同一个对象；如果我们的数据是一个浮点类型的数据，有的时候计算机并不会将这个数据完全转换成一个二进制数据，而是将这个将其转换成一个无限的。
链表刷题集
最新发布
yajunjiao的专栏
04-30 279
本文主要列举了一些刷的题，不多，有那么几道，也建议各位去建立自己的刷题集。积少成多。
Lambda表达式特点
weixin_57763462的博客
04-24 799
**API 设计**：Lambda 表达式鼓励使用函数式接口的设计模式，这改变了 Java 库的设计，例如 `java.util.function` 包下的一系列函数式接口。- **函数式编程**：Lambda 表达式引入了函数式编程的理念，使得 Java 更接近于函数式编程语言，如 Scala 和 Clojure。- **并发编程**：Lambda 表达式与 Java 8 新增的 Stream API 结合使用，可以简化并发编程，特别是与集合的操作相关。
MSE实现全链路灰度实践
云计算、数据库、大数据、深度学习、NLP、Python
04-24 409
待更新。
OkHttp 应该怎么封装网络工具类
06-08
OkHttp 是一款非常优秀的网络请求框架，可以用来实现 Android 应用中的网络请求。如果要封装一个网络工具类，可以考虑以下几个步骤： 1. 引入 OkHttp 库。可以通过在 build.gradle 文件中添加以下依赖来引入 OkHttp 库： ``` implementation 'com.squareup.okhttp3:okhttp:4.9.0' ``` 2. 创建一个单例类来管理 OkHttp。在这个类中，我们可以创建一个 OkHttpClient 对象，用于发送网络请求。同时，可以在这个类中定义一些公共的请求参数、头部信息等，以便在发送网络请求时使用。 ```java public class HttpUtils { private static HttpUtils mInstance; private OkHttpClient mOkHttpClient; private HttpUtils() { mOkHttpClient = new OkHttpClient.Builder() .connectTimeout(10, TimeUnit.SECONDS) .readTimeout(10, TimeUnit.SECONDS) .writeTimeout(10, TimeUnit.SECONDS) .build(); } public static HttpUtils getInstance() { if (mInstance == null) { synchronized (HttpUtils.class) { if (mInstance == null) { mInstance = new HttpUtils(); } } } return mInstance; } public OkHttpClient getOkHttpClient() { return mOkHttpClient; } } ``` 3. 封装网络请求。在发送网络请求时，我们可以使用 OkHttp 提供的 Request 和 Response 类来实现。可以考虑封装一个方法，传入请求参数和回调函数，来发送网络请求，并将结果返回给回调函数。 ```java public void sendRequest(Request request, Callback callback) { mOkHttpClient.newCall(request).enqueue(callback); } ``` 4. 在回调函数中处理请求结果。在发送网络请求时，我们可以通过传入回调函数的方式，来处理请求结果。在回调函数中，可以根据请求结果的状态码、响应体等信息，来处理请求结果。 ```java public abstract class HttpCallback implements Callback { @Override public void onFailure(Call call, IOException e) { // 网络请求失败 } @Override public void onResponse(Call call, Response response) throws IOException { if (response.isSuccessful()) { // 网络请求成功，处理响应结果 String result = response.body().string(); onSuccess(result); } else { // 网络请求失败 onFailure(response.code(), response.message()); } } public abstract void onSuccess(String result); public abstract void onFailure(int code, String message); } ``` 5. 封装常用的网络请求方法。根据业务需求，可以封装一些常用的网络请求方法，例如 GET、POST 等请求方法，以便在发送网络请求时使用。 ```java public void doGet(String url, HttpCallback callback) { Request request = new Request.Builder().url(url).build(); sendRequest(request, callback); } public void doPost(String url, RequestBody body, HttpCallback callback) { Request request = new Request.Builder().url(url).post(body).build(); sendRequest(request, callback); } ``` 通过以上步骤，我们可以封装一个简单的 OkHttp 网络工具类，用于发送网络请求。当然，具体的实现还需要根据业务需求进行调整和优化，以上仅供参考。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值