Http客户端工具类

在平时工作中，我们经常会有请求接口的需求，抽时间总结了一下供大家参考。

依赖包:

1. 
   
2. <dependency>
3. <groupId>org.apache.httpcomponents</groupId>
4. <artifactId>httpclient</artifactId>
5. <version>4.5</version>
6. </dependency>

工具类文件：

1. 
   
2. package com.rz.util;
4. import java.io.IOException;
5. import java.io.UnsupportedEncodingException;
6. import java.net.SocketTimeoutException;
7. import java.net.URI;
8. import java.net.URISyntaxException;
9. import java.net.URL;
10. import java.util.ArrayList;
11. import java.util.List;
12. import java.util.Map;
14. import org.apache.commons.httpclient.HttpStatus;
15. import org.apache.commons.lang3.StringUtils;
16. import org.apache.http.HttpResponse;
17. import org.apache.http.NameValuePair;
18. import org.apache.http.ParseException;
19. import org.apache.http.client.config.RequestConfig;
20. import org.apache.http.client.entity.UrlEncodedFormEntity;
21. import org.apache.http.client.methods.CloseableHttpResponse;
22. import org.apache.http.client.methods.HttpDelete;
23. import org.apache.http.client.methods.HttpGet;
24. import org.apache.http.client.methods.HttpPost;
25. import org.apache.http.client.methods.HttpPut;
26. import org.apache.http.client.utils.URLEncodedUtils;
27. import org.apache.http.entity.StringEntity;
28. import org.apache.http.impl.client.CloseableHttpClient;
29. import org.apache.http.impl.client.HttpClients;
30. import org.apache.http.message.BasicNameValuePair;
31. import org.apache.http.util.EntityUtils;
32. import org.slf4j.Logger;
33. import org.slf4j.LoggerFactory;
35. import com.alibaba.fastjson.JSONObject;
37. /**
38. * HTTP客户端帮助类
39. */
40. public class HttpClientUtil {
41. private static final Logger LOG = LoggerFactory.getLogger(HttpClientUtil.class);
42. public static final String CHAR_SET = "UTF-8";
44. private static CloseableHttpClient httpClient;
45. private static int socketTimeout = 30000;
46. private static int connectTimeout = 30000;
47. private static int connectionRequestTimeout = 30000;
48. // 配置总体最大连接池（maxConnTotal）和单个路由连接最大数（maxConnPerRoute），默认是(20，2)
49. private static int maxConnTotal = 200; // 最大不要超过1000
50. private static int maxConnPerRoute = 100;// 实际的单个连接池大小，如tps定为50，那就配置50
52. static {
53. RequestConfig config = RequestConfig.custom()
54. .setSocketTimeout(socketTimeout)
55. .setConnectTimeout(connectTimeout)
56. .setConnectionRequestTimeout(connectionRequestTimeout).build();
57. httpClient = HttpClients.custom().setDefaultRequestConfig(config)
58. .setMaxConnTotal(maxConnTotal)
59. .setMaxConnPerRoute(maxConnPerRoute).build();
60. }
62. public static CloseableHttpClient getClient() {
63. return httpClient;
64. }
67. public static String get(String url) {
68. try {
69. return get(url, null, null);
70. } catch (IOException e) {
71. LOG.error("HttpClientUtil.get()报错：", e);
72. }
73. return null;
74. }
76. public static String get(String url, Map<String, String> map) {
77. try {
78. return get(url, map, null);
79. } catch (IOException e) {
80. LOG.error("HttpClientUtil.get()报错：", e);
81. }
82. return null;
83. }
85. public static String get(String url, String charset) {
86. try {
87. return get(url, null, charset);
88. } catch (IOException e) {
89. LOG.error("HttpClientUtil.get()报错：", e);
90. }
91. return null;
92. }
94. public static String get(String url, Map<String, String> paramsMap, String charset) throws IOException {
95. if ( StringUtils.isBlank(url) ) {
96. return null;
97. }
98. charset = (charset == null ? CHAR_SET : charset);
99. if (null != paramsMap && !paramsMap.isEmpty()) {
100. List<NameValuePair> params = new ArrayList<NameValuePair>();
101. for (Map.Entry<String, String> map : paramsMap.entrySet()) {
102. params.add(new BasicNameValuePair(map.getKey(), map.getValue()));
103. }
104. //GET方式URL参数编码
105. String querystring = URLEncodedUtils.format(params, charset);
106. if(StringUtils.contains(url, "?")) {
107. url += "&" + querystring;
108. } else {
109. url += "?" + querystring;
110. }
111. }
112. HttpGet httpGet = new HttpGet(url);
113. httpGet.addHeader("Accept-Encoding", "*");
114. CloseableHttpResponse response = null;
115. try {
116. response = getClient().execute(httpGet);
117. } catch (SocketTimeoutException e) {
118. LOG.error("请求超时，1秒后将重试1次："+ url, e);
119. try {
120. Thread.sleep(1000);
121. } catch (InterruptedException e1) { }
122. response = getClient().execute(httpGet);
123. }
124. // 状态不为200的异常处理。
125. return EntityUtils.toString(response.getEntity(), charset);
126. }
129. /**
130. * 提供返回json结果的get请求(ESG专用)
131. * @param url
132. * @param charset
133. * @return
134. * @throws IOException */
135. public static String getResponseJson(String url, Map<String, String> map) {
136. try {
137. return getResponseJson(url, map, null);
138. } catch (IOException e) {
139. LOG.error("HttpClientUtil.getResponseJson()报错：", e);
140. }
141. return null;
142. }
144. public static String getResponseJson(String url, Map<String, String> paramsMap, String charset) throws IOException {
145. if ( StringUtils.isBlank(url) ) {
146. return null;
147. }
148. charset = (charset == null ? CHAR_SET : charset);
149. if (null != paramsMap && !paramsMap.isEmpty()) {
150. List<NameValuePair> params = new ArrayList<NameValuePair>();
151. for (Map.Entry<String, String> map : paramsMap.entrySet()) {
152. params.add(new BasicNameValuePair(map.getKey(), map.getValue()));
153. }
154. //GET方式URL参数编码
155. String querystring = URLEncodedUtils.format(params, charset);
156. if(StringUtils.contains(url, "?")) {
157. url += "&" + querystring;
158. } else {
159. url += "?" + querystring;
160. }
161. }
162. HttpGet httpGet = new HttpGet(url);
163. httpGet.addHeader("Accept-Encoding", "*");
164. httpGet.addHeader("Accept", "application/json;charset=UTF-8");
165. CloseableHttpResponse response = null;
166. try {
167. response = getClient().execute(httpGet);
168. } catch (SocketTimeoutException e) {
169. //LOG.error("请求超时，1秒后将重试1次："+ url, e);
170. LOG.error(e.getMessage()+ "请求超时，1秒后将重试1次："+ url);
171. try {
172. Thread.sleep(1000);
173. } catch (InterruptedException e1) { }
174. response = getClient().execute(httpGet);
175. }
177. // 状态不为200的异常处理。
178. return EntityUtils.toString(response.getEntity(), charset);
179. }
181. public static String delete(String url, Map<String, String> paramsMap, String charset) throws IOException {
182. if ( StringUtils.isBlank(url) ) {
183. return null;
184. }
185. charset = (charset == null ? CHAR_SET : charset);
186. if (null != paramsMap && !paramsMap.isEmpty()) {
187. List<NameValuePair> params = new ArrayList<NameValuePair>();
188. for (Map.Entry<String, String> map : paramsMap.entrySet()) {
189. params.add(new BasicNameValuePair(map.getKey(), map.getValue()));
190. }
191. //GET方式URL参数编码
192. String querystring = URLEncodedUtils.format(params, charset);
193. if(StringUtils.contains(url, "?")) {
194. url += "&" + querystring;
195. } else {
196. url += "?" + querystring;
197. }
198. }
199. HttpDelete httpDelete = new HttpDelete(url);
200. httpDelete.addHeader("Accept-Encoding", "*");
201. CloseableHttpResponse response = getClient().execute(httpDelete);
202. // 状态不为200的异常处理。
203. return EntityUtils.toString(response.getEntity(), charset);
204. }
209. public static String post(String url, String request) {
210. return post(url, request, null);
211. }
213. public static String post(String url, String request, String charset) {
214. if ( StringUtils.isBlank(url) ) {
215. return null;
216. }
217. String res = null;
218. CloseableHttpResponse response = null;
219. try {
220. charset = (charset == null ? CHAR_SET : charset);
221. StringEntity entity = new StringEntity(request, charset);
222. HttpPost httpPost = new HttpPost(url);
223. httpPost.addHeader("Content-Type", "application/json;charset=utf-8");
224. httpPost.addHeader("Accept-Encoding", "*");
225. httpPost.setEntity(entity);
226. try {
227. response = getClient().execute(httpPost);
228. } catch (SocketTimeoutException e) {
229. LOG.error("请求超时，1秒后将重试1次："+ url, e);
230. try {
231. Thread.sleep(1000);
232. } catch (InterruptedException e1) { }
233. response = getClient().execute(httpPost);
234. }
235. res = EntityUtils.toString(response.getEntity());
236. // 状态不为200的异常处理。
237. } catch (ParseException e) {
238. LOG.error("HTTP Post(), ParseException: ", e);
239. } catch (IOException e) {
240. LOG.error("HTTP Post(), IOException: ", e);
241. } finally {
242. if (response != null) {
243. try {
244. response.close();
245. } catch (IOException e) {
246. }
247. }
248. }
249. return res;
250. }
252. public static String post(String url, Map<String, String> map) {
253. return post(url, map, null);
254. }
256. public static String post(String url, Map<String, String> paramsMap, String charset) {
257. if ( StringUtils.isBlank(url) ) {
258. return null;
259. }
260. String res = null;
261. CloseableHttpResponse response = null;
262. try {
263. charset = (charset == null ? CHAR_SET : charset);
264. List<NameValuePair> params = new ArrayList<NameValuePair>();
265. for (Map.Entry<String, String> map : paramsMap.entrySet()) {
266. params.add(new BasicNameValuePair(map.getKey(), map.getValue()));
267. }
268. UrlEncodedFormEntity formEntity = new UrlEncodedFormEntity(params, charset);
269. HttpPost httpPost = new HttpPost(url);
270. httpPost.addHeader("Accept-Encoding", "*");
271. httpPost.setEntity(formEntity);
272. try {
273. response = getClient().execute(httpPost);
274. } catch (SocketTimeoutException e) {
275. LOG.error("请求超时，1秒后将重试1次："+ url, e);
276. try {
277. Thread.sleep(1000);
278. } catch (InterruptedException e1) { }
279. response = getClient().execute(httpPost);
280. }
282. res = EntityUtils.toString(response.getEntity());
283. // 状态不为200的异常处理。
284. if (response.getStatusLine().getStatusCode() != 200) {
285. throw new IOException(res);
286. }
287. } catch (IOException e) {
288. LOG.error("HTTP Post(), IOException: ", e);
289. } finally {
290. if (response != null) {
291. try {
292. response.close();
293. } catch (IOException e) {
294. }
295. }
296. }
297. return res;
298. }
301. /**
302. * 提供返回json结果的post请求
303. * @param url
304. * @param map
305. * @param charset
306. * @return json
307. * @throws IOException */
308. public static String postResponseJson(String url, Map<String, String> map) {
309. return postResponseJson(url, map, null);
310. }
312. /**
313. * Put方式提交
314. * @param url
315. * @param paramsMap
316. * @param charset
317. * @return response.getEntity() */
318. public static String postResponseJson(String url, Map<String, String> paramsMap, String charset) {
319. if ( StringUtils.isBlank(url) ) {
320. return null;
321. }
322. String res = null;
323. CloseableHttpResponse response = null;
324. try {
325. charset = (charset == null ? CHAR_SET : charset);
326. List<NameValuePair> params = new ArrayList<NameValuePair>();
327. for (Map.Entry<String, String> map : paramsMap.entrySet()) {
328. params.add(new BasicNameValuePair(map.getKey(), map.getValue()));
329. }
330. UrlEncodedFormEntity formEntity = new UrlEncodedFormEntity(params, charset);
332. //解决url中的一些特殊字符
333. URI uri = null;
334. HttpPost httpPost = null;
335. try {
336. URL url2 = new URL(url);
337. uri = new URI(url2.getProtocol(), url2.getUserInfo(), url2.getHost(), url2.getPort(), url2.getPath(), url2.getQuery(), null);
338. } catch (URISyntaxException e) {
339. LOG.error("URL中存在非法编码："+ url, e);
340. uri = null;
341. }
342. if(uri != null) {
343. httpPost = new HttpPost( uri );
344. } else {
345. httpPost = new HttpPost( url );
346. }
347. httpPost.addHeader("Accept-Encoding", "*");
348. httpPost.addHeader("Accept", "application/json;charset=UTF-8");
349. httpPost.setEntity(formEntity);
350. try {
351. response = getClient().execute(httpPost);
352. } catch (SocketTimeoutException e) {
353. //LOG.error("请求超时，1秒后将重试1次："+ url, e);
354. LOG.error(e.getMessage()+ "请求超时，1秒后将重试1次："+ url);
355. try {
356. Thread.sleep(1000);
357. } catch (InterruptedException e1) { }
358. response = getClient().execute(httpPost);
359. }
361. res = EntityUtils.toString(response.getEntity());
362. // 状态不为200的异常处理。
363. if (response.getStatusLine().getStatusCode() != 200) {
364. throw new IOException(res);
365. }
366. } catch (IOException e) {
367. LOG.error("postResponseJson方法报错: ", e);
368. } finally {
369. if (response != null) {
370. try {
371. response.close();
372. } catch (IOException e) {
373. }
374. }
375. }
376. return res;
377. }
380. /**
381. * Put方式提交
382. * @param url
383. * @param paramsMap
384. * @param charset
385. * @return response.getEntity() */
386. public static String put(String url, Map<String, String> paramsMap, String charset) {
387. if ( StringUtils.isBlank(url) ) {
388. return null;
389. }
390. String res = null;
391. CloseableHttpResponse response = null;
392. try {
393. charset = (charset == null ? CHAR_SET : charset);
394. List<NameValuePair> params = new ArrayList<NameValuePair>();
395. for (Map.Entry<String, String> map : paramsMap.entrySet()) {
396. params.add(new BasicNameValuePair(map.getKey(), map.getValue()));
397. }
398. UrlEncodedFormEntity formEntity = new UrlEncodedFormEntity(params, charset);
399. HttpPut httpPut = new HttpPut(url);
400. httpPut.addHeader("Accept-Encoding", "*");
401. httpPut.setEntity(formEntity);
402. try {
403. response = getClient().execute(httpPut);
404. } catch (SocketTimeoutException e) {
405. LOG.error("请求超时，1秒后将重试1次："+ url, e);
406. try {
407. Thread.sleep(1000);
408. } catch (InterruptedException e1) { }
409. response = getClient().execute(httpPut);
410. }
412. res = EntityUtils.toString(response.getEntity());
413. // 状态不为200的异常处理。
414. if (response.getStatusLine().getStatusCode() != 200) {
415. throw new IOException(res);
416. }
417. } catch (IOException e) {
418. LOG.error("HTTP put(), IOException: ", e);
419. } finally {
420. if (response != null) {
421. try {
422. response.close();
423. } catch (IOException e) {
424. }
425. }
426. }
427. return res;
428. }
431. /**
432. * Titel 提交HTTP请求，获得响应(application/x-www-form-urlencoded) Description
433. * 使用NameValuePair封装参数，适用于下载文件。
434. * @param serviceURI : 接口地址
435. * @param timeOut : 超时时间
436. * @param params : 请求参数
437. * @param charset : 参数编码
438. * @return CloseableHttpResponse */
439. public static CloseableHttpResponse submitPostHttpReq(final String serviceURI, final int timeOut,
440. final Map<String, String> pmap, final String charset) {
441. CloseableHttpResponse response = null;
442. LOG.info("即将发起HTTP请求！serviceURI：" + serviceURI);
443. // 遍历封装参数
444. List<NameValuePair> formParams = new ArrayList<NameValuePair>();
445. for (String key : pmap.keySet()) {
446. NameValuePair pair = new BasicNameValuePair(key, pmap.get(key));
447. formParams.add(pair);
448. }
449. // 转换为from Entity
450. UrlEncodedFormEntity fromEntity = null;
451. try {
452. fromEntity = new UrlEncodedFormEntity(formParams, CHAR_SET);
453. } catch (UnsupportedEncodingException e) {
454. LOG.error("创建UrlEncodedFormEntity异常，编码问题: " + e.getMessage());
455. return null;
456. }
458. // 创建http post请求
459. HttpPost httpPost = new HttpPost(serviceURI);
460. httpPost.setEntity(fromEntity);
461. // 设置请求和传输超时时间
462. RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(timeOut).setConnectTimeout(timeOut).build();
463. httpPost.setConfig(requestConfig);
465. // 提交请求、获取响应
466. LOG.info("提交http请求！serviceURI：" + serviceURI);
467. CloseableHttpClient httpclient = HttpClients.createDefault();
468. try {
469. response = httpclient.execute(httpPost);
470. } catch (SocketTimeoutException e) {
471. LOG.error("请求超时，1秒后将重试1次："+ serviceURI, e);
472. try {
473. Thread.sleep(1000);
474. response = httpclient.execute(httpPost);
475. } catch (Exception e1) {
476. LOG.error("超时后再次请求报错：", e);
477. response = null;
478. }
479. } catch (IOException e) {
480. LOG.error("httpclient.execute异常！" + e.getMessage());
481. response = null;
482. }
483. LOG.info("提交http请求！serviceURI：" + serviceURI);
484. return response;
485. }
488. public static int getSocketTimeout() {
489. return socketTimeout;
490. }
492. public static void setSocketTimeout(int socketTimeout) {
493. HttpClientUtil.socketTimeout = socketTimeout;
494. }
496. public static int getConnectTimeout() {
497. return connectTimeout;
498. }
500. public static void setConnectTimeout(int connectTimeout) {
501. HttpClientUtil.connectTimeout = connectTimeout;
502. }
504. public static int getConnectionRequestTimeout() {
505. return connectionRequestTimeout;
506. }
508. public static void setConnectionRequestTimeout(int connectionRequestTimeout) {
509. HttpClientUtil.connectionRequestTimeout = connectionRequestTimeout;
510. }
512. /**
513. * 请求josn串，返回josn对象
514. * */
515. public static JSONObject doPost(String url, String jsonStr) {
516. HttpPost post = new HttpPost(url);
517. JSONObject response = null;
518. try {
519. StringEntity s = new StringEntity(jsonStr,"UTF-8");
520. s.setContentType("application/json");// 发送json数据需要设置contentType
521. post.setEntity(s);
522. HttpResponse res = getClient().execute(post);
523. if (res.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
524. String result = EntityUtils.toString(res.getEntity());// 返回json格式：
525. response = JSONObject.parseObject(result);
526. }
527. } catch (Exception e) {
528. throw new RuntimeException(e);
529. }
530. return response;
531. }
532. }

完