2024年1月15日发(作者:)
httpclient使用详解
Http协议的重要性相信不用我多说了,HttpClient相比传统JDK自带的URLConnection,增加了易用性和灵活性(具体区别,日后我们再讨论),它不仅是客户端发送Http请求变得容易,而且也方便了开发人员测试接口(基于Http协议的),即提高了开发的效率,也方便提高代码的健壮性。因此熟练掌握HttpClient是很重要的必修内容,掌握HttpClient后,相信对于Http协议的了解会更加深入。
一、简介
HttpClient是Apache Jakarta Common下的子项目,用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包,并且它支持HTTP协议最新的版本和建议。HttpClient已经应用在很多的项目中,比如Apache Jakarta上很著名的另外两个开源项目Cactus和HTMLUnit都使用了HttpClient。
下载地址: /
二、特性
1. 基于标准、纯净的Java语言。实现了Http1.0和Http1.1
2. 以可扩展的面向对象的结构实现了Http全部的方法(GET, POST, PUT, DELETE, HEAD, OPTIONS, and TRACE)。
3. 支持HTTPS协议。
4. 通过Http代理建立透明的连接。
5. 利用CONNECT方法通过Http代理建立隧道的https连接。
6. Basic, Digest, NTLMv1, NTLMv2, NTLM2 Session, SNPNEGO/Kerberos认证方案。
7. 插件式的自定义认证方案。
8. 便携可靠的套接字工厂使它更容易的使用第三方解决方案。
9. 连接管理器支持多线程应用。支持设置最大连接数,同时支持设置每个主机的最大连接数,发现并关闭过期的连接。
10. 自动处理Set-Cookie中的Cookie。
11. 插件式的自定义Cookie策略。
12. Request的输出流可以避免流中内容直接缓冲到socket服务器。
13. Response的输入流可以有效的从socket服务器直接读取相应内容。
14. 在http1.0和http1.1中利用KeepAlive保持持久连接。
15. 直接获取服务器发送的response code和 headers。
16. 设置连接超时的能力。
17. 实验性的支持http1.1 response caching。
18. 源代码基于Apache License 可免费获取。
三、使用方法
使用HttpClient发送请求、接收响应很简单,一般需要如下几步即可。
1. 创建HttpClient对象。
2. 创建请求方法的实例,并指定请求URL。如果需要发送GET请求,创建HttpGet对象;如果需要发送POST请求,创建HttpPost对象。
3. 如果需要发送请求参数,可调用HttpGet、HttpPost共同的setParams(HetpParams params)方法来添加请求参数;对于HttpPost对象而言,也可调用setEntity(HttpEntity entity)方法来设置请求参数。
4. 调用HttpClient对象的execute(HttpUriRequest request)发送请求,该方法返回一个HttpResponse。
5. 调用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可获取服务器的响应头;调用HttpResponse的getEntity()方法可获取HttpEntity对象,该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
1 / 8
6. 释放连接。无论执行方法是否成功,都必须释放连接
四、实例
1. package ;
2.
3. import ;
4. import putStream;
5. import ption;
6. import ortedEncodingException;
7. import agementException;
8. import re;
9. import reException;
10. import AlgorithmException;
11. import icateException;
12. import ist;
13. import ;
14.
15. import text;
16.
17. import tity;
18. import luePair;
19. import xception;
20. import ProtocolException;
21. import odedFormEntity;
22. import bleHttpResponse;
23. import t;
24. import st;
25. import nectionSocketFactory;
26. import texts;
27. import elfSignedStrategy;
28. import tType;
29. import artEntityBuilder;
30. import dy;
31. import Body;
32. import bleHttpClient;
33. import ients;
34. import ameValuePair;
35. import Utils;
36. import ;
37.
38. public class HttpClientTest {
2 / 8
39.
40. @Test
41. public void jUnitTest() {
42. get();
43. }
44.
45. /**
46. * HttpClient连接SSL
47. */
48. public void ssl() {
49. CloseableHttpClient httpclient = null;
50. try {
51. KeyStore trustStore = tance(aultType());
52. FileInputStream instream = new FileInputStream(new File("d:re"));
53. try {
54. // 加载keyStore d:re
55. (instream, "123456".toCharArray());
56. } catch (CertificateException e) {
57. tackTrace();
58. } finally {
59. try {
60. ();
61. } catch (Exception ignore) {
62. }
63. }
64. // 相信自己的CA和所有自签名的证书
65. SSLContext sslcontext = ().loadTrustMaterial(trustStore, new TrustSelfSignedStrategy()).build();
66. // 只允许使用TLSv1协议
67. SSLConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(sslcontext, new String[] {
"TLSv1" }, null,
68. R_COMPATIBLE_HOSTNAME_VERIFIER);
69. httpclient = ().setSSLSocketFactory(sslsf).build();
70. // 创建http请求(get方式)
71. HttpGet httpget = new HttpGet("localhost:8443/myDemo/Ajax/");
72. n("executing request" + uestLine());
73. CloseableHttpResponse response = e(httpget);
74. try {
75. HttpEntity entity = ity();
76. n("----------------------------------------");
77. n(tusLine());
3 / 8
78. if (entity != null) {
79. n("Response content length: " + tentLength());
80. n(ng(entity));
81. e(entity);
82. }
83. } finally {
84. ();
85. }
86. } catch (ParseException e) {
87. tackTrace();
88. } catch (IOException e) {
89. tackTrace();
90. } catch (KeyManagementException e) {
91. tackTrace();
92. } catch (NoSuchAlgorithmException e) {
93. tackTrace();
94. } catch (KeyStoreException e) {
95. tackTrace();
96. } finally {
97. if (httpclient != null) {
98. try {
99. ();
100. } catch (IOException e) {
101. tackTrace();
102. }
103. }
104. }
105. }
106.
107. /**
108. * post方式提交表单(模拟用户登录请求)
109. */
110. public void postForm() {
111. // 创建默认的httpClient实例.
112. CloseableHttpClient httpclient = Default();
113. // 创建httppost
114. HttpPost httppost = new HttpPost("localhost:8080/myDemo/Ajax/");
115. // 创建参数队列
116. List
117. (new BasicNameValuePair("username", "admin"));
118. (new BasicNameValuePair("password", "123456"));
4 / 8
119. UrlEncodedFormEntity uefEntity;
120. try {
121. uefEntity = new UrlEncodedFormEntity(formparams, "UTF-8");
122. ity(uefEntity);
123. n("executing request " + ());
124. CloseableHttpResponse response = e(httppost);
125. try {
126. HttpEntity entity = ity();
127. if (entity != null) {
128. n("--------------------------------------");
129. n("Response content: " + ng(entity, "UTF-8"));
130. n("--------------------------------------");
131. }
132. } finally {
133. ();
134. }
135. } catch (ClientProtocolException e) {
136. tackTrace();
137. } catch (UnsupportedEncodingException e1) {
138. tackTrace();
139. } catch (IOException e) {
140. tackTrace();
141. } finally {
142. // 关闭连接,释放资源
143. try {
144. ();
145. } catch (IOException e) {
146. tackTrace();
147. }
148. }
149. }
150.
151. /**
152. * 发送 post请求访问本地应用并根据传递参数不同返回不同结果
153. */
154. public void post() {
155. // 创建默认的httpClient实例.
156. CloseableHttpClient httpclient = Default();
157. // 创建httppost
158. HttpPost httppost = new HttpPost("localhost:8080/myDemo/Ajax/");
159. // 创建参数队列
5 / 8
160. List
161. (new BasicNameValuePair("type", "house"));
162. UrlEncodedFormEntity uefEntity;
163. try {
164. uefEntity = new UrlEncodedFormEntity(formparams, "UTF-8");
165. ity(uefEntity);
166. n("executing request " + ());
167. CloseableHttpResponse response = e(httppost);
168. try {
169. HttpEntity entity = ity();
170. if (entity != null) {
171. n("--------------------------------------");
172. n("Response content: " + ng(entity, "UTF-8"));
173. n("--------------------------------------");
174. }
175. } finally {
176. ();
177. }
178. } catch (ClientProtocolException e) {
179. tackTrace();
180. } catch (UnsupportedEncodingException e1) {
181. tackTrace();
182. } catch (IOException e) {
183. tackTrace();
184. } finally {
185. // 关闭连接,释放资源
186. try {
187. ();
188. } catch (IOException e) {
189. tackTrace();
190. }
191. }
192. }
193.
194. /**
195. * 发送 get请求
196. */
197. public void get() {
198. CloseableHttpClient httpclient = Default();
199. try {
200. // 创建httpget.
6 / 8
201. HttpGet httpget = new HttpGet("/");
202. n("executing request " + ());
203. // 执行get请求.
204. CloseableHttpResponse response = e(httpget);
205. try {
206. // 获取响应实体
207. HttpEntity entity = ity();
208. n("--------------------------------------");
209. // 打印响应状态
210. n(tusLine());
211. if (entity != null) {
212. // 打印响应内容长度
213. n("Response content length: " + tentLength());
214. // 打印响应内容
215. n("Response content: " + ng(entity));
216. }
217. n("------------------------------------");
218. } finally {
219. ();
220. }
221. } catch (ClientProtocolException e) {
222. tackTrace();
223. } catch (ParseException e) {
224. tackTrace();
225. } catch (IOException e) {
226. tackTrace();
227. } finally {
228. // 关闭连接,释放资源
229. try {
230. ();
231. } catch (IOException e) {
232. tackTrace();
233. }
234. }
235. }
236.
237. /**
238. * 上传文件
239. */
240. public void upload() {
241. CloseableHttpClient httpclient = Default();
7 / 8
242. try {
243. HttpPost httppost = new HttpPost("localhost:8080/myDemo/Ajax/");
244.
245. FileBody bin = new FileBody(new File("F:"));
246. StringBody comment = new StringBody("A binary file of some kind", _PLAIN);
247.
248. HttpEntity reqEntity = ().addPart("bin", bin).addPart("comment", comment).build();
249.
250. ity(reqEntity);
251.
252. n("executing request " + uestLine());
253. CloseableHttpResponse response = e(httppost);
254. try {
255. n("----------------------------------------");
256. n(tusLine());
257. HttpEntity resEntity = ity();
258. if (resEntity != null) {
259. n("Response content length: " + tentLength());
260. }
261. e(resEntity);
262. } finally {
263. ();
264. }
265. } catch (ClientProtocolException e) {
266. tackTrace();
267. } catch (IOException e) {
268. tackTrace();
269. } finally {
270. try {
271. ();
272. } catch (IOException e) {
273. tackTrace();
274. }
275. }
276. }
277.}
本实例是采用HttpClient4.3最新版本。该版本与之前的代码写法风格相差较大,大家多留意下。
本文作者:wangpeng
8 / 8


发布评论