前言
在前面有一章我转载过一篇关于HttpClient的文章:HttpClient使用详解,在那篇文章中详细讲解了HttpClient的特性,使用方法和实例。
这篇文章主要就上篇文章进一步浓缩,封装了HttpClient发送http和https请求的方法,形成一个工具类HttpClientUtil,大家以后在用到网络请求时,直接用这个工具类即可。
本文是为后续接口测试框架系列的文章做铺垫,大家可以好好看,把代码拷贝下来,测试一下,无非就是通过request得到response,然后校验response的值。
主要方法
主要方法如下:
1.doGet
发送GET请求(HTTP),K-V形式2.doPost
发送POST请求(HTTP),K-V形式3.doPostSSL
发送 SSL POST请(HTTPS),K-V形式4.postWithFile
发送post请求,并上传文件
实例代码
由于我是通过maven建的project,所以pom.xml文件中主要依赖如下:
不会使用maven的也可以到apache的网站上直接下载相应的jar包,导入到Eclipse中添加依赖即可,不会的可以联系我,我会在线回答!!
<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient-osgi -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient-osgi</artifactId>
<version>4.5.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpmime -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpmime</artifactId>
<version>4.5.2</version>
</dependency>
HttpClientUtil代码如下:
package com.dji.utils;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.security.GeneralSecurityException;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLException;
import javax.net.ssl.SSLSession;
import javax.net.ssl.SSLSocket;
import org.apache.http.HttpEntity;
import org.apache.http.HttpStatus;
import org.apache.http.NameValuePair;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.conn.ssl.SSLContextBuilder;
import org.apache.http.conn.ssl.TrustStrategy;
import org.apache.http.conn.ssl.X509HostnameVerifier;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
/**
* 封装了HttpClient发送http和https请求的方法(包括get和post请求),形成一个工具类HttpClientUtil,
* 大家以后在用到网络请求时,直接用这个工具类即可
* @author Charlie.chen
* @date 2016-10-31
*
*/
public class HttpClientUtil {
//public static LogUtil log = new LogUtil(HttpclientUtil.class);
private static PoolingHttpClientConnectionManager connMgr;
private static RequestConfig requestConfig;
private static final int MAX_TIMEOUT = 7000;
static {
// 设置连接池
connMgr = new PoolingHttpClientConnectionManager();
// 设置连接池大小
connMgr.setMaxTotal(100);
connMgr.setDefaultMaxPerRoute(connMgr.getMaxTotal());
RequestConfig.Builder configBuilder = RequestConfig.custom();
// 设置连接超时
configBuilder.setConnectTimeout(MAX_TIMEOUT);
// 设置读取超时
configBuilder.setSocketTimeout(MAX_TIMEOUT);
// 设置从连接池获取连接实例的超时
configBuilder.setConnectionRequestTimeout(MAX_TIMEOUT);
// 在提交请求之前 测试连接是否可用
configBuilder.setStaleConnectionCheckEnabled(true);
requestConfig = configBuilder.build();
}
/**
* 发送GET请求(HTTP),K-V形式
* @param url
* @param params
* @author Charlie.chen;
* @return
*/
public static String doGet(String url,Map<String, Object> params) {
String apiUrl = url;
StringBuffer param = new StringBuffer();
int i = 0;
for (String key : params.keySet()) {
if (i == 0)
param.append("?");
else
param.append("&");
param.append(key).append("=").append(params.get(key));
i++;
}
apiUrl += param;
// 创建默认的HttpClient实例.
CloseableHttpClient httpclient = HttpClients.createDefault();
try {
// 定义一个get请求方法
HttpGet httpget = new HttpGet(apiUrl);
// 执行get请求,返回response服务器响应对象, 其中包含了状态信息和服务器返回的数据
CloseableHttpResponse httpResponse = httpclient.execute(httpget);
// 使用响应对象, 获得状态码, 处理内容
int statusCode = httpResponse.getStatusLine().getStatusCode();
if (statusCode == 200) {
// 使用响应对象获取响应实体
HttpEntity entity = httpResponse.getEntity();
// 将响应实体转为字符串
String response = EntityUtils.toString(entity, "utf-8");
return response;
} else {
// log.error("访问失败"+statusCode);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
// 关闭连接, 和释放资源
httpclient.close();
} catch (IOException e) {
e.printStackTrace();
}
}
return null;
}
/**
* 发送POST请求(HTTP),K-V形式
* @param url
* @param params
* @author Charlie.chen
* @return
*/
public static String doPost(String url, Map<String, String> params) {
// 创建默认的HttpClient实例.
CloseableHttpClient httpclient = HttpClients.createDefault();
try {
// 定义一个get请求方法
HttpPost httppost = new HttpPost(url);
// List<NameValuePair> parameters = new ArrayList<NameValuePair>();
// parameters.add(new BasicNameValuePair("username", userName));
// parameters.add(new BasicNameValuePair("password", password));
// 定义post请求的参数
// 建立一个NameValuePair数组,用于存储欲传送的参数
List<NameValuePair> list = new ArrayList<NameValuePair>();
Iterator iterator = params.entrySet().iterator();
while (iterator.hasNext()) {
Entry<String, String> elem = (Entry<String, String>) iterator.next();
list.add(new BasicNameValuePair(elem.getKey(), elem.getValue()));
}
if (list.size() > 0) {
httppost.setEntity(new UrlEncodedFormEntity(list, "utf-8"));
}
// httppost.setHeader("Content-type","application/json,charset=utf-8");
// httppost.setHeader("Accept", "application/json");
// 执行post请求,返回response服务器响应对象, 其中包含了状态信息和服务器返回的数据
CloseableHttpResponse httpResponse = httpclient.execute(httppost);
// 使用响应对象, 获得状态码, 处理内容
int statusCode = httpResponse.getStatusLine().getStatusCode();
if (statusCode == 200) {
// 使用响应对象获取响应实体
HttpEntity entity = httpResponse.getEntity();
// 将响应实体转为字符串
String response = EntityUtils.toString(entity, "utf-8");
return response;
} else {
// log.error("访问失败"+statusCode);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
// 关闭连接, 和释放资源
httpclient.close();
} catch (IOException e) {
e.printStackTrace();
}
}
return null;
}
/**
* 发送 SSL POST请(HTTPS),K-V形式
* @param url
* @param params
* @author Charlie.chen
*/
public static String doPostSSL(String url, Map<String, Object> params) {
CloseableHttpClient httpClient = HttpClients.custom().setSSLSocketFactory(createSSLConn()).setConnectionManager(connMgr).setDefaultRequestConfig(requestConfig).build();
HttpPost httpPost = new HttpPost(url);
CloseableHttpResponse response = null;
String httpStr = null;
try {
httpPost.setConfig(requestConfig);
List<NameValuePair> pairList = new ArrayList<NameValuePair>(params.size());
for (Map.Entry<String, Object> entry : params.entrySet()) {
NameValuePair pair = new BasicNameValuePair(entry.getKey(), entry
.getValue().toString());
pairList.add(pair);
}
httpPost.setEntity(new UrlEncodedFormEntity(pairList, Charset.forName("utf-8")));
response = httpClient.execute(httpPost);
int statusCode = response.getStatusLine().getStatusCode();
if (statusCode != HttpStatus.SC_OK) {
return null;
}
HttpEntity entity = response.getEntity();
if (entity == null) {
return null;
}
httpStr = EntityUtils.toString(entity, "utf-8");
} catch (Exception e) {
e.printStackTrace();
} finally {
if (response != null) {
try {
EntityUtils.consume(response.getEntity());
} catch (IOException e) {
e.printStackTrace();
}
}
}
return httpStr;
}
/**
* 创建SSL安全连接
* @param url
* @param params
* @author Charlie.chen
* @return
*/
private static SSLConnectionSocketFactory createSSLConn() {
SSLConnectionSocketFactory sslsf = null;
try {
SSLContext sslContext = new SSLContextBuilder().loadTrustMaterial(null, new TrustStrategy() {
public boolean isTrusted(X509Certificate[] chain, String authType) throws CertificateException {
return true;
}
}).build();
sslsf = new SSLConnectionSocketFactory(sslContext, new X509HostnameVerifier() {
public boolean verify(String arg0, SSLSession arg1) {
return true;
}
public void verify(String host, SSLSocket ssl) throws IOException {
}
public void verify(String host, X509Certificate cert) throws SSLException {
}
public void verify(String host, String[] cns, String[] subjectAlts) throws SSLException {
}
});
} catch (GeneralSecurityException e) {
e.printStackTrace();
}
return sslsf;
}
/**
* 发送post请求,并上传文件
*/
public String postWithFile(String url,String filePath) {
CloseableHttpClient httpclient = HttpClients.createDefault();
try {
HttpPost httppost = new HttpPost(url);
FileBody bin=null;
File file = new File(filePath);
if (file.exists()) {
bin=new FileBody(file);
}else{
System.out.println("Can't find " + filePath);
}
StringBody comment = new StringBody("A binary file of some kind",ContentType.TEXT_PLAIN);
//请求实体
HttpEntity reqEntity = MultipartEntityBuilder.create().addPart("bin",bin).addPart("comment", comment).build();
httppost.setEntity(reqEntity);
//执行post请求,返回response服务器响应对象, 其中包含了状态信息和服务器返回的数据
CloseableHttpResponse httpResponse = httpclient.execute(httppost);
// 使用响应对象, 获得状态码, 处理内容
int statusCode = httpResponse.getStatusLine().getStatusCode();
if(statusCode == 200) {
// 使用响应对象获取响应实体
HttpEntity entity = httpResponse.getEntity();
//将响应实体转为字符串
String response = EntityUtils.toString(entity,"utf-8");
return response;
}else{
System.out.println("访问失败"+statusCode);
}
}catch (Exception e) {
e.printStackTrace();
} finally {
try {
// 关闭连接, 和释放资源
httpclient.close();
} catch (IOException e) {
e.printStackTrace();
}
}
return null;
}
}