HttpClient入门

1.拳头之Get/Post
拳头是最基本的一重武器，也是最重要的，好比练武之人必须先扎稳马步。

java 代码


    HttpClient httpclient=new HttpClient();//创建一个客户端，类似打开一个浏览器 
    GetMethod getMethod=new GetMethod("http://www.blablabla.com");//创建一个get方法，类似在浏览器地址栏中输入一个地址 
    int statusCode=httpclient.executeMethod(getMethod);//回车——出拳！ 
    System.out.println("response=" + getMethod.getResponseBodyAsString());//察看拳头命中情况，可以获得的东西还有很多，比如head, cookies等等 
    getMethod.releaseConnection();//释放，记得收拳哦 



2.孔雀翎之支持https

如何支持https?
java 代码


    static{ 
        Protocol easyhttps = new Protocol("https", new EasySSLProtocolSocketFactory(), 443); 
        Protocol.registerProtocol("https", easyhttps); 
    } 


在执行具体的http method之前，暗中将https协议注册一把，如孔雀翎暗藏玄机，毙敌于无形。记住，官方的binary发行版本没有ssl的contribute包，方法一是下载源代码版本来打造你的孔雀翎。

3.多情环之cookies
常道人老多情，其实是记忆太多，所以情之所至，正如cookies甜心，无论你走到那，总把你牵挂：
java 代码


    HttpClient httpclient=new HttpClient(); 
    httpclient.getParams().setCookiePolicy(CookiePolicy.RFC_2109);//RFC_2109是支持较普遍的一个，还有其他cookie协议 
    HttpState initialState = new HttpState(); 
    Cookie cookie=new Cookie(); 
    cookie.setDomain("www.balblabla.com"); 
    cookie.setPath("/"); 
    cookie.setName("多情环"); 
    cookie.setValue("多情即无情"); 
    initialState.addCookie(cookie); 
    httpclient.setState(initialState); 
    ... 



4.离别钩之解构cookies
多情环的反面即离别钩，钩出，敌之身体某个部件即要与身体别离，端的是无情：
java 代码


    ...//执行了某些get/post方法后 
    Cookie[] cookies = httpclient.getState().getCookies(); 
    System.out.println("Present cookies: "); 
    for (int i = 0; i < cookies.length; i++) {//循环结构零部件 
        System.out.println(" - " + cookies[i].toExternalForm()); 
        System.out.println(" - domain=" + cookies[i].getDomain()); 
        System.out.println(" - path=" + cookies[i].getPath()); 
        ...           
    } 



5.霸王抢之post参数
枪，长兵器之王，诸多名将均使一杆或金或银命名的名枪，比如岳飞。post方法在提交参数对时,犹如灵蛇出洞：
java 代码


    PostMethod postMethod = new PostMethod("http://www.saybot.com/postme"); 
    NameValuePair[] postData = new NameValuePair[2]; 
    postData[0] = new NameValuePair("武器", "枪"); 
    postData[1] = new NameValuePair("什么枪", "神枪"); 
    postMethod.addParameters(postData); 
    ...//出枪吧 



6.七星碧玉刀之支持代理(proxy)
代理，非常重要，尤其在局域网横行的年头，没有代理，你在公司上不了QQ，没有代理，google不了网页快照，代理之威，可比七星碧玉刀，无刀，在局域网和开发当中，一切白搭：
java 代码


    HttpClient httpclient=new HttpClient(); 
    httpClient.getHostConfiguration().setProxy("192.168.0.1", 9527); 
    httpClient.getParams().setAuthenticationPreemptive(true);//重要！！！告诉httpclient，使用抢先认证，否则你会收到“你没有资格”的恶果 
    /*
      这一步也至关重要，MyProxyCredentialsProvider实现了org.apache.commons.httpclient.auth.CredentialsProvider接口，
      返回代理的credential(username/password)*/ 
    httpClient.getParams().setParameter(CredentialsProvider.PROVIDER, new MyProxyCredentialsProvider()); 
    httpClient.getState().setProxyCredentials( 
        new AuthScope("192.168.0.1", 
            AuthScope.ANY_PORT, //任意端口哦，可要小心 
            AuthScope.ANY_REALM),//任意域哦，可要小心 
    new UsernamePasswordCredentials("username",//proxy的用户名 
                            "password"));//proxy的密码 


--------------------------------------------------------------------------------------------------


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 test;
import java.io.IOException;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.params.HttpMethodParams;
public class GetSample{
  public static void main(String[] args) {
  //构造HttpClient的实例
  HttpClient httpClient = new HttpClient();
  //创建GET方法的实例
  GetMethod getMethod = new GetMethod("http://www.ibm.com");
  //使用系统提供的默认的恢复策略
  getMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,
    new DefaultHttpMethodRetryHandler());
  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));
  } 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，不支持自动转发，因此需要自己对页面转向做处理。具体的页面转向处理请参见下面的"自动转向"部分。代码如下：

    String url = "http://www.newsmth.net/bbslogin2.php";
    PostMethod postMethod = new PostMethod(url);
    // 填入各个表单域的值
    NameValuePair[] data = { new NameValuePair("id", "youUserName"),
    new NameValuePair("passwd", "yourPwd") };
    // 将表单的值放入postMethod中
    postMethod.setRequestBody(data);
    // 执行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;
        if (locationHeader != null) {
         location = locationHeader.getValue();
         System.out.println("The page was redirected to:" + location);
        } else {
         System.err.println("Location field value is null.");
        }
        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中会有<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的值也可以是一个相对地址，如果是这样的话，需要对它做一些处理后才可以转发。