技术教程 编程教程 HttpClient相关 正文

HttpClient相关

2023-06-02,

HTTPClient的主页是http://jakarta.apache.org/commons/httpclient/，你可以在这里得到关于HttpClient更加详细的信息

HttpClient入门

HttpClient 是 Apache Jakarta Common 下的子项目，可以用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。本文首先介绍 HTTPClient，然后根据作者实际工作经验给出了一些常见问题的解决方法。

HttpClient简介

HTTP 协议可能是现在 Internet 上使用得最多、最重要的协议了，越来越多的 Java 应用程序需要直接通过 HTTP 协议来访问网络资源。虽然在 JDK 的 java.net 包中已经提供了访问 HTTP 协议的基本功能，但是对于大部分应用程序来说，JDK 库本身提供的功能还不够丰富和灵活。HttpClient 是 Apache Jakarta Common 下的子项目，用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。HttpClient 已经应用在很多的项目中，比如 Apache Jakarta 上很著名的另外两个开源项目 Cactus 和 HTMLUnit 都使用了 HttpClient，更多使用 HttpClient 的应用可以参见http://wiki.apache.org/jakarta-httpclient/HttpClientPowered。HttpClient 项目非常活跃，使用的人还是非常多的。目前 HttpClient 版本是在 2005.10.11 发布的 3.0 RC4 。

HttpClient 功能介绍

以下列出的是 HttpClient 提供的主要的功能，要知道更多详细的功能可以参见 HttpClient 的主页。

实现了所有 HTTP 的方法（GET,POST,PUT,HEAD 等）
支持自动转向
支持 HTTPS 协议
支持代理服务器等

下面将逐一介绍怎样使用这些功能。首先，我们必须安装好 HttpClient。

HttpClient 可以在http://jakarta.apache.org/commons/httpclient/downloads.html下载
HttpClient 用到了 Apache Jakarta common 下的子项目 logging，你可以从这个地址http://jakarta.apache.org/site/downloads/downloads_commons-logging.cgi下载到 common logging，从下载后的压缩包中取出 commons-logging.jar 加到 CLASSPATH 中
HttpClient 用到了 Apache Jakarta common 下的子项目 codec，你可以从这个地址http://jakarta.apache.org/site/downloads/downloads_commons-codec.cgi 下载到最新的 common codec，从下载后的压缩包中取出 commons-codec-1.x.jar 加到 CLASSPATH 中

HttpClient 基本功能的使用

GET 方法

使用 HttpClient 需要以下 6 个步骤：

1. 创建 HttpClient 的实例

2. 创建某种连接方法的实例，在这里是 GetMethod。在 GetMethod 的构造函数中传入待连接的地址

3. 调用第一步中创建好的实例的 execute 方法来执行第二步中创建好的 method 实例

4. 读 response

5. 释放连接。无论执行方法是否成功，都必须释放连接

6. 对得到后的内容进行处理

根据以上步骤，我们来编写用GET方法来取得某网页内容的代码。

大部分情况下 HttpClient 默认的构造函数已经足够使用。

 HttpClient httpClient = new HttpClient(); 

创建GET方法的实例。在GET方法的构造函数中传入待连接的地址即可。用GetMethod将会自动处理转发过程，如果想要把自动处理转发过程去掉的话，可以调用方法setFollowRedirects(false)。

GetMethod getMethod = new GetMethod("http://www.ibm.com/");

调用实例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,

        new DefaultHttpMethodRetryHandler());

//执行getMethod

int statusCode = client.executeMethod(getMethod);

if (statusCode != HttpStatus.SC_OK) {

  System.err.println("Method failed: " + getMethod.getStatusLine());

}

在返回的状态码正确后，即可取得内容。取得目标地址的内容有三种方法：第一种，getResponseBody，该方法返回的是目标的二进制的byte流；第二种，getResponseBodyAsString，这个方法返回的是String类型，值得注意的是该方法返回的String的编码是根据系统默认的编码方式，所以返回的String值可能编码类型有误，在本文的"字符编码"部分中将对此做详细介绍；第三种，getResponseBodyAsStream，这个方法对于目标地址中有大量数据需要传输是最佳的。在这里我们使用了最简单的getResponseBody方法。

byte[] responseBody = method.getResponseBody();

释放连接。无论执行方法是否成功，都必须释放连接。

method.releaseConnection();

处理内容。在这一步中根据你的需要处理内容，在例子中只是简单的将内容打印到控制台。

System.out.println(new String(responseBody));

下面是程序的完整代码，这些代码也可在附件中的test.GetSample中找到。

package com.httpclientTest;

/**

 * HttpClient get方法功能介绍

 * 实现了所有 HTTP 的方法（GET,POST,PUT,HEAD 等）

 * 支持自动转向

 * 支持 HTTPS 协议

 * 支持代理服务器等

 */

import java.io.IOException;

import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler;

import org.apache.commons.httpclient.HttpClient;

import org.apache.commons.httpclient.HttpException;

import org.apache.commons.httpclient.HttpStatus;

import org.apache.commons.httpclient.methods.GetMethod;

import org.apache.commons.httpclient.params.HttpMethodParams;

import org.apache.http.protocol.HTTP;

/**

 * @author 作者：wn

 * @version 创建时间：2016年12月30日 上午10:48:25

 *

 */

