Apache httpclient4.5 GET/POST/PUT/OPTION/DELETE工具类

位置:首页>文章>详情   分类: 教程分享 > Java教程   阅读(1702)   2023-03-28 11:29:14
Apache httpclient4.5 GET/POST/PUT/OPTION/DELETE工具类

该工具类使用比较新的
Apache httpclient4.5版本

支持GET请求、POST请求、DELETE请求、PATCH请求、PUT请求、DELETE请求、OPTIONS请求

工具类代码如下:

import org.apache.http.Header;
import org.apache.http.NameValuePair;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.*;
import org.apache.http.entity.StringEntity;
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 org.springframework.util.StringUtils;

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.nio.charset.Charset;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * 工具类 httpclient4.5
 *
 * @author xq
 */
public class HttpclientUtils {
    private final static Logger logger = LoggerFactory.getLogger(HttpclientUtilss.class);

    /**
     * post请求 json参数
     *
     * @param url
     * @param bodyJsonParams
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doPost(String url, String bodyJsonParams, Map<String, String> headers) throws IOException {
        HttpPost httpPost = new HttpPost(url);
        httpPost.addHeader("Content-Type", "application/json");
        httpPost.setEntity(new StringEntity(bodyJsonParams, Charset.forName("UTF-8")));

        addHeader(httpPost, headers);
        return execute(httpPost);
    }

    /**
     * post k-v参数
     *
     * @param url
     * @param params
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doPost(String url, Map<String, String> params, Map<String, String> headers)
            throws IOException {
        HttpPost httpPost = new HttpPost(url);
        if (params != null && params.keySet().isEmpty()) {
            httpPost.setEntity(getUrlEncodedFormEntity(params));
        }
        addHeader(httpPost, headers);
        return execute(httpPost);
    }

    /**
     * patch json参数
     *
     * @param url
     * @param bodyJsonParams
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doPatch(String url, String bodyJsonParams, Map<String, String> headers) throws IOException {
        HttpPatch httpPatch = new HttpPatch(url);
        httpPatch.setEntity(new StringEntity(bodyJsonParams));
        addHeader(httpPatch, headers);
        return execute(httpPatch);
    }

    /**
     * patch k-v参数
     *
     * @param url
     * @param params
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doPatch(String url, Map<String, String> params, Map<String, String> headers)
            throws IOException {
        HttpPatch httpPatch = new HttpPatch(url);
        if (params != null && !params.isEmpty()) {
            httpPatch.setEntity(getUrlEncodedFormEntity(params));
        }
        addHeader(httpPatch, headers);
        return execute(httpPatch);
    }


    /**
     * PUT JSON参数
     *
     * @param url
     * @param bodyJsonParams
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doPut(String url, String bodyJsonParams, Map<String, String> headers) throws IOException {
        HttpPut httpPut = new HttpPut(url);
        httpPut.addHeader("Content-Type", "application/json");
        httpPut.setEntity(new StringEntity(bodyJsonParams, Charset.forName("UTF-8")));

        addHeader(httpPut, headers);
        return execute(httpPut);
    }

    /**
     * put k-v参数
     *
     * @param url
     * @param params
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doPut(String url, Map<String, String> params, Map<String, String> headers)
            throws IOException {
        HttpPut httpPut = new HttpPut(url);
        if (params != null && params.keySet().isEmpty()) {
            httpPut.setEntity(getUrlEncodedFormEntity(params));
        }
        addHeader(httpPut, headers);
        return execute(httpPut);
    }

    /**
     * Delete json 参数
     *
     * @param url
     * @param bodyJsonParams
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doDeletedoPut(String url, String bodyJsonParams, Map<String, String> headers) throws IOException {
        HttpDeleteWithEntity httpDelete = new HttpDeleteWithEntity(url);
        httpDelete.setEntity(new StringEntity(bodyJsonParams));
        addHeader(httpDelete, headers);
        return execute(httpDelete);
    }

    /**
     * delete k-v参数
     *
     * @param url
     * @param params
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doDelete(String url, Map<String, String> params, Map<String, String> headers)
            throws IOException {
        HttpDeleteWithEntity httpDelete = new HttpDeleteWithEntity(url);
        addHeader(httpDelete, headers);
        if (params != null && !params.isEmpty()) {
            httpDelete.setEntity(getUrlEncodedFormEntity(params));
        }
        return execute(httpDelete);
    }

    /**
     * options json参数
     *
     * @param url
     * @param bodyJsonParams
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doOptions(String url, String bodyJsonParams, Map<String, String> headers) throws IOException {
        HttpOptionsWithEntity httpOptions = new HttpOptionsWithEntity(url);
        addHeader(httpOptions, headers);
        httpOptions.setEntity(new StringEntity(bodyJsonParams));
        return execute(httpOptions);
    }

    /**
     * options k-v参数
     *
     * @param url
     * @param params
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doOptions(String url, Map<String, String> params, Map<String, String> headers)
            throws IOException {
        HttpOptionsWithEntity httpOptions = new HttpOptionsWithEntity(url);
        addHeader(httpOptions, headers);
        if (params != null && !params.isEmpty()) {
            httpOptions.setEntity(getUrlEncodedFormEntity(params));
        }
        return execute(httpOptions);
    }

    /**
     * head请求
     *
     * @param url
     * @param headers
     * @return
     * @throws IOException
     */
    public static String doHeader(String url, Map<String, String> headers) throws IOException {
        HttpHead httpHead = new HttpHead(url);
        addHeader(httpHead, headers);
        return execute(httpHead);

    }

