谈谈HttpClient使用详解
HttpClient是一个客户端的HTTP通信实现库。HttpClient的目标是发送和接收HTTP报文。
Http协议的重要性相信不用我多说了,HttpClient相比传统JDK自带的URLConnection,增加了易用性和灵活性(具体区别,日后我们再讨论),它不仅是客户端发送Http请求变得容易,而且也方便了开发人员测试接口(基于Http协议的),即提高了开发的效率,也方便提高代码的健壮性。因此熟练掌握HttpClient是很重要的必修内容,掌握HttpClient后,相信对于Http协议的了解会更加深入。
一、简介
HttpClient是ApacheJakartaCommon下的子项目,用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包,并且它支持HTTP协议最新的版本和建议。HttpClient已经应用在很多的项目中,比如ApacheJakarta上很著名的另外两个开源项目Cactus和HTMLUnit都使用了HttpClient。
下载地址:http://hc.apache.org/downloads.cgi
二、特性
1.基于标准、纯净的java语言。实现了Http1.0和Http1.1
2.以可扩展的面向对象的结构实现了Http全部的方法(GET,POST,PUT,DELETE,HEAD,OPTIONS,andTRACE)。
3.支持HTTPS协议。
4.通过Http代理建立透明的连接。
5.利用CONNECT方法通过Http代理建立隧道的https连接。
6.Basic,Digest,NTLMv1,NTLMv2,NTLM2Session,SNPNEGO/Kerberos认证方案。
7.插件式的自定义认证方案。
8.便携可靠的套接字工厂使它更容易的使用第三方解决方案。
9.连接管理器支持多线程应用。支持设置最大连接数,同时支持设置每个主机的最大连接数,发现并关闭过期的连接。
10.自动处理Set-Cookie中的Cookie。
11.插件式的自定义Cookie策略。
12.Request的输出流可以避免流中内容直接缓冲到socket服务器。
13.Response的输入流可以有效的从socket服务器直接读取相应内容。
14.在http1.0和http1.1中利用KeepAlive保持持久连接。
15.直接获取服务器发送的responsecode和headers。
16.设置连接超时的能力。
17.实验性的支持http1.1responsecaching。
18.源代码基于ApacheLicense可免费获取。
三、使用方法
使用HttpClient发送请求、接收响应很简单,一般需要如下几步即可。
1.创建HttpClient对象。
2.创建请求方法的实例,并指定请求URL。如果需要发送GET请求,创建HttpGet对象;如果需要发送POST请求,创建HttpPost对象。
3.如果需要发送请求参数,可调用HttpGet、HttpPost共同的setParams(HetpParamsparams)方法来添加请求参数;对于HttpPost对象而言,也可调用setEntity(HttpEntityentity)方法来设置请求参数。
4.调用HttpClient对象的execute(HttpUriRequestrequest)发送请求,该方法返回一个HttpResponse。
5.调用HttpResponse的getAllHeaders()、getHeaders(Stringname)等方法可获取服务器的响应头;调用HttpResponse的getEntity()方法可获取HttpEntity对象,该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
6.释放连接。无论执行方法是否成功,都必须释放连接
四、实例
packagecom.test;
importjava.io.File;
importjava.io.FileInputStream;
importjava.io.IOException;
importjava.io.UnsupportedEncodingException;
importjava.security.KeyManagementException;
importjava.security.KeyStore;
importjava.security.KeyStoreException;
importjava.security.NoSuchAlgorithmException;
importjava.security.cert.CertificateException;
importjava.util.ArrayList;
importjava.util.List;
importjavax.net.ssl.SSLContext;
importorg.apache.http.HttpEntity;
importorg.apache.http.NameValuePair;
importorg.apache.http.ParseException;
importorg.apache.http.client.ClientProtocolException;
importorg.apache.http.client.entity.UrlEncodedFormEntity;
importorg.apache.http.client.methods.CloseableHttpResponse;
importorg.apache.http.client.methods.HttpGet;
importorg.apache.http.client.methods.HttpPost;
importorg.apache.http.conn.ssl.SSLConnectionSocketFactory;
importorg.apache.http.conn.ssl.SSLContexts;
importorg.apache.http.conn.ssl.TrustSelfSignedStrategy;
importorg.apache.http.entity.ContentType;
importorg.apache.http.entity.mime.MultipartEntityBuilder;
importorg.apache.http.entity.mime.content.FileBody;
importorg.apache.http.entity.mime.content.StringBody;
importorg.apache.http.impl.client.CloseableHttpClient;
importorg.apache.http.impl.client.HttpClients;
importorg.apache.http.message.BasicNameValuePair;
importorg.apache.http.util.EntityUtils;
importorg.junit.Test;
publicclassHttpClientTest{
@Test
publicvoidjUnitTest(){
get();
}
/**
*HttpClient连接SSL
*/
publicvoidssl(){
CloseableHttpClienthttpclient=null;
try{
KeyStoretrustStore=KeyStore.getInstance(KeyStore.getDefaultType());
FileInputStreaminstream=newFileInputStream(newFile("d:\\tomcat.keystore"));
try{
//加载keyStored:\\tomcat.keystore
trustStore.load(instream,"123456".toCharArray());
}catch(CertificateExceptione){
e.printStackTrace();
}finally{
try{
instream.close();
}catch(Exceptionignore){
}
}
//相信自己的CA和所有自签名的证书
SSLContextsslcontext=SSLContexts.custom().loadTrustMaterial(trustStore,newTrustSelfSignedStrategy()).build();
//只允许使用TLSv1协议
SSLConnectionSocketFactorysslsf=newSSLConnectionSocketFactory(sslcontext,newString[]{"TLSv1"},null,
SSLConnectionSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER);
httpclient=HttpClients.custom().setSSLSocketFactory(sslsf).build();
//创建http请求(get方式)
HttpGethttpget=newHttpGet("https://localhost:8443/myDemo/Ajax/serivceJ.action");
System.out.println("executingrequest"+httpget.getRequestLine());
CloseableHttpResponseresponse=httpclient.execute(httpget);
try{
HttpEntityentity=response.getEntity();
System.out.println("----------------------------------------");
System.out.println(response.getStatusLine());
if(entity!=null){
System.out.println("Responsecontentlength:"+entity.getContentLength());
System.out.println(EntityUtils.toString(entity));
EntityUtils.consume(entity);
}
}finally{
response.close();
}
}catch(ParseExceptione){
e.printStackTrace();
}catch(IOExceptione){
e.printStackTrace();
}catch(KeyManagementExceptione){
e.printStackTrace();
}catch(NoSuchAlgorithmExceptione){
e.printStackTrace();
}catch(KeyStoreExceptione){
e.printStackTrace();
}finally{
if(httpclient!=null){
try{
httpclient.close();
}catch(IOExceptione){
e.printStackTrace();
}
}
}
}
/**
*post方式提交表单(模拟用户登录请求)
*/
publicvoidpostForm(){
//创建默认的httpClient实例.
CloseableHttpClienthttpclient=HttpClients.createDefault();
//创建httppost
HttpPosthttppost=newHttpPost("http://localhost:8080/myDemo/Ajax/serivceJ.action");
//创建参数队列
List<namevaluepair>formparams=newArrayList<namevaluepair>();
formparams.add(newBasicNameValuePair("username","admin"));
formparams.add(newBasicNameValuePair("password","123456"));
UrlEncodedFormEntityuefEntity;
try{
uefEntity=newUrlEncodedFormEntity(formparams,"UTF-8");
httppost.setEntity(uefEntity);
System.out.println("executingrequest"+httppost.getURI());
CloseableHttpResponseresponse=httpclient.execute(httppost);
try{
HttpEntityentity=response.getEntity();
if(entity!=null){
System.out.println("--------------------------------------");
System.out.println("Responsecontent:"+EntityUtils.toString(entity,"UTF-8"));
System.out.println("--------------------------------------");
}
}finally{
response.close();
}
}catch(ClientProtocolExceptione){
e.printStackTrace();
}catch(UnsupportedEncodingExceptione1){
e1.printStackTrace();
}catch(IOExceptione){
e.printStackTrace();
}finally{
//关闭连接,释放资源
try{
httpclient.close();
}catch(IOExceptione){
e.printStackTrace();
}
}
}
/**
*发送post请求访问本地应用并根据传递参数不同返回不同结果
*/
publicvoidpost(){
//创建默认的httpClient实例.
CloseableHttpClienthttpclient=HttpClients.createDefault();
//创建httppost
HttpPosthttppost=newHttpPost("http://localhost:8080/myDemo/Ajax/serivceJ.action");
//创建参数队列
List<namevaluepair>formparams=newArrayList<namevaluepair>();
formparams.add(newBasicNameValuePair("type","house"));
UrlEncodedFormEntityuefEntity;
try{
uefEntity=newUrlEncodedFormEntity(formparams,"UTF-8");
httppost.setEntity(uefEntity);
System.out.println("executingrequest"+httppost.getURI());
CloseableHttpResponseresponse=httpclient.execute(httppost);
try{
HttpEntityentity=response.getEntity();
if(entity!=null){
System.out.println("--------------------------------------");
System.out.println("Responsecontent:"+EntityUtils.toString(entity,"UTF-8"));
System.out.println("--------------------------------------");
}
}finally{
response.close();
}
}catch(ClientProtocolExceptione){
e.printStackTrace();
}catch(UnsupportedEncodingExceptione1){
e1.printStackTrace();
}catch(IOExceptione){
e.printStackTrace();
}finally{
//关闭连接,释放资源
try{
httpclient.close();
}catch(IOExceptione){
e.printStackTrace();
}
}
}
/**
*发送get请求
*/
publicvoidget(){
CloseableHttpClienthttpclient=HttpClients.createDefault();
try{
//创建httpget.
HttpGethttpget=newHttpGet("http://www.baidu.com/");
System.out.println("executingrequest"+httpget.getURI());
//执行get请求.
CloseableHttpResponseresponse=httpclient.execute(httpget);
try{
//获取响应实体
HttpEntityentity=response.getEntity();
System.out.println("--------------------------------------");
//打印响应状态
System.out.println(response.getStatusLine());
if(entity!=null){
//打印响应内容长度
System.out.println("Responsecontentlength:"+entity.getContentLength());
//打印响应内容
System.out.println("Responsecontent:"+EntityUtils.toString(entity));
}
System.out.println("------------------------------------");
}finally{
response.close();
}
}catch(ClientProtocolExceptione){
e.printStackTrace();
}catch(ParseExceptione){
e.printStackTrace();
}catch(IOExceptione){
e.printStackTrace();
}finally{
//关闭连接,释放资源
try{
httpclient.close();
}catch(IOExceptione){
e.printStackTrace();
}
}
}
/**
*上传文件
*/
publicvoidupload(){
CloseableHttpClienthttpclient=HttpClients.createDefault();
try{
HttpPosthttppost=newHttpPost("http://localhost:8080/myDemo/Ajax/serivceFile.action");
FileBodybin=newFileBody(newFile("F:\\image\\sendpix0.jpg"));
StringBodycomment=newStringBody("Abinaryfileofsomekind",ContentType.TEXT_PLAIN);
HttpEntityreqEntity=MultipartEntityBuilder.create().addPart("bin",bin).addPart("comment",comment).build();
httppost.setEntity(reqEntity);
System.out.println("executingrequest"+httppost.getRequestLine());
CloseableHttpResponseresponse=httpclient.execute(httppost);
try{
System.out.println("----------------------------------------");
System.out.println(response.getStatusLine());
HttpEntityresEntity=response.getEntity();
if(resEntity!=null){
System.out.println("Responsecontentlength:"+resEntity.getContentLength());
}
EntityUtils.consume(resEntity);
}finally{
response.close();
}
}catch(ClientProtocolExceptione){
e.printStackTrace();
}catch(IOExceptione){
e.printStackTrace();
}finally{
try{
httpclient.close();
}catch(IOExceptione){
e.printStackTrace();
}
}
}
}</namevaluepair></namevaluepair></namevaluepair></namevaluepair>
本实例是采用HttpClient4.3最新版本。该版本与之前的代码写法风格相差较大,大家多留意下。
好了,以上所述就是本文的全部内容,希望大家喜欢。
