java实现http请求之HttpClient工具类

已于 2022-07-27 18:15:44 修改
阅读量1.3k 收藏 3
点赞数
分类专栏： java代码 文章标签： java http apache
于 2022-07-27 18:14:59 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chaozhuanyi2927/article/details/126020358
版权

针对HttpClient的使用封装一个常用的工具类，以便后续使用
基本实现步骤

  1. 接收url地址
  2. 接收参数信息
  3. 设置连接信息，设置相应信息
  4. 发起请求
  5. 获取相应数据
  6. 返回数据

针对以上功能，只简单做了数据的获取，没有进行数据封装，针对不同场景中的返回值样式需要根据实际业务进行修改。

		<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>

在这里插入代码片

代码块


import lombok.extern.slf4j.Slf4j;
import org.apache.http.HttpEntity;
import org.apache.http.ParseException;
import org.apache.http.client.config.RequestConfig;
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.utils.URIBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.InputStreamEntity;
import org.apache.http.entity.StringEntity;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.util.List;

/**
 * @Author wcj
 * @Date 2022/7/27
 * @Description: HttpClient工具类
 */
@Slf4j
public class HttpClientUtils {
    /**
     * 上传文件至服务器
     *
     * @param url
     * @param file
     */
    public static String httpPostFile(String url, MultipartFile file) {
        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            MultipartEntityBuilder builder = MultipartEntityBuilder.create();
            String filename = file.getOriginalFilename();
            builder.addBinaryBody("file", file.getBytes(), ContentType.MULTIPART_FORM_DATA, filename);
            // 如果需要，传递额外参数
            // StringBody fileName = new StringBody("文件名称", ContentType.MULTIPART_FORM_DATA);
            // StringBody userName = new StringBody("用户名", ContentType.MULTIPART_FORM_DATA);
            // builder.addPart("fileName", fileName);
            // builder.addPart("userName", userName);

            HttpEntity entity = builder.build();
            httpPost.setEntity(entity);
            CloseableHttpResponse response = httpClient.execute(httpPost);
            String result = EntityUtils.toString(response.getEntity(), "UTF-8");
            log.info("结果：" + result);
            return result;
        } catch (Exception e) {
            throw new RuntimeException("文件上传失败！");
        }
    }

    /**
     * GET---无参测试
     *
     * @date
     */

    public static String doGetTestOne(String url) {

        // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
        CloseableHttpClient httpClient = HttpClientBuilder.create().build();

        // 创建Get请求
        HttpGet httpGet = new HttpGet();
        // 响应模型 由客户端执行(发送)Get请求
        try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
            // 从响应模型中获取响应实体
            HttpEntity responseEntity = response.getEntity();
            log.info("响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("响应内容长度为:" + responseEntity.getContentLength());
                log.info("响应内容为:" + EntityUtils.toString(responseEntity));
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;
    }

    /**
     * GET---有参测试 (方式一:手动在url后面加上参数)
     * <p>
     * 参数示例：
     * url:http://localhost:8080/list
     * StringBuilder params = new StringBuilder();
     * try {
     * // 字符数据最好encoding以下;这样一来，某些特殊字符才能传过去(如:某人的名字就是“&”,不encoding的话,传不过去)
     * params.append("name=").append(URLEncoder.encode("&", "utf-8")).append("&").append("age=24");
     * } catch (UnsupportedEncodingException e1) {
     * e1.printStackTrace();
     * }
     *
     * @date
     */

    public static String doGetTestWayOne(String url, StringBuilder params) {
        // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
        CloseableHttpClient httpClient = HttpClientBuilder.create().build();
        // 创建Get请求
        HttpGet httpGet = new HttpGet(url + "?" + params);
        // 响应模型
        try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
            // 配置信息
            RequestConfig requestConfig = RequestConfig.custom()
                    // 设置连接超时时间(单位毫秒)
                    .setConnectTimeout(5000)
                    // 设置请求超时时间(单位毫秒)
                    .setConnectionRequestTimeout(5000)
                    // socket读写超时时间(单位毫秒)
                    .setSocketTimeout(5000)
                    // 设置是否允许重定向(默认为true)
                    .setRedirectsEnabled(true).build();
            // 将上面的配置信息 运用到这个Get请求里
            httpGet.setConfig(requestConfig);

            // 从响应模型中获取响应实体
            HttpEntity responseEntity = response.getEntity();
            log.info("响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("响应内容长度为:" + responseEntity.getContentLength());
                log.info("响应内容为:" + EntityUtils.toString(responseEntity));
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;
    }

    /**
     * GET---有参测试 (方式二:将参数放入键值对类中,再放入URI中,从而通过URI得到HttpGet实例)
     * 参数示例
     *
     * @param scheme http
     * @param host   127.0.0.1
     * @param port   8080
     * @param path   /doGetControllerTwo
     * @param params 将参数放入键值对类NameValuePair中,再放入集合中
     *               List params = new ArrayList<>();
     *               params.add(new BasicNameValuePair("name", "&"));
     *               params.add(new BasicNameValuePair("age", "18"));
     * @date
     */

    public static String doGetTestWayTwo(String scheme, String host, int port, String path, List params) {
        // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
        CloseableHttpClient httpClient = HttpClientBuilder.create().build();
        // 参数
        URI uri = null;
        try {
            // 设置uri信息,并将参数集合放入uri;
            // 注:这里也支持一个键值对一个键值对地往里面放setParameter(String key, String value)
            uri = new URIBuilder().setScheme(scheme).setHost(host).setPort(port).setPath(path).setParameters(params).build();
        } catch (URISyntaxException e1) {
            e1.printStackTrace();
        }
        // 创建Get请求
        HttpGet httpGet = new HttpGet(uri);
        // 响应模型
        try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
            // 配置信息
            RequestConfig requestConfig = RequestConfig.custom()
                    // 设置连接超时时间(单位毫秒)
                    .setConnectTimeout(5000)
                    // 设置请求超时时间(单位毫秒)
                    .setConnectionRequestTimeout(5000)
                    // socket读写超时时间(单位毫秒)
                    .setSocketTimeout(5000)
                    // 设置是否允许重定向(默认为true)
                    .setRedirectsEnabled(true).build();
            // 将上面的配置信息 运用到这个Get请求里
            httpGet.setConfig(requestConfig);
            // 从响应模型中获取响应实体
            HttpEntity responseEntity = response.getEntity();
            log.info("响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("响应内容长度为:" + responseEntity.getContentLength());
                log.info("响应内容为:" + EntityUtils.toString(responseEntity));
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;
    }

    /**
     * POST---无参测试
     *
     * @param url
     */

    public static String doPostTestOne(String url) {

        // 创建Post请求
        HttpPost httpPost = new HttpPost(url);
        // 响应模型
        // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build(); CloseableHttpResponse response = httpClient.execute(httpPost)) {

            // 从响应模型中获取响应实体
            HttpEntity responseEntity = response.getEntity();
            log.info("响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("响应内容长度为:" + responseEntity.getContentLength());
                log.info("响应内容为:" + EntityUtils.toString(responseEntity));
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;

    }

    /**
     * POST---有参测试(普通参数)
     *
     * @param url
     * @param params StringBuilder params = new StringBuilder();
     *               // 字符数据最好encoding以下;这样一来，某些特殊字符才能传过去(如:某人的名字就是“&”,不encoding的话,传不过去)
     *               params.append("phone=").append(URLEncoder.encode("admin", "utf-8"));
     *               params.append("&");
     *               params.append("password=admin");
     */

    public static String doPostTestFour(String url, StringBuilder params) {
        // 创建Post请求
        HttpPost httpPost = new HttpPost(url + "?" + params);
        // 设置ContentType(注:如果只是传普通参数的话,ContentType不一定非要用application/json)
        httpPost.setHeader("Content-Type", "application/json;charset=utf8");
        // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build(); CloseableHttpResponse response = httpClient.execute(httpPost)) {
            // 从响应模型中获取响应实体
            HttpEntity responseEntity = response.getEntity();
            log.info("响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("响应内容长度为:" + responseEntity.getContentLength());
                log.info("响应内容为:" + EntityUtils.toString(responseEntity));
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;
    }

    /**
     * POST---有参测试(对象参数)
     *
     * @param url
     * @param jsonString //User user = new User();
     *                   //user.setName("潘晓婷");
     *                   //user.setAge(18);
     *                   //user.setGender("女");
     *                   //user.setMotto("姿势要优雅~");
     *                   // 我这里利用阿里的fastjson，将Object转换为json字符串;
     *                   // (需要导入com.alibaba.fastjson.JSON包)
     *                   //String jsonString = JSON.toJSONString(user);
     * @return
     */

    public static String doPostTestTwo(String url, String jsonString) {
        // 创建Post请求
        HttpPost httpPost = new HttpPost(url);
        StringEntity entity = new StringEntity(jsonString, "UTF-8");
        // post请求是将参数放在请求体里面传过去的;这里将entity放入post请求体中
        httpPost.setEntity(entity);

        httpPost.setHeader("Content-Type", "application/json;charset=utf8");

        // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build(); CloseableHttpResponse response = httpClient.execute(httpPost)) {
            // 从响应模型中获取响应实体
            HttpEntity responseEntity = response.getEntity();
            log.info("响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("响应内容长度为:" + responseEntity.getContentLength());
                log.info("响应内容为:" + EntityUtils.toString(responseEntity));
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;
    }

    /**
     * 发送文件
     * <p>
     * multipart/form-data传递文件(及相关信息)
     * <p>
     * 注:如果想要灵活方便的传输文件的话，
     * <p>
     * 除了引入org.apache.httpcomponents基本的httpclient依赖外
     * <p>
     * 再额外引入org.apache.httpcomponents的httpmime依赖。
     * <p>
     * 追注:即便不引入httpmime依赖，也是能传输文件的，不过功能不够强大。
     * MultipartEntityBuilder multipartEntityBuilder = MultipartEntityBuilder.create();
     * // 第一个文件
     * String filesKey = "files";
     * File file1 = new File("C:\\Users\\JustryDeng\\Desktop\\back.jpg");
     * multipartEntityBuilder.addBinaryBody(filesKey, file1);
     * // 第二个文件(多个文件的话，使用同一个key就行，后端用数组或集合进行接收即可)
     * File file2 = new File("C:\\Users\\JustryDeng\\Desktop\\头像.jpg");
     * // 防止服务端收到的文件名乱码。 我们这里可以先将文件名URLEncode，然后服务端拿到文件名时在URLDecode。就能避免乱码问题。
     * // 文件名其实是放在请求头的Content-Disposition里面进行传输的，如其值为form-data; name="files"; filename="头像.jpg"
     * multipartEntityBuilder.addBinaryBody(filesKey, file2, ContentType.DEFAULT_BINARY, URLEncoder.encode(file2.getName(), "utf-8"));
     * // 其它参数(注:自定义contentType，设置UTF-8是为了防止服务端拿到的参数出现乱码)
     * ContentType contentType = ContentType.create("text/plain", StandardCharsets.UTF_8);
     * multipartEntityBuilder.addTextBody("name", "邓沙利文", contentType);
     * multipartEntityBuilder.addTextBody("age", "25", contentType);
     */

    public static String sendFile(String url, MultipartEntityBuilder multipartEntityBuilder) {
        HttpPost httpPost = new HttpPost(url);
        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build(); CloseableHttpResponse response = httpClient.execute(httpPost);) {

            HttpEntity httpEntity = multipartEntityBuilder.build();
            httpPost.setEntity(httpEntity);

            HttpEntity responseEntity = response.getEntity();
            log.info("HTTPS响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("HTTPS响应内容长度为:" + responseEntity.getContentLength());
                // 主动设置编码，来防止响应乱码
                String responseStr = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8);
                log.info("HTTPS响应内容为:" + responseStr);
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;
    }

    /**
     * 发送流
     *
     * @param url
     * @param is
     * @return
     */
    public static String sendStream(String url, InputStream is) {
        HttpPost httpPost = new HttpPost(url);
        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build(); CloseableHttpResponse response = httpClient.execute(httpPost)) {
            InputStreamEntity ise = new InputStreamEntity(is);
            httpPost.setEntity(ise);
            HttpEntity responseEntity = response.getEntity();
            log.info("HTTPS响应状态为:" + response.getStatusLine());
            if (responseEntity != null) {
                log.info("HTTPS响应内容长度为:" + responseEntity.getContentLength());
                // 主动设置编码，来防止响应乱码
                String responseStr = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8);
                log.info("HTTPS响应内容为:" + responseStr);
                return EntityUtils.toString(responseEntity);
            }
        } catch (ParseException | IOException e) {
            throw new RuntimeException("请求异常，异常信息为：" + e.getMessage());
        }
        return null;
    }

}

参考地址

粉墨听禅
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
httpclient工具类
qq_44077470的博客
05-27 423
【代码】httpclient工具类。
【Java】HTTP请求工具类
Syals的博客
12-26 4998
在工作中可能存在要去调用其他项目的接口，这篇文章我们实现在Java代码中实现调用其他项目的接口。创建一个携带参数的POST请求，去请求其他项目的接口并返回数据。附加HTTP请求工具类，包含（GET、POST、无参GET、无参POST）
集成框架 -- 阿里网关API
寿春
09-26 1019
直接用HTTPS 安全校验是可以跳过的，所以相比较HTTP HTTPS 可以任意切换。外部接口，避免复杂配置，增加证书校验，可以选择API 网关。
JavaHTTP请求工具类HTTPUtils
weixin_42077074的博客
03-17 3402
其中涉及 HTTP 请求相关的各种操作，关于这些方法详细的介绍可以查看这些博客。博客文章《Java发起HTTP请求并解析JSON返回数据》博客文章《JavaJSON处理工具类JSONUtils》博客文章《Java发起同异步HTTP请求和处理数据》HTTP 请求工具类。HTTP 请求工具类。
JAVA的http工具类
航仔的博客
11-17 2168
【代码】JAVA的http工具类。
java中几种httpclient工具类
weixin_44263023的博客
05-06 1101
总结 java httpclient工具类
java实现http请求工具类示例
09-04
log.info("HttpClientUtils 执行 GET 请求，响应为：" + responseJson); return responseJson; } /** * GET方式调用，可设置超时时间 * * @param url * @param timeout 超时时间，单位毫秒 * @return 响应字符串 * ...
Https请求工具类，Java实现http请求，https请求
最新发布
12-14
Https请求工具类，Java实现http请求，https请求 本篇文章将详细介绍如何使用Java语言实现Http和Https请求的工具类，包括如何建立Https连接、如何实现Post请求、如何处理SSL验证等内容。 在Java中，使用...
Java http请求封装工具类代码实例
08-19
Java HTTP 请求封装工具类的实现主要涉及到两种方式，一种是通过 Java 自带的标准类 HttpURLConnection 去实现，另一种是通过 Apache 的 HttpClient 去实现。本文中，我们使用 HttpClient 来实现 HTTP 请求封装工具...
JAVA 发送http请求工具类
04-13
本文将详细解析如何使用Java实现HTTP和HTTPS的GET与POST请求，并结合提供的类文件名称（HttpsHandler.java、HttpUtil.java、NetUtil.java）探讨可能的实现方式。 首先，`HttpUtil`类通常用于封装HTTP请求的操作。在...
Java实现Http工具类的封装操作示例
08-28
Java实现Http工具类的封装操作示例主要介绍了Java实现Http工具类的封装操作，涉及java针对http请求与响应、远程交互与字符串拼接等操作封装技巧。下面是对标题、描述、标签和部分内容的详细解释和知识点总结： 一...
httpclient需要的各种jar包
11-15
httpclient需要的各种jar包 commons-codec-1.7.jar commons-httpclient.jar commons-logging-1.1.1.jar httpclient-4.2.2.jar httpcore-4.2.2.jar
HttpClient Java工具类
小星星专栏
07-19 300
HttpClient
通用Http请求的工具类（Java）
ldwtxwh的专栏
11-16 409
在Java开发中很常用的就是调用http请求或者发起http接口请求，这里我把我平时常用的封装类代码贴出来，望留下宝贵意见到评论区；
HTTPClient工具类
Planing & Design & Arrange & Do & willWinner
11-13 3217
HTTPClient 的实现工具类。
Java(114)：通过HttpClient方法请求Get请求方式的下载接口
fen_fen的专栏
03-30 1644
通过HttpClient方法请求Get请求方式的下载接口
【HttpUtil】基于 HttpClient 的简易 Java 工具类
NXY666
04-03 455
基于 HttpClient 的简易 Java 工具类。
使用Apache提供的HttpClient对象调用HTTP接口(基于POST请求)
ShangHai0123的博客
08-04 2934
本篇将主要介绍如何使用HttpClient4.5版本调用接口的实例.(实现代码中有大量注释供理解所用) 先准备好一个Springboot项目,方便自己编写接口与后台直接main方法调用. Springboot工程结构展示: 准备好后,第一步引入Apache提供的HttpClient4.5版本的依赖包. 依赖如下: <dependency> <groupId>org.apache.httpcomponents</groupId> <ar
Postman系列（七）-查看接口响应
做测试多少要会点的技能
08-22 7200
Postman查看接口响应
java实现http请求之httpclient
09-27
JAVA实现HTTP请求之HTTPClient是一种常用的方法。在使用HTTPClient之前，需要首先引入相应的依赖，可以通过Maven来管理依赖。使用以下代码片段可以引入HTTPClient的Maven依赖： ```xml <groupId>org.apache....

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值