com.gitee.qdbp.tools.http

类 HttpTools

java.lang.Object

com.gitee.qdbp.tools.http.HttpTools

直接已知子类:

HttpTools.HttpFormImpl, HttpTools.HttpJsonImpl

public abstract class HttpTools
extends Object

HTTP请求工具类

作者:

zhaohuihua

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HttpTools.HttpFormImpl 以application/x-www-form-urlencoded的方式提交请求参数
static class	HttpTools.HttpJsonImpl 以application/json的方式提交请求参数

字段概要

字段

限定符和类型	字段和说明
protected Charset	charset
protected org.apache.http.entity.ContentType	contentType
static HttpTools	form
protected IHttpHandler	httpHandler
static HttpTools	json

构造器概要

构造器

构造器和说明
HttpTools()
HttpTools(IHttpHandler httpHandler)

方法概要

限定符和类型	方法和说明
protected void	addParam(org.apache.http.entity.mime.MultipartEntityBuilder builder, String key, Object value, List<KeyString> logs)
ResponseMessage	execute(HttpUrl hurl) 执行远程请求
<P> ResponseMessage	execute(HttpUrl hurl, Map<String,P> params) 执行远程请求
protected <P> Map<String,Object>	fillBaseParams(HttpUrl hurl, Map<String,P> params) 填充基础参数, 如填充配置信息在的公共参数/计算摘要等操作
String	get(String url) 发送GET请求 注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!
<P> String	get(String url, Map<String,P> params) 发送GET请求 注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!
<T> List<T>	list(HttpUrl hurl, Class<T> type) 执行远程请求并返回对象列表
<T,P> List<T>	list(HttpUrl hurl, Map<String,Object> params, Class<T> type) 执行远程请求并返回对象列表
protected void	onAfterExecute(org.apache.http.HttpMessage hm, org.apache.http.HttpResponse resp) 发送请求后的操作
protected void	onBeforeExecute(org.apache.http.HttpMessage hm) 发送请求前设置header参数等操作
protected ResponseMessage	parseResult(HttpUrl hurl, String string)
String	post(String url) 发送POST请求 注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!
<P> String	post(String url, Map<String,P> params) 发送POST请求 注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!
<T> T	query(HttpUrl hurl, Class<T> type) 执行远程请求并返回指定对象
<T,P> T	query(HttpUrl hurl, Map<String,P> params, Class<T> type) 执行远程请求并返回指定对象
protected String	responseToString(org.apache.http.HttpResponse resp) 获取响应文本
protected abstract <P> void	setGetParams(org.apache.http.client.utils.URIBuilder builder, Map<String,P> params) 设置GET参数
void	setHttpHandler(IHttpHandler httpHandler)
protected abstract <P> void	setPostParams(org.apache.http.client.methods.HttpPost method, Map<String,P> params, List<KeyString> logs) 设置POST参数
protected abstract <P> void	setUploadParams(org.apache.http.client.methods.HttpPost method, Map<String,P> params, List<KeyString> logs) 设置文件上传参数 这种方式提交的参数, Filter无法获取到, 只有通过Controller才能获取到, 因为是以二进制流的方式提交的
protected String	toLogString(String key, Object value, List<KeyString> logs)
protected String	toParamString(List<KeyString> logs)
<P> ResponseMessage	upload(HttpUrl hurl, Map<String,P> params) 文件上传
<P> String	upload(String url, Map<String,P> params) 文件上传 注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!

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

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

字段详细资料

form

public static final HttpTools form

json

public static final HttpTools json

httpHandler

protected IHttpHandler httpHandler

charset

protected Charset charset

contentType

protected org.apache.http.entity.ContentType contentType

构造器详细资料

HttpTools

public HttpTools()

HttpTools

public HttpTools(IHttpHandler httpHandler)

方法详细资料

setHttpHandler

public void setHttpHandler(IHttpHandler httpHandler)

execute

public ResponseMessage execute(HttpUrl hurl)
                        throws HttpException

执行远程请求

参数:

hurl - 请求地址和请求方法

返回:

响应结果

抛出:

HttpException

execute

public <P> ResponseMessage execute(HttpUrl hurl,
                                   Map<String,P> params)
                            throws HttpException

执行远程请求

参数:

hurl - 请求地址和请求方法

params - 请求参数

返回:

响应结果

抛出:

HttpException

query

public <T> T query(HttpUrl hurl,
                   Class<T> type)
            throws HttpException

