基于ApacheHttpclient封装的请求工具类（记笔记）

已于 2023-11-09 17:26:29 修改
阅读量573 收藏
点赞数
文章标签： java
于 2023-08-01 15:26:27 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_17805707/article/details/132043010
版权

我们的项目中通常不可避免的会与第三方系统做交互，这个时候就需要用到一些http工具类，因为对于每一个不同的业务需求我们关注的是入参和出参，至于中间的步骤，比如创建客户端，填充参数等等，我们是不需要关心的，那么这个时候封装一个工具类就很有必要了，尤其是最近经历的一个项目里面，发送http请求竟然用了五中不同的玩法（okhttp、apachehttpclients、hutool、原生的jdk自带的客户端、restTemplate），让我很是无语，于是自己基于apachehttpclients写了一个封装的工具类，废话不多说，直接上代码：

package org.example.http;

import cn.hutool.core.util.HexUtil;
import com.alibaba.fastjson.JSON;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.InputStream;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class HttpRequestUtil {
    private static final Logger LOGGER = LoggerFactory.getLogger(HttpRequestUtil.class);

    /**
     * 设置请求头
     *
     * @param request
     * @param header
     */
    private static void setHeader(HttpRequestBase request, Map<String, String> header) {
        if (null != header && !header.isEmpty()) {
            for (Map.Entry<String, String> stringStringEntry : header.entrySet()) {
                request.addHeader(stringStringEntry.getKey(), stringStringEntry.getValue());
            }
        }
    }

    /**
     * 发送请求，返回结果
     *
     * @param httpClient
     * @param requestBase
     * @return
     */
    private static String execAndResolveResponse(CloseableHttpClient httpClient, HttpRequestBase requestBase) {
        String result = "{}";
        try {
            CloseableHttpResponse execute = httpClient.execute(requestBase);
            HttpEntity responseEntity = execute.getEntity();
            result = EntityUtils.toString(responseEntity, Charset.forName("utf-8"));
        } catch (Exception e) {
            LOGGER.error("execute request exception", e);
        }
        return result;
    }

    /**
     * raw方式发送请求
     */
    public static String doPost(String url, Map<String, String> header, String jsonParam) {
        String result = "{}";
        try {
            //构造post
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpPost httpPost = new HttpPost(url);
            //设置header
            setHeader(httpPost, header);
            StringEntity stringEntity = new StringEntity(jsonParam, ContentType.APPLICATION_JSON);
            //设置请求参数
            httpPost.setEntity(stringEntity);
            //发送请求
            result = execAndResolveResponse(httpClient, httpPost);
        } catch (Exception e) {
            LOGGER.error("url:{},header:{},params{}", url, JSON.toJSONString(header), jsonParam);
            LOGGER.error(result);
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doPost exception", e);
        }
        return result;
    }

    /**
     * 表单方式发送请求
     *
     * @param url
     * @param header
     * @param formData
     * @return
     */
    public static String doPost(String url, Map<String, String> header, Map<String, Object> formData) {
        String result = "{}";
        try {
            //构造post
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpPost httpPost = new HttpPost(url);
            //设置header
            setHeader(httpPost, header);
            //设置params
            MultipartEntityBuilder builder = MultipartEntityBuilder.create();
            builder.setCharset(Charset.forName("utf-8"));
            builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
            for (Map.Entry<String, Object> stringObjectEntry : formData.entrySet()) {
                builder.addTextBody(stringObjectEntry.getKey(), stringObjectEntry.getValue().toString(), ContentType.create("text/plain", "utf-8"));
            }
            HttpEntity entity = builder.build();
            httpPost.setEntity(entity);
            //发送请求
            result = execAndResolveResponse(httpClient, httpPost);
        } catch (Exception e) {
            LOGGER.error("url:{},header:{},formData{}", url, JSON.toJSONString(header), formData);
            LOGGER.error(result);
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doPost exception", e);
        }
        return result;
    }

    public static String doPostV2(String url, Map<String, String> header, Map<String, String> formData) {
        String result = "{}";
        try {
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpPost httpPost = new HttpPost(url);
            setHeader(httpPost, header);

            List<NameValuePair> params = new ArrayList<>();
            for (Map.Entry<String, String> entry : formData.entrySet()) {
                params.add(new BasicNameValuePair(entry.getKey(), entry.getValue()));
            }
            UrlEncodedFormEntity entity = new UrlEncodedFormEntity(params, "UTF-8");
            httpPost.setEntity(entity);

            result = execAndResolveResponse(httpClient, httpPost);
        } catch (Exception e) {
            LOGGER.error("url:{},header:{},formData{}", url, JSON.toJSONString(header), formData);
            LOGGER.error(result);
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doPost exception", e);
        }
        return result;
    }

    /**
     * get请求
     */
    public static String doGet(String url, Map<String, String> header) {
        String result = "{}";
        try {
            //构造get
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpGet httpGet = new HttpGet(url);
            //设置header
            setHeader(httpGet, header);
            //发送请求
            result = execAndResolveResponse(httpClient, httpGet);
        } catch (Exception e) {
            LOGGER.error("url:{},header:{}", url, JSON.toJSONString(header));
            LOGGER.error(result);
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doGet exception", e);
        }
        return result;
    }

    /**
     * hutool的上传不好使，所以这里改用apache httpclients做上传
     * file:表单提交文件的变量名
     * fileName：文件名
     * fileData：文件字节数组
     * params:表单其他数据
     */
    public static String doUpload(String url, Map<String, String> header, String file, String fileName, byte[] fileData, Map<String, Object> params) {
        String result = "{}";
        try {
            //构造post
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpPost httpPost = new HttpPost(url);
            //设置header
            setHeader(httpPost, header);
            MultipartEntityBuilder builder = MultipartEntityBuilder.create();
            builder.setCharset(Charset.forName("utf-8"));
            builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
            builder.addBinaryBody(file, fileData, ContentType.MULTIPART_FORM_DATA, fileName);
            for (Map.Entry<String, Object> stringObjectEntry : params.entrySet()) {
                builder.addTextBody(stringObjectEntry.getKey(), stringObjectEntry.getValue().toString(), ContentType.create("text/plain", "utf-8"));
            }
            HttpEntity entity = builder.build();
            httpPost.setEntity(entity);
            result = execAndResolveResponse(httpClient, httpPost);
        } catch (Exception e) {
            LOGGER.error("url:{},header:{},fileName{}", url, JSON.toJSONString(header), file);
            LOGGER.error(result);
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doUpload exception", e);
        }
        return result;
    }

    /**
     * 上传文件，这个方法只上传文件字节数组数据，不是表单的那种上传
     */
    public static String doUpload(String url, Map<String, String> header, byte[] fileData) {
        String result = "{}";
        try {
            //构造post
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpPost httpPost = new HttpPost(url);
            //设置header
            setHeader(httpPost, header);
            HttpEntity entity = new ByteArrayEntity(fileData);
            httpPost.setEntity(entity);
            result = execAndResolveResponse(httpClient, httpPost);
        } catch (Exception e) {
            LOGGER.error("url:{},header:{},fileData{}", url, JSON.toJSONString(header), HexUtil.encodeHexStr(fileData));
            LOGGER.error(result);
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doUpload exception", e);
        }
        return result;
    }

    /**
     * get请求，返回InputStream
     */
    public static InputStream doGetInputStream(String url, Map<String, String> header) {
        InputStream inputStream = null;
        try {
            //构造get
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpGet httpGet = new HttpGet(url);
            //设置header
            setHeader(httpGet, header);
            //发送请求
            CloseableHttpResponse execute = httpClient.execute(httpGet);
            HttpEntity entity = execute.getEntity();
            return entity.getContent();
        } catch (Exception e) {
            LOGGER.error("url:{},header:{}", url, JSON.toJSONString(header));
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doGet exception", e);
        }
        return inputStream;
    }

    /**
     * raw方式发送请求，同时返回responseHeader当中指定的key
     */
    public static Pair<String, String> doPost(String url, Map<String, String> header, String jsonParam, String responseHeaderKey) {
        String result = "{}";
        String targetHeader = "";
        try {
            //构造post
            CloseableHttpClient httpClient = HttpClients.createDefault();
            HttpPost httpPost = new HttpPost(url);
            //设置header
            setHeader(httpPost, header);
            StringEntity stringEntity = new StringEntity(jsonParam, ContentType.APPLICATION_JSON);
            //设置请求参数
            httpPost.setEntity(stringEntity);
            //发送请求
            CloseableHttpResponse execute = httpClient.execute(httpPost);
            Header firstHeader = execute.getLastHeader(responseHeaderKey);
            targetHeader = null == firstHeader ? "" : firstHeader.getValue();
            HttpEntity responseEntity = execute.getEntity();
            result = EntityUtils.toString(responseEntity, Charset.forName("utf-8"));
        } catch (Exception e) {
            LOGGER.error("url:{},header:{},params:{},responseHeaderKey:{}", url, JSON.toJSONString(header), jsonParam, responseHeaderKey);
            LOGGER.error(result);
            LOGGER.error("cn.tk.cloud.common.util.HttpRequestUtil.doPost exception", e);
        }
        Pair<String, String> pair = new ImmutablePair(result, targetHeader);
        return pair;
    }
}

