HttpClient介绍与使用

个人博客：打开链接

1 简介

HttpClient是Apache Jakarta Common下的子项目，用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包，并且它支持HTTP协议最新的版本和建议。HttpClient已经应用在很多的项目中，比如Apache Jakarta上很著名的另外两个开源项目Cactus和HTMLUnit都使用了HttpClient。

下载地址: http://hc.apache.org/downloads.cgi

2 特性

1. 基于标准、纯净的java语言。实现了Http1.0和Http1.1
2. 以可扩展的面向对象的结构实现了Http全部的方法（GET, POST, PUT, DELETE, HEAD, OPTIONS, and TRACE）。
3. 支持HTTPS协议。
4. 通过Http代理建立透明的连接。
5. 利用CONNECT方法通过Http代理建立隧道的https连接。
6. Basic, Digest, NTLMv1, NTLMv2, NTLM2 Session, SNPNEGO/Kerberos认证方案。
7. 插件式的自定义认证方案。
8. 便携可靠的套接字工厂使它更容易的使用第三方解决方案。
9. 连接管理器支持多线程应用。支持设置最大连接数，同时支持设置每个主机的最大连接数，发现并关闭过期的连接。
10. 自动处理Set-Cookie中的Cookie。
11. 插件式的自定义Cookie策略。
12. Request的输出流可以避免流中内容直接缓冲到socket服务器。
13. Response的输入流可以有效的从socket服务器直接读取相应内容。
14. 在http1.0和http1.1中利用KeepAlive保持持久连接。
15. 直接获取服务器发送的response code和 headers。
16. 设置连接超时的能力。
17. 实验性的支持http1.1 response caching。
18. 源代码基于Apache License 可免费获取。

3 使用步骤

第一步：把HttpClient使用的jar包添加到工程中。
第二步：创建一个HttpClient的测试类
第三步：创建测试方法。
第四步：创建一个HttpClient对象
第五步：创建一个HttpGet对象，需要制定一个请求的url
第六步：执行请求。
第七步：接收返回结果。HttpEntity对象。
第八步：取响应的内容。
第九步：关闭HttpGet、HttpClient。

4 get请求

@Test
    public void testHttpGet() throws Exception {
        // 第一步：把HttpClient使用的jar包添加到工程中。
        // 第二步：创建一个HttpClient的测试类
        // 第三步：创建测试方法。
        // 第四步：创建一个HttpClient对象
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 第五步：创建一个HttpGet对象，需要制定一个请求的url
        HttpGet get = new HttpGet("http://www.jinglisen.com");
        // 第六步：执行请求。
        CloseableHttpResponse response = httpClient.execute(get);
        // 第七步：接收返回结果。HttpEntity对象。
        HttpEntity entity = response.getEntity();
        // 第八步：取响应的内容。
        String html = EntityUtils.toString(entity);
        System.out.println(html);
        // 第九步：关闭response、HttpClient。
        response.close();
        httpClient.close();
    }

5 Post请求

实现步骤：
第一步：创建一个httpClient对象
第二步：创建一个HttpPost对象。需要指定一个url
第三步：创建一个list模拟表单，list中每个元素是一个NameValuePair对象
第四步：需要把表单包装到Entity对象中。StringEntity
第五步：执行请求。
第六步：接收返回结果
第七步：关闭流。

@Test
    public void testHttpPost() throws Exception {

        // 第一步：创建一个httpClient对象
        CloseableHttpClient httpClient = HttpClients.createDefault();
        // 第二步：创建一个HttpPost对象。需要指定一个url
        HttpPost post = new HttpPost("http://localhost:8082/posttest.html");
        // 第三步：创建一个list模拟表单，list中每个元素是一个NameValuePair对象
        List formList = new ArrayList<>();
        formList.add(new BasicNameValuePair("name", "张三"));
        formList.add(new BasicNameValuePair("pass", "1243"));
        // 第四步：需要把表单包装到Entity对象中。StringEntity
        StringEntity entity = new UrlEncodedFormEntity(formList, "utf-8");
        post.setEntity(entity);
        // 第五步：执行请求。
        CloseableHttpResponse response = httpClient.execute(post);
        // 第六步：接收返回结果
        HttpEntity httpEntity = response.getEntity();
        String result = EntityUtils.toString(httpEntity);
        System.out.println(result);
        // 第七步：关闭流。
        response.close();
        httpClient.close();
    }

提交表单和提交json数据，content-Type不同
表单的content-type：application/x-www-form-urlencoded
Json的content-type：application/json

6 HttpClientUtil 工具类

实际使用时需要把HttpClient封装成一个工具类。

import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
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.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;

public class HttpClientUtil {

    public static String doGet(String url, Map param) {

        // 创建Httpclient对象
        CloseableHttpClient httpclient = HttpClients.createDefault();

        String resultString = "";
        CloseableHttpResponse response = null;
        try {
            // 创建uri
            URIBuilder builder = new URIBuilder(url);
            if (param != null) {
                for (String key : param.keySet()) {
                    builder.addParameter(key, param.get(key));
                }
            }
            URI uri = builder.build();

            // 创建http GET请求
            HttpGet httpGet = new HttpGet(uri);

            // 执行请求
            response = httpclient.execute(httpGet);
            // 判断返回状态是否为200
            if (response.getStatusLine().getStatusCode() == 200) {
                resultString = EntityUtils.toString(response.getEntity(), "UTF-8");
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (response != null) {
                    response.close();
                }
                httpclient.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return resultString;
    }

    public static String doGet(String url) {
        return doGet(url, null);
    }

    public static String doPost(String url, Map param) {
        // 创建Httpclient对象
        CloseableHttpClient httpClient = HttpClients.createDefault();
        CloseableHttpResponse response = null;
        String resultString = "";
        try {
            // 创建Http Post请求
            HttpPost httpPost = new HttpPost(url);
            // 创建参数列表
            if (param != null) {
                List paramList = new ArrayList<>();
                for (String key : param.keySet()) {
                    paramList.add(new BasicNameValuePair(key, param.get(key)));
                }
                // 模拟表单
                UrlEncodedFormEntity entity = new UrlEncodedFormEntity(paramList);
                httpPost.setEntity(entity);
            }
            // 执行http请求
            response = httpClient.execute(httpPost);
            resultString = EntityUtils.toString(response.getEntity(), "utf-8");
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                response.close();
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }

        return resultString;
    }

    public static String doPost(String url) {
        return doPost(url, null);
    }

    public static String doPostJson(String url, String json) {
        // 创建Httpclient对象
        CloseableHttpClient httpClient = HttpClients.createDefault();
        CloseableHttpResponse response = null;
        String resultString = "";
        try {
            // 创建Http Post请求
            HttpPost httpPost = new HttpPost(url);
            // 创建请求内容
            StringEntity entity = new StringEntity(json, ContentType.APPLICATION_JSON);
            httpPost.setEntity(entity);
            // 执行http请求
            response = httpClient.execute(httpPost);
            resultString = EntityUtils.toString(response.getEntity(), "utf-8");
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                response.close();
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }

        return resultString;
    }
}