HttpClient4.5教程-基础 1.1

最新推荐文章于 2025-03-25 11:25:55 发布
最新推荐文章于 2025-03-25 11:25:55 发布
阅读量704 收藏 1
点赞数
分类专栏： http httpClient
本文深入讲解了HttpClient的基本功能，包括HTTP请求与响应处理、消息头管理、实体内容操作及资源释放等内容，并介绍了如何使用ResponseHandler简化响应处理。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1.1 Request 的执行

HttpClient最必不可少的功能就是执行HTTP的方法，执行HTTP方法会涉及到一个或者多个HTTP request/HTTP response交换，而这些过程通常会在HttpClient内部完成。使用者提交一个request的对象去执行，HttpClient会发送这个request到目标服务器并且获得一个对应的response对象，如果不成功的话则抛出一个异常。

自然而然，满足了上面描述的HttpClient接口就是HttpClient API的主要入口。

下面是一个最简单的request执行过程：

[java]  view plain  copy
  1. CloseableHttpClient httpclient = HttpClients.createDefault();  
  2. HttpGet httpget = new HttpGet("http://localhost/");  
  3. CloseableHttpResponse response = httpclient.execute(httpget);  
  4. try {  
  5.     <...>  
  6. } finally {  
  7.     response.close();  
  8. }  

1.1.1 HTTP request

所有的HTTP request都有一个请求线，包含了请求的方法名称，请求的URI和HTTP协议版本。

HttpClient开箱即用的支持所有HTTP/1.1中定义的HTTP方法，包括GET,HEAD,POST,PUT,DELETE,TRACE 和 OPTIONS，这些HTTP方法类型都有一个与之对应的类：HttpGet,HttpHead,HttpPost,HttpPut,HttpDelete,HttpTrace 和 HttpOptions。

Request-URI是一个统一资源定位符，它指明了用于处理该request的资源的位置。HTTP request URIs包含了一个协议类型，主机名，可选端口，资源路径，可选查询参数，可选片段。

[java]  view plain  copy
  1. HttpGet httpget = new HttpGet(  
  2.      "http://www.google.com/search?hl=en&q=httpclient&btnG=Google+Search&aq=f&oq=");  
  3. HttpClient提供URIBuilder实用类用于简化request URIS的创建和修改。  
  4. URI uri = new URIBuilder()  
  5.         .setScheme("http")  
  6.         .setHost("www.google.com")  
  7.         .setPath("/search")  
  8.         .setParameter("q", "httpclient")  
  9.         .setParameter("btnG", "Google Search")  
  10.         .setParameter("aq", "f")  
  11.         .setParameter("oq", "")  
  12.         .build();  
  13. HttpGet httpget = new HttpGet(uri);  
  14. System.out.println(httpget.getURI());  

输出：

[java]  view plain  copy
  1. http://www.google.com/search?q=httpclient&btnG=Google+Search&aq=f&oq=  

1.1.2 HTTP response

HTTP response是服务器在接收并且处理完request消息之后返回给客户端的消息，消息的第一行包含了协议版本，status code和与之关联的文本。

[java]  view plain  copy
  1. HttpResponse response = new BasicHttpResponse(HttpVersion.HTTP_1_1,   
  2. HttpStatus.SC_OK, "OK");  
  3.   
  4. System.out.println(response.getProtocolVersion());  
  5. System.out.println(response.getStatusLine().getStatusCode());  
  6. System.out.println(response.getStatusLine().getReasonPhrase());  
  7. System.out.println(response.getStatusLine().toString());  

输出：

[java]  view plain  copy
  1. HTTP/1.1  
  2. 200  
  3. OK  
  4. HTTP/1.1 200 OK  

1.1.3 消息头处理

HTTP消息包含多个header，这些header描述了消息的属性比如content length,content type等等，HttpClient提供了取出，添加，删除和遍历header的方法。