/**

 * 调用实例httpClient的executeMethod方法来执行getMethod。

 * 由于是执行在网络上的程序，在运行executeMethod方法的时候，需要处理两个异常，

 * 分别是HttpException和IOException。引起第一种异常的原因主要可能是在构

 * 造getMethod的时候传入的协议不对，比如不小心将"http"写成"htp"，或者服务

 * 器端返回的内容不正常等，并且该异常发生是不可恢复的；第二种异常一般是由于网络原因

 * 引起的异常，对于这种异常 （IOException），HttpClient会根据你指定的恢复

 * 策略自动试着重新执行executeMethod方法。HttpClient的恢复策略可以自定义

 * （通过实现接口HttpMethodRetryHandler来实现）。通过httpClient的方

 * 法setParameter设置你实现的恢复策略，本文中使用的是系统提供的默认恢复策略，

 * 该策略在碰到第二类异常的时候将自动重试3次。executeMethod返回值是一个整数，

 * 表示了执行该方法后服务器返回的状态码，该状态码能表示出该方法执行是否成功、需要认

 * 证或者页面发生了跳转（默认状态下GetMethod的实例是自动处理跳转的）等。

 *

 *

 * 在返回的状态码正确后，即可取得内容。取得目标地址的内容有三种方法：

 * 第一种，getResponseBody，该方法返回的是目标的二进制的byte流；

 * 第二种，getResponseBodyAsString，这个方法返回的是String类型，值得注

 * 意的是该方法返回的String的编码是根据系统默认的编码方式，所以返回的String值可

 * 能编码类型有误，在本文的"字符编码"部分中将对此做详细介绍；

 * 第三种，getResponseBodyAsStream，这个方法对于目标地址中有大量数据需要传

 * 输是最佳的。在这里我们使用了最简单的getResponseBody方法

 *

 *

 * 在返回的状态码正确后，即可取得内容。取得目标地址的内容有三种方法：

 * 第一种，getResponseBody，该方法返回的是目标的二进制的byte流；

 * 第二种，getResponseBodyAsString，这个方法返回的是String类型，值得注意

 * 的是该方法返回的String的编码是根据系统默认的编码方式，所以返回的String值可能编

 * 码类型有误，在本文的"字符编码"部分中将对此做详细介绍；

 * 第三种，getResponseBodyAsStream，这个方法对于目标地址中有大量数据需要传输

 * 是最佳的。在这里我们使用了最简单的getResponseBody方法。

 *

 */

public class GetSample {

	public static void main(String[] args) {

		// 构造httpclient的实例

		HttpClient httpclient = new HttpClient();

		// 设置编码模式

		httpclient.getParams().setContentCharset("UTF-8");

		// 创建get方法的实例

		GetMethod getMethod = new GetMethod("http://www.baidu.com");

		//GetMethod syncMethod = new GetMethod(baseUrl + syncUrl + "?start=" + dateStr + "&end=" + dateStr);

		// 使用系统提供的默认的恢复策略

		getMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,

				new DefaultHttpMethodRetryHandler());

		// 设置响应头格式

		// getMethod.addRequestHeader(HTTP.CONTENT_TYPE,"application/x-www-form-urlencoded;charset=utf-8");

		// 添加响应头

		// String sign="";

		// String nonce ="";

		// getMethod.addRequestHeader("authorization", "sign=\"" + sign

		// + "\"," + "nonce=\"" + nonce + "\"");

		try {

			// 执行getMethod

			int statusCode = httpclient.executeMethod(getMethod);

			if (statusCode != HttpStatus.SC_OK) {

				System.err

						.println("Method failed:" + getMethod.getStatusLine());

			}

			// 读取内容

			byte[] responseBody = getMethod.getResponseBody();

			// 处理内容

			System.out.println(new String(responseBody));

			// String result = getMethod.getResponseBodyAsString();

		} catch (HttpException e) {

			// 发生致命的异常，可能是协议不对或者返回的内容有问题

			System.out.println("Please check your provided http address!");

			e.printStackTrace();

		} catch (IOException e) {

			// 发生网络异常

			e.printStackTrace();

		} finally {

			// 释放连接

			getMethod.releaseConnection();

		}

	}

}

POST方法

根据RFC2616，对POST的解释如下：POST方法用来向目的服务器发出请求，要求它接受被附在请求后的实体，并把它当作请求队列（Request-Line）中请求URI所指定资源的附加新子项。POST被设计成用统一的方法实现下列功能：

对现有资源的注释（Annotation of existing resources）
向电子公告栏、新闻组，邮件列表或类似讨论组发送消息
提交数据块，如将表单的结果提交给数据处理过程
通过附加操作来扩展数据库

调用HttpClient中的PostMethod与GetMethod类似，除了设置PostMethod的实例与GetMethod有些不同之外，剩下的步骤都差不多。在下面的例子中，省去了与GetMethod相同的步骤，只说明与上面不同的地方，并以登录清华大学BBS为例子进行说明。

构造PostMethod之前的步骤都相同，与GetMethod一样，构造PostMethod也需要一个URI参数，在本例中，登录的地址是http://www.newsmth.net/bbslogin2.php。在创建了PostMethod的实例之后，需要给method实例填充表单的值，在BBS的登录表单中需要有两个域，第一个是用户名（域名叫id），第二个是密码（域名叫passwd）。表单中的域用类NameValuePair来表示，该类的构造函数第一个参数是域名，第二参数是该域的值；将表单所有的值设置到PostMethod中用方法setRequestBody。另外由于BBS登录成功后会转向另外一个页面，但是HttpClient对于要求接受后继服务的请求，比如POST和PUT，不支持自动转发，因此需要自己对页面转向做处理。具体的页面转向处理请参见下面的"自动转向"部分。代码如下：

package com.httpclientTest;

import java.io.IOException;

import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler;

import org.apache.commons.httpclient.Header;

import org.apache.commons.httpclient.HttpClient;

import org.apache.commons.httpclient.HttpException;

import org.apache.commons.httpclient.HttpStatus;

import org.apache.commons.httpclient.NameValuePair;

import org.apache.commons.httpclient.methods.PostMethod;

import org.apache.commons.httpclient.params.HttpMethodParams;

/**

 * @author 作者：wn

 * @version 创建时间：2016年12月30日 下午1:59:35

 *

 */