下面是pom依赖：

<dependency>
            <groupId>com.alibaba.</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.70</version>
        </dependency>

        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.5.13</version>
        </dependency>
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpmime</artifactId>
            <version>4.5.13</version>
        </dependency>

        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.20</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.12.0</version>
        </dependency>

其实最开始我是想基于hutool封装的，但是表单上传的那个方法试了，文件传不上去，没找到问题，就放弃了

时间的痕迹01
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
HttpClient常用操作及封装工具类
rqz__的博客
07-30 1578
HttpClient 是一个用于发送 HTTP 请求和接收 HTTP 响应的类库/模块，可以用于编写客户端应用程序，通过 HTTP 与服务器进行通信。 HttpClient 提供了一组方法和类，使得发送 HTTP 请求变得简单和方便。它支持各种 HTTP 方法，例如 GET、POST、PUT、DELETE 等，并可以设置请求的头部信息、请求参数、请求体等。
apache的HttpClient使用总结
wujun2412的博客
10-11 3334
目录 1.前言 2.Apache官网例子 3.HttpClient及其连接池配置 4.MaxtTotal和DefaultMaxPerRoute的区别 5.HttpClient连接池模型 6.HttpClient从连接池中获取连接源码分析 7.HttpClient从连接池中获取连接流程图 8.连接重用和保持策略 8.1.HttpClientBuilder创建MainClientExec 8.2.ConnectionReuseStrategy(连接重用策略) 8.3.MainCl...
Java工具库系列（十一）：Apache HttpClient
最新发布
阿里渣渣java研发组-群主
06-13 724
Apache HttpClient 是Apache软件基金会下的一个项目，旨在提供一个高效的、功能丰富的HTTP客户端工具库。它支持HTTP/1.1和HTTP/2，提供了易于使用的API，支持同步和异步请求、连接池管理、请求重试等功能。Apache HttpClient 是一个功能强大的HTTP客户端库，通过提供丰富的API和配置选项，极大地简化了Java应用程序的HTTP通信。在本篇文章中，我们介绍了HttpClient的核心功能和使用方法。
apache httpclient 工具类_策略模式之HttpClient
weixin_39526185的博客
11-28 146
1.链接重用机制参考了HttpClient官方sample代码的深入分析(连接池) - mumuxinfei - 博客园​www.cnblogs.com这篇文章；代码基于httpcore的4.4版本和httpclient的4.5版本首先我们来开重用策略类的接口，即位于httpcore包中的org.apache.http.ConnectionReuseStrategypackage 他的两个子类：同...
Apache HttpComponents 简单使用
qq_43842093的博客
10-14 1200
Apache Commons HttpClient（或被称为 Apache HttpClient 3.x）、Apache HttpComponents Client（或被称为 Apache HttpClient 4.x）HttpComponents 项目就是专门设计来简化 HTTP 客户端与服务器进行各种通讯编程。现在的 HttpComponents 包含多个子项目主要的功能实现了所有 HTTP 的方法（GET,POST,PUT,HEAD 等）支持自动转向支持 HTTPS 协议。
httpclient4 实现http协议post、get类型接口调用
shuyichao的博客
03-08 456
代码如下，不支持https package UDS.UdsTest.comme; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.util.Iterator; import java...
HTTPClient工具类
Planing & Design & Arrange & Do & willWinner
11-13 3224
HTTPClient 的实现工具类。
使用Apache提供的HttpClient对象调用HTTP接口(基于POST请求)
ShangHai0123的博客
08-04 2958
本篇将主要介绍如何使用HttpClient4.5版本调用接口的实例.(实现代码中有大量注释供理解所用) 先准备好一个Springboot项目,方便自己编写接口与后台直接main方法调用. Springboot工程结构展示: 准备好后,第一步引入Apache提供的HttpClient4.5版本的依赖包. 依赖如下: <dependency> <groupId>org.apache.httpcomponents</groupId> <ar
Java http请求封装工具类代码实例
08-19
Java HTTP 请求封装工具类是一个封装了 HTTP 请求的工具类，主要用于封装 HTTP 请求的参数、头信息和请求体等信息，使得开发者可以更加方便地发送 HTTP 请求。 二、Java HTTP 请求封装工具类的实现 Java HTTP 请求...
Android封装的http请求实用工具类
01-05
代码如下:import java.io.BufferedReader;import java.io.InputStreamReader;import java.net.URLEncoder;import java.security.KeyStore;import java.util.Iterator;import java.util.List;import java.util.Map;...
AFN网络请求封装工具类
06-11
本篇文章将深入解析一个基于AFNetworking封装的网络请求工具类，以"LCNetWorking"为例，探讨其设计理念和使用方法，帮助开发者更高效地进行网络请求操作。 ### AFNetworking基础 AFNetworking是Objective-C的网络...
基于apache http的工具类
03-28
NULL 博文链接：https://913.iteye.com/blog/1249526
Carthage 集成AFN，封装的网络请求工具类
05-09
总结，本篇文章主要讲述了如何使用Carthage集成AFNetworking库，并基于AFNetworking封装了一个网络请求工具类`AFNTool`。通过这种方式，我们可以更好地管理和使用网络请求功能，提高代码的可复用性和可维护性。在...
HttpClients工具类
dsaggdsd的博客
07-31 471
<dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> </dependency> //只发送java发送http请求，不需要后面的依赖 <dependency> <groupId>com.alibaba</groupId> <ar.
实现一个支持高并发的HttpClient工具，成倍提升系统的性能和QPS
十三月的博客
02-07 307
是 Apache HttpClient 库中的一个核心类，用于发送 HTTP 请求并处理 HTTP 响应。HttpClient提供了发送各种类型的 HTTP 请求的方法，包括 GET、POST、PUT、DELETE 等。通过这些方法，你可以向服务器发送请求，并获取服务器的响应。HttpClient可以帮助你处理服务器返回的 HTTP 响应。你可以从响应中获取状态码、头部信息、响应内容等，并根据需要进行相应的处理，例如解析 JSON、XML 等格式的数据。HttpClient。
HttpClient工具类编写
qq_42736179的博客
04-26 846
HttpClient是Apache Jakarta Common下的一个子项目，它提供了一个高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包。它支持HTTP协议最新的版本和建议，并实现了Http1.0和Http1.1协议。HttpClient具有可扩展的面向对象的结构，。它支持HTTPS协议，并允许通过Http代理建立透明的连接，以及利用CONNECT方法建立隧道的https连接。
Apache HttpClient 5 使用详细教程
ch98000的博客
08-19 5739
超文本传输协议（HTTP）可能是当今互联网上最重要的协议之一，Web 服务、微服务以及支持网络的各种设备上的服务几乎都是 HTTP 协议，HTTP 协议已经从 Web 浏览器走向了更广泛的使用场景。虽然java.net包已经提供了 HTTP 访问资源的基本功能，但是它不够灵活，而且不能随心所欲的进行自定义。Apache HttpClient 5 是一个开源的 HTTP 工具包，可以支持最新 HTTP 协议标准，且有丰富的 API 和强大的扩展特性，可以用于构建任何需要进行 HTTP 协议处理的应用程序。..
Apache HttpClient 客户端使用详解、文件上传、文件下载
热门推荐
蚩尤后裔-汪茂雄
05-30 1万+
目录 环境准备 二进制 Jar 包 Maven 依赖 Http get 请求 环境准备 二进制 Jar 包 1、本文的 HttpClient 是指 Apache 官网 HttpComponents 项目下的子项目HttpClient 。 2、如果项目使用手动导入 Jar 包的方式，则可以从官网下载，地址：http://hc.apache.org/downloads.cgi ...
httpclient、hutool（发送HTTP请求）
loveLifeLoveCoding的博客
05-26 3192
使用 hutool <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>4.5.16</version> </dependency> 使用 cn.hutool.http.HttpRe
基于ThreadLocal封装的工具类
08-25
基于ThreadLocal封装的工具类可以提供一些方便的方法，用于在多线程环境中访问和操作ThreadLocal变量。 以下是一个基于ThreadLocal封装的工具类的示例： ```java public class ThreadLocalUtil<T> { private ...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值