[java]  view plain  copy
  1. HttpResponse response = new BasicHttpResponse(HttpVersion.HTTP_1_1, HttpStatus.SC_OK, "OK");  
  2. response.addHeader("Set-Cookie", "c1=a; path=/; domain=localhost");  
  3. response.addHeader("Set-Cookie", "c2=b; path=\"/\", c3=c; domain=\"localhost\"");  
  4. Header h1 = response.getFirstHeader("Set-Cookie");  
  5. System.out.println(h1);  
  6. Header h2 = response.getLastHeader("Set-Cookie");  
  7. System.out.println(h2);  
  8. Header[] hs = response.getHeaders("Set-Cookie");  
  9. System.out.println(hs.length);  

输出：

[java]  view plain  copy
  1. Set-Cookie: c1=a; path=/; domain=localhost  
  2. Set-Cookie: c2=b; path="/", c3=c; domain="localhost"  
  3. 2  

获取所有指定headers的最高效的方式是使用HeaderIterator接口。

[java]  view plain  copy
  1. HttpResponse response = new BasicHttpResponse(HttpVersion.HTTP_1_1, HttpStatus.SC_OK, "OK");  
  2. response.addHeader("Set-Cookie", "c1=a; path=/; domain=localhost");  
  3. response.addHeader("Set-Cookie", "c2=b; path=\"/\", c3=c; domain=\"localhost\"");  
  4.   
  5. HeaderIterator it = response.headerIterator("Set-Cookie");  
  6.   
  7. while (it.hasNext()) {  
  8.     System.out.println(it.next());  
  9. }  

输出：

[java]  view plain  copy
  1. Set-Cookie: c1=a; path=/; domain=localhost  
  2. Set-Cookie: c2=b; path="/", c3=c; domain="localhost"  

该接口同时也提供HTTP消息转换到独立header元素的便利方法。

[java]  view plain  copy
  1. HttpResponse response = new BasicHttpResponse(HttpVersion.HTTP_1_1, HttpStatus.SC_OK, "OK");  
  2. response.addHeader("Set-Cookie", "c1=a; path=/; domain=localhost");  
  3. response.addHeader("Set-Cookie", "c2=b; path=\"/\", c3=c; domain=\"localhost\"");  
  4.   
  5. HeaderElementIterator it = new BasicHeaderElementIterator(response.headerIterator("Set-Cookie"));  
  6.   
  7. while (it.hasNext()) {  
  8.     HeaderElement elem = it.nextElement();   
  9.     System.out.println(elem.getName() + " = " + elem.getValue());  
  10.     NameValuePair[] params = elem.getParameters();  
  11.     for (int i = 0; i < params.length; i++) {  
  12.         System.out.println(" " + params[i]);  
  13.     }  
  14. }  

输出：

[java]  view plain  copy
  1. c1 = a  
  2. path=/  
  3. domain=localhost  
  4. c2 = b  
  5. path=/  
  6. c3 = c  
  7. domain=localhost  

1.1.4 HTTP entity

HTTP消息可以携带跟request和response相关联的content entity。由于这些Entity是可选的，所以他们在某些request和response中可以查找到，有些则查不到。使用了entity的request被称为entity封装请求，HTTP定义了两种entity封装请求方法：POST 和 PUT。Response通常会封装一个content entity。不同的方法会有对应的异常，比如对于HEAD来说就有204 No Content,304 Not Modified, 205 Reset Content异常。

HttpClient根据内容来源将Entities区分为3种，根据内容来源区分为：

streamed: 内容来自于流或者实时产生。特别的是，这个分类包含了从HTTP responses接收到的entities，Streamed entities通常不可重复。

self-contained: 内容来自于内存或者通过独立于connection或者其他entity的手段获得，self-contained entities通常可以重复，其也是封装了entity的HTTP request最常用的Entities类型。

wrapping : 内容来自于其他的entity。

这种区分对于HTTP response输出内容时的连接管理是非常重要的。对于request entites来说，由于其是被应用创建并且通过HttpClient发送，streamed和self-contained有什么不同就没有那么重要。

由此，建议将不可重复的entites视为streamed，可以重复的entities视为self-contained。


1.1.4.1 可重复的entities

一个entity能够重复，表明它的内容可以被读取多次，这种情况只会在self contained entities中发生（比如ByteArrayEntity 或者 StringEntity）


1.1.4.2 使用HTTP entities

