HttpClient入门.docx
- 文档编号:30468713
- 上传时间:2023-08-15
- 格式:DOCX
- 页数:15
- 大小:23.48KB
HttpClient入门.docx
《HttpClient入门.docx》由会员分享,可在线阅读,更多相关《HttpClient入门.docx(15页珍藏版)》请在冰豆网上搜索。
HttpClient入门
HttpClient是ApacheJakartaCommon下的子项目,可以用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包,并且它支持HTTP协议最新的版本和建议。
本文首先介绍HTTPClient,然后根据作者实际工作经验给出了一些常见问题的解决方法。
HttpClient简介
HTTP协议可能是现在Internet上使用得最多、最重要的协议了,越来越多的Java应用程序需要直接通过HTTP协议来访问网络资源。
虽然在JDK的包中已经提供了访问HTTP协议的基本功能,但是对于大部分应用程序来说,JDK库本身提供的功能还不够丰富和灵活。
HttpClient是ApacheJakartaCommon下的子项目,用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包,并且它支持HTTP协议最新的版本和建议。
HttpClient已经应用在很多的项目中,比如ApacheJakarta上很著名的另外两个开源项目Cactus和HTMLUnit都使用了HttpClient,更多使用HttpClient的应用可以参见http:
//wiki.apache.org/jakarta-httpclient/HttpClientPowered。
HttpClient项目非常活跃,使用的人还是非常多的。
目前HttpClient版本是在2005.10.11发布的3.0RC4。
HttpClient功能介绍
以下列出的是HttpClient提供的主要的功能,要知道更多详细的功能可以参见HttpClient的主页。
∙实现了所有HTTP的方法(GET,POST,PUT,HEAD等)
∙支持自动转向
∙支持HTTPS协议
∙支持代理服务器等
下面将逐一介绍怎样使用这些功能。
首先,我们必须安装好HttpClient。
∙HttpClient可以在http:
//jakarta.apache.org/commons/httpclient/downloads.html下载
∙HttpClient用到了ApacheJakartacommon下的子项目logging,你可以从这个地址http:
//jakarta.apache.org/site/downloads/downloads_commons-logging.cgi下载到commonlogging,从下载后的压缩包中取出commons-logging.jar加到CLASSPATH中
∙HttpClient用到了ApacheJakartacommon下的子项目codec,你可以从这个地址http:
//jakarta.apache.org/site/downloads/downloads_commons-codec.cgi下载到最新的commoncodec,从下载后的压缩包中取出commons-codec-1.x.jar加到CLASSPATH中
HttpClient基本功能的使用
GET方法
使用HttpClient需要以下6个步骤:
1.创建HttpClient的实例
2.创建某种连接方法的实例,在这里是GetMethod。
在GetMethod的构造函数中传入待连接的地址
3.调用第一步中创建好的实例的execute方法来执行第二步中创建好的method实例
4.读response
5.释放连接。
无论执行方法是否成功,都必须释放连接
6.对得到后的内容进行处理
根据以上步骤,我们来编写用GET方法来取得某网页内容的代码。
∙大部分情况下HttpClient默认的构造函数已经足够使用。
HttpClienthttpClient=newHttpClient();
∙创建GET方法的实例。
在GET方法的构造函数中传入待连接的地址即可。
用GetMethod将会自动处理转发过程,如果想要把自动处理转发过程去掉的话,可以调用方法setFollowRedirects(false)。
GetMethodgetMethod=newGetMethod("
∙调用实例httpClient的executeMethod方法来执行getMethod。
由于是执行在网络上的程序,在运行executeMethod方法的时候,需要处理两个异常,分别是HttpException和IOException。
引起第一种异常的原因主要可能是在构造getMethod的时候传入的协议不对,比如不小心将"http"写成"htp",或者服务器端返回的内容不正常等,并且该异常发生是不可恢复的;第二种异常一般是由于网络原因引起的异常,对于这种异常(IOException),HttpClient会根据你指定的恢复策略自动试着重新执行executeMethod方法。
HttpClient的恢复策略可以自定义(通过实现接口HttpMethodRetryHandler来实现)。
通过httpClient的方法setParameter设置你实现的恢复策略,本文中使用的是系统提供的默认恢复策略,该策略在碰到第二类异常的时候将自动重试3次。
executeMethod返回值是一个整数,表示了执行该方法后服务器返回的状态码,该状态码能表示出该方法执行是否成功、需要认证或者页面发生了跳转(默认状态下GetMethod的实例是自动处理跳转的)等。
//设置成了默认的恢复策略,在发生异常时候将自动重试3次,在这里你也可以设置成自定义的恢复策略
getMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,
newDefaultHttpMethodRetryHandler());
//执行getMethod
intstatusCode=client.executeMethod(getMethod);
if(statusCode!
=HttpStatus.SC_OK){
System.err.println("Methodfailed:
"+getMethod.getStatusLine());
}
∙在返回的状态码正确后,即可取得内容。
取得目标地址的内容有三种方法:
第一种,getResponseBody,该方法返回的是目标的二进制的byte流;第二种,getResponseBodyAsString,这个方法返回的是String类型,值得注意的是该方法返回的String的编码是根据系统默认的编码方式,所以返回的String值可能编码类型有误,在本文的"字符编码"部分中将对此做详细介绍;第三种,getResponseBodyAsStream,这个方法对于目标地址中有大量数据需要传输是最佳的。
在这里我们使用了最简单的getResponseBody方法。
byte[]responseBody=method.getResponseBody();
∙释放连接。
无论执行方法是否成功,都必须释放连接。
method.releaseConnection();
∙处理内容。
在这一步中根据你的需要处理内容,在例子中只是简单的将内容打印到控制台。
System.out.println(newString(responseBody));
下面是程序的完整代码,这些代码也可在附件中的test.GetSample中找到。
packagetest;
importjava.io.IOException;
importmons.httpclient.*;
importmons.httpclient.methods.GetMethod;
importmons.httpclient.params.HttpMethodParams;
publicclassGetSample{
publicstaticvoidmain(String[]args){
//构造HttpClient的实例
HttpClienthttpClient=newHttpClient();
//创建GET方法的实例
GetMethodgetMethod=newGetMethod("");
//使用系统提供的默认的恢复策略
getMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,
newDefaultHttpMethodRetryHandler());
try{
//执行getMethod
intstatusCode=httpClient.executeMethod(getMethod);
if(statusCode!
=HttpStatus.SC_OK){
System.err.println("Methodfailed:
"
+getMethod.getStatusLine());
}
//读取内容
byte[]responseBody=getMethod.getResponseBody();
//处理内容
System.out.println(newString(responseBody));
}catch(HttpExceptione){
//发生致命的异常,可能是协议不对或者返回的内容有问题
System.out.println("Pleasecheckyourprovidedhttpaddress!
");
e.printStackTrace();
}catch(IOExceptione){
//发生网络异常
e.printStackTrace();
}finally{
//释放连接
getMethod.releaseConnection();
}
}
}
POST方法
根据RFC2616,对POST的解释如下:
POST方法用来向目的服务器发出请求,要求它接受被附在请求后的实体,并把它当作请求队列(Request-Line)中请求URI所指定资源的附加新子项。
POST被设计成用统一的方法实现下列功能:
∙对现有资源的注释(Annotationofexistingresources)
∙向电子公告栏、新闻组,邮件列表或类似讨论组发送消息
∙提交数据块,如将表单的结果提交给数据处理过程
∙通过附加操作来扩展数据库
调用HttpClient中的PostMethod与GetMethod类似,除了设置PostMethod的实例与GetMethod有些不同之外,剩下的步骤都差不多。
在下面的例子中,省去了与GetMethod相同的步骤,只说明与上面不同的地方,并以登录清华大学BBS为例子进行说明。
∙构造PostMethod之前的步骤都相同,与GetMethod一样,构造PostMethod也需要一个URI参数,在本例中,登录的地址是
Stringurl="
PostMethodpostMethod=newPostMethod(url);
//填入各个表单域的值
NameValuePair[]data={newNameValuePair("id","youUserName"),
newNameValuePair("passwd","yourPwd")};
//将表单的值放入postMethod中
postMethod.setRequestBody(data);
//执行postMethod
intstatusCode=httpClient.executeMethod(postMethod);
//HttpClient对于要求接受后继服务的请求,象POST和PUT等不能自动处理转发
//301或者302
if(statusCode==HttpStatus.SC_MOVED_PERMANENTLY||
statusCode==HttpStatus.SC_MOVED_TEMPORARILY){
//从头中取出转向的地址
HeaderlocationHeader=postMethod.getResponseHeader("location");
Stringlocation=null;
if(locationHeader!
=null){
location=locationHeader.getValue();
System.out.println("Thepagewasredirectedto:
"+location);
}else{
System.err.println("Locationfieldvalueisnull.");
}
return;
}
完整的程序代码请参见附件中的test.PostSample
使用HttpClient过程中常见的一些问题
下面介绍在使用HttpClient过程中常见的一些问题。
字符编码
某目标页的编码可能出现在两个地方,第一个地方是服务器返回的http头中,另外一个地方是得到的html/xml页面中。
∙在http头的Content-Type字段可能会包含字符编码信息。
例如可能返回的头会包含这样子的信息:
Content-Type:
text/html;charset=UTF-8。
这个头信息表明该页的编码是UTF-8,但是服务器返回的头信息未必与内容能匹配上。
比如对于一些双字节语言国家,可能服务器返回的编码类型是UTF-8,但真正的内容却不是UTF-8编码的,因此需要在另外的地方去得到页面的编码信息;但是如果服务器返回的编码不是UTF-8,而是具体的一些编码,比如gb2312等,那服务器返回的可能是正确的编码信息。
通过method对象的getResponseCharSet()方法就可以得到http头中的编码信息。
∙对于象xml或者html这样的文件,允许作者在页面中直接指定编码类型。
比如在html中会有
xmlversion="1.0"encoding="gb2312"?
>这样的标签,在这些情况下,可能与http头中返回的编码信息冲突,需要用户自己判断到底那种编码类型应该是真正的编码。
自动转向
根据RFC2616中对自动转向的定义,主要有两种:
301和302。
301表示永久的移走(MovedPermanently),当返回的是301,则表示请求的资源已经被移到一个固定的新地方,任何向该地址发起请求都会被转到新的地址上。
302表示暂时的转向,比如在服务器端的servlet程序调用了sendRedirect方法,则在客户端就会得到一个302的代码,这时服务器返回的头信息中location的值就是sendRedirect转向的目标地址。
HttpClient支持自动转向处理,但是象POST和PUT方式这种要求接受后继服务的请求方式,暂时不支持自动转向,因此如果碰到POST方式提交后返回的是301或者302的话需要自己处理。
就像刚才在POSTMethod中举的例子:
如果想进入登录BBS后的页面,必须重新发起登录的请求,请求的地址可以在头字段location中得到。
不过需要注意的是,有时候location返回的可能是相对路径,因此需要对location返回的值做一些处理才可以发起向新地址的请求。
另外除了在头中包含的信息可能使页面发生重定向外,在页面中也有可能会发生页面的重定向。
引起页面自动转发的标签是:
处理HTTPS协议 HttpClient提供了对SSL的支持,在使用SSL之前必须安装JSSE。 在Sun提供的1.4以后的版本中,JSSE已经集成到JDK中,如果你使用的是JDK1.4以前的版本则必须安装JSSE。 JSSE不同的厂家有不同的实现。 下面介绍怎么使用HttpClient来打开Https连接。 这里有两种方法可以打开https连接,第一种就是得到服务器颁发的证书,然后导入到本地的keystore中;另外一种办法就是通过扩展HttpClient的类来实现自动接受证书。 方法1,取得证书,并导入本地的keystore: ∙安装JSSE(如果你使用的JDK版本是1.4或者1.4以上就可以跳过这一步)。 本文以IBM的JSSE为例子说明。 先到IBM网站上下载JSSE的安装包。 然后解压开之后将ibmjsse.jar包拷贝到 ∙取得并且导入证书。 证书可以通过IE来获得: 1.用IE打开需要连接的https网址,会弹出如下对话框: 2.单击"ViewCertificate",在弹出的对话框中选择"Details",然后再单击"CopytoFile",根据提供的向导生成待访问网页的证书文件 3.向导第一步,欢迎界面,直接单击"Next", 4.向导第二步,选择导出的文件格式,默认,单击"Next", 5.向导第三步,输入导出的文件名,输入后,单击"Next", 6.向导第四步,单击"Finish",完成向导 7.最后弹出一个对话框,显示导出成功 ∙用keytool工具把刚才导出的证书倒入本地keystore。 Keytool命令在 keytool-import-noprompt-keystorecacerts-storepasschangeit-aliasyourEntry1-fileyour.cer 其中参数alias后跟的值是当前证书在keystore中的唯一标识符,但是大小写不区分;参数file后跟的是刚才通过IE导出的证书所在的路径和文件名;如果你想删除刚才导入到keystore的证书,可以用命令: keytool-delete-keystorecacerts-storepasschangeit-aliasyourEntry1 ∙写程序访问https地址。 如果想测试是否能连上https,只需要稍改一下GetSample例子,把请求的目标变成一个https地址。 GetMethodgetMethod=newGetMethod(""); 运行该程序可能出现的问题: 1.抛出异常.SocketException: AlgorithmSSLnotavailable。 出现这个异常可能是因为没有加JSSEProvider,如果用的是IBM的JSSEProvider,在程序中加入这样的一行: if(Security.getProvider("com.ibm.jsse.IBMJSSEProvider")==null) Security.addProvider(newIBMJSSEProvider()); 或者也可以打开 security.provider.1=sun.security.provider.Sun security.provider.2=com.ibm.crypto.provider.IBMJCE 后面加入security.provider.3=com.ibm.jsse.IBMJSSEProvider 2.抛出异常.SocketException: SSLimplementationnotavailable。 出现这个异常可能是你没有把ibmjsse.jar拷贝到 3.抛出异常.ssl.SSLHandshakeException: unknowncertificate。 出现这个异常表明你的JSSE应该已经安装正确,但是可能因为你没有把证书导入到当前运行JRE的keystore中,请按照前面介绍的步骤来导入你的证书。 方法2,扩展HttpClient类实现自动接受证书 因为这种方法自动接收所有证书,因此存在一定的安全问题,所以在使用这种方法前请仔细考虑您的系统的安全需求。 具体的步骤如下: ∙提供一个自定义的socketfactory(test.MySecureProtocolSocketFactory)。 这个自定义的类必须实现接口mons.httpclient.protocol.SecureProtocolSocketFactory,在实现接口的类中调用自定义的X509TrustManager(test.MyX509TrustManager),这两个类可以在随本文带的附件中得到 ∙创建一个mons.httpclient.protocol.Protocol的实例,指定协议名称和默认的端口号 Protocolmyhttps=newProtocol("https",newMySecureProtocolSocketFactory(),443); ∙注册刚才创建的https协议对象 Protocol.registerProtocol("https",myhttps); ∙然后按照普通编程
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- HttpClient 入门