Voovan开发指南 (三) HttpClient开发

HttpClient 特点介绍

Voovan HttpClient 是基于 Voovan 开源项目的异步通信开发,兼容 Http1.1协议的 Http 通信客户端工具，支持标准的 HTTP1.1协议及 HTTPS。本文将引导大家如何快速的使用 HttpClient 连续的访问一个网址.

特点:

• 基于 Voovan 的异步通信框架实现
• 同时支持一个 httpclient 多次和服务端进行交互，以此来避免每次交互都新建立一个 socket 连接的性能损耗。
• Voovan HttpClient 通过请求地址的协议类型自动分析采用 http 请求还是 https 进行请求。

####1.材料准备 首先我们需要确定我们需要访问的网址,有两种情况即: http 和 https 网站,下面我们给出我们本次的目标网址:

• HTTP 协议网址:http://www.oschina.net/
• HTTPS 协议网址:https://www.oschina.net/

---

####2.准备 HttpClient 对象 首先我们需要获得一个 HttpClient 对象来完成我们的访问操作.那么我们需要如何构造我们的对象呢? 很显然是new一个咯。下面我们来看看 new 方法的说明：

public HttpClient(String urlString)
public HttpClient(String urlString,int timeOut) 
public HttpClient(String urlString,String charset,int timeOut) 
public HttpClient(String urlString,String charset)

• 构造一个 HttpClient 对象。
• urlString: 请求的 URL 地址。
• timeOut: 请求超时时间。
• charset: 请求使用的字符集,默认 UTF-8。

urlString这个参数大家需要注意一下,这里可以设置为一个根域名,然后在 send 的时候使用不同的域名路径.实现连续访问。

我们可以看到HttpClient有4个构造方法,三个参数,相信不用多说,聪明的你看看上面的说明就立刻明白了. 下面我们来做两个实例化:

//构造一个基于 http 的请求
HttpClient http = new HttpClient("http://www.oschina.net","UTF-8",10000);
//构造一个基于 https 的请求
HttpClient https = new HttpClient("https://www.oschina.net/","UTF-8",10000);

---

####3.填充HttpClient 现在我们已经有了一个 HttpClient 对象了,我们可能会需要做如下操作:

• 设置请求方法
• 设置 HTTP header
• 设置 Cookie
• 设置请求参数
• 设置请求的 Part 内容(multipart/form-data)

下面我们来逐一讲解: 设置 HTTP方法

public void setMethod(String method)

• 为当前 HTTP 设置请求方法,如:GET、POST、HEAD、CONNECT、TRACE、DELETE等。
• method: 方法字符串。

设置 HTTP Header

public Header getHeader()

• 返回值: HTTP 请求头。

通过'getHeader'方法获得一个Map,通过对这个 Map进行put、get、remove可以对 Header 进行操作。

** 设置 HTTP Cookies**

public List<Cookie> getCookies()

• 返回值: 获取HTTPCookies集合。

通过'getCookies'可以获得一个 Cookie对象的集合,可以通过 对这个 List 集客进行 add、get、remove进行操作,增加一个 Cookie 对象时需要getCookies().add(Cookie。newInstance(...))来进行。

设置 HTTP 请求参数

public HttpClient putParameters(String name,Object value)

• 为HTTP设置请求参数
• name: 参数名。
• value: 参数值。

设置请求参数,不需要多说什么,需要说明的是这里设置的参数会根据 GET/POST(但不包括multipart/form-data请求) 等请求的规范自动附加到请求中。

** 添加 HTTP multipart请求**

public void addPart(Part part)

• 类似Form 的 Actiong="POST" enctype="multipart/form-data"提交的请求。
• part: org.voovan.http.message.packet.Part对象封装了HTTP multipart请求,Part对象的有一个方便的构造函数:

public Part(String name,String value)

• name: 参数名。
• value: 参数值。

multipart请求可能很多同学不太清楚,其实可以简单的理解为上传文件的那种类型的请求.Part 对象包含自己的 Header 和 Body,Header可以不用理会系统会自动处理,Body就是保存的参数的值。实际使用时请大家参数org.voovan.http.message.packet.Part类进行调用.

ok,具体设置我们就不举例,好多哦~~大家根据自己的需要使用.

---

####4.发送HttpClient 好了,现在到了,我们发送 Http 请求的时候了,棒棒哒. 发送 Http 请求有两种方式:

默认路径参数发送

public Response Send() throws Exception

• 发送HTTP请求,默认访问域名根。
• 返回值: Response对象。

指定路径发送

public Response Send(String urlString) throws Exception

• urlString: 相对于主机的相对 URL 路径,用于一次连接主机多次请求操作. 例如:访问的网址是 http://www.baid.com/s ,那么构造 HttpClient 时使用http://www.baid.com/作为参数,调用 send 时使用/s作为参数。
• 发送HTTP请求。
• 返回值: Response对象。

好了,我们可以发送请求,但不要忘了,在发送完以后记得调用'close()'方法来关闭连接哦.

下面我们来使用第一步创建的两个 HttpClient 对象来访问 开源中国

        HttpClient http = new HttpClient("http://www.oschina.net","UTF-8",10000);
        Logger.simple(http.send().body().getBodyString());
        http.close();

        HttpClient https = new HttpClient("https://www.oschina.net/","UTF-8",10000);
        Logger.simple(https.send().body().getBodyString());
        https.close();

https.send().body().getBodyString()就是一个 Stream

• 调用send方法向服务器发送请求返回了一个 Response 对象。
• 调用body方法向服务器发送请求返回了一个 Response 对象的 Body 对象(保存了 http 实际请求的页面内容)。
• 调用getBodyString方法向服务器发送请求返回了一个 Body 的内容通过 String 类型返回。 这样我们就获得了所请求页面内容了。 最后 close 方法来关闭 HttpClient。

前面我们提到 Voovan 的 HttpClient 可以实现连续访问即: 一次 Socket 连接多次不断的发送 Http 请求. 下面我们先来描述一个场景: 首先我们通过浏览器打开了:http://www.oschina.net/,然后我们对其中的一篇文章产生了兴趣,我们就会点击连接:http://www.oschina.net/news/76652/redisson-2-3-0,那么这个时候浏览器是使用了上次的 socket 连接来发送和接收第二个请求的.幸运的是 Voovan HttpClient 也支持.美美哒。下面我们举一个连续调用的例子：

        HttpClient http = new HttpClient("http://www.oschina.net","UTF-8",10000);
        Logger.simple(http.send().body().getBodyString());
        Logger.simple(http.send("/news/76652/redisson-2-3-0").body().getBodyString());
        http.close();

我们在close方法调用之前连续访问了两个不同的网址,这两个网址的根域名都是 http://www.oschina.net ,现在大家可以根据自己的需要修改代码进行测试了.

转载于:https://my.oschina.net/helyho/blog/834612