Entity可以同时代表二进制和文字内容，支持对字符进行编码，比如对character content进行编码。

Entity产生于request（封装内容 ）执行时，或者request成功请求并且response body用于发送结果数据到客户端时。

从Entity中读取内容，可以通过HttpEntity#getContent()获取input stream，也可以向HttpEntity#writeTo(OutputStream)提供一个output stream，该方法会将内容一次性全部写回给指派的stream。

当消息到达并且Entity已经被接收时，可以用 HttpEntity#getContentType() 和 HttpEntity#getContentLength() 方法读取常用的元数据，如Content-Type 和 Content-Length 头信息，Content-Type头信息包含文本的mime-type编码信息如 text/plain 或者 text/html，该信息可以通过 HttpEntity#getContentType() 获取到，如果Header里面不包含这些信息，那么 HttpEntity#getContentLength()  会返回-1 并且  HttpEntity#getContentType()  返回 NULL，如果Header包含这些信息，那么 HttpEntity#getContentType() 会返回 Header 对象。

当创建一个出站消息的entity时，必须同时指定其相关的参数。

[java]  view plain  copy
  1. StringEntity myEntity = new StringEntity("important message",   
  2.    ContentType.create("text/plain", "UTF-8"));  
  3.   
  4. System.out.println(myEntity.getContentType());  
  5. System.out.println(myEntity.getContentLength());  
  6. System.out.println(EntityUtils.toString(myEntity));  
  7. System.out.println(EntityUtils.toByteArray(myEntity).length);  

输出：

[java]  view plain  copy
  1. Content-Type: text/plain; charset=utf-8  
  2. 17  
  3. important message  
  4. 17  

1.1.5 确保释放低级资源

为了保证恰当的释放系统资源，使用完毕后必须关闭entity相关的stream和response。

[java]  view plain  copy
  1. CloseableHttpClient httpclient = HttpClients.createDefault();  
  2. HttpGet httpget = new HttpGet("http://localhost/");  
  3. CloseableHttpResponse response = httpclient.execute(httpget);  
  4. try {  
  5.     HttpEntity entity = response.getEntity();  
  6.     if (entity != null) {  
  7.         InputStream instream = entity.getContent();  
  8.         try {  
  9.             // do something useful  
  10.         } finally {  
  11.             instream.close();  
  12.         }  
  13.     }  
  14. } finally {  
  15.     response.close();  
  16. }  

关闭内容流和关闭response的不同之处在于，关闭内容流会尝试通过消费entity的content来保持底层连接，而关闭response则是直接关闭和丢弃掉这个连接。

注意 HttpEntity#writeTo(OutputStream)  方法也需要在entity被写出到流之后恰当的释放系统资源。如果通过HttpEntity#getContent()获取了java.io.InputStream流的实例，那么在finally阶段也需要关闭该流。

当处理streaming entites时，可以使用 EntityUtils#consume(HttpEntity) 方法来确保entity内容已经被完全消费并且底层stream已经被关闭。

有另一种情况是，当我们只需要从response content里面获取一小部分数据，但是消费剩余数据和保持连接复用的性能损失又太高时，我们可以直接关闭response。

[java]  view plain  copy
  1. CloseableHttpClient httpclient = HttpClients.createDefault();  
  2. HttpGet httpget = new HttpGet("http://localhost/");  
  3. CloseableHttpResponse response = httpclient.execute(httpget);  
  4. try {  
  5.     HttpEntity entity = response.getEntity();  
  6.     if (entity != null) {  
  7.         InputStream instream = entity.getContent();  
  8.         int byteOne = instream.read();  
  9.         int byteTwo = instream.read();  
  10.         // Do not need the rest  
  11.     }  
  12. } finally {  
  13.     response.close();  
  14. }  

这样这个连接不会被复用，连接的所有资源都会被正确的释放掉。


1.1.6 消费entity内容

消费Entity内容的推荐方式是使用 HttpEntity#getContent() 或者 HttpEntity#writeTo(OuptputStream) 方法，也可以使用EntityUtils类，该类提供了一些静态方法来简化读取Entity内容或者其他信息。通过使用该类的某些方法，你可以以String /byte[] 方式来获取整个content body，从而替代直接读取 InputStream 的方式。但是，除非你知道response entity来自于可信HTTP server 并且其长度有限，否则不推荐使用EntityUtils。

[java]  view plain  copy
  1. CloseableHttpClient httpclient = HttpClients.createDefault();  
  2. HttpGet httpget = new HttpGet("http://localhost/");  
  3. CloseableHttpResponse response = httpclient.execute(httpget);  
  4. try {  
  5.     HttpEntity entity = response.getEntity();  
  6.     if (entity != null) {  
  7.         long len = entity.getContentLength();  
  8.         if (len != -1 && len < 2048) {  
  9.             System.out.println(EntityUtils.toString(entity));  
  10.         } else {  
  11.             // Stream content out  
  12.         }  
  13.     }  
  14. } finally {  
  15.     response.close();  
  16. }  

某些情况下你可能读取entity content不止一次，这时就需要将内容通过内存或者磁盘的方式缓存起来，最简单的实现方式就是使用BufferedHttpEntity包装源Entity，该类会将源 Entity 的内容读取到内存中。如果通过其他方式来实现，那么就必须要保存一个源entity了。

[java]  view plain  copy
  1. CloseableHttpResponse response = <...>  
  2. HttpEntity entity = response.getEntity();  
  3. if (entity != null) {  
  4.     entity = new BufferedHttpEntity(entity);  
  5. }  

1.1.7 生产 entity content

HttpClient提供多个可以通过HTTP连接高效的输出内容的类，这些类的实例可以跟POST和PUT等request相关联并且为request封装entity内容，HttpClient提供了最常用的数据容器如string, byte array , input stream 和文件 ： StringEntity , ByteArrayEntity,InputStreamEntity,和FileEntity。

[java]  view plain  copy
  1. File file = new File("somefile.txt");  
  2. FileEntity entity = new FileEntity(file,   
  3.     ContentType.create("text/plain", "UTF-8"));          
  4.   
  5. HttpPost httppost = new HttpPost("http://localhost/action.do");  
  6. httppost.setEntity(entity);  

注意 InputStreamEntity 不可以重复，因为它只能从底层数据流读取一次。通常建议用HttpEntity的实现（self-contained）来替代普通的InputStreamEntity，FileEntity是一个不错的起始点。


1.1.7.1 HTML表单

许多应用程序需要模拟表单提交的过程，比如登录web应用或者提交input 数据，HttpClient提供了UrlEncodedFormEntity类来简化这个过程。

[java]  view plain  copy
  1. List<NameValuePair> formparams = new ArrayList<NameValuePair>();  
  2. formparams.add(new BasicNameValuePair("param1", "value1"));  
  3. formparams.add(new BasicNameValuePair("param2", "value2"));  
  4. UrlEncodedFormEntity entity = new UrlEncodedFormEntity(formparams, Consts.UTF_8);  
  5. HttpPost httppost = new HttpPost("http://localhost/handler.do");  
  6. httppost.setEntity(entity);  

UrlEncodedFormEntity实例会使用URL encoding来编码参数并且产生出如下内容：

[java]  view plain  copy
  1. param1=value1¶m2=value2  

1.1.7.2 内容分块

通常来说，建议让HttpClient选择最合适的传输编码，HttpClient选择的传输编码会基于被传输的HTTP消息的属性而定。你可以通过设置HttpEntity#setChunked()为true来通知HttpClient需要进行chunk编码。注意HttpClient只是把这一标识当做一个提示使用，该值在不支持chunk编码的HTTP协议版本中如HTTP/1.0中会被忽略。

[java]  view plain  copy
  1. StringEntity entity = new StringEntity("important message",  
  2.         ContentType.create("plain/text", Consts.UTF_8));  
  3. entity.setChunked(true);  
  4. HttpPost httppost = new HttpPost("http://localhost/acrtion.do");  
  5. httppost.setEntity(entity);  

1.1.8 Response handlers

最简单和方便处理response的方式是使用ResponseHandler，该类包含了handleResponse(HttpResponse response)方法。该方法使得用户完全不需要去操心连接管理的事情。当使用ResponseHandler时，HttpClient会自动确保将连接释放回连接管理器，无论request是否执行成功。

