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

本文主要是介绍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

相关文章

springboot报错Invalid bound statement (not found)的解决

《springboot报错Invalidboundstatement(notfound)的解决》本文主要介绍了springboot报错Invalidboundstatement(not... 目录一. 问题描述二.解决问题三. 添加配置项 四.其他的解决方案4.1 Mapper 接口与 XML 文件不匹配

GORM中Model和Table的区别及使用

《GORM中Model和Table的区别及使用》Model和Table是两种与数据库表交互的核心方法,但它们的用途和行为存在著差异,本文主要介绍了GORM中Model和Table的区别及使用,具有一... 目录1. Model 的作用与特点1.1 核心用途1.2 行为特点1.3 示例China编程代码2. Tab

MySQL新增字段后Java实体未更新的潜在问题与解决方案

《MySQL新增字段后Java实体未更新的潜在问题与解决方案》在Java+MySQL的开发中,我们通常使用ORM框架来映射数据库表与Java对象,但有时候,数据库表结构变更(如新增字段)后,开发人员可... 目录引言1. 问题背景:数据库与 Java 实体不同步1.1 常见场景1.2 示例代码2. 不同操作

Python GUI框架中的PyQt详解

《PythonGUI框架中的PyQt详解》PyQt是Python语言中最强大且广泛应用的GUI框架之一,基于Qt库的Python绑定实现,本文将深入解析PyQt的核心模块,并通过代码示例展示其应用场... 目录一、PyQt核心模块概览二、核心模块详解与示例1. QtCore - 核心基础模块2. QtWid

JavaScript错误处理避坑指南

《JavaScript错误处理避坑指南》JavaScript错误处理是编程过程中不可避免的部分,它涉及到识别、捕获和响应代码运行时可能出现的问题,本文将详细给大家介绍一下JavaScript错误处理的... 目录一、错误类型:三大“杀手”与应对策略1. 语法错误(SyntaxError)2. 运行时错误(R

Redis 中的热点键和数据倾斜示例详解

《Redis中的热点键和数据倾斜示例详解》热点键是指在Redis中被频繁访问的特定键,这些键由于其高访问频率,可能导致Redis服务器的性能问题,尤其是在高并发场景下,本文给大家介绍Redis中的热... 目录Redis 中的热点键和数据倾斜热点键(Hot Key)定义特点应对策略示例数据倾斜(Data S

使用Python实现获取网页指定内容

《使用Python实现获取网页指定内容》在当今互联网时代,网页数据抓取是一项非常重要的技能,本文将带你从零开始学习如何使用Python获取网页中的指定内容,希望对大家有所帮助... 目录引言1. 网页抓取的基本概念2. python中的网页抓取库3. 安装必要的库4. 发送HTTP请求并获取网页内容5. 解

Android Kotlin 高阶函数详解及其在协程中的应用小结

《AndroidKotlin高阶函数详解及其在协程中的应用小结》高阶函数是Kotlin中的一个重要特性,它能够将函数作为一等公民(First-ClassCitizen),使得代码更加简洁、灵活和可... 目录1. 引言2. 什么是高阶函数?3. 高阶函数的基础用法3.1 传递函数作为参数3.2 Lambda

SpringBoot如何通过Map实现策略模式

《SpringBoot如何通过Map实现策略模式》策略模式是一种行为设计模式,它允许在运行时选择算法的行为,在Spring框架中,我们可以利用@Resource注解和Map集合来优雅地实现策略模式,这... 目录前言底层机制解析Spring的集合类型自动装配@Resource注解的行为实现原理使用直接使用M

Python实现Microsoft Office自动化的几种方式及对比详解

《Python实现MicrosoftOffice自动化的几种方式及对比详解》办公自动化是指利用现代化设备和技术,代替办公人员的部分手动或重复性业务活动,优质而高效地处理办公事务,实现对信息的高效利用... 目录一、基于COM接口的自动化(pywin32)二、独立文件操作库1. Word处理(python-d