阐述使用 HttpClient 进行 http 请求

1 概述

(1)HTTPClient 实现了所有 HTTP 的方法(包括 GET、POST、PUT、DELETE、OPTIONS

等),使用该工具包可以很方便的发起http请求。

(2)Maven 依赖

bash 复制代码
<dependency>
    <groupId>org.apache.httpcomponents.client5</groupId>
    <artifactId>httpclient5</artifactId>
    <version>5.3</version>
</dependency>

(3)执行http请求的步骤如下:

  • 创建 HttpClient 实例
  • 创建请求实例(如 HttpGet)
  • 执行请求
  • 处理响应结果
  • 关闭连接(释放资源)

2 Http接口案例

下面是几个 Http 接口。后续接口调用案例将调用下述接口。

java 复制代码
@RestController
@RequestMapping("/request")
public class RequestTestController {


    @GetMapping("/getWithoutParam")
    public String getWithoutParam() {
        return "data_getWithoutParam";
    }

    @GetMapping("/getWithParam")
    public String getWithParam(String param, String param2) {
        return "data_getWithParam_" + param + "_" + param2;
    }

    @PostMapping("/postWithoutParam")
    public String postWithoutParam() {
        return "data_postWithoutParam";
    }

    @PostMapping("/postWithParam")
    public String postWithParam(@RequestBody PostWithParamDto param) {
        return "data_postWithParam_" + param.getParam() + "_" + param.getParam2();
    }

    @Data
    public static class PostWithParamDto {
        private String param;
        private String param2;
    }

}

3 get请求

下面是 get 请求的调用方式,分别为调用无入参和有入参的 get 接口。

3.1 get 无参

java 复制代码
    /**
     * get 无参
     */
    public void getWithoutParam() {
        CloseableHttpResponse response = null;
        // 创建 httpClient 实例
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 创建请求实例
        HttpGet httpGet = new HttpGet("http://127.0.0.1:8080/request/getWithoutParam");
        try {
            // 执行请求
            response = httpClient.execute(httpGet);
            // 处理响应结果
            if (response.getStatusLine().getStatusCode() != 200) {
                log.error("http getWithoutParam error. response:{}", JSON.toJSONString(response));
                return;
            }

            String resultString = EntityUtils.toString(response.getEntity(), "UTF-8");
            log.info("http getWithoutParam result:{}", JSON.toJSONString(resultString));
        } catch (Exception e) {
            log.error("http getWithoutParam error", e);
        } finally {
            // 关闭连接
            try {
                if (response != null) {
                    response.close();
                }
                httpClient.close();
            } catch (Exception e) {
                log.error("http getWithoutParam error", e);
            }
        }
    }

3.2 get 有参

java 复制代码
    public void getWithParam() {
        CloseableHttpResponse response = null;
        // 创建 httpClient 实例
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 创建请求实例
        StringBuilder stringBuilder = new StringBuilder();
        try {
            stringBuilder.append("param=").append(URLEncoder.encode("123", "utf-8"));
            stringBuilder.append("&");
            stringBuilder.append("param2=").append(URLEncoder.encode("456", "utf-8"));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }

        HttpGet httpGet = new HttpGet("http://127.0.0.1:8080/request/getWithParam?"+stringBuilder);
        try {
            // 执行请求
            response = httpClient.execute(httpGet);
            // 处理响应结果
            if (response.getStatusLine().getStatusCode() != 200) {
                log.error("http getWithParam error. response:{}", JSON.toJSONString(response));
                return;
            }

            String resultString = EntityUtils.toString(response.getEntity(), "UTF-8");
            log.info("http getWithParam result:{}", JSON.toJSONString(resultString));
        } catch (Exception e) {
            log.error("http getWithParam error", e);
        } finally {
            // 关闭连接
            try {
                if (response != null) {
                    response.close();
                }
                httpClient.close();
            } catch (Exception e) {
                log.error("http getWithParam error", e);
            }
        }
    }

4 post 请求

