Java 网络请求工具类（HttpUtils/HttpClientUtils）

引言

在现代应用程序开发中，网络请求是必不可少的功能之一。无论是访问第三方API、微服务之间的通信，还是请求远程数据，都需要通过HTTP协议实现。在Java中，java.net.HttpURLConnection、Apache的HttpClient库以及OkHttp等库提供了丰富的HTTP请求功能，但这些API有时需要较多的样板代码，因此封装一个通用的网络请求工具类（如HttpUtils或HttpClientUtils）可以简化开发流程，提高效率。

HttpClientUtils 工具类设计

HttpClientUtils 是一个封装了常用HTTP请求操作的工具类，基于 Apache HttpClient 实现。这个工具类支持 GET、POST、PUT、DELETE 等常见请求方法，并提供了请求头设置、参数传递、响应处理、超时设置等功能。

以下是 HttpClientUtils 工具类的主要功能：

1. 发送 GET 请求：用于从服务器获取资源。
2. 发送 POST 请求：用于向服务器提交数据。
3. 发送 PUT 请求：用于更新服务器上的资源。
4. 发送 DELETE 请求：用于删除服务器上的资源。
5. 设置请求头：支持自定义请求头，如Content-Type、Authorization等。
6. 超时设置：支持连接超时和读取超时的设置。
7. SSL 证书支持：支持HTTPS请求，提供信任所有证书的功能。

以下是 HttpClientUtils 工具类的实现：

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.*;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;
import java.util.Map;

public class HttpClientUtils {

    // 默认超时时间
    private static final int TIMEOUT = 5000;

    // 创建默认的 HttpClient
    private static CloseableHttpClient createHttpClient() {
        RequestConfig config = RequestConfig.custom()
                .setConnectTimeout(TIMEOUT)
                .setConnectionRequestTimeout(TIMEOUT)
                .setSocketTimeout(TIMEOUT)
                .build();
        return HttpClients.custom()
                .setDefaultRequestConfig(config)
                .build();
    }

    // 发送 GET 请求
    public static String sendGet(String url, Map<String, String> headers) throws IOException {
        HttpGet httpGet = new HttpGet(url);
        if (headers != null) {
            headers.forEach(httpGet::addHeader);
        }

        try (CloseableHttpClient httpClient = createHttpClient();
             CloseableHttpResponse response = httpClient.execute(httpGet)) {

            return handleResponse(response);
        }
    }

    // 发送 POST 请求
    public static String sendPost(String url, String body, Map<String, String> headers) throws IOException {
        HttpPost httpPost = new HttpPost(url);
        if (headers != null) {
            headers.forEach(httpPost::addHeader);
        }
        if (body != null) {
            HttpEntity entity = new StringEntity(body, ContentType.APPLICATION_JSON);
            httpPost.setEntity(entity);
        }

        try (CloseableHttpClient httpClient = createHttpClient();
             CloseableHttpResponse response = httpClient.execute(httpPost)) {

            return handleResponse(response);
        }
    }

    // 发送 PUT 请求
    public static String sendPut(String url, String body, Map<String, String> headers) throws IOException {
        HttpPut httpPut = new HttpPut(url);
        if (headers != null) {
            headers.forEach(httpPut::addHeader);
        }
        if (body != null) {
            HttpEntity entity = new StringEntity(body, ContentType.APPLICATION_JSON);
            httpPut.setEntity(entity);
        }

        try (CloseableHttpClient httpClient = createHttpClient();
             CloseableHttpResponse response = httpClient.execute(httpPut)) {

            return handleResponse(response);
        }
    }

    // 发送 DELETE 请求
    public static String sendDelete(String url, Map<String, String> headers) throws IOException {
        HttpDelete httpDelete = new HttpDelete(url);
        if (headers != null) {
            headers.forEach(httpDelete::addHeader);
        }

        try (CloseableHttpClient httpClient = createHttpClient();
             CloseableHttpResponse response = httpClient.execute(httpDelete)) {

            return handleResponse(response);
        }
    }

    // 处理响应
    private static String handleResponse(HttpResponse response) throws IOException {
        int statusCode = response.getStatusLine().getStatusCode();
        if (statusCode >= 200 && statusCode < 300) {
            HttpEntity entity = response.getEntity();
            return entity != null ? EntityUtils.toString(entity) : null;
        } else {
            throw new ClientProtocolException("Unexpected response status: " + statusCode);
        }
    }
}

方法详解

1. 创建 HttpClient：

   • createHttpClient(): 创建一个带有默认请求配置（超时设置）的 HttpClient 实例。超时时间可以自定义调整。

