在程序的开发过程中,我们经常需要访问第三方接口来获得数据,下面提供一个HttpClient的工具类供大家使用和参考。
1.引入依赖
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.9</version>
</dependency>
<!--如果是异步请求 需要引入的依赖-->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpasyncclient</artifactId>
<version>4.1.4</version>
</dependency>
2.具体实现
@Slf4j
public class HttpClientUtil {
/**
* 配置
*/
private static final RequestConfig config = RequestConfig.custom()
//连接超时时间 单位毫秒
.setConnectTimeout(2000)
//请求超时时间 单位毫秒
.setConnectionRequestTimeout(2000)
// socket 读写超时时间
.setSocketTimeout(1000)
// 是否允许重定向 默认为true
.setRedirectsEnabled(true)
// 是否启用内容压缩 默认为true
.setContentCompressionEnabled(true)
.build();
/**
* 获得Http客户端
*/
private final static CloseableHttpClient HTTP_CLIENT = HttpClientBuilder.create()
//失败重试 默认3次
.setRetryHandler(new DefaultHttpRequestRetryHandler())
.build();
/**
* 异步Http客户端
*/
private final static CloseableHttpAsyncClient HTTP_ASYNC_CLIENT = HttpAsyncClients.custom()
.setDefaultRequestConfig(config)
.build();
/**
* 异步请求
* @param httpRequestBase
*/
private static void executeAsync(final HttpRequestBase httpRequestBase){
HTTP_ASYNC_CLIENT.start();
HTTP_ASYNC_CLIENT.execute(httpRequestBase, new FutureCallback<HttpResponse>() {
@SneakyThrows
@Override
public void completed(HttpResponse httpResponse) {
log.info("thread id is :{}",Thread.currentThread().getId());
StringBuffer stringBuffer = new StringBuffer();
Header[] requestHeaders = httpRequestBase.getAllHeaders();
for (Header header : requestHeaders) {
stringBuffer.append(header.toString()).append(",");
}
log.info("HttpClientUtil executeAsync请求头信息 :{}",stringBuffer.toString());
String result = null;
HttpEntity entity = httpResponse.getEntity();
log.info("HttpClientUtil executeAsync响应状态:{}",httpResponse.getStatusLine().getStatusCode());
if (entity != null){
result = EntityUtils.toString(entity,"UTF-8");
}
log.info("HttpClientUtil executeAsync响应信息:{}",result);
stringBuffer = new StringBuffer();
Header[] responseHeaders = httpResponse.getAllHeaders();
for (Header header : responseHeaders) {
stringBuffer.append(header.toString()).append(",");
}
log.info("HttpClientUtil executeAsync响应头信息 :{}",stringBuffer.toString());
}
@Override
public void failed(Exception e) {
log.info("thread id is :{}",Thread.currentThread().getId());
log.error("HttpClientUtil executeAsync请求失败 :{}",e.getMessage());
}
@Override
public void cancelled() {
log.info(httpRequestBase.getRequestLine() + " cancelled");
}
});
}
/**
* execute请求
* @param httpRequestBase
* @return string
*/
private static String execute(HttpRequestBase httpRequestBase) {
log.info("HttpClientUtil execute请求地址:{},请求类型:{}",httpRequestBase.getURI(),httpRequestBase.getMethod());
log.info("HttpClientUtil execute请求参数信息:{}",httpRequestBase.getURI().getQuery());
StringBuffer stringBuffer = new StringBuffer();
Header[] requestHeaders = httpRequestBase.getAllHeaders();
for (Header header : requestHeaders) {
stringBuffer.append(header.toString()).append(",");
}
log.info("HttpClientUtil execute请求头信息:{}",stringBuffer.toString());
String result = null;
//响应模型
CloseableHttpResponse response = null;
try {
httpRequestBase.setConfig(config);
long startTime = System.currentTimeMillis();
response = HTTP_CLIENT.execute(httpRequestBase);
// 从响应模型中获取响应实体
HttpEntity entity = response.getEntity();
log.info("HttpClientUtil execute响应状态码:{}",response.getStatusLine().getStatusCode());
long endTime = System.currentTimeMillis();
if (entity != null){
result = EntityUtils.toString(entity, "UTF-8");
log.info("HttpClientUtil execute响应信息:{}",result);
}
stringBuffer = new StringBuffer();
Header[] responseHeaders = response.getAllHeaders();
for (Header header : responseHeaders) {
stringBuffer.append(header.toString()).append(",");
}
log.info("HttpClientUtil execute响应头信息:{}",stringBuffer.toString());
log.info("HttpClientUtil execute执行时间:{}",endTime-startTime);
}catch (Exception e){
log.error("HttpClientUtil execute请求失败信息:{}" ,e.getMessage());
}finally {
try {
if (response != null){
response.close();
}
}catch (Exception e){
log.error("HttpClientUtil execute exception result:{}",e.getMessage());
}
}
return result;
}
/**
* 处理get请求
* @param url 地址
* @param params 参数
* @param headers 请求头 header key-value
* @return
*/
public static String doGet(String url,Map<String,Object> params,Map<String,Object> headers){
CloseableHttpResponse response = null;
try {
//1.处理参数
URIBuilder uriBuilder = new URIBuilder(url);
if (params != null && !params.isEmpty()){
for (Object param : params.keySet()) {
uriBuilder.setParameter(param +"",params.get(param)+"");
}
}
HttpGet get = new HttpGet(uriBuilder.build());
log.info("HttpClientUtil-GET>>>>>>>>>>请求:{}",get);
//2.设置请求头信息
if (headers != null && !headers.isEmpty()){
for (Object headerKey : headers.keySet()) {
get.setHeader(String.valueOf(headerKey),String.valueOf(headers.get(headerKey)));
}
}
//3.请求数据
response = HTTP_CLIENT.execute(get);
//4.处理响应信息
String result = null;
if (response != null && response.getStatusLine().getStatusCode() == 200){
result = handleData(response.getEntity().getContent());
}
log.info("HttpClientUtil-GET>>>>>>>>>返回的数据:{}",result);
return result;
}catch (Exception e){
log.info("HttpClientUtil-GET 出错:{}",e.getMessage());
}
return null;
}
/**
* 处理post请求
* @param url 地址
* @param params 参数
* @param headers 请求头 header key-value
* @return
*/
public static String doPost(String url,Map<String,Object> params,Map<String,Object> headers){
HttpResponse response = null;
try {
//1.处理参数
HttpPost post = new HttpPost(url);
JSONObject json = new JSONObject();
if (params != null && !params.isEmpty()){
for (String key : params.keySet()) {
json.put(key,String.valueOf(params.get(key)));
}
}
HttpEntity entity = new StringEntity(json.toString(),"UTF-8");
post.setEntity(entity);
//2.处理请求头信息
if (headers != null && !headers.isEmpty()){
for (String key : headers.keySet()) {
post.setHeader(key,String.valueOf(headers.get(key)));
}
}
log.info("HttpClientUtil-POST>>>>>>>>>>请求:{}",post);
//3.请求数据
response = HTTP_CLIENT.execute(post);
//4.解析数据
String result = null;
if (response != null && response.getStatusLine().getStatusCode() == 200){
result = handleData(response.getEntity().getContent());
}
return result;
}catch (Exception e){
log.info("HttpClientUtil-POST 出错:{}",e.getMessage());
}
return null;
}
/**
* 流对象
* @param is 流
* @return
* @throws Exception
*/
private static String handleData(InputStream is) throws Exception{
int len=0;
//将is字节流,转化为字符流
InputStreamReader reader = new InputStreamReader(is);
//创建StringBuffer对象
char[] buf=new char[1024];
StringBuffer result = new StringBuffer();
while((len=reader.read(buf))!=-1){
result.append(String.valueOf(buf,0,len));
}
reader.close();
return String.valueOf(result);
}
}
3.使用
//get
public class ObjectUtil {
//根据位置获取天气
public static void main(String[] args) {
String path = "http://wthrcdn.etouch.cn/weather_mini";
Map<String,Object> params = new HashMap<>();
params.put("city","北京");
//如果header参数为空传null即可
String s = HttpClientUtil.doGet(path, params, null);
System.out.println(s);
}
}
//结果
{
"data": {
"yesterday": {
"date": "21日星期日",
"high": "高温 25℃",
"fx": "西北风",
"low": "低温 4℃",
"fl": "<![CDATA[2级]]>",
"type": "多云"
},
"city": "北京",
"forecast": [
{
"date": "22日星期一",
"high": "高温 11℃",
"fengli": "<![CDATA[2级]]>",
"low": "低温 0℃",
"fengxiang": "东北风",
"type": "晴"
},
{
"date": "23日星期二",
"high": "高温 5℃",
"fengli": "<![CDATA[2级]]>",
"low": "低温 -4℃",
"fengxiang": "东南风",
"type": "多云"
},
{
"date": "24日星期三",
"high": "高温 7℃",
"fengli": "<![CDATA[1级]]>",
"low": "低温 -2℃",
"fengxiang": "东北风",
"type": "多云"
},
{
"date": "25日星期四",
"high": "高温 9℃",
"fengli": "<![CDATA[2级]]>",
"low": "低温 -3℃",
"fengxiang": "南风",
"type": "多云"
},
{
"date": "26日星期五",
"high": "高温 11℃",
"fengli": "<![CDATA[2级]]>",
"low": "低温 -2℃",
"fengxiang": "南风",
"type": "晴"
}
],
"ganmao": "感冒高发期,尽量避免外出,外出戴口罩防护。",
"wendu": "10"
},
"status": 1000,
"desc": "OK"
}
//psot
参考get请求实例即可