HttpClient 学习整理【转】

时间 2019-12-13

原文原文链接

转自php

http://www.blogjava.net/Alpha/archive/2007/01/22/95216.htmlhtml

HttpClient 是我最近想研究的东西，之前想过的一些应用没能有很好的实现，发现这个开源项目以后就有点眉目了，使人头痛的cookie问题仍是有办法解决滴。在网上整理了一些东西，写得很好，寄放在这里。

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来对付各类顽固的WEB服务器
转自：http://blog.csdn.net/ambitiontan/archive/2006/01/06/572171.aspxjava

通常的状况下咱们都是使用IE或者Navigator浏览器来访问一个WEB服务器，用来浏览页面查看信息或者提交一些数据等等。所访问的这些页面有的仅仅是一些普通的页面，有的须要用户登陆后方可以使用，或者须要认证以及是一些经过加密方式传输，例如HTTPS。目前咱们使用的浏览器处理这些状况都不会构成问题。不过你可能在某些时候须要经过程序来访问这样的一些页面，好比从别人的网页中“偷”一些数据；利用某些站点提供的页面来完成某种功能，例如说咱们想知道某个手机号码的归属地而咱们本身又没有这样的数据，所以只好借助其余公司已有的网站来完成这个功能，这个时候咱们须要向网页提交手机号码并从返回的页面中解析出咱们想要的数据来。若是对方仅仅是一个很简单的页面，那咱们的程序会很简单，本文也就没有必要大张旗鼓的在这里浪费口舌。可是考虑到一些服务受权的问题，不少公司提供的页面每每并非能够经过一个简单的URL就能够访问的，而必须通过注册而后登陆后方可以使用提供服务的页面，这个时候就涉及到COOKIE问题的处理。咱们知道目前流行的动态网页技术例如ASP、JSP无不是经过COOKIE来处理会话信息的。为了使咱们的程序能使用别人所提供的服务页面，就要求程序首先登陆后再访问服务页面，这过程就须要自行处理cookie，想一想当你用java.net.HttpURLConnection来完成这些功能时是多么恐怖的事情啊！何况这仅仅是咱们所说的顽固的WEB服务器中的一个很常见的“顽固”！再有如经过HTTP来上传文件呢？不须要头疼，这些问题有了“它”就很容易解决了！apache

咱们不可能列举全部可能的顽固，咱们会针对几种最多见的问题进行处理。固然了，正如前面说到的，若是咱们本身使用java.net.HttpURLConnection来搞定这些问题是很恐怖的事情，所以在开始以前咱们先要介绍一下一个开放源码的项目，这个项目就是Apache开源组织中的httpclient，它隶属于Jakarta的commons项目，目前的版本是2.0RC2。commons下原本已经有一个net的子项目，可是又把httpclient单独提出来，可见http服务器的访问绝非易事。编程

Commons-httpclient项目就是专门设计来简化HTTP客户端与服务器进行各类通信编程。经过它可让原来很头疼的事情如今轻松的解决，例如你再也不管是HTTP或者HTTPS的通信方式，告诉它你想使用HTTPS方式，剩下的事情交给httpclient替你完成。本文会针对咱们在编写HTTP客户端程序时常常碰到的几个问题进行分别介绍如何使用httpclient来解决它们，为了让读者更快的熟悉这个项目咱们最开始先给出一个简单的例子来读取一个网页的内容，而后按部就班解决掉前进中的全部问题。浏览器

1．读取网页(HTTP/HTTPS)内容安全

下面是咱们给出的一个简单的例子用来访问某个页面服务器

/*
* Created on 2003-12-14 by Liudong
*/cookie

package http.demo;
import java.io.IOException;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.*;网络

/**
*最简单的HTTP客户端,用来演示经过GET或者POST方式访问某个页面
*@authorLiudong
*/

public class SimpleClient {
public static void main(String[] args) throws IOException
{
HttpClient client = new HttpClient();
// 设置代理服务器地址和端口

      //client.getHostConfiguration().setProxy("proxy_host_addr",proxy_port);
      // 使用 GET 方法，若是服务器须要经过 HTTPS 链接，那只须要将下面 URL 中的 http 换成 https
         HttpMethodmethod=newGetMethod("http://java.sun.com");
      //使用POST方法
      //HttpMethod method = new PostMethod("http://java.sun.com");
      client.executeMethod(method);

      //打印服务器返回的状态
       System.out.println(method.getStatusLine());
      //打印返回的信息
      System.out.println(method.getResponseBodyAsString());
      //释放链接
      method.releaseConnection();
   }
}

在这个例子中首先建立一个HTTP客户端(HttpClient)的实例，而后选择提交的方法是GET或者POST，最后在HttpClient实例上执行提交的方法，最后从所选择的提交方法中读取服务器反馈回来的结果。这就是使用HttpClient的基本流程。其实用一行代码也就能够搞定整个请求的过程，很是的简单！

2．以GET或者POST方式向网页提交参数

其实前面一个最简单的示例中咱们已经介绍了如何使用GET或者POST方式来请求一个页面，本小节与之不一样的是多了提交时设定页面所需的参数，咱们知道若是是GET的请求方式，那么全部参数都直接放到页面的URL后面用问号与页面地址隔开，每一个参数用&隔开，例如：http://java.sun.com/?name=liudong&mobile=123456，可是当使用POST方法时就会稍微有一点点麻烦。本小节的例子演示向如何查询手机号码所在的城市，代码以下：

