最近在使用Apache的httpclient的时候,maven引用了最新版本4.3,发现eclipse提示DefaultHttpClient等常用的类已经不推荐使用了,之前在使用4.2.3版本的时候,还没有被deprecated。去看了下官方文档,确实不推荐使用了,点击此处详情。
<!-- HttpClient --> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.3</version> </dependency>
Http协议的重要性相信不用我多说了,HttpClient相比传统JDK自带的URLConnection,增加了易用性和灵活性(具体区别,日后我们再讨论),它不仅是客户端发送Http请求变得容易,而且也方便了开发人员测试接口(基于Http协议的),即提高了开发的效率,也方便提高代码的健壮性。因此熟练掌握HttpClient是很重要的必修内容,掌握HttpClient后,相信对于Http协议的了解会更加深入。
HttpClient是Apache Jakarta Common下的子项目,用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包,并且它支持HTTP协议最新的版本和建议。HttpClient已经应用在很多的项目中,比如Apache Jakarta上很著名的另外两个开源项目Cactus和HTMLUnit都使用了HttpClient。
下载地址: http://hc.apache.org/downloads.cgi
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 可免费获取。
使用HttpClient发送请求、接收响应很简单,一般需要如下几步即可。
1. 创建HttpClient对象。
2. 创建请求方法的实例,并指定请求URL。如果需要发送GET请求,创建HttpGet对象;如果需要发送POST请求,创建HttpPost对象。
3. 如果需要发送请求参数,可调用HttpGet、HttpPost共同的setParams(HetpParams params)方法来添加请求参数;对于HttpPost对象而言,也可调用setEntity(HttpEntity entity)方法来设置请求参数。
4. 调用HttpClient对象的execute(HttpUriRequest request)发送请求,该方法返回一个HttpResponse。
5. 调用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可获取服务器的响应头;调用HttpResponse的getEntity()方法可获取HttpEntity对象,该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
6. 释放连接。无论执行方法是否成功,都必须释放连接
package com.somnus.http; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import java.nio.charset.Charset; import java.util.ArrayList; import java.util.List; import java.util.Map; import net.sf.json.JSONObject; import org.apache.http.HttpEntity; import org.apache.http.HttpStatus; import org.apache.http.NameValuePair; import org.apache.http.client.ClientProtocolException; 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; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class HttpUtils { private transient static Logger log = LoggerFactory.getLogger(HttpUtils.class); public static String doGet(String url, Map<String,String> param){ //创建HttpClient对象 CloseableHttpClient httpclient = HttpClients.createDefault(); String resultString = ""; CloseableHttpResponse httpResponse = null; try { //创建uri URIBuilder builder = new URIBuilder(url); if(param!=null && !param.isEmpty()){ for(String key :param.keySet()){ builder.addParameter(key, param.get(key)); } } URI uri = builder.build(); // 创建httpGet请求 HttpGet httpGet = new HttpGet(uri); // 开始执行http请求 long startTime = System.currentTimeMillis(); httpResponse = httpclient.execute(httpGet); long endTime = System.currentTimeMillis(); // 获得响应状态码 int statusCode = httpResponse.getStatusLine().getStatusCode(); log.info("statusCode:" + statusCode); log.info("调用API花费时间(单位:毫秒):" + (endTime - startTime)); // 取出应答字符串 HttpEntity httpEntity = httpResponse.getEntity(); resultString = EntityUtils.toString(httpEntity,Charset.forName("UTF-8")); // 去掉返回结果中的"\r"字符,否则会在结果字符串后面显示一个小方格 resultString.replaceAll("\r", ""); // 判断返回状态是否为200 if (statusCode != HttpStatus.SC_OK) { throw new RuntimeException(String.format("\n\tStatus:%s\n\tError Message:%s", statusCode,resultString)); } } catch (ClientProtocolException e) { log.error(e.getMessage(), e); } catch (IOException e) { log.error(e.getMessage(), e); } catch (URISyntaxException e) { log.error(e.getMessage(), e); } finally{ try { if(httpResponse != null){ httpResponse.close(); } httpclient.close(); } catch (IOException e) { log.error(e.getMessage(), e); } } return resultString; } public static String doGet(String url){ return doGet(url,null); } public static String doPost(String url, Map<String,String> param){ //创建HttpClient对象 CloseableHttpClient httpclient = HttpClients.createDefault(); String resultString = ""; CloseableHttpResponse httpResponse = null; try { // 创建HttpPost对象 HttpPost httpPost = new HttpPost(url); if(param!=null && !param.isEmpty()){ List<NameValuePair> params = new ArrayList<NameValuePair>(); for(String key :param.keySet()){ params.add(new BasicNameValuePair(key, param.get(key))); } httpPost.setEntity(new UrlEncodedFormEntity(params, Charset.forName("UTF-8"))); } // 开始执行http请求 long startTime = System.currentTimeMillis(); httpResponse = httpclient.execute(httpPost); long endTime = System.currentTimeMillis(); // 获得响应状态码 int statusCode = httpResponse.getStatusLine().getStatusCode(); log.info("statusCode:" + statusCode); log.info("调用API花费时间(单位:毫秒):" + (endTime - startTime)); // 取出应答字符串 HttpEntity httpEntity = httpResponse.getEntity(); resultString = EntityUtils.toString(httpEntity,Charset.forName("UTF-8")); // 判断返回状态是否为200 if (statusCode != HttpStatus.SC_OK) { throw new RuntimeException(String.format("\n\tStatus:%s\n\tError Message:%s", statusCode,resultString)); } } catch (ClientProtocolException e) { log.error(e.getMessage(), e); } catch (IOException e) { log.error(e.getMessage(), e); } finally{ try { if(httpResponse != null){ httpResponse.close(); } httpclient.close(); } catch (IOException e) { log.error(e.getMessage(), e); } } return resultString; } public static String doJsonPost(String url, Map<String,String> param){ String resultString = ""; if(param!=null && !param.isEmpty()){ JSONObject jsonObject = new JSONObject(); for(String key :param.keySet()){ jsonObject.put(key, param.get(key)); } String json = jsonObject.toString(); resultString = doJsonPost(url,json); } else{ resultString = doJsonPost(url,""); } return resultString; } public static String doJsonPost(String url, String json){ //创建HttpClient对象 CloseableHttpClient httpclient = HttpClients.createDefault(); String resultString = ""; CloseableHttpResponse httpResponse = null; try { // 创建HttpPost对象 HttpPost httpPost = new HttpPost(url); httpPost.setEntity(new StringEntity(json,ContentType.APPLICATION_JSON)); // 开始执行http请求 long startTime = System.currentTimeMillis(); httpResponse = httpclient.execute(httpPost); long endTime = System.currentTimeMillis(); // 获得响应状态码 int statusCode = httpResponse.getStatusLine().getStatusCode(); log.info("statusCode:" + statusCode); log.info("调用API 花费时间(单位:毫秒):" + (endTime - startTime)); // 取出应答字符串 HttpEntity httpEntity = httpResponse.getEntity(); resultString = EntityUtils.toString(httpEntity,Charset.forName("UTF-8")); // 判断返回状态是否为200 if (statusCode != HttpStatus.SC_OK) { throw new RuntimeException(String.format("\n\tStatus:%s\n\tError Message:%s", statusCode,resultString)); } } catch (ClientProtocolException e) { log.error(e.getMessage(), e); } catch (IOException e) { log.error(e.getMessage(), e); } finally{ try { if(httpResponse != null){ httpResponse.close(); } httpclient.close(); } catch (IOException e) { log.error(e.getMessage(), e); } } return resultString; } }