com.hynnet.util

类 HttpClientUtils

java.lang.Object

com.hynnet.util.HttpClientUtils

public class HttpClientUtils
extends java.lang.Object

HttpClient简化编程工具类。

作者:

hyn

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HttpClientUtils.HttpClientException Http客户端异常类。
static class	HttpClientUtils.HttpResult Http请求结果类。

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_CONNECT_TIMEOUT 默认连接超时（秒），默认10秒。
static int	DEFAULT_REQUEST_TIMEOUT 默认请求超时（秒）默认180秒。
static int	DEFAULT_SOCKET_TIMEOUT 默认Socket超时（秒），默认60秒。
static int	MAX_CONN 设置整个连接池最大连接数。
static int	MAX_EXECUT_COUNT 连接丢失后,重试次数。
static int	SINGLE_ROUTE_MAX_CONN 设置单个路由默认连接数。

构造器概要

构造器

构造器和说明
HttpClientUtils() 构造函数。
HttpClientUtils(org.apache.http.client.CookieStore cookieStore, java.lang.String encoding, java.lang.String userAgent, java.lang.String referer) 构造函数。
HttpClientUtils(java.lang.String cookieStoreFile, java.lang.String encoding, java.lang.String userAgent, java.lang.String referer) 构造函数。

方法概要

方法

限定符和类型	方法和说明
void	addHeader(java.lang.String name, java.lang.String value) 添加请求的头信息。
int	getConnectTimeout() 获取连接超时秒数。
java.lang.String	getData(java.lang.String url) GET方式获取指定URL的网页数据。
void	getDownloadFile(java.lang.String url, java.io.File file) 通过GET方式下载文件。
org.apache.http.Header[]	getHeaders() 获取所有预置头信息。
org.apache.http.client.HttpClient	getHttpClient() 从连接池获取HttpClient获取连接。
static org.apache.http.client.HttpClient	getHttpClient(org.apache.http.client.CookieStore cookieStore) 从连接池获取HttpClient获取连接。
static org.apache.http.client.HttpClient	getHttpClient(org.apache.http.client.CookieStore cookieStore, int connectTimeout, int requestTimeout, int socketTimeout) 从连接池获取HttpClient获取连接。
java.lang.String	getReferer() 获取当前的来源地址（自动设置为上次请求的地址）。
int	getRequestTimeout() 获取请求超时秒数。
int	getSocketTimeout() 获取Socket超时秒数。
java.lang.String	head(java.lang.String url) HEAD方式获取指定URL的头数据。
static java.lang.String	httpGetData(org.apache.http.client.HttpClient httpClient, java.lang.String url) 获取http的字符串数据。
static java.lang.String	httpGetData(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.lang.String encoding) 获取http的字符串数据。
static java.lang.String	httpGetData(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.lang.String encoding, org.apache.http.Header[] headers, HttpClientSignInterface signer) 获取http的字符串数据。
static java.lang.String	httpGetData(java.lang.String url) 获取http的字符串数据。
static void	httpGetDownloadFile(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.io.File file) 下载文件。
static void	httpGetDownloadFile(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.io.File file, org.apache.http.Header[] headers, HttpClientSignInterface signer, int connectTimeout, int requestTimeout, int socketTimeout) 下载文件。
static void	httpGetDownloadFile(java.lang.String url, java.io.File file) 下载文件。
static HttpClientUtils.HttpResult	httpGetResult(org.apache.http.client.HttpClient httpClient, java.lang.String url, org.apache.http.Header[] headers, HttpClientSignInterface signer, int connectTimeout, int requestTimeout, int socketTimeout) 获取http的处理结果。
HttpClientUtils.HttpResult	httpGetResult(java.lang.String url) GET方式获取指定URL的请求结果。
static HttpClientUtils.HttpResult	httpGetResult(java.lang.String url, org.apache.http.Header[] headers) 获取http的处理结果。
static HttpClientUtils.HttpResult	httpHeadResult(org.apache.http.client.HttpClient httpClient, java.lang.String url, org.apache.http.Header[] headers, HttpClientSignInterface signer, int connectTimeout, int requestTimeout, int socketTimeout) 获取指定地址的头信息。
static HttpClientUtils.HttpResult	httpHeadResult(java.lang.String url, org.apache.http.Header[] headers) 获取指定地址的头信息。
static java.lang.String	httpPostData(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.util.List<java.lang.String[]> datas) 提交数据到指定地址。
static java.lang.String	httpPostData(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.util.List<java.lang.String[]> datas, java.lang.String encoding) 提交数据到指定地址。
static java.lang.String	httpPostData(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.util.List<java.lang.String[]> datas, java.lang.String encoding, org.apache.http.Header[] headers, HttpClientSignInterface signer) 提交数据到指定地址。
static java.lang.String	httpPostData(java.lang.String url, java.util.List<java.lang.String[]> datas) 提交数据到指定地址。
static void	httpPostDownloadFile(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.util.List<java.lang.String[]> datas, java.lang.String encoding, java.io.File file) 下载文件。
static void	httpPostDownloadFile(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.util.List<java.lang.String[]> datas, java.lang.String encoding, java.io.File file, org.apache.http.Header[] headers, HttpClientSignInterface signer) 下载文件。
static void	httpPostDownloadFile(java.lang.String url, java.util.List<java.lang.String[]> datas, java.lang.String encoding, java.io.File file) 下载文件。
static HttpClientUtils.HttpResult	httpPostResult(org.apache.http.client.HttpClient httpClient, java.lang.String url, java.util.List<java.lang.String[]> datas, java.lang.String encoding, org.apache.http.Header[] headers, HttpClientSignInterface signer, int connectTimeout, int requestTimeout, int socketTimeout) 提交数据到指定地址。
static HttpClientUtils.HttpResult	httpPostResult(java.lang.String url, java.util.List<java.lang.String[]> datas, java.lang.String encoding, org.apache.http.Header[] headers, HttpClientSignInterface signer) 提交数据到指定地址。
static void	InstallCert(java.lang.String url) 安装指定URL的SSL证书。
java.lang.String	postData(java.lang.String url, java.util.List<java.lang.String[]> datas) POST提交数据到指定地址。
void	postDownloadFile(java.lang.String url, java.util.List<java.lang.String[]> datas, java.io.File file) POST方式提交数据后下载文件。
boolean	saveCookieStore() 保存Cookie存储到文件。
boolean	saveCookieStore(java.lang.String cookieStoreFile) 保存Cookie存储到指定文件。
void	setConnectTimeout(int connectTimeout) 设置连接超时秒数。
void	setEncoding(java.lang.String encoding) 设置字符编码。
void	setRequestTimeout(int requestTimeout) 设置请求超时秒数。
void	setSigner(HttpClientSignInterface signer) 设置签名对象。
void	setSocketTimeout(int socketTimeout) 设置Socket超时秒数。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_CONNECT_TIMEOUT