/*
* Created on 2003-12-7 by Liudong
*/

package http.demo;
import java.io.IOException;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.*;

/**
*提交参数演示
*该程序链接到一个用于查询手机号码所属地的页面
*以便查询号码段1330227所在的省份以及城市
*@authorLiudong
*/

public class SimpleHttpClient {
   public static void main(String[] args) throws IOException {
      HttpClient client = new HttpClient();
      client.getHostConfiguration().setHost( "www.imobile.com.cn" , 80, "http" );
      method = getPostMethod();    // 使用 POST 方式提交数据
      client.executeMethod(method);   //打印服务器返回的状态
      System.out.println(method.getStatusLine());   //打印结果页面
      Stringresponse=newString(method.getResponseBodyAsString().getBytes("8859_1"));

      //打印返回的信息
      System.out.println(response);
      method.releaseConnection();
   }

   /**
    * 使用 GET 方式提交数据
    *@return
    */

   privatestaticHttpMethodgetGetMethod(){
      returnnewGetMethod("/simcard.php?simcard=1330227");
   }

    /**
     * 使用 POST 方式提交数据
     *@return
     */

    private static HttpMethod getPostMethod(){
      PostMethod post = new PostMethod( "/simcard.php" );
      NameValuePair simcard = new NameValuePair( "simcard" , "1330227" );
      post.setRequestBody( new NameValuePair[] { simcard});
      return post;
   }
}

在上面的例子中页面http://www.imobile.com.cn/simcard.php须要一个参数是simcard，这个参数值为手机号码段，即手机号码的前七位，服务器会返回提交的手机号码对应的省份、城市以及其余详细信息。GET的提交方法只须要在URL后加入参数信息，而POST则须要经过NameValuePair类来设置参数名称和它所对应的值。

3．处理页面重定向

在JSP/Servlet编程中response.sendRedirect方法就是使用HTTP协议中的重定向机制。它与JSP中的<jsp:forward …>的区别在于后者是在服务器中实现页面的跳转，也就是说应用容器加载了所要跳转的页面的内容并返回给客户端；而前者是返回一个状态码，这些状态码的可能值见下表，而后客户端读取须要跳转到的页面的URL并从新加载新的页面。就是这样一个过程，因此咱们编程的时候就要经过HttpMethod.getStatusCode()方法判断返回值是否为下表中的某个值来判断是否须要跳转。若是已经确认须要进行页面跳转了，那么能够经过读取HTTP头中的location属性来获取新的地址。

状态码

对应 HttpServletResponse 的常量

详细描述

301

SC_MOVED_PERMANENTLY

页面已经永久移到另一个新地址

302

SC_MOVED_TEMPORARILY

页面暂时移动到另一个新的地址

303

SC_SEE_OTHER

客户端请求的地址必须经过另外的 URL 来访问

307

SC_TEMPORARY_REDIRECT

同 SC_MOVED_TEMPORARILY

下面的代码片断演示如何处理页面的重定向

client.executeMethod(post);
System.out.println(post.getStatusLine().toString());
post.releaseConnection();
// 检查是否重定向
int statuscode = post.getStatusCode();
if ((statuscode == HttpStatus.SC_MOVED_TEMPORARILY) || (statuscode == HttpStatus.SC_MOVED_PERMANENTLY) || (statuscode == HttpStatus.SC_SEE_OTHER) || (statuscode ==HttpStatus.SC_TEMPORARY_REDIRECT)) {
// 读取新的 URL 地址
   Headerheader=post.getResponseHeader("location");
   if (header!=null){
      Stringnewuri=header.getValue();
      if((newuri==null)||(newuri.equals("")))
         newuri="/";
         GetMethodredirect=newGetMethod(newuri);
         client.executeMethod(redirect);
         System.out.println("Redirect:"+redirect.getStatusLine().toString());
         redirect.releaseConnection();
   }else
    System.out.println("Invalid redirect");
}

咱们能够自行编写两个JSP页面，其中一个页面用response.sendRedirect方法重定向到另一个页面用来测试上面的例子。

4．模拟输入用户名和口令进行登陆

本小节应该说是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 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();
   }
}

5．提交XML格式参数

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

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();
   }
}

6．经过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即为要上传的文件所在的路径。

7．访问启用认证的页面

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

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

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();
   }
}

8．多线程模式下使用httpclient

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

MultiThreadedHttpConnectionManager connectionManager = new MultiThreadedHttpConnectionManager();

HttpClient client = new HttpClient(connectionManager);

之后尽管访问client实例便可。

参考资料：

httpclient首页： http://jakarta.apache.org/commons/httpclient/
关于NTLM是如何工做： http://davenport.sourceforge.net/ntlm.html

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－

HttpClient入门
http://blog.csdn.net/ambitiontan/archive/2006/01/07/572644.aspx

Jakarta Commons HttpClient 学习笔记
http://blog.csdn.net/cxl34/archive/2005/01/19/259051.aspx

Cookies,SSL，httpclient的多线程处理，HTTP方法
http://blog.csdn.net/bjbs_270/archive/2004/11/05/168233.aspx