/**

 *

 * 构造PostMethod之前的步骤都相同，与GetMethod一样，构造PostMethod也需要一个URI参数，

 * 在本例中，登录的地址是http://www.newsmth.net/bbslogin2.php。在创建了PostMethod

 * 的实例之后，需要给method实例填充表单的值，在BBS的登录表单中需要有两个域，第一个是用户名（域名叫id）

 * ，第二个是密码（域名叫passwd）。表单中的域用类NameValuePair来表示，该类的构造函数第一个参数是

 * 域名，第二参数是该域的值；将表单所有的值设置到PostMethod中用方法setRequestBody。另外由于BBS

 * 登录成功后会转向另外一个页面，但是HttpClient对于要求接受后继服务的请求，比如POST和PUT，不支持自

 * 动转发，因此需要自己对页面转向做处理。具体的页面转向处理请参见下面的"自动转向"部分。代码如下：

 *

 */

public class PostSamp {

	public static void main(String[] args) {

		// 构造httpclient的实例

		HttpClient httpclient = new HttpClient();

		// 设置编码模式

		httpclient.getParams().setContentCharset("UTF-8");

		// 创建get方法的实例

		String url = "http://www.newsmth.net/bbslogin2.php";

		PostMethod postMethod = new PostMethod(url);

		// 设置响应头格式

		// postMethod.addRequestHeader(HTTP.CONTENT_TYPE,"application/x-www-form-urlencoded;charset=utf-8");

		// 添加响应头

		// String sign="";

		// String nonce ="";

		// postMethod.addRequestHeader("authorization", "sign=\"" + sign

		// + "\"," + "nonce=\"" + nonce + "\"");

		//填入各表单域的值

		NameValuePair[] data = { new NameValuePair("id", "youUserName"),new NameValuePair("passwd", "yourPwd") };

		// 将表单的值放入postMethod中

		postMethod.setRequestBody(data);

		// 执行postMethod

		try {

			// 执行postMethod

			int statusCode = httpclient.executeMethod(postMethod);
　　　　                 // 检查是否重定向

			// HttpClient对于要求接受后继服务的请求，象POST和PUT等不能自动处理转发

			// 301或者302

			if (statusCode == HttpStatus.SC_MOVED_PERMANENTLY ||

					statusCode == HttpStatus.SC_MOVED_TEMPORARILY) {

				 // 从头中取出转向的地址

			    Header locationHeader = postMethod.getResponseHeader("location");

			    String location = null;

			    /**

			     * 自动转向根据RFC2616中对自动转向的定义，主要有两种：301和302。301表示永久的移走（Moved Permanently，

			     * 当返回的是301，则表示请求的资源已经被移到一个固定的新地方，任何向该地址发起请求都会被转到新的地址上。

			     * 302表示暂时的转向，比如在服务器端的servlet程序调用了sendRedirect方法，则在客户端就会得到一个302的代码，

			     * 这时服务器返回的头信息中location的值就是sendRedirect转向的目标地址。HttpClient支持自动转向处理，但是

			     * 象POST和PUT方式这种要求接受后继服务的请求方式，暂时不支持自动转向，因此如果碰到POST方式提交后返回的是301或者

			     * 302的话需要自己处理。就像刚才在POSTMethod中举的例子：如果想进入登录BBS后的页面，必须重新发起登录的请求，请求

			     * 的地址可以在头字段location中得到。不过需要注意的是，有时候location返回的可能是相对路径，因此需要对location

			     * 返回的值做一些处理才可以发起向新地址的请求。

			     */

			    if (locationHeader != null) {

			     location = locationHeader.getValue();

			     System.out.println("The page was redirected to:" + location);

			    } else {

			     System.err.println("Location field value is null.");

			    }

				// 读取内容

				byte[] responseBody = postMethod.getResponseBody();

				// 处理内容

				System.out.println(new String(responseBody));

				// String result = postMethod.getResponseBodyAsString();

			    return;

			}

		} catch (HttpException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		} catch (IOException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		}finally {

			// 释放连接

			postMethod.releaseConnection();

		}

	}

}

模拟输入用户名和口令进行登录

本小节应该说是HTTP客户端编程中最常碰见的问题，很多网站的内容都只是对注册用户可见的，这种情况下就必须要求使用正确的用户名和口令登录成功后，方可浏览到想要的页面。因为HTTP协议是无状态的，也就是连接的有效期只限于当前请求，请求内容结束后连接就关闭了。在这种情况下为了保存用户的登录信息必须使用到Cookie机制。以JSP/Servlet为例，当浏览器请求一个JSP或者是Servlet的页面时，应用服务器会返回一个参数，名为jsessionid（因不同应用服务器而异），值是一个较长的唯一字符串的Cookie，这个字符串值也就是当前访问该站点的会话标识。浏览器在每访问该站点的其他页面时候都要带上jsessionid这样的Cookie信息，应用服务器根据读取这个会话标识来获取对应的会话信息。

对于需要用户登录的网站，一般在用户登录成功后会将用户资料保存在服务器的会话中，这样当访问到其他的页面时候，应用服务器根据浏览器送上的Cookie中读取当前请求对应的会话标识以获得对应的会话信息，然后就可以判断用户资料是否存在于会话信息中，如果存在则允许访问页面，否则跳转到登录页面中要求用户输入帐号和口令进行登录。这就是一般使用JSP开发网站在处理用户登录的比较通用的方法。