2. 发送 GET 请求：

   • sendGet(String url, Map<String, String> headers): 发送一个 GET 请求，并可选地设置请求头。通过 HttpGet 对象发起请求并处理响应。

3. 发送 POST 请求：

   • sendPost(String url, String body, Map<String, String> headers): 发送一个 POST 请求，将请求体作为 JSON 字符串发送，同时支持设置请求头。

4. 发送 PUT 请求：

   • sendPut(String url, String body, Map<String, String> headers): 发送一个 PUT 请求，功能类似于 POST 请求，用于更新资源。

5. 发送 DELETE 请求：

   • sendDelete(String url, Map<String, String> headers): 发送一个 DELETE 请求，用于删除资源。

6. 处理响应：

   • handleResponse(HttpResponse response): 处理服务器返回的响应。如果状态码在 200-299 之间，返回响应体内容；否则抛出异常。

实际应用示例

public class HttpClientUtilsExample {
    public static void main(String[] args) {
        try {
            // 发送 GET 请求
            String response = HttpClientUtils.sendGet("https://jsonplaceholder.typicode.com/posts/1", null);
            System.out.println("GET Response: " + response);

            // 发送 POST 请求
            String postBody = "{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}";
            response = HttpClientUtils.sendPost("https://jsonplaceholder.typicode.com/posts", postBody, null);
            System.out.println("POST Response: " + response);

            // 发送 PUT 请求
            String putBody = "{\"id\": 1, \"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}";
            response = HttpClientUtils.sendPut("https://jsonplaceholder.typicode.com/posts/1", putBody, null);
            System.out.println("PUT Response: " + response);

            // 发送 DELETE 请求
            response = HttpClientUtils.sendDelete("https://jsonplaceholder.typicode.com/posts/1", null);
            System.out.println("DELETE Response: " + response);

        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

HttpClientUtils 的优势

1. 简化代码：通过封装常用的 HTTP 请求操作，减少了样板代码，开发者无需处理底层细节。
2. 灵活性：支持自定义请求头、请求体和超时设置，适应多种场景需求。
3. 易于扩展：可以轻松添加更多的请求方法（如 PATCH）或支持更多的功能（如多部分表单提交）。
4. 支持 HTTPS：可以轻松扩展以支持 HTTPS 请求，并实现信任所有证书等功能。

扩展与改进

1. SSL 支持：扩展工具类以支持 HTTPS 请求，通过自定义 SSL 上下文来信任所有证书或使用特定证书。
2. 连接池管理：通过 HttpClient 的连接池管理，提高并发请求性能。
3. 异步请求：增加异步请求的支持，使用 Future 或 CompletableFuture 提供非阻塞的 HTTP 请求能力。
4. 错误处理：增强错误处理机制，根据不同的状态码返回详细的错误信息或执行不同的逻辑。

结论

HttpClientUtils 工具类通过封装 Apache HttpClient 的常用功能，提供了简洁易用的 HTTP 请求接口，显著简化了 Java 应用中的网络请求操作。通过支持常见的 HTTP 方法、自定义请求头和请求体、超时设置等功能，HttpClientUtils 能够满足大多数应用场景的需求。在实际开发中，工具类的使用不仅提高了开发效率，还提升了代码的可读性和可维护性。随着需求的变化，HttpClientUtils 还可以不断扩展，以应对更多复杂的网络请求场景。

总结

  Java网络请求工具类（HttpUtils/HttpClientUtils）是用来简化与服务器进行网络请求的过程。它是基于HttpClient库开发的。

该工具类提供了一系列方法，可以方便地发送HTTP请求（GET、POST等）。它可以帮助我们完成以下操作：

1. 发送GET请求：通过传入URL和参数，发送GET请求并获取服务器返回的数据。

2. 发送POST请求：通过传入URL、参数和请求体，发送POST请求并获取服务器返回的数据。

3. 设置请求头：可以设置请求头，如User-Agent、Cookie等。

4. 设置连接超时和读取超时时间：可以设置连接超时和读取超时时间，防止请求过程中出现超时问题。

5. 处理响应结果：可以将服务器返回的响应结果解析为字符串、JSON对象等。

6. 处理异常：可以捕获网络请求过程中可能出现的异常，如连接超时、读取超时等。

使用HttpUtils/HttpClientUtils可以让我们在发送网络请求时代码更加简洁和易于维护。它封装了底层的网络请求逻辑，提供了一种使用简单的方式来进行网络请求操作。