public static int DEFAULT_CONNECT_TIMEOUT

默认连接超时（秒），默认10秒。

DEFAULT_REQUEST_TIMEOUT

public static int DEFAULT_REQUEST_TIMEOUT

默认请求超时（秒）默认180秒。

DEFAULT_SOCKET_TIMEOUT

public static int DEFAULT_SOCKET_TIMEOUT

默认Socket超时（秒），默认60秒。

MAX_CONN

public static int MAX_CONN

设置整个连接池最大连接数。默认300。

SINGLE_ROUTE_MAX_CONN

public static int SINGLE_ROUTE_MAX_CONN

设置单个路由默认连接数。默认100。

MAX_EXECUT_COUNT

public static int MAX_EXECUT_COUNT

连接丢失后,重试次数。默认0。

构造器详细资料

HttpClientUtils

public HttpClientUtils()

构造函数。 获取工具类实例。实例可以保存链接状态等。

HttpClientUtils

public HttpClientUtils(org.apache.http.client.CookieStore cookieStore,
               java.lang.String encoding,
               java.lang.String userAgent,
               java.lang.String referer)

构造函数。 获取工具类实例。实例可以保存链接状态等。

参数:

cookieStore -

encoding -

userAgent -

referer -

HttpClientUtils

public HttpClientUtils(java.lang.String cookieStoreFile,
               java.lang.String encoding,
               java.lang.String userAgent,
               java.lang.String referer)

构造函数。 获取工具类实例。实例可以保存链接状态等。

参数:

cookieStoreFile -

encoding -

userAgent -

referer -

方法详细资料

getHttpClient

public final org.apache.http.client.HttpClient getHttpClient()

从连接池获取HttpClient获取连接。

返回:

addHeader

public void addHeader(java.lang.String name,
             java.lang.String value)

添加请求的头信息。

参数:

name -

value -

getHeaders

public org.apache.http.Header[] getHeaders()

获取所有预置头信息。

返回:

getHttpClient

public static final org.apache.http.client.HttpClient getHttpClient(org.apache.http.client.CookieStore cookieStore)

