HttpClient完整使用示例-CSDN博客

本文链接：https://blog.csdn.net/weixin_44516305/article/details/88380119

本文详细介绍了如何使用Apache HttpClient发送HTTP GET和POST请求，包括HttpClient的版本、创建项目、设置请求参数、处理响应等步骤。通过示例代码展示了HttpClientUtil和HttpResult工具类的使用，同时讲解了CookieStore在处理Cookie中的作用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

HttpClient完整使用示例

1 前言
2 示例说明
3 创建HttpClient客户端工程
- 3.1 版本说明
- 3.2 创建项目
4 创建HttpClientService服务端工程
- 4.1 版本说明
- 4.2 创建项目
5 测试
6 总结

1 前言

HTTP 协议可能是现在 Internet 上使用得最多、最重要的协议了，越来越多的 Java 应用程序需要直接通过 HTTP 协议来访问网络资源。虽然JDK 的 java net包中已经提供了访问 HTTP 协议的基本功能，但是对于大部分应用程序来说，JDK 库本身提供的功能还不够丰富和灵活。HttpClient用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议的最新版本。

Jakarta Commons HttpClient项目已经终止维护了，取而代之的是Apache HttpComponents项目中的HttpClient模块，后者比前者效率更高且更加灵活，本文也是基于Apache HttpComponents项目中的HttpClient。

使用HttpClient发送请求和接收响应一般分为以下几步：

创建HttpClient对象。
创建某种请求方法对象，并按需指定请求信息（包括：URL、请求参数、Header、Cookie等信息）。例如：发送Get请求则创建HttpGet对象，发送Post请求则创建HttpPost对象。
调用HttpClient对象的execute方法来执行第2步中创建的请求方法对象，并得到HttpResponse响应对象。
通过HttpResponse响应对象按需读取返回结果（包括：返回数据、Header、Cookiet等信息）。
释放连接（无论执行方法是否成功，都必须释放连接）。

2 示例说明

本文主要介绍HttpClient的完整使用示例，所以创建了两个Spring Boot工程：

HttpClientService工程：作为服务端工程，主要是为了提供Restful风格的API接口，供客户端调用。
HttpClient工程：作为客户端工程，主要是使用HttpClient类库访问HttpClientService服务端工程中的接口，演示了使用HttpGet和HttpPost发送请求、获取结果等完整流程。

本文最重要的是HttpClient工程中的以下两个封装的工具类：

HttpClientUtil：主要是封装了使用HttpClient发送Get请求和发送Post请求的方法。
HttpResult：主要是封装了Get请求和Post请求的返回结果。

注意：如果读者关心的是HttpClient的完整使用示例，则可以通读全文，如果只关心HttpClient的封装，则只需要关注上述两个封装的工具类即可。

3 创建HttpClient客户端工程

3.1 版本说明

Spring Boot: 2.1.13
HttpClient: 4.5.6
JDK: 1.8
IDE: IDEA

3.2 创建项目

创建一个名为HttpClient的Spring Boot项目，并添加maven依赖和相应的Java代码，最后的项目结构如下图所示：
在这里插入图片描述
pom.xml文件内容如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.http.client</groupId>
    <artifactId>http-client</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>HttpClient</name>
    <description>HttpClient使用示例</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

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

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

User类程序如下所示：

package com.http.client.model;

/**
 * 用户信息实体
 */
public class User {
   
    private String id;
    private String name;
    private String sex;

    public String getId() {
   
        return id;
    }

    public void setId(String id) {
   
        this.id = id;
    }

    public String getName() {
   
        return name;
    }

    public void setName(String name) {
   
        this.name = name;
    }

    public String getSex() {
   
        return sex;
    }

    public void setSex(String sex) {
   
        this.sex = sex;
    }
}

HttpResult类程序如下所示：

package com.http.client.model;

import org.apache.http.Header;
import org.apache.http.cookie.Cookie;

import java.util.List;

/**
 * Http请求的响应结果封装类
 */
public class HttpResult {
   

    /**
     * 响应的Header信息
     */
    private Header[] headers;

    /**
     * 响应的Cookie信息
     */
    private List<Cookie> cookies;

    /**
     * 响应状态码
     */
    private int statusCode;

    /**
     * 响应内容的类型
     */
    private String contentType;

    /**
     * 响应的内容是否是文本类型
     */
    private boolean isTextType;

    /**
     * 响应的内容（字符串形式）
     */
    private String stringContent;

    /**
     * 响应的内容（字节数组形式）
     */
    private byte[] byteArrayContent;

    public Header[] getHeaders() {
   
        return headers;
    }

    public void setHeaders(Header[] headers) {
   
        this.headers = headers;
    }

    public List<Cookie> getCookies() {
   
        return cookies;
    }

    public void setCookies(List<Cookie> cookies) {
   
        this.cookies = cookies;
    }

    public int getStatusCode() {
   
        return statusCode;
    }

    public void setStatusCode(int statusCode) {
   
        this.statusCode = statusCode;
    }

    public String getContentType() {
   
        return contentType;
    }

    public void setContentType(String contentType) {
   
        this.contentType = contentType;
    }

    public boolean isTextType() {
   
        return isTextType;
    }

    public void setTextType(boolean textType) {
   
        isTextType = textType;
    }

    public String getStringContent() {
   
        return stringContent;
    }

    public void setStringContent(String stringContent) {
   
        this.stringContent = stringContent;
    }

    public byte[] getByteArrayContent() {
   
        return byteArrayContent;
    }

    public void setByteArrayContent(byte[] byteArrayContent) {
   
        this.byteArrayContent = byteArrayContent;
    }
}

HttpClientUtil类程序如下所示：

package com.http.client.util;

import com.http.client.model.HttpResult;
import org.apache.http.Consts;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.StatusLine;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpResponseException;
import org.apache.http.client.ResponseHandler;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.entity.UrlEncodedFormEntity;
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.config.ConnectionConfig;
import org.apache.http.config.SocketConfig;
import org.apache.http.cookie.Cookie;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.BasicCookieStore;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache