当前位置:

首页 > 编程开发 > Java封装REST请求工具类示例

Java封装REST请求工具类示例

封装JavaREST请求工具类的核心在于抽象HTTP请求细节并提供统一API。1.工具类基于OkHttp和Jackson构建,支持GET、POST、PUT等HTTP方法;2.封装了请求头、查询参数、请求体的处理;3.包含响应解析与异常管理机制;4.提供默认及可自定义的客户端配置,提升灵活性和可测试性;5.通过统一异常处理确保请求行为一致性和可维护性。

本文目录

    封装Java REST请求工具类的核心在于抽象HTTP请求细节并提供统一API。1. 工具类基于OkHttp和Jackson构建,支持GET、POST、PUT等HTTP方法;2. 封装了请求头、查询参数、请求体的处理;3. 包含响应解析与异常管理机制;4. 提供默认及可自定义的客户端配置,提升灵活性和可测试性;5. 通过统一异常处理确保请求行为一致性和可维护性。

    如何使用Java封装REST请求工具类 Java通用网络请求封装示例

    封装Java REST请求工具类,核心在于将HTTP请求的底层细节抽象化,提供一套简洁、统一且可复用的API,让开发者能够专注于业务逻辑而非繁琐的网络通信配置。这不仅能提升开发效率,还能确保请求行为的一致性和可维护性。

    如何使用Java封装REST请求工具类 Java通用网络请求封装示例

    解决方案

    一个实用的Java REST请求工具类,通常会基于一个成熟的HTTP客户端库来构建,例如OkHttp。它会包含不同HTTP方法(GET, POST, PUT, DELETE等)的封装,并处理请求头、查询参数、请求体以及响应解析和异常。

    以下是一个基于OkHttp和Jackson库的通用REST请求工具类示例:

    如何使用Java封装REST请求工具类 Java通用网络请求封装示例
    import okhttp3.*;
    import java.io.IOException;
    import java.util.Map;
    import java.util.concurrent.TimeUnit;
    import com.fasterxml.jackson.databind.ObjectMapper; // 用于JSON序列化/反序列化
    
    public class RestApiClient {
    
        private static final MediaType JSON_MEDIA_TYPE = MediaType.get("application/json; charset=utf-8");
        private final OkHttpClient client;
        private final ObjectMapper objectMapper;
    
        /**
         * 默认构造函数,使用预设的超时时间创建OkHttpClient实例
         * 和默认的ObjectMapper。
         */
        public RestApiClient() {
            this.client = new OkHttpClient.Builder()
                    .connectTimeout(10, TimeUnit.SECONDS) // 连接超时
                    .readTimeout(30, TimeUnit.SECONDS)    // 读取超时
                    .writeTimeout(30, TimeUnit.SECONDS)   // 写入超时
                    .build();
            this.objectMapper = new ObjectMapper();
        }
    
        /**
         * 允许外部传入自定义的OkHttpClient和ObjectMapper实例,
         * 提升灵活性和可测试性。
         * @param customClient 自定义的OkHttpClient
         * @param customMapper 自定义的ObjectMapper
         */
        public RestApiClient(OkHttpClient customClient, ObjectMapper customMapper) {
            this.client = customClient;
            this.objectMapper = customMapper;
        }
    
        /**
         * 发送GET请求。
         * @param url 请求URL
         * @param headers 请求头,可为null
         * @param queryParams 查询参数,可为null
         * @return 响应体字符串
         * @throws IOException 网络或IO错误
         * @throws HttpRequestException HTTP请求失败(非2xx状态码)
         */
        public String get(String url, Map headers, Map queryParams) throws IOException, HttpRequestException {
            HttpUrl.Builder urlBuilder = HttpUrl.parse(url).newBuilder();
            if (queryParams != null) {
                queryParams.forEach(urlBuilder::addQueryParameter);
            }
    
            Request.Builder requestBuilder = new Request.Builder().url(urlBuilder.build());
            if (headers != null) {
                headers.forEach(requestBuilder::addHeader);
            }
    
            try (Response response = client.newCall(requestBuilder.build()).execute()) {
                return handleResponse(response);
            }
        }
    
        /**
         * 发送POST请求,请求体为JSON格式。
         * @param url 请求URL
         * @param headers 请求头,可为null
         * @param bodyObj 请求体对象,将被序列化为JSON
         * @return 响应体字符串
         * @throws IOException 网络或IO错误,或JSON序列化错误
         * @throws HttpRequestException HTTP请求失败(非2xx状态码)
         */
        public String postJson(String url, Map headers, Object bodyObj) throws IOException, HttpRequestException {
            String jsonBody = objectMapper.writeValueAsString(bodyObj);
            RequestBody requestBody = RequestBody.create(jsonBody, JSON_MEDIA_TYPE);
    
            Request.Builder requestBuilder = new Request.Builder().url(url).post(requestBody);
            if (headers != null) {
                headers.forEach(requestBuilder::addHeader);
            }
    
            try (Response response = client.newCall(requestBuilder.build()).execute()) {
                return handleResponse(response);
            }
        }
    
        /**
         * 发送PUT请求,请求体为JSON格式。
         * @param url 请求URL
         * @param headers 请求头,可为null
         * @param bodyObj 请求体对象,将被序列化为JSON

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 Java Java代码 Java函数
    相关文章 更多
    Java单元测试入门:使用JUnit 5编写第一个测试用例
    Java单元测试入门:使用JUnit 5编写第一个测试用例

    面向初学者的JUnit 5实用入门指南。从测试概念、Maven依赖配置,到手把手编写首个单元测试用例及断言验证,助你掌握Java单元测试的核心流程。

    Java变量未初始化报错解析:局部变量与成员变量默认值差异
    Java变量未初始化报错解析:局部变量与成员变量默认值差异

    深入解析Java中局部变量未初始化编译报错与成员变量自动赋予默认值的机制差异,涵盖JVM内存分配、编译期确定性赋值检查与实际排查修复方案。

    Java获取当前时间并格式化输出:DateTimeFormatter与SimpleDateFormat
    Java获取当前时间并格式化输出:DateTimeFormatter与SimpleDateFormat

    详细讲解在Java中获取当前系统时间并进行格式化输出的两种核心方案:基于Java 8全新日期时间API的DateTimeFormatter与传统遗留的SimpleDateFormat,包含完整代码示例、线程安全机制对比及生产选型建议。

    Java中final与static final常量的定义及初始化规则
    Java中final与static final常量的定义及初始化规则

    深入解析Java中final变量与static final常量的定义、内存语义、初始化时机及合法赋值路径,涵盖编译期常量优化与实战避坑指南。

    Java抽象方法与接口方法的区别及选型建议
    Java抽象方法与接口方法的区别及选型建议

    深入对比Java中抽象类抽象方法与接口方法的语法演进、设计意图及运行期差异,并提供清晰的架构选型决策流程与实战范例。

    Java实现HTTP请求与JSON解析的完整代码示例
    Java实现HTTP请求与JSON解析的完整代码示例

    本文提供Java标准库HttpClient发起HTTP GET/POST请求并结合Jackson进行JSON数据反序列化与序列化的完整代码示例与工程实践指南。

    Java递归出现StackOverflowError的原因分析及栈空间优化方案
    Java递归出现StackOverflowError的原因分析及栈空间优化方案

    详细分析Java递归调用出现StackOverflowError的原因,结合代码说明线程栈、栈帧和递归深度之间的关系,并介绍终止条件排查、迭代改写、减少栈帧开销以及通过-Xss调整JVM栈空间的方法。

    Java空指针异常(NPE)的代码排查与修复实例
    Java空指针异常(NPE)的代码排查与修复实例

    针对Java中常见的NullPointerException(NPE),本文从堆栈日志定位、典型代码触发场景、具体修复代码对比到防御体系进行系统讲解,提供实用且易上手的排查与修复方案。

    selenium上传文件教程本地文件路径设置方法
    selenium上传文件教程本地文件路径设置方法

    深入解析Selenium处理文件上传的技术细节,涵盖标准HTML控件的路径直接注入法与非标准控件的系统级模拟方案,提供Windows与Linux环境下的路径设置最佳实践及常见异常排查。

    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景
    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景

    针对大数据工程场景,系统对比Java、Scala与Python在执行性能、生态结合、开发效率和维护成本上的核心差异,给出清晰的架构选型依据与落地方案。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。