这样一来，对于HTTP的客户端来讲，如果要访问一个受保护的页面时就必须模拟浏览器所做的工作，首先就是请求登录页面，然后读取Cookie值；再次请求登录页面并加入登录页所需的每个参数；最后就是请求最终所需的页面。当然在除第一次请求外其他的请求都需要附带上Cookie信息以便服务器能判断当前请求是否已经通过验证。说了这么多，可是如果你使用httpclient的话，你甚至连一行代码都无需增加，你只需要先传递登录信息执行登录过程，然后直接访问想要的页面，跟访问一个普通的页面没有任何区别，因为类HttpClient已经帮你做了所有该做的事情了，太棒了！下面的例子实现了这样一个访问的过程。

/*

* Created on 2003-12-7 by Liudong

*/

package com.zuidaima.http.demo;

import org.apache.commons.httpclient.*;

import org.apache.commons.httpclient.cookie.*;

import org.apache.commons.httpclient.methods.*; 

/**

 * 用来演示登录表单的示例

 * @author Liudong

 */

public class FormLoginDemo {

   static final String LOGON_SITE = "localhost" ;

   static final int     LOGON_PORT = 8080;

   public static void main(String[] args) throws Exception{

      HttpClient client = new HttpClient();

      client.getHostConfiguration().setHost(LOGON_SITE, LOGON_PORT);

      // 模拟登录页面 login.jsp->main.jsp

      PostMethod post = new PostMethod( "/main.jsp" );

      NameValuePair name = new NameValuePair( "name" , "ld" );

      NameValuePair pass = new NameValuePair( "password" , "ld" );

      post.setRequestBody( new NameValuePair[]{name,pass});

      int status = client.executeMethod(post);

      System.out.println(post.getResponseBodyAsString());

      post.releaseConnection();

      // 查看 cookie 信息

      CookieSpec cookiespec = CookiePolicy.getDefaultSpec();

      Cookie[] cookies = cookiespec.match(LOGON_SITE, LOGON_PORT, "/" , false , client.getState().getCookies());

      if (cookies.length == 0) {

         System.out.println( "None" );

      } else {

         for ( int i = 0; i < cookies.length; i++) {

            System.out.println(cookies[i].toString());

         }

      }

      // 访问所需的页面 main2.jsp

      GetMethodget=newGetMethod("/main2.jsp");

      client.executeMethod(get);

      System.out.println(get.getResponseBodyAsString());

      get.releaseConnection();

   }

}

提交XML格式参数 

提交XML格式的参数很简单，仅仅是一个提交时候的ContentType问题，下面的例子演示从文件文件中读取XML信息并提交给服务器的过程，该过程可以用来测试Web服务。

package com.zuidaima.httpclient;

import java.io.File;

import java.io.FileInputStream;

import org.apache.commons.httpclient.HttpClient;

import org.apache.commons.httpclient.methods.EntityEnclosingMethod;

import org.apache.commons.httpclient.methods.PostMethod;

/**

 *用来演示提交XML格式数据的例子

*/

public class PostXMLClient {

   public static void main(String[] args) throws Exception {

      File input = new File(“test.xml”);

      PostMethod post = new PostMethod(“http://localhost:8080/httpclient/xml.jsp”);

      // 设置请求的内容直接从文件中读取

      post.setRequestBody( new FileInputStream(input));

      if (input.length() < Integer.MAX_VALUE)

         post.setRequestContentLength(input.length());

      else

         post.setRequestContentLength(EntityEnclosingMethod.CONTENT_LENGTH_CHUNKED);

      // 指定请求内容的类型

      post.setRequestHeader( "Content-type" , "text/xml; charset=GBK" );

      HttpClient httpclient = new HttpClient();

      int result = httpclient.executeMethod(post);

      System.out.println( "Response status code: " + result);

      System.out.println( "Response body: " );

      System.out.println(post.getResponseBodyAsString());

      post.releaseConnection();

   }

}

通过HTTP上传文件

httpclient使用了单独的一个HttpMethod子类来处理文件的上传，这个类就是MultipartPostMethod，该类已经封装了文件上传的细节，我们要做的仅仅是告诉它我们要上传文件的全路径即可，下面的代码片段演示如何使用这个类。

MultipartPostMethod filePost = new MultipartPostMethod(targetURL);

filePost.addParameter( "fileName" , targetFilePath);

HttpClient client = new HttpClient();

// 由于要上传的文件可能比较大 , 因此在此设置最大的连接超时时间

client.getHttpConnectionManager(). getParams().setConnectionTimeout(5000);

int status = client.executeMethod(filePost);

上面代码中，targetFilePath即为要上传的文件所在的路径

访问启用认证的页面

我们经常会碰到这样的页面，当访问它的时候会弹出一个浏览器的对话框要求输入用户名和密码后方可，这种用户认证的方式不同于我们在前面介绍的基于表单的用户身份验证。这是HTTP的认证策略，httpclient支持三种认证方式包括：基本、摘要以及NTLM认证。其中基本认证最简单、通用但也最不安全；摘要认证是在HTTP 1.1中加入的认证方式，而NTLM则是微软公司定义的而不是通用的规范，最新版本的NTLM是比摘要认证还要安全的一种方式。

下面例子是从httpclient的CVS服务器中下载的，它简单演示如何访问一个认证保护的页面

package com.zuidaima.httpclient;

import org.apache.commons.httpclient.HttpClient;

import org.apache.commons.httpclient.UsernamePasswordCredentials;

import org.apache.commons.httpclient.methods.GetMethod; 

public class BasicAuthenticationExample { 

   public BasicAuthenticationExample() {

   }