执行远程请求并返回指定对象

参数:

hurl - 请求地址和请求方法

type - 结果类型

返回:

响应结果对象

抛出:

HttpException

query

public <T,P> T query(HttpUrl hurl,
                     Map<String,P> params,
                     Class<T> type)
              throws HttpException

执行远程请求并返回指定对象

参数:

hurl - 请求地址和请求方法

params - 请求参数

type - 结果类型

返回:

响应结果对象

抛出:

HttpException

list

public <T> List<T> list(HttpUrl hurl,
                        Class<T> type)
                 throws HttpException

执行远程请求并返回对象列表

参数:

hurl - 请求地址和请求方法

type - 结果类型

返回:

对象列表

抛出:

HttpException

list

public <T,P> List<T> list(HttpUrl hurl,
                          Map<String,Object> params,
                          Class<T> type)
                   throws HttpException

执行远程请求并返回对象列表

参数:

hurl - 请求地址和请求方法

params - 请求参数

type - 结果类型

返回:

对象列表

抛出:

HttpException

parseResult

protected ResponseMessage parseResult(HttpUrl hurl,
                                      String string)
                               throws RemoteServiceException,
                                      Exception

抛出:

RemoteServiceException

Exception

fillBaseParams

protected <P> Map<String,Object> fillBaseParams(HttpUrl hurl,
                                                Map<String,P> params)

填充基础参数, 如填充配置信息在的公共参数/计算摘要等操作

参数:

hurl - 请求地址

params - 业务参数

返回:

业务参数+基础参数

get

public String get(String url)
           throws HttpException

发送GET请求
注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!

参数:

url - 请求地址

返回:

响应字符串

抛出:

ServiceException

HttpException

post

public String post(String url)
            throws HttpException

发送POST请求
注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!

参数:

url - 请求地址

返回:

响应字符串

抛出:

ServiceException

HttpException

get

public <P> String get(String url,
                      Map<String,P> params)
               throws HttpException

发送GET请求
注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!

参数:

url - 请求地址

params - 请求参数

返回:

响应字符串

抛出:

ServiceException

HttpException

post

public <P> String post(String url,
                       Map<String,P> params)
                throws HttpException

发送POST请求
注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!

参数:

url - 请求地址

params - 请求参数

返回:

响应字符串

抛出:

ServiceException

HttpException

upload

public <P> String upload(String url,
                         Map<String,P> params)
                  throws HttpException

文件上传
注意, 这里的请求参数和响应报文都没有经过HttpHandler处理!

参数:

url - 请求地址

files - 文件

params - 请求参数

返回:

响应字符串

抛出:

ServiceException

HttpException

upload

public <P> ResponseMessage upload(HttpUrl hurl,
                                  Map<String,P> params)
                           throws HttpException

文件上传

参数:

hurl - 请求地址和请求方法

params - 请求参数

返回:

响应结果

抛出:

HttpException

setGetParams

protected abstract <P> void setGetParams(org.apache.http.client.utils.URIBuilder builder,
                                         Map<String,P> params)

设置GET参数

参数:

builder -

params -

setPostParams

protected abstract <P> void setPostParams(org.apache.http.client.methods.HttpPost method,
                                          Map<String,P> params,
                                          List<KeyString> logs)

设置POST参数

参数:

method -

params -

setUploadParams

protected abstract <P> void setUploadParams(org.apache.http.client.methods.HttpPost method,
                                            Map<String,P> params,
                                            List<KeyString> logs)

设置文件上传参数
这种方式提交的参数, Filter无法获取到, 只有通过Controller才能获取到, 因为是以二进制流的方式提交的

参数:

method -

params -

addParam

protected void addParam(org.apache.http.entity.mime.MultipartEntityBuilder builder,
                        String key,
                        Object value,
                        List<KeyString> logs)

toParamString

protected String toParamString(List<KeyString> logs)

toLogString

protected String toLogString(String key,
                             Object value,
                             List<KeyString> logs)

onBeforeExecute

protected void onBeforeExecute(org.apache.http.HttpMessage hm)

发送请求前设置header参数等操作

onAfterExecute

protected void onAfterExecute(org.apache.http.HttpMessage hm,
                              org.apache.http.HttpResponse resp)

发送请求后的操作

responseToString

protected String responseToString(org.apache.http.HttpResponse resp)
                           throws org.apache.http.ParseException,
                                  IOException

获取响应文本

抛出:

org.apache.http.ParseException

IOException