[java]  view plain  copy
  1. CloseableHttpClient httpclient = HttpClients.createDefault();  
  2. HttpGet httpget = new HttpGet("http://localhost/json");  
  3.   
  4. ResponseHandler<MyJsonObject> rh = new ResponseHandler<MyJsonObject>() {  
  5.   
  6.     @Override  
  7.     public JsonObject handleResponse(  
  8.             final HttpResponse response) throws IOException {  
  9.         StatusLine statusLine = response.getStatusLine();  
  10.         HttpEntity entity = response.getEntity();  
  11.         if (statusLine.getStatusCode() >= 300) {  
  12.             throw new HttpResponseException(  
  13.                     statusLine.getStatusCode(),  
  14.                     statusLine.getReasonPhrase());  
  15.         }  
  16.         if (entity == null) {  
  17.             throw new ClientProtocolException("Response contains no content");  
  18.         }  
  19.         Gson gson = new GsonBuilder().create();  
  20.         ContentType contentType = ContentType.getOrDefault(entity);  
  21.         Charset charset = contentType.getCharset();  
  22.         Reader reader = new InputStreamReader(entity.getContent(), charset);  
  23.         return gson.fromJson(reader, MyJsonObject.class);  
  24.     }  
  25. };  
  26. MyJsonObject myjson = client.execute(httpget, rh); 