   public static void main(String[] args) throws Exception {

      HttpClient client = new HttpClient();

      client.getState().setCredentials( "www.verisign.com" , "realm" , new UsernamePasswordCredentials( "username" , "password") );

      GetMethod get = new GetMethod( "https://www.verisign.com/products/index.html" );

      get.setDoAuthentication( true );

      int status = client.executeMethod( get );

      System.out.println(status+ "\n" + get.getResponseBodyAsString());

      get.releaseConnection();

   }

}

多线程模式下使用httpclient

多线程同时访问httpclient，例如同时从一个站点上下载多个文件。对于同一个HttpConnection同一个时间只能有一个线程访问，为了保证多线程工作环境下不产生冲突，httpclient使用了一个多线程连接管理器的类：MultiThreadedHttpConnectionManager，要使用这个类很简单，只需要在构造HttpClient实例的时候传入即可，代码如下：

MultiThreadedHttpConnectionManager connectionManager = new MultiThreadedHttpConnectionManager();

HttpClient client = new HttpClient(connectionManager);

以后尽管访问client实例即可。

使用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中会有<meta http-equiv="Content-Type" content="text/html; charset=gb2312"/>这样的标签；或者在xml中会有<?xml version="1.0" encoding="gb2312"?>这样的标签，在这些情况下，可能与http头中返回的编码信息冲突，需要用户自己判断到底那种编码类型应该是真正的编码。

自动转向

根据RFC2616中对自动转向的定义，主要有两种：301和302。301表示永久的移走（Moved Permanently），当返回的是301，则表示请求的资源已经被移到一个固定的新地方，任何向该地址发起请求都会被转到新的地址上。302表示暂时的转向，比如在服务器端的servlet程序调用了sendRedirect方法，则在客户端就会得到一个302的代码，这时服务器返回的头信息中location的值就是sendRedirect转向的目标地址。

HttpClient支持自动转向处理，但是象POST和PUT方式这种要求接受后继服务的请求方式，暂时不支持自动转向，因此如果碰到POST方式提交后返回的是301或者302的话需要自己处理。就像刚才在POSTMethod中举的例子：如果想进入登录BBS后的页面，必须重新发起登录的请求，请求的地址可以在头字段location中得到。不过需要注意的是，有时候location返回的可能是相对路径，因此需要对location返回的值做一些处理才可以发起向新地址的请求。

另外除了在头中包含的信息可能使页面发生重定向外，在页面中也有可能会发生页面的重定向。引起页面自动转发的标签是：<meta http-equiv="refresh" content="5; url=http://www.ibm.com/us">。如果你想在程序中也处理这种情况的话得自己分析页面来实现转向。需要注意的是，在上面那个标签中url的值也可以是一个相对地址，如果是这样的话，需要对它做一些处理后才可以转发。

处理HTTPS协议

HttpClient提供了对SSL的支持，在使用SSL之前必须安装JSSE。在Sun提供的1.4以后的版本中，JSSE已经集成到JDK中，如果你使用的是JDK1.4以前的版本则必须安装JSSE。JSSE不同的厂家有不同的实现。下面介绍怎么使用HttpClient来打开Https连接。这里有两种方法可以打开https连接，第一种就是得到服务器颁发的证书，然后导入到本地的keystore中；另外一种办法就是通过扩展HttpClient的类来实现自动接受证书。

一个https协议的例子：

package com.fenxiao.channel.youpaiyun;

import java.io.IOException;

import java.net.URLDecoder;

import java.text.SimpleDateFormat;

import java.util.Date;

import java.util.Map;

import org.apache.commons.httpclient.HttpException;

import org.apache.commons.lang.StringUtils;

import org.apache.log4j.LogManager;

import org.apache.log4j.Logger;

import org.sevenstar.component.cache.ehcache.EHCacheHelper;

import com.alibaba.fastjson.JSON;

import com.alibaba.fastjson.JSONObject;

import com.fenxiao.channel.youpaiyun.util.CryptAES;

/**

 * @author 作者：wn

 * @version 创建时间：2016年12月22日 下午3:55:33

 *

 */

public class YouPaiYunTest {

    @SuppressWarnings("unused")

    private Logger log = LogManager.getLogger(YouPaiYunTest.class);

    String get_token_url = "https://ptp-api.upyun.com/refreshToken";

    String flowurl = "https://ptp-api.upyun.com/chargeOrder";

    String appkey = "UOdaq2g9jR2t9wBS";

    String appsecret = "d1a464de8590118d693a8859536b92a0";

    String queryurl = "https://ptp-api.upyun.com/seekOrder";    

    public static void main(String[] args) throws Exception {

        YouPaiYunTest test = new YouPaiYunTest();

        test.chargeOrder();

        //test.seekOrder();

    }

    /**

     * 创建订单

     * @throws Exception

     */

    public void chargeOrder() throws Exception {

        System.out.println("=====可当下单到又拍云====");

        // 获取token，token有效期120分钟

        String token = refreshToken(get_token_url, appkey, appsecret);

        if (StringUtils.isEmpty(token)) {

            System.out.println("=====又拍云获取token异常====");

            return;

        }else {

            System.out.println("=====youpaiyun_token===token:"+token);

        }

        //手机号

        String mobile0 = "18902506499";

        String mobile = CryptAES.encrypt(mobile0, token, appkey);

        //流量包的产品编号

        String prodcode = "CTC_5";   //电信5M，1元

        //客户自定义的订单号，用于客户内部记录订单，长度必须小于30， 且每次充值，编号不重复

        String custno = "15415451115127";

        //签名

        String sign ="";

        //拼接字符串

        String content = new StringBuffer().append("appkey").append(appkey).append("custno").append(custno).append("mobile").append(mobile).append("prodcode").append(prodcode).append("token").append(token).toString();

        sign = CryptAES.SHA1(content);

        System.out.println("=======签名："+sign);

        //String result = sendPost(flowurl, sign);

        JSONObject json = new JSONObject();

        json.put("appkey", appkey);

        json.put("custno", custno);

        json.put("mobile", mobile);

        json.put("prodcode", prodcode);

        json.put("sign", sign);

        try {

            String fUrl = flowurl +json.toString();

            System.out.println(fUrl);

            String params = json.toString();

            String retJSON = HttpRequestUtil.sendHttpsRequest(flowurl, params);

            System.out.println("retJSON====" + retJSON);

        } catch (Exception e) {

            e.printStackTrace();

        }

    }

