HttpClient 4.0封装工具类是怎样的

2023-06-09

这篇文章将为大家详细讲解有关HttpClient 4.0封装工具类是怎样的,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。

以下为本人在实际开发过程中封装的HttpClient工具类,HttpClient 4 较之 HttpClient 3 的变动较大,尤其是在SSL方面,包结构已经改得面目全非, 不过使用HttpClient 4 的SSL 及数字证书的双向认证方面更为清晰及简单了。[@more@]

/*

* @{#} HttpclientUtil.java

*

* Pingzonglangji.com Inc.

*

* Copyright (c) 2008-2009 All Rights Reserved.

*/

package com.pingzonglangji.common.net;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.io.InputStream;

import java.io.UnsupportedEncodingException;

import java.net.URL;

import java.security.KeyManagementException;

import java.security.KeyStore;

import java.security.KeyStoreException;

import java.security.NoSuchAlgorithmException;

import java.security.UnrecoverableKeyException;

import java.security.cert.CertificateException;

import java.util.ArrayList;

import java.util.List;

import java.util.Map;

import javax.net.ssl.SSLHandshakeException;

import org.apache.http.HttpEntity;

import org.apache.http.HttpEntityEnclosingRequest;

import org.apache.http.HttpException;

import org.apache.http.HttpRequest;

import org.apache.http.HttpResponse;

import org.apache.http.HttpVersion;

import org.apache.http.NameValuePair;

import org.apache.http.NoHttpResponseException;

import org.apache.http.client.ClientProtocolException;

import org.apache.http.client.HttpClient;

import org.apache.http.client.HttpRequestRetryHandler;

import org.apache.http.HttpRequestInterceptor;

import org.apache.http.client.ResponseHandler;

import org.apache.http.client.entity.UrlEncodedFormEntity;

import org.apache.http.client.methods.HttpGet;

import org.apache.http.client.methods.HttpPost;

import org.apache.http.client.methods.HttpRequestBase;

import org.apache.http.client.utils.URLEncodedUtils;

import org.apache.http.conn.scheme.Scheme;

import org.apache.http.conn.ssl.SSLSocketFactory;

import org.apache.http.impl.client.DefaultHttpClient;

import org.apache.http.message.BasicNameValuePair;

import org.apache.http.params.CoreProtocolPNames;

import org.apache.http.protocol.ExecutionContext;

import org.apache.http.protocol.HttpContext;

import org.apache.http.util.EntityUtils;

import com.pingzonglangji.common.lang.StringUtil;

/**

* Apache Httpclient 4.0 工具包装类

*

* @author shezy

*/

@SuppressWarnings("all")