下面是 post 请求的调用方式,分别为调用无入参和有入参的 post 接口。

4.1 post 无参

java 复制代码
    public void postWithoutParam() {
        CloseableHttpResponse response = null;
        // 创建 httpClient 实例
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 创建请求实例
        HttpPost httpPost = new HttpPost("http://127.0.0.1:8080/request/postWithoutParam");
        try {
            // 执行请求
            response = httpClient.execute(httpPost);
            // 处理响应结果
            if (response.getStatusLine().getStatusCode() != 200) {
                log.error("http postWithoutParam error. response:{}", JSON.toJSONString(response));
                return;
            }

            String resultString = EntityUtils.toString(response.getEntity(), "UTF-8");
            log.info("http postWithoutParam result:{}", JSON.toJSONString(resultString));
        } catch (Exception e) {
            log.error("http postWithoutParam error", e);
        } finally {
            // 关闭连接
            try {
                if (response != null) {
                    response.close();
                }
                httpClient.close();
            } catch (Exception e) {
                log.error("http postWithoutParam error", e);
            }
        }
    }

4.2 post 有参

java 复制代码
    public void postWithParam() {
        CloseableHttpResponse response = null;
        // 创建 httpClient 实例
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 创建请求实例
        HttpPost httpPost = new HttpPost("http://127.0.0.1:8080/request/postWithParam");
        // 接口请求参数 PostWithParamDto
        PostWithParamDto postWithParamDto = new PostWithParamDto();
        postWithParamDto.setParam("123");
        postWithParamDto.setParam2("456");
        StringEntity entity = new StringEntity(JSON.toJSONString(postWithParamDto), "UTF-8");
        httpPost.setEntity(entity);
        httpPost.setHeader("Content-Type", "application/json;charset=utf8");
        try {
            // 执行请求
            response = httpClient.execute(httpPost);
            // 处理响应结果
            if (response.getStatusLine().getStatusCode() != 200) {
                log.error("http postWithParam error. response:{}", JSON.toJSONString(response));
                return;
            }

            String resultString = EntityUtils.toString(response.getEntity(), "UTF-8");
            log.info("http postWithParam result:{}", JSON.toJSONString(resultString));
        } catch (Exception e) {
            log.error("http postWithParam error", e);
        } finally {
            // 关闭连接
            try {
                if (response != null) {
                    response.close();
                }
                httpClient.close();
            } catch (Exception e) {
                log.error("http postWithParam error", e);
            }
        }
    }

    @Data
    public static class PostWithParamDto {
        private String param;
        private String param2;
    }

5 参考文献

(1)HttpClient详细使用示例

相关推荐
Arva .7 小时前
HTTP Client
网络协议·http·lua
2501_9151063221 小时前
CDN 可以实现 HTTPS 吗?实战要点、部署模式与真机验证流程
网络协议·http·ios·小程序·https·uni-app·iphone
千里马-horse1 天前
HTTP、WebSocket、XMPP、CoAP、MQTT、DDS 六大协议在机器人通讯场景应用
mqtt·websocket·http·机器人·xmpp·coap·fastdds
安卓开发者1 天前
鸿蒙NEXT网络通信实战:使用HTTP协议进行网络请求
网络·http·harmonyos
苜蓿草茸茸2 天前
HTTP 协议详解
网络协议·http
Apifox.2 天前
Apifox 9 月更新| AI 生成接口测试用例、在线文档调试能力全面升级、内置更多 HTTP 状态码、支持将目录转换为模块
前端·人工智能·后端·http·ai·测试用例·postman
飞天巨兽2 天前
HTTP基础教程详解
前端·网络·网络协议·http
安卓开发者2 天前
鸿蒙NEXT网络通信进阶:全方位优化HTTP传输性能
http·华为·harmonyos
qq762118222 天前
Http 上传压缩包需要加0\r\n\r\n
http
半桔2 天前
【网络编程】揭秘 HTTPS 数据安全:加密方案与证书体系的协同防护
linux·网络·网络协议·http·https