    /**

     * 查询seekOrder

     */

    public Object seekOrder()throws HttpException,IOException{

        String custno = "15415451115126";

        String requesttime = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(new Date());

        String sign="";    

        System.out.println("=====开始查询又拍云====");

        // 获取token，token有效期120分钟

        String token = refreshToken(get_token_url, appkey, appsecret);

        if (StringUtils.isEmpty(token)) {

            System.out.println("=====又拍云获取token异常====");

            return null;

        }else {

            System.out.println("=====youpaiyun_token===token:"+token);

        }    

        //拼接字符串

        String content = new StringBuffer().append("appkey").append(appkey).append("custno").

                append(custno).append("requesttime").append(requesttime).append("TOKEN").append(token).toString();

        System.out.println("=======拼接好的字符串："+content);

        sign =  CryptAES.SHA1(content);

        System.out.println("=======签名："+sign);

        JSONObject json = new JSONObject();

        json.put("appkey", appkey);

        json.put("custno", custno);

        json.put("requesttime", requesttime);

        json.put("sign", sign);

        String fUrl = queryurl +json.toString();

        System.out.println(fUrl);

        String params = json.toString();

        String retJSON = HttpRequestUtil.sendHttpsRequest(queryurl, params);

        System.out.println("retJSON====" + retJSON);

        return retJSON;

    }

    /**

     * 令牌请求接口

     */

    @SuppressWarnings("unchecked")

    public static String refreshToken(String url,String appkey,String appsecret){

        String token = "";

        Map<String, Object> map = null;

        //从缓存中获取token

        Object cacheToken = EHCacheHelper.get("youpanyun_token", "YOUPAIYUN_TOKEN");

        if (null!=cacheToken) {

            token = String.valueOf(cacheToken);

        }

        System.out.println("===从缓存中获取youpaiyun_token=====cacheToken:"+token);

        if (StringUtils.isBlank(token)) {

            System.out.println("====从缓存中无法获取youpaiyun_token,则重新获取又拍云Token====");

            JSONObject json = new JSONObject();

            json.put("appkey", appkey);

            json.put("appsecret", appsecret);

            String param = json.toString();

            System.out.println("====请求参数===="+param);

            try {

                param = URLDecoder.decode(param, "UTF-8");

                System.out.println(url+param);

                String response = HttpRequestUtil.sendHttpsRequest(url, param);

                map = (Map<String, Object>) JSON.parse(response);

                System.out.println("=====获取又拍云token的结果response:"+ response);

            } catch (Exception e) {

                e.printStackTrace();

            }

            if(null != map && map.containsKey("token")){

                token = (String) map.get("token");

                System.out.println("=====创建新的youpaiyun_token===token:" + token);

                //储存token

                storageToken("YOUPAIYUN_TOKEN",token);

            }else{

                System.out.println("===又拍云获取token异常===returnMap:null");

            }

            storageToken("YPUPAIYUN_TOKEN",token);

        }

        return token;

    }

    /**

     * 存储 token

     *

     * @param key

     * @param value

     */

    public static void storageToken(String key, String value) {

        if (!EHCacheHelper.exists("YOUPAIYUN_TOKEN")) {

            System.out.println("===EHCache not found [YOUPAIYUN_TOKEN]===");

            EHCacheHelper.addCache("YOUPAIYUN_TOKEN");

            EHCacheHelper.getCache("YOUPAIYUN_TOKEN").getCacheConfiguration().setTimeToIdleSeconds(0);// 无限期地处于空闲状态

            EHCacheHelper.getCache("YOUPAIYUN_TOKEN").getCacheConfiguration().setTimeToLiveSeconds(7100);// 允许存在于缓存中的最长时间，以秒为单位.超过600s自动从缓存中清除

            EHCacheHelper.getCache("YOUPAIYUN_TOKEN").getCacheConfiguration().setMaxElementsInMemory(100);// 设置基于内存的缓存可存放对象的最大数目

            EHCacheHelper.getCache("YOUPAIYUN_TOKEN").getCacheConfiguration().setDiskPersistent(false);

            EHCacheHelper.getCache("YOUPAIYUN_TOKEN").getCacheConfiguration().setEternal(false);

        }

        EHCacheHelper.put("youpanyun_token", key, value);

        if (null != EHCacheHelper.get("youpanyun_token","YOUPAIYUN_TOKEN")) {

            System.out.println("===已存储YOUPAIYUN_TOKEN===TOKEN:"+ EHCacheHelper.get("youpanyun_token","YOUPAIYUN_TOKEN") + "");

        }

    }

}

Https协议工具类：

package com.fenxiao.channel.youpaiyun;

import javax.net.ssl.*;

import java.io.BufferedReader;

import java.io.InputStreamReader;

import java.io.OutputStream;

import java.net.HttpURLConnection;

import java.net.URL;

import java.net.URLConnection;

import java.security.cert.CertificateException;

import java.security.cert.X509Certificate;

/**

 * Created by Administrator on 2014/11/11.

 */

public class HttpRequestUtil {

    private static String encoding = "utf-8";

    /**

     * http方式调用

     * @param remoteUrl

     * @param message

     * @return

     */