【HttpClient】HttpClient4.5基础教程
df0128的专栏
10-14 1万+
一、前言 1、说明 HttpClient是一个目前最常用的用于模拟客户端发送http请求的工具，可用于接口自动化测试或者爬虫或者在项目中加入获取其他网站数据等； 支持目前所有的请求方式，如put，post，get，delete等； 2、maven依赖添加 maven依赖如下： &amp;amp;amp;lt;dependency&amp;amp;amp;gt; &amp;amp;amp;lt;groupId&amp;amp;amp;gt;org.apache.ht
HttpClient4.5 入门
更新博客
06-30 815
引言 本文主要记录如何初始化HttpClient4.5.x和入门使用. 参考官方文档 http://hc.apache.org/httpcomponents-client-4.5.x/current/tutorial/html/ 1. 构建HttpClient 1.1 构建前准备 在构建之前, 先大致了解一下HttpClient类 HttpClient子类 DecompressingHttpClient: HttpClient装饰器类, 支持解压逻辑. AutoRetryHttpClient: Http
Apache HttpClient使用
最新发布
qq_60275529的博客
03-25 1526
Apache HttpClient 是一个开源的 Java HTTP 客户端库，支持 HTTP/1.1 和 HTTP/2 协议。它提供了丰富的功能，例如：发送 GET、POST、PUT、DELETE 等 HTTP 请求。处理 HTTP 请求和响应的头部、状态码、实体等。支持连接池、重试机制、代理、SSL/TLS 等高级功能。
httpClient 教程
Now . Or Never ``
09-04 2783
HttpClient 教程 (一) 前言 超文本传输协议（HTTP）也许是当今互联网上使用的最重要的协议了。Web服务，有网络功能的设备和网络计算的发展，都持续扩展了HTTP协议的角色，超越了用户使用的Web浏览器范畴，同时，也增加了需要HTTP协议支持的应用程序的数量。 尽管java.net包提供了基本通过HTTP访问资源的功能，但它没有提供全面的灵活性和其
HttpClient 4.3教程
不知所云的专栏
05-06 9415
前言 Http协议应该是互联网中最重要的协议。持续增长的web服务、可联网的家用电器等都在继承并拓展着Http协议，向着浏览器之外的方向发展。 虽然jdk中的java.net包中提供了一些基本的方法，通过http协议来访问网络资源，但是大多数场景下，它都不够灵活和强大。HttpClient致力于填补这个空白，它可以提供有效的、最新的、功能丰富的包来实现http客户端。 为了拓展，
HttpClient4.5教程-序言
子沭的博客
03-04 837
超文本传输协议（HTTP）是当今Internet上最值得关注的协议，随着HTTP应用数量的增加，WEB服务，网络设备和网络计算量的增长对HTTP普及的推动作用已经超过了用户使用的浏览器。 尽管java.net包已经提供了一些HTTP访问网络资源的基本功能，但是在许多应用看来，它并不灵活而且功能也不强大。在这种情况下 HTTPCLIENT诞生了，它提供了一系列高效，最新并且功能丰富的包来填补了这一
httpclient-4.5.jar
06-14
《深入理解HTTPClient 4.5及其依赖》 在Java编程世界中，HTTPClient是一个非常重要的库，它允许开发者执行HTTP请求并处理响应。本文将深入探讨`httpclient-4.5.jar`这个包，以及它所依赖的相关jar包，帮助你更好地...
httpclient4.5.zip
08-01
此外，HttpClient 4.5还支持HTTP/1.1和HTTP/2协议，确保了与现代Web服务器的兼容性。 HttpClient 4.5包含以下几个关键组件： 1. `httpclient-4.5.jar`：这是HttpClient的主要库，包含了执行HTTP请求的所有核心类和...
httpclient-4.5所需jar包.zip
08-25
4. **全面的HTTP/1.1支持**：HttpClient 4.5完全支持HTTP/1.1规范，包括各种请求方法（GET、POST、PUT等）、头信息和状态码。 5. **HTTP/2支持**：虽然HTTP/2标准相对较新，但HttpClient 4.5已对其进行部分支持，...
【HttpClient4.5中文教程】【第一章 ：基础】1.2 HttpClient接口
Ryan Z 的技术日志
10-29 566
原文：http://blog.csdn.net/u011179993/article/details/47251909 更多HttpClient4.5中文教程请查看目录：点击打开链接 =================================================== 1.2.HttpClient接口 HttpClient代表HTT
httpclient教程
02-20
httpclient教程
httpclient使用教程
12-25
httpclient使用教程
httpClient4.5.1教程
12-13
httpClient4.5.1教程 httpClient4.5.1教程 httpClient4.5.1教程
httpclient4.5.4 开发文档
01-11
httpclient4.5.4 开发文档 超文本传输协议(HTTP)或许是最重要的互联网上使用的协议。Web服务、网络功能和网络计算的增长继续扩展HTTP协议的作用超出用户的Web浏览器、应用数量的增加，需要支持HTTP。 尽管net包提供基本功能，用于经由HTTP访问的资源，它不能提供充分的灵活性或功能所需的许多应用。HttpClient寻求填补这个空隙通过提供高效的、最新的、功能丰富的封装和实现与客户机侧HTTP的最新标准和建议。 设计用于扩展而提供坚固的支撑基座的HTTP协议，HttpClient感兴趣的任何人可构建HTTP-察觉的客户端应用诸如web浏览器、web服务客户端或系统，或利用扩展HTTP协议用于分布式通信。
httpclient官网教程中文版
03-28
httpclient官网教程中文版，这是根据官方文档翻译的doc文件，带有目录
【HttpClient4.5中文教程】十.HttpClient连接管理2
要啥自行车
01-14 5832
4.请求执行的多线程当配备连接池管理器时，比如 PoolingClientConnectionManager， HttpClient 可以被用使用多线程来同时执行多个请求。PoolingClientConnectionManager将会基于它的配置来分配连接。如果对于给定路由的所有连接都被使用了，那么连接的请求将会阻塞，直到一个连接被释放回连接池。 它可以通过设置'http.conn-manage
【HttpClient4.5中文教程】二.构建开发环境
热门推荐
要啥自行车
07-29 1万+
本系列教程使用maven开发，依赖为：  org.apache.httpcomponents httpclient 4.5.4
HttpClient4.5中文教程
cpzhanghao的博客
08-06 2345
https://blog.csdn.net/column/details/httpclient.html
HttpClient4.5组件：完整资源文件与使用教程
本文将详细介绍HttpClient4.5组件的各个方面。 ### HttpClient4.5组件概述 HttpClient4.5组件作为Apache HttpComponents项目的一部分，是一个专门用于发送HTTP请求并处理HTTP响应的客户端库。这一组件是构建于其他...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值