从连接池获取HttpClient获取连接。需要保存连接状态时使用此方法获取http连接。

参数:

cookieStore - cookie存储对象。

返回:

getHttpClient

public static final org.apache.http.client.HttpClient getHttpClient(org.apache.http.client.CookieStore cookieStore,
                                              int connectTimeout,
                                              int requestTimeout,
                                              int socketTimeout)

从连接池获取HttpClient获取连接。需要保存连接状态时使用此方法获取http连接。

参数:

cookieStore - cookie存储对象。

connectTimeout - 连接超时秒数。

requestTimeout - 请求超时秒数（等待服务器处理的时长）。

socketTimeout - Socket超时秒数。

返回:

httpGetData

public static final java.lang.String httpGetData(java.lang.String url)
                                          throws HttpClientUtils.HttpClientException

获取http的字符串数据。

参数:

url -

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpGetData

public static final java.lang.String httpGetData(org.apache.http.client.HttpClient httpClient,
                           java.lang.String url)
                                          throws HttpClientUtils.HttpClientException

获取http的字符串数据。

参数:

httpClient - HttpClient连接对象。

url -

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpGetData

public static final java.lang.String httpGetData(org.apache.http.client.HttpClient httpClient,
                           java.lang.String url,
                           java.lang.String encoding)
                                          throws HttpClientUtils.HttpClientException

获取http的字符串数据。

参数:

httpClient - HttpClient连接对象。

url - 请求的地址。

encoding - 字符编码。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpGetData

public static final java.lang.String httpGetData(org.apache.http.client.HttpClient httpClient,
                           java.lang.String url,
                           java.lang.String encoding,
                           org.apache.http.Header[] headers,
                           HttpClientSignInterface signer)
                                          throws HttpClientUtils.HttpClientException

获取http的字符串数据。

参数:

httpClient - HttpClient连接对象。

url - 请求的地址。

encoding - 字符编码。

headers - 头信息。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpGetResult

public static final HttpClientUtils.HttpResult httpGetResult(java.lang.String url,
                                       org.apache.http.Header[] headers)
                                                      throws HttpClientUtils.HttpClientException

获取http的处理结果。
连接请求从默认连接池获取。

参数:

url - 请求的地址。

headers - 头信息。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpGetResult

public static final HttpClientUtils.HttpResult httpGetResult(org.apache.http.client.HttpClient httpClient,
                                       java.lang.String url,
                                       org.apache.http.Header[] headers,
                                       HttpClientSignInterface signer,
                                       int connectTimeout,
                                       int requestTimeout,
                                       int socketTimeout)
                                                      throws HttpClientUtils.HttpClientException

获取http的处理结果。

参数:

httpClient - HttpClient连接对象。

url - 请求的地址。

headers - 头信息。

signer - 签名加密对象。

connectTimeout - 连接超时秒数。

requestTimeout - 请求超时秒数（等待服务器处理的时长）。

socketTimeout - Socket超时秒数。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpHeadResult

public static final HttpClientUtils.HttpResult httpHeadResult(org.apache.http.client.HttpClient httpClient,
                                        java.lang.String url,
                                        org.apache.http.Header[] headers,
                                        HttpClientSignInterface signer,
                                        int connectTimeout,
                                        int requestTimeout,
                                        int socketTimeout)
                                                       throws HttpClientUtils.HttpClientException

获取指定地址的头信息。

参数:

httpClient -

url -

headers -

signer -

connectTimeout - 连接超时秒数。

requestTimeout - 请求超时秒数（等待服务器处理的时长）。

socketTimeout - Socket超时秒数。

返回:

抛出:

HttpClientUtils.HttpClientException

httpHeadResult

public static final HttpClientUtils.HttpResult httpHeadResult(java.lang.String url,
                                        org.apache.http.Header[] headers)
                                                       throws HttpClientUtils.HttpClientException

获取指定地址的头信息。
连接请求从默认连接池获取。

参数:

url - 请求的地址。

headers - 头信息。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpGetDownloadFile

public static final void httpGetDownloadFile(org.apache.http.client.HttpClient httpClient,
                       java.lang.String url,
                       java.io.File file)
                                      throws HttpClientUtils.HttpClientException

下载文件。

参数:

httpClient - HttpClient连接对象。

url -

file -

抛出:

HttpClientUtils.HttpClientException

httpGetDownloadFile