    public static String sendHttpRequest(String remoteUrl, String message) {

        URLConnection conn = null;

        try {

            URL url = new URL(remoteUrl);

            conn = url.openConnection();

            //发送请求

            if (conn instanceof HttpURLConnection) {

                HttpURLConnection httpUrlConnection = (HttpURLConnection) conn;

                httpUrlConnection.setRequestMethod("POST");

                byte[] data = message.getBytes(encoding);

                httpUrlConnection.setConnectTimeout(20 * 1000);   //20s超时

                httpUrlConnection.setReadTimeout(20 * 1000);//20s

                httpUrlConnection.setDoOutput(true);

                httpUrlConnection.setUseCaches(false);

                httpUrlConnection.setInstanceFollowRedirects(false);

                httpUrlConnection.addRequestProperty("Content-Type", "application/json;charset=" + encoding);

                httpUrlConnection.addRequestProperty("Content-Length", String.valueOf(data.length));

                OutputStream out = httpUrlConnection.getOutputStream();

                out.write(data);

                // flush and close

                out.flush();

                out.close();

            }

            //响应返回

            InputStreamReader inputStreamReader = new InputStreamReader(conn.getInputStream(), encoding);

            BufferedReader in = new BufferedReader(inputStreamReader);

            String line = null;

            final StringBuilder stringBuffer = new StringBuilder(255);

            while ((line = in.readLine()) != null) {

                stringBuffer.append(line);

                stringBuffer.append("\n");

            }

            String responseMessage = stringBuffer.toString();

            return responseMessage;

        } catch (final Exception e) {

           e.printStackTrace();

        } finally {

            if (conn != null && conn instanceof HttpURLConnection) {

                ((HttpURLConnection) conn).disconnect();

            }

        }

        return null;

    }

    /**

     * https方式调用

     * @param remoteUrl

     * @param message

     * @return

     */

    public static String sendHttpsRequest(String remoteUrl, String message) {

        URLConnection conn = null;

        try {

            URL url = new URL(remoteUrl);

            //信任与主机验证

            trustAllHosts();

            conn = url.openConnection();

            //发送请求

            if (conn instanceof HttpsURLConnection) {

                HttpsURLConnection httpUrlConnection = (HttpsURLConnection) conn;

                httpUrlConnection.setRequestMethod("POST");

                byte[] data = message.getBytes(encoding);

                httpUrlConnection.setConnectTimeout(20 * 1000);   //20s超时

                httpUrlConnection.setReadTimeout(20 * 1000);//20s

                httpUrlConnection.setDoOutput(true);

                httpUrlConnection.setUseCaches(false);

                httpUrlConnection.setInstanceFollowRedirects(false);

                httpUrlConnection.addRequestProperty("Content-Type", "application/json;charset=" + encoding);

                httpUrlConnection.addRequestProperty("Content-Length", String.valueOf(data.length));

                OutputStream out = httpUrlConnection.getOutputStream();

                out.write(data);

                // flush and close

                out.flush();

                out.close();

            }

            //响应返回

            InputStreamReader inputStreamReader = new InputStreamReader(conn.getInputStream(), encoding);

            BufferedReader in = new BufferedReader(inputStreamReader);

            String line = null;

            final StringBuilder stringBuffer = new StringBuilder(255);

            while ((line = in.readLine()) != null) {

                stringBuffer.append(line);

                stringBuffer.append("\n");

            }

            String responseMessage = stringBuffer.toString();

            return responseMessage;

        } catch (final Exception e) {

            e.printStackTrace();

        } finally {

            if (conn != null && conn instanceof HttpURLConnection) {

                ((HttpURLConnection) conn).disconnect();

            }

        }

        return null;

    }

    /**

     * @param encoding the encoding to set

     */

    public void setEncoding(String encoding) {

        HttpRequestUtil.encoding = encoding;

    }

    /**

     *创建一个信任管理器不验证证书链及主机名的验证

     */

    public static void trustAllHosts() {

        //创建一个信任管理器不验证证书链

        TrustManager[] trustAllCerts = new TrustManager[] { new X509TrustManager() {

            public java.security.cert.X509Certificate[] getAcceptedIssuers() {

                return new java.security.cert.X509Certificate[] {};

            }

            public void checkClientTrusted(X509Certificate[] chain, String authType)

                    throws CertificateException {

            }

            public void checkServerTrusted(X509Certificate[] chain, String authType)

                    throws CertificateException {

            }

        }

        };

        try {

            SSLContext sc = SSLContext.getInstance("TLS");

            sc.init(null, trustAllCerts, new java.security.SecureRandom());

            HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());

            //如果不创建新的信任管理器，则需要服务器端的keystore文件，才能访问服务端

//            String sslKeyStorePath = "C:\\deploy\\jetty.keystore";

//            String sslKeyStorePassword = "12345678";

//            String sslKeyStoreType = "JKS"; // 密钥库类型，有JKS PKCS12等

//            String sslTrustStore = "C:\\deploy\\jetty.keystore";

//            String sslTrustStorePassword = "12345678";

//            System.setProperty("javax.net.ssl.keyStore", sslKeyStorePath);

//            System.setProperty("javax.net.ssl.keyStorePassword",

//                    sslKeyStorePassword);

//            System.setProperty("javax.net.ssl.keyStoreType", sslKeyStoreType);

//            // 设置系统参数

//            System.setProperty("javax.net.ssl.trustStore", sslTrustStore);

//            System.setProperty("javax.net.ssl.trustStorePassword",

//                    sslTrustStorePassword);

//            System.setProperty("java.protocol.handler.pkgs", "sun.net.www.protocol");

            //主机名的验证，返回true

            HostnameVerifier hv = new HostnameVerifier() {

                public boolean verify(String urlHostName, SSLSession session) {

                    return true;

                }

            };

            HttpsURLConnection.setDefaultHostnameVerifier(hv);

        } catch (Exception e) {

            e.printStackTrace();

        }

    }

}

方法1，取得证书，并导入本地的keystore：

安装JSSE （如果你使用的JDK版本是1.4或者1.4以上就可以跳过这一步）。本文以IBM的JSSE为例子说明。先到IBM网站上下载JSSE的安装包。然后解压开之后将ibmjsse.jar包拷贝到<java-home>\lib\ext\目录下。
取得并且导入证书。证书可以通过IE来获得：