    /**
     * get请求
     *
     * @param url
     * @param params
     * @param headers
     * @return
     * @throws IOException
     * @throws ClientProtocolException
     */
    public static String doGet(String url, Map<String, String> params, Map<String, String> headers) throws IOException {
        // 参数
        StringBuilder paramsBuilder = new StringBuilder(url);

        if (params != null && params.keySet().isEmpty()) {
            if (url.indexOf("?") == -1) {
                paramsBuilder.append("?");
            }
            List<NameValuePair> list = new ArrayList<>();

            Set<String> keySet = headers.keySet();
            Iterator<String> iterator = keySet.iterator();
            while (iterator.hasNext()) {
                String key = iterator.next();
                String value = headers.get(key);
                list.add(new BasicNameValuePair(key, value));
            }
            String paramsStr = EntityUtils.toString(new UrlEncodedFormEntity(list));
            paramsBuilder.append(paramsStr);
        }
        HttpGet httpGet = new HttpGet(paramsBuilder.toString());
        // 头
        addHeader(httpGet, headers);
        return execute(httpGet);
    }


    /**
     * 执行请求并返回string值
     *
     * @param httpUriRequest
     * @return
     * @throws IOException
     */
    private static String execute(HttpUriRequest httpUriRequest) throws IOException {
        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            CloseableHttpResponse response = httpClient.execute(httpUriRequest);

//            if (response.getStatusLine().getStatusCode() == 200) {// 请求成功状态
//                try (BufferedReader bufferedReader = new BufferedReader(
//                        new InputStreamReader(response.getEntity().getContent()))) {
//                    StringBuilder sb = new StringBuilder();
//                    String tmp;
//                    while ((tmp = bufferedReader.readLine()) != null) {
//                        sb.append(tmp);
//                    }
//                    return sb.toString();
//                }
//            }
            Header type = response.getEntity().getContentType();
            logger.debug("Type:" + type.getValue());
            String defaultCharset = "UTF-8";
            String charset = getCharSet(type.getValue());
            if (!StringUtils.isEmpty(charset)) {
                defaultCharset = charset;
            }
            return EntityUtils.toString(response.getEntity(), defaultCharset);
        }
//        return null;
    }

    /**
     * 添加请求头部
     *
     * @param httpUriRequest
     * @param headers
     */
    private static void addHeader(HttpUriRequest httpUriRequest, Map<String, String> headers) {
        if (httpUriRequest != null) {
            if (headers != null && !headers.keySet().isEmpty()) {
                Set<String> keySet = headers.keySet();
                Iterator<String> iterator = keySet.iterator();
                while (iterator.hasNext()) {
                    String key = iterator.next();
                    String value = headers.get(key);
                    httpUriRequest.addHeader(key, value);
                }
            }
        }
    }

    /**
     * 获取 UrlEncodedFormEntity 参数实体
     *
     * @param params
     * @return
     * @throws UnsupportedEncodingException
     */
    private static UrlEncodedFormEntity getUrlEncodedFormEntity(Map<String, String> params) throws UnsupportedEncodingException {
        if (params != null && params.keySet().isEmpty()) {
            List<NameValuePair> list = new ArrayList<>();

            Set<String> keySet = params.keySet();
            Iterator<String> iterator = keySet.iterator();
            while (iterator.hasNext()) {
                String key = iterator.next();
                String value = params.get(key);
                list.add(new BasicNameValuePair(key, value));
            }
            return new UrlEncodedFormEntity(list);
        }
        return null;
    }

    /**
     * 根据HTTP 响应头部的content type抓取响应的字符集编码
     *
     * @param content
     * @return
     */
    private static String getCharSet(String content) {
        String regex = ".*charset=([^;]*).*";
        Pattern pattern = Pattern.compile(regex);
        Matcher matcher = pattern.matcher(content);
        if (matcher.find())
            return matcher.group(1);
        else
            return null;
    }


    /**
     * 解决httpclient 的DELETE默认不支持setEntity
     */
    static class HttpDeleteWithEntity extends HttpEntityEnclosingRequestBase {
        public static final String METHOD_NAME = "DELETE";

        @Override
        public String getMethod() {
            return METHOD_NAME;
        }

        public HttpDeleteWithEntity(final String uri) {
            super();
            setURI(URI.create(uri));
        }

        public HttpDeleteWithEntity(final URI uri) {
            super();
            setURI(uri);
        }

        public HttpDeleteWithEntity() {
            super();
        }
    }

    /**
     * 解决httpclient 的OPTIONS默认不支持setEntity
     */
    static class HttpOptionsWithEntity extends HttpEntityEnclosingRequestBase {
        public static final String METHOD_NAME = "OPTIONS";

        @Override
        public String getMethod() {
            return METHOD_NAME;
        }

        public HttpOptionsWithEntity() {
            super();
        }

        public HttpOptionsWithEntity(final String uri) {
            super();
            setURI(URI.create(uri));
        }

        public HttpOptionsWithEntity(final URI uri) {
            super();
            setURI(uri);
        }
    }

    public static void main(String[] args) {

    }


}
 
标签: httpclient java
地址:https://www.leftso.com/article/424.html

相关阅读

HttpClient的RestTemplate - Java配置示例
Apache HttpClient 4.x 使用详解
httpclient4.5使用详解 httpclient 4.5 post传递json参数
在本教程中 - 我们将使用HttpClient 4进行POST - 首先使用授权,然后使用流畅的HttpClient API。最后 - 我们将讨论如何使用HttpClient上传文件。
HttpClient Basic Authentication基本认证,本教程将说明如何在Apache HttpClient 4上配置基本身份验证。
本文将展示如何使用“接受所有”SSL支持来配置Apache HttpClient 4。目标很简单 - 使用没有有效证书的HTTPS URL。
HttpClient 4 按照POST重定向请求,本快速教程将展示如何配置Apache HttpClient 4以自动遵循POST请求的重定向。
Apache httpclient4.5 GET/POST/PUT/OPTION/DELETE工具类
1.概述本教程将重点介绍如何使用Apache HttpClient 4发送自定义Cookie
java编程中采用Apache common.httpclient方式模拟POST请求