public class HttpclientUtil {

private static final String CHARSET_UTF8 = "UTF-8";

private static final String CHARSET_GBK = "GBK";

private static final String SSL_DEFAULT_SCHEME = "https";

private static final int SSL_DEFAULT_PORT = 443;

// 异常自动恢复处理, 使用HttpRequestRetryHandler接口实现请求的异常恢复

private static HttpRequestRetryHandler requestRetryHandler = new HttpRequestRetryHandler() {

// 自定义的恢复策略

public boolean retryRequest(IOException exception, int executionCount, HttpContext context) {

// 设置恢复策略,在发生异常时候将自动重试3次

if (executionCount >= 3) {

// Do not retry if over max retry count

return false;

}

if (exception instanceof NoHttpResponseException) {

// Retry if the server dropped connection on us

return true;

}

if (exception instanceof SSLHandshakeException) {

// Do not retry on SSL handshake exception

return false;

}

HttpRequest request = (HttpRequest) context.getAttribute(ExecutionContext.HTTP_REQUEST);

boolean idempotent = (request instanceof HttpEntityEnclosingRequest);

if (!idempotent) {

// Retry if the request is considered idempotent

return true;

}

return false;

}

};

// 使用ResponseHandler接口处理响应,HttpClient使用ResponseHandler会自动管理连接的释放,解决了对连接的释放管理

private static ResponseHandlerresponseHandler = new ResponseHandler() {

// 自定义响应处理

public String handleResponse(HttpResponse response)throws ClientProtocolException, IOException {

HttpEntity entity = response.getEntity();

if (entity != null) {

String charset = EntityUtils.getContentCharSet(entity) == null ? CHARSET_GBK : EntityUtils.getContentCharSet(entity);

return new String(EntityUtils.toByteArray(entity), charset);

} else {

return null;

}

}

};

/**

* Get方式提交,URL中包含查询参数, 格式:http://www.g.cn?search=p&name=s.....

*

* @param url

*            提交地址

* @return 响应消息

*/

public static String get(String url) {

return get(url, null, null);

}

/**

* Get方式提交,URL中不包含查询参数, 格式:http://www.g.cn

*

* @param url

*            提交地址

* @param params

*            查询参数集, 键/值对

* @return 响应消息

*/

public static String get(String url, Mapparams) {

return get(url, params, null);

}

/**

* Get方式提交,URL中不包含查询参数, 格式:http://www.g.cn

*

* @param url

*            提交地址

* @param params

*            查询参数集, 键/值对

* @param charset

*            参数提交编码集

* @return 响应消息

*/

public static String get(String url, Mapparams, String charset) {

if (url == null || StringUtil.isEmpty(url)) {

return null;

}

Listqparams = getParamsList(params);

if (qparams != null && qparams.size() > 0) {

charset = (charset == null ? CHARSET_GBK : charset);

String formatParams = URLEncodedUtils.format(qparams, charset);

url = (url.indexOf("?")) < 0 ? (url + "?" + formatParams) : (url

.substring(0, url.indexOf("?") + 1) + formatParams);

}

DefaultHttpClient httpclient = getDefaultHttpClient(charset);

HttpGet hg = new HttpGet(url);

// 发送请求,得到响应

String responseStr = null;

try {

responseStr = httpclient.execute(hg, responseHandler);

} catch (ClientProtocolException e) {

throw new NetServiceException("客户端连接协议错误", e);

} catch (IOException e) {

throw new NetServiceException("IO操作异常", e);

}  finally {

abortConnection(hg, httpclient);

}

return responseStr;

}

/**

* Post方式提交,URL中不包含提交参数, 格式:http://www.g.cn

*

* @param url

*            提交地址

* @param params

*            提交参数集, 键/值对

* @return 响应消息

*/

public static String post(String url, Mapparams) {

return post(url, params, null);

}

/**

* Post方式提交,URL中不包含提交参数, 格式:http://www.g.cn

*

* @param url

*            提交地址

* @param params

*            提交参数集, 键/值对

* @param charset

*            参数提交编码集

* @return 响应消息

*/

public static String post(String url, Mapparams, String charset) {

if (url == null || StringUtil.isEmpty(url)) {

return null;

}

// 创建HttpClient实例

DefaultHttpClient httpclient = getDefaultHttpClient(charset);

UrlEncodedFormEntity formEntity = null;

try {

if (charset == null || StringUtil.isEmpty(charset)) {

formEntity = new UrlEncodedFormEntity(getParamsList(params));

} else {

formEntity = new UrlEncodedFormEntity(getParamsList(params), charset);

}

} catch (UnsupportedEncodingException e) {

throw new NetServiceException("不支持的编码集", e);

}

HttpPost hp = new HttpPost(url);

hp.setEntity(formEntity);

// 发送请求,得到响应

String responseStr = null;

try {

responseStr = httpclient.execute(hp, responseHandler);

} catch (ClientProtocolException e) {

throw new NetServiceException("客户端连接协议错误", e);

} catch (IOException e) {

throw new NetServiceException("IO操作异常", e);

} finally {

abortConnection(hp, httpclient);

}

return responseStr;

}

/**

* Post方式提交,忽略URL中包含的参数,解决SSL双向数字证书认证

*

* @param url

*            提交地址

* @param params

*            提交参数集, 键/值对

* @param charset

*            参数编码集

* @param keystoreUrl

*            密钥存储库路径

* @param keystorePassword

*            密钥存储库访问密码

* @param truststoreUrl

*            信任存储库绝路径

* @param truststorePassword

*            信任存储库访问密码, 可为null

* @return 响应消息

* @throws NetServiceException

*/

public static String post(String url, Mapparams, String charset, final URL keystoreUrl,

final String keystorePassword, final URL truststoreUrl,final String truststorePassword) {

if (url == null || StringUtil.isEmpty(url)) {

return null;

}

DefaultHttpClient httpclient = getDefaultHttpClient(charset);

UrlEncodedFormEntity formEntity = null;

try {

if (charset == null || StringUtil.isEmpty(charset)) {

formEntity = new UrlEncodedFormEntity(getParamsList(params));

} else {

formEntity = new UrlEncodedFormEntity(getParamsList(params), charset);

}

} catch (UnsupportedEncodingException e) {

throw new NetServiceException("不支持的编码集", e);

}

HttpPost hp = null;

String responseStr = null;

try {

KeyStore keyStore = createKeyStore(keystoreUrl, keystorePassword);

KeyStore trustStore = createKeyStore(truststoreUrl, keystorePassword);

SSLSocketFactory socketFactory = new SSLSocketFactory(keyStore,keystorePassword, trustStore);

Scheme scheme = new Scheme(SSL_DEFAULT_SCHEME, socketFactory, SSL_DEFAULT_PORT);

httpclient.getConnectionManager().getSchemeRegistry().register(scheme);

hp = new HttpPost(url);

hp.setEntity(formEntity);

responseStr = httpclient.execute(hp, responseHandler);

} catch (NoSuchAlgorithmException e) {

throw new NetServiceException("指定的加密算法不可用", e);

} catch (KeyStoreException e) {

throw new NetServiceException("keytore解析异常", e);

} catch (CertificateException e) {

throw new NetServiceException("信任证书过期或解析异常", e);

} catch (FileNotFoundException e) {

throw new NetServiceException("keystore文件不存在", e);

} catch (IOException e) {

throw new NetServiceException("I/O操作失败或中断  ", e);

} catch (UnrecoverableKeyException e) {

throw new NetServiceException("keystore中的密钥无法恢复异常", e);

} catch (KeyManagementException e) {

throw new NetServiceException("处理密钥管理的操作异常", e);

} finally {

abortConnection(hp, httpclient);

}

return responseStr;

}

/**

* 获取DefaultHttpClient实例

*

* @param charset

*            参数编码集, 可空

* @return DefaultHttpClient 对象

*/

private static DefaultHttpClient getDefaultHttpClient(final String charset){

DefaultHttpClient httpclient = new DefaultHttpClient();

httpclient.getParams().setParameter(CoreProtocolPNames.PROTOCOL_VERSION, HttpVersion.HTTP_1_1);

//模拟浏览器,解决一些服务器程序只允许浏览器访问的问题

httpclient.getParams().setParameter(CoreProtocolPNames.USER_AGENT, "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)");

httpclient.getParams().setParameter(CoreProtocolPNames.USE_EXPECT_CONTINUE, Boolean.FALSE);

httpclient.getParams().setParameter(CoreProtocolPNames.HTTP_CONTENT_CHARSET, charset == null ? CHARSET_GBK : charset);

httpclient.setHttpRequestRetryHandler(requestRetryHandler);

return httpclient;

}

/**

* 释放HttpClient连接

*

* @param hrb

*            请求对象

* @param httpclient

*   client对象

*/

private static void abortConnection(final HttpRequestBase hrb, final HttpClient httpclient){

if (hrb != null) {

hrb.abort();

}

if (httpclient != null) {

httpclient.getConnectionManager().shutdown();

}

}

/**

* 从给定的路径中加载此 KeyStore

*

* @param url

*            keystore URL路径

* @param password

*            keystore访问密钥

* @return keystore 对象

*/

private static KeyStore createKeyStore(final URL url, final String password)

throws KeyStoreException, NoSuchAlgorithmException,CertificateException, IOException {

if (url == null) {

throw new IllegalArgumentException("Keystore url may not be null");

}

KeyStore keystore = KeyStore.getInstance(KeyStore.getDefaultType());

InputStream is = null;

try {

is = url.openStream();

keystore.load(is, password != null ? password.toCharArray() : null);

} finally {

if (is != null){

is.close();

is = null;

}

}

return keystore;

}

/**

* 将传入的键/值对参数转换为NameValuePair参数集

*

* @param paramsMap

*            参数集, 键/值对

* @return NameValuePair参数集

*/

private static ListgetParamsList(MapparamsMap) {

if (paramsMap == null || paramsMap.size() == 0) {

return null;

}

Listparams = new ArrayList();

for (Map.Entrymap : paramsMap.entrySet()) {

params.add(new BasicNameValuePair(map.getKey(), map.getValue()));

}

return params;

}

}

关于HttpClient 4.0封装工具类是怎样的就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

《HttpClient 4.0封装工具类是怎样的.doc》

下载本文的Word格式文档,以方便收藏与打印。