1． 用IE打开需要连接的https网址，会弹出如下对话框：

2． 单击"View Certificate"，在弹出的对话框中选择"Details"，然后再单击"Copy to File"，根据提供的向导生成待访问网页的证书文件

3． 向导第一步，欢迎界面，直接单击"Next"，

4． 向导第二步，选择导出的文件格式，默认，单击"Next"，

5． 向导第三步，输入导出的文件名，输入后，单击"Next"，

6． 向导第四步，单击"Finish"，完成向导

7． 最后弹出一个对话框，显示导出成功

用keytool工具把刚才导出的证书倒入本地keystore。Keytool命令在<java-home>\bin\下，打开命令行窗口，并到<java-home>\lib\security\目录下，运行下面的命令：

keytool -import -noprompt -keystore cacerts

-storepass changeit -alias yourEntry1 -file your.cer

其中参数alias后跟的值是当前证书在keystore中的唯一标识符，但是大小写不区分；参数file后跟的是刚才通过IE导出的证书所在的路径和文件名；如果你想删除刚才导入到keystore的证书，可以用命令：

keytool -delete -keystore cacerts -storepass changeit -alias yourEntry1

写程序访问https地址。如果想测试是否能连上https，只需要稍改一下GetSample例子，把请求的目标变成一个https地址。

GetMethod getMethod = new GetMethod("https://www.yourdomain.com");

运行该程序可能出现的问题：

1. 抛出异常java.net.SocketException: Algorithm SSL not available。出现这个异常可能是因为没有加JSSEProvider，如果用的是IBM的JSSE Provider，在程序中加入这样的一行：

 if(Security.getProvider("com.ibm.jsse.IBMJSSEProvider") == null)

 Security.addProvider(new IBMJSSEProvider());

或者也可以打开<java-home>\lib\security\java.security，在行

security.provider.1=sun.security.provider.Sun

security.provider.2=com.ibm.crypto.provider.IBMJCE

后面加入security.provider.3=com.ibm.jsse.IBMJSSEProvider

2. 抛出异常java.net.SocketException: SSL implementation not available。出现这个异常可能是你没有把ibmjsse.jar拷贝到<java-home>\lib\ext\目录下。

3. 抛出异常javax.net.ssl.SSLHandshakeException: unknown certificate。出现这个异常表明你的JSSE应该已经安装正确，但是可能因为你没有把证书导入到当前运行JRE的keystore中，请按照前面介绍的步骤来导入你的证书。

方法２，扩展HttpClient类实现自动接受证书

因为这种方法自动接收所有证书，因此存在一定的安全问题，所以在使用这种方法前请仔细考虑您的系统的安全需求。具体的步骤如下：

提供一个自定义的socket factory（test.MySecureProtocolSocketFactory）。这个自定义的类必须实现接口org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory，在实现接口的类中调用自定义的X509TrustManager(test.MyX509TrustManager)，这两个类可以在随本文带的附件中得到
创建一个org.apache.commons.httpclient.protocol.Protocol的实例，指定协议名称和默认的端口号

Protocol myhttps = new Protocol("https", new MySecureProtocolSocketFactory (), 443);

注册刚才创建的https协议对象

Protocol.registerProtocol("https ", myhttps);

然后按照普通编程方式打开https的目标地址，代码请参见test.NoCertificationHttpsGetSample

处理代理服务器

HttpClient中使用代理服务器非常简单，调用HttpClient中setProxy方法就可以，方法的第一个参数是代理服务器地址，第二个参数是端口号。另外HttpClient也支持SOCKS代理。

httpClient.getHostConfiguration().setProxy(hostName,port);

结论

从上面的介绍中，可以知道HttpClient对http协议支持非常好，使用起来很简单，版本更新快，功能也很强大，具有足够的灵活性和扩展性。对于想在Java应用中直接访问http资源的编程人员来说，HttpClient是一个不可多得的好工具。

参考资料

Commons logging包含了各种各样的日志API的实现，读者可以通过站点http://jakarta.apache.org/commons/logging/得到详细的内容
Commons codec包含了一些一般的解码/编码算法。包含了语音编码、十六进制、Base64和URL编码等，通过http://jakarta.apache.org/commons/codec/可以得到详细的内容
rfc2616是关于HTTP/1.1的文档，可以在http://www.faqs.org/rfcs/rfc2616.html上得到详细的内容，另外rfc1945是关于HTTP/1.0的文档，通过http://www.faqs.org/rfcs/rfc1945.html可以得到详细内容
SSL――SSL 是由 Netscape Communications Corporation 于 1994 年开发的，而 TLS V1.0 是由 Internet Engineering Task Force（IETF）定义的标准，它基于 SSL V3.0，并且在使用的加密算法上与其有些许的不同。例如，SSL 使用 Message Authentication Code（MAC）算法来生成完整性校验值，而 TLS 应用密钥的 Hashing for Message Authentication Code（HMAC）算法。
IBM JSSE提供了SSL（Secure Sockets Layer）和TLS（Transport Layer Security）的java实现，在http://www-03.ibm.com/servers/eserver/zseries/software/java/jsse.html中可以得到详细的信息
Keytool是一个管理密钥和证书的工具。关于它详细的使用信息可以在http://www.doc.ic.ac.uk/csg/java/1.3.1docs/tooldocs/solaris/keytool.html上得到
HTTPClient的主页是http://jakarta.apache.org/commons/httpclient/，你可以在这里得到关于HttpClient更加详细的信息

HttpClient相关的相关教程结束。

《HttpClient相关.doc》

下载本文的Word格式文档，以方便收藏与打印。

Copyright 2023. 昆居客 - IT编程,互联网信息技术文档大全!