public static final void httpGetDownloadFile(org.apache.http.client.HttpClient httpClient,
                       java.lang.String url,
                       java.io.File file,
                       org.apache.http.Header[] headers,
                       HttpClientSignInterface signer,
                       int connectTimeout,
                       int requestTimeout,
                       int socketTimeout)
                                      throws HttpClientUtils.HttpClientException

下载文件。

参数:

httpClient - HttpClient连接对象。

url -

file -

headers -

signer -

connectTimeout - 连接超时秒数。

requestTimeout - 请求超时秒数（等待服务器处理的时长）。

socketTimeout - Socket超时秒数。

抛出:

HttpClientUtils.HttpClientException

httpGetDownloadFile

public static final void httpGetDownloadFile(java.lang.String url,
                       java.io.File file)
                                      throws HttpClientUtils.HttpClientException

下载文件。

参数:

url -

file -

抛出:

HttpClientUtils.HttpClientException

httpPostDownloadFile

public static final void httpPostDownloadFile(org.apache.http.client.HttpClient httpClient,
                        java.lang.String url,
                        java.util.List<java.lang.String[]> datas,
                        java.lang.String encoding,
                        java.io.File file)
                                       throws HttpClientUtils.HttpClientException

下载文件。

参数:

httpClient - HttpClient连接对象。

url -

file -

抛出:

HttpClientUtils.HttpClientException

httpPostDownloadFile

public static final void httpPostDownloadFile(org.apache.http.client.HttpClient httpClient,
                        java.lang.String url,
                        java.util.List<java.lang.String[]> datas,
                        java.lang.String encoding,
                        java.io.File file,
                        org.apache.http.Header[] headers,
                        HttpClientSignInterface signer)
                                       throws HttpClientUtils.HttpClientException

下载文件。

参数:

httpClient - HttpClient连接对象。

url -

file -

抛出:

HttpClientUtils.HttpClientException

httpPostDownloadFile

public static final void httpPostDownloadFile(java.lang.String url,
                        java.util.List<java.lang.String[]> datas,
                        java.lang.String encoding,
                        java.io.File file)
                                       throws HttpClientUtils.HttpClientException

下载文件。

参数:

url -

file -

抛出:

HttpClientUtils.HttpClientException

httpPostData

public static final java.lang.String httpPostData(java.lang.String url,
                            java.util.List<java.lang.String[]> datas)
                                           throws HttpClientUtils.HttpClientException

提交数据到指定地址。

参数:

url -

datas -

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpPostData

public static final java.lang.String httpPostData(org.apache.http.client.HttpClient httpClient,
                            java.lang.String url,
                            java.util.List<java.lang.String[]> datas)
                                           throws HttpClientUtils.HttpClientException

提交数据到指定地址。

参数:

httpClient - HttpClient连接对象。

url -

datas - 列表每个元素为一组表单参数。元素为字符串数组，数组的第一个值为表单参数名称，第二个值为表单参数值。
当要提交无名称的数据时， 应该参数为大小为1的列表对象，列表的元素为第一个字符串为null，第二个字符串为数据的字符串数组。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpPostData

public static final java.lang.String httpPostData(org.apache.http.client.HttpClient httpClient,
                            java.lang.String url,
                            java.util.List<java.lang.String[]> datas,
                            java.lang.String encoding)
                                           throws HttpClientUtils.HttpClientException

提交数据到指定地址。

参数:

httpClient - HttpClient连接对象。

url -

datas - 列表每个元素为一组表单参数。元素为字符串数组，数组的第一个值为表单参数名称，第二个值为表单参数值。
当要提交无名称的数据时， 应该参数为大小为1的列表对象，列表的元素为第一个字符串为null，第二个字符串为数据的字符串数组。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpPostData

public static final java.lang.String httpPostData(org.apache.http.client.HttpClient httpClient,
                            java.lang.String url,
                            java.util.List<java.lang.String[]> datas,
                            java.lang.String encoding,
                            org.apache.http.Header[] headers,
                            HttpClientSignInterface signer)
                                           throws HttpClientUtils.HttpClientException

提交数据到指定地址。

参数:

httpClient - HttpClient连接对象。

url -

datas - 列表每个元素为一组表单参数。元素为字符串数组，数组的第一个值为表单参数名称，第二个值为表单参数值。
当要提交无名称的数据时， 应该参数为大小为1的列表对象，列表的元素为第一个字符串为null，第二个字符串为数据的字符串数组。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpPostResult

public static final HttpClientUtils.HttpResult httpPostResult(java.lang.String url,
                                        java.util.List<java.lang.String[]> datas,
                                        java.lang.String encoding,
                                        org.apache.http.Header[] headers,
                                        HttpClientSignInterface signer)
                                                       throws HttpClientUtils.HttpClientException

提交数据到指定地址。

参数:

url - 添加的地址。

datas - 列表每个元素为一组表单参数。元素为字符串数组，数组的第一个值为表单参数名称，第二个值为表单参数值。
当要提交无名称的数据时， 应该参数为大小为1的列表对象，列表的元素为第一个字符串为null，第二个字符串为数据的字符串数组。

encoding - 字符编码。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

httpPostResult

public static final HttpClientUtils.HttpResult httpPostResult(org.apache.http.client.HttpClient httpClient,
                                        java.lang.String url,
                                        java.util.List<java.lang.String[]> datas,
                                        java.lang.String encoding,
                                        org.apache.http.Header[] headers,
                                        HttpClientSignInterface signer,
                                        int connectTimeout,
                                        int requestTimeout,
                                        int socketTimeout)
                                                       throws HttpClientUtils.HttpClientException

提交数据到指定地址。

参数:

httpClient - HttpClient连接对象。

url - 提交的地址。

datas - 列表每个元素为一组表单参数。元素为字符串数组，数组的第一个值为表单参数名称，第二个值为表单参数值。
当要提交无名称的数据时， 应该参数为大小为1的列表对象，列表的元素为第一个字符串为null，第二个字符串为数据的字符串数组。

encoding - 字符编码。

headers - 头信息。

signer - 签名加密对象。

connectTimeout - 连接超时秒数。

requestTimeout - 请求超时秒数（等待服务器处理的时长）。

socketTimeout - Socket超时秒数。

返回:

返回字符串数据，发生异常返回null。

抛出:

HttpClientUtils.HttpClientException

InstallCert

public static final void InstallCert(java.lang.String url)

安装指定URL的SSL证书。
证书存储访问密码通过 System.setProperty("KeyStore.password", newPassword) 设置。

参数:

url -

saveCookieStore

public boolean saveCookieStore()

保存Cookie存储到文件。

返回:

saveCookieStore

public boolean saveCookieStore(java.lang.String cookieStoreFile)

保存Cookie存储到指定文件。

参数:

cookieStoreFile -

返回:

getReferer

public java.lang.String getReferer()

获取当前的来源地址（自动设置为上次请求的地址）。

返回:

getData

public java.lang.String getData(java.lang.String url)

GET方式获取指定URL的网页数据。

参数:

url -

返回:

httpGetResult

public HttpClientUtils.HttpResult httpGetResult(java.lang.String url)

GET方式获取指定URL的请求结果。

参数:

url -

返回:

head

public java.lang.String head(java.lang.String url)

HEAD方式获取指定URL的头数据。

参数:

url -

返回:

getDownloadFile

public void getDownloadFile(java.lang.String url,
                   java.io.File file)
                     throws HttpClientUtils.HttpClientException

通过GET方式下载文件。

参数:

url -

file -

抛出:

HttpClientUtils.HttpClientException

postData

public java.lang.String postData(java.lang.String url,
                        java.util.List<java.lang.String[]> datas)

POST提交数据到指定地址。

参数:

url -

datas -

返回:

postDownloadFile

public void postDownloadFile(java.lang.String url,
                    java.util.List<java.lang.String[]> datas,
                    java.io.File file)
                      throws HttpClientUtils.HttpClientException

POST方式提交数据后下载文件。

参数:

url -

datas -

file -

抛出:

HttpClientUtils.HttpClientException

setSigner

public void setSigner(HttpClientSignInterface signer)

设置签名对象。

参数:

signer -

setEncoding

public void setEncoding(java.lang.String encoding)

设置字符编码。

参数:

encoding -

getConnectTimeout

public int getConnectTimeout()

获取连接超时秒数。

返回:

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

设置连接超时秒数。
必须在第一次建立连接前修改此参数，否则不会生效。

参数:

connectTimeout -

getRequestTimeout

public int getRequestTimeout()

获取请求超时秒数。

返回:

setRequestTimeout

public void setRequestTimeout(int requestTimeout)

设置请求超时秒数。
必须在第一次建立连接前修改此参数，否则不会生效。

参数:

requestTimeout -

getSocketTimeout

public int getSocketTimeout()

获取Socket超时秒数。

返回:

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

设置Socket超时秒数。
必须在第一次建立连接前修改此参数，否则不会生效。

参数:

socketTimeout -