首页 > Java > java教程 > 正文

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

爱谁谁
发布: 2025-07-19 19:02:03
原创
279人浏览过

封装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等)的封装,并处理请求头、查询参数、请求体以及响应解析和异常。

AI Sofiya
AI Sofiya

一款AI驱动的多功能工具

AI Sofiya 109
查看详情 AI Sofiya

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

立即学习Java免费学习笔记(深入)”;

如何使用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<String, String> headers, Map<String, String> 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<String, String> 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
登录后复制

以上就是如何使用Java封装REST请求工具类 Java通用网络请求封装示例的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号