Java HttpClient用法的示例詳解
1、導入依賴
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.3</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.58</version>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpmime</artifactId>
<version>4.5.3</version>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcore</artifactId>
<version>4.4.13</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.7</version>
</dependency>
2、使用工具類
該工具類將get請求和post請求當中幾種傳參方式都寫瞭，其中有get地址欄傳參、get的params傳參、post的params傳參、post的json傳參。
import com.alibaba.fastjson.JSONObject;
import org.apache.http.Consts;
import org.apache.http.HttpEntity;
import org.apache.http.HttpStatus;
import org.apache.http.NameValuePair;
import org.apache.http.client.ClientProtocolException;
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.client.utils.URIBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.*;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
public class HttpClientUtil {
private static Logger logger = LoggerFactory.getLogger(HttpClientUtil.class);
private static final int DEFULT_TIMEOUT = 30 * 1000;//默認超時時間20秒
/**
* 可以訪問 http://localhost:9005/yzhwsj/addPersonal/1/2 這樣的接口
* @param url
* @param headers
* @param urlParam
* @param timeout
* @return
*/
private static String doUrlGet(String url, Map<String, String> headers, List<String> urlParam, Integer timeout) {
//創建httpClient對象
CloseableHttpClient httpClient = HttpClients.createDefault();
String resultString = null;
CloseableHttpResponse response = null;
try {
//創建uri
if (urlParam != null){
for (String param : urlParam) {
url = url + "/" + param;
}
}
//創建hTTP get請求
HttpGet httpGet = new HttpGet(url);
//設置超時時間
int timeoutTmp = DEFULT_TIMEOUT;
if (timeout != null) {
timeoutTmp = timeout;
}
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(timeoutTmp)
.setConnectionRequestTimeout(timeoutTmp).setSocketTimeout(timeoutTmp).build();
httpGet.setConfig(requestConfig);
//設置頭信息
if (null != headers) {
for (String key : headers.keySet()) {
httpGet.setHeader(key, headers.get(key));
}
}
//執行請求
response = httpClient.execute(httpGet);
if (HttpStatus.SC_OK == response.getStatusLine().getStatusCode()) {
resultString = EntityUtils.toString(response.getEntity(), Consts.UTF_8);
}
} catch (IOException e) {
logger.error("http調用異常" + e.toString(), e);
} finally {
try {
if (null != response) {
response.close();
}
} catch (IOException e) {
logger.error("response關閉異常" + e.toString(), e);
}
try {
if (null != httpClient) {
httpClient.close();
}
} catch (IOException e) {
logger.error("httpClient關閉異常" + e.toString(), e);
}
}
return resultString;
}
/**
* @param url
* @param headers
* @param params
* @param timeout
* @return
*/
private static String doGet(String url, Map<String, String> headers, Map<String, Object> params, Integer timeout) {
//創建httpClient對象
CloseableHttpClient httpClient = HttpClients.createDefault();
String resultString = null;
CloseableHttpResponse response = null;
try {
// 1.創建uri
URIBuilder builder = new URIBuilder(url);
if (params != null) {
//uri添加參數
for (String key : params.keySet()) {
builder.addParameter(key, String.valueOf(params.get(key)));
}
}
URI uri = builder.build();
// 2.創建hTTP get請求
HttpGet httpGet = new HttpGet(uri);
// 3.設置超時時間
int timeoutTmp = DEFULT_TIMEOUT;
if (timeout != null) {
timeoutTmp = timeout;
}
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(timeoutTmp)
.setConnectionRequestTimeout(timeoutTmp).setSocketTimeout(timeoutTmp).build();
httpGet.setConfig(requestConfig);
// 4.設置頭信息
if (null != headers) {
for (String key : headers.keySet()) {
httpGet.setHeader(key, headers.get(key));
}
}
// 5.執行請求
response = httpClient.execute(httpGet);
if (HttpStatus.SC_OK == response.getStatusLine().getStatusCode()) {
resultString = EntityUtils.toString(response.getEntity(), Consts.UTF_8);
}
} catch (URISyntaxException e) {
logger.error("http調用異常" + e.toString(), e);
} catch (IOException e) {
logger.error("http調用異常" + e.toString(), e);
} finally {
try {
if (null != response) {
response.close();
}
} catch (IOException e) {
logger.error("response關閉異常" + e.toString(), e);
}
try {
if (null != httpClient) {
httpClient.close();
}
} catch (IOException e) {
logger.error("httpClient關閉異常" + e.toString(), e);
}
}
return resultString;
}
/**
* 調用http post請求（json數據）
*
* @param url
* @param headers
* @param json
* @return
*/
public static String doJsonPost(String url, Map<String, String> headers, JSONObject json, Integer timeout) {
CloseableHttpClient httpClient = HttpClients.createDefault();
CloseableHttpResponse response = null;
String resultString = "";
try {
// 1.創建http post請求
HttpPost httpPost = new HttpPost(url);
// 2.設置超時時間
int timeoutTmp = DEFULT_TIMEOUT;
if (timeout != null) {
timeoutTmp = timeout;
}
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(timeoutTmp)
.setConnectionRequestTimeout(timeoutTmp).setSocketTimeout(timeoutTmp).build();
httpPost.setConfig(requestConfig);
// 3.設置參數信息
StringEntity s = new StringEntity(json.toString(), Consts.UTF_8);
// 發送json數據需要設置的contentType
s.setContentType("application/json");
httpPost.setEntity(s);
// 4.設置頭信息
if (headers != null) {
for (String key : headers.keySet()) {
httpPost.setHeader(key, headers.get(key));
}
}
// 5.執行http請求
response = httpClient.execute(httpPost);
if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
resultString = EntityUtils.toString(response.getEntity(), Consts.UTF_8);
}
} catch (UnsupportedEncodingException e) {
logger.error("調用http異常" + e.toString(), e);
} catch (ClientProtocolException e) {
logger.error("調用http異常" + e.toString(), e);
} catch (IOException e) {
logger.error("調用http異常" + e.toString(), e);
} finally {
try {
if (null != response) {
response.close();
}
} catch (IOException e) {
logger.error("關閉response異常" + e.toString(), e);
}
try {
if (null != httpClient) {
httpClient.close();
}
} catch (IOException e) {
logger.error("關閉httpClient異常" + e.toString(), e);
}
}
return resultString;
}
/**
* 調用http post請求 基礎方法
*
* @param url 請求的url
* @param headers 請求頭
* @param params 參數
* @param timeout 超時時間
* @return
*/
public static String doPost(String url, Map<String, String> headers, Map<String, Object> params, Integer timeout) {
CloseableHttpClient httpClient = HttpClients.createDefault();
CloseableHttpResponse response = null;
String resultString = "";
try {
// 1.創建http post請求
HttpPost httpPost = new HttpPost(url);
// 2.設置超時時間
int timeoutTmp = DEFULT_TIMEOUT;
if (timeout != null) {
timeoutTmp = timeout;
}
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(timeoutTmp)
.setConnectionRequestTimeout(timeoutTmp).setSocketTimeout(timeoutTmp).build();
httpPost.setConfig(requestConfig);
// 3.設置參數信息
if (params != null) {
List<NameValuePair> paramList = new ArrayList<>();
for (String key : params.keySet()) {
paramList.add(new BasicNameValuePair(key, String.valueOf(params.get(key))));
}
// 模擬表單
UrlEncodedFormEntity entity = new UrlEncodedFormEntity(paramList, Consts.UTF_8);
httpPost.setEntity(entity);
}
// 4.設置頭信息
if (headers != null) {
for (String key : headers.keySet()) {
httpPost.setHeader(key, headers.get(key));
}
}
// 5.執行http請求
response = httpClient.execute(httpPost);
if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
resultString = EntityUtils.toString(response.getEntity(), Consts.UTF_8);
}
} catch (UnsupportedEncodingException e) {
logger.error("調用http異常" + e.toString(), e);
} catch (ClientProtocolException e) {
logger.error("調用http異常" + e.toString(), e);
} catch (IOException e) {
logger.error("調用http異常" + e.toString(), e);
} finally {
try {
if (null != response) {
response.close();
}
} catch (IOException e) {
logger.error("關閉response異常" + e.toString(), e);
}
try {
if (null != httpClient) {
httpClient.close();
}
} catch (IOException e) {
logger.error("關閉httpClient異常" + e.toString(), e);
}
}
return resultString;
}
/**
* 通過httpClient上傳文件
*
* @param url 請求的URL
* @param headers 請求頭參數
* @param path 文件路徑
* @param fileName 文件名稱
* @param timeout 超時時間
* @return
*/
public static String UploadFileByHttpClient(String url, Map<String, String> headers, String path, String fileName, Integer timeout) {
String resultString = "";
CloseableHttpClient httpClient = HttpClients.createDefault();
CloseableHttpResponse response = null;
InputStream content = null;
BufferedReader in = null;
try {
// 1.創建http post請求
HttpPost httpPost = new HttpPost(url);
// 2.設置超時時間
int timeoutTmp = DEFULT_TIMEOUT;
if (timeout != null) {
timeoutTmp = timeout;
}
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(timeoutTmp)
.setConnectionRequestTimeout(timeoutTmp).setSocketTimeout(timeoutTmp).build();
httpPost.setConfig(requestConfig);
// 3.設置參數信息
// HttpMultipartMode.RFC6532參數的設定是為避免文件名為中文時亂碼
MultipartEntityBuilder builder = MultipartEntityBuilder.create().setMode(HttpMultipartMode.RFC6532);
// 上傳文件的路徑
File file = new File(path + File.separator + fileName);
builder.setCharset(Charset.forName("UTF-8"));
builder.addBinaryBody("file", file, ContentType.MULTIPART_FORM_DATA, fileName);
HttpEntity entity = builder.build();
httpPost.setEntity(entity);
// 4.設置頭信息
if (headers != null) {
for (String key : headers.keySet()) {
httpPost.setHeader(key, headers.get(key));
}
}
// 5.執行http請求
response = httpClient.execute(httpPost);
if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
resultString = EntityUtils.toString(response.getEntity(), Consts.UTF_8);
}
} catch (Exception e) {
logger.error("上傳文件失敗：", e);
} finally {
try {
if (null != httpClient) {
httpClient.close();
}
} catch (IOException e) {
logger.error("關閉httpClient異常" + e.toString(), e);
}
try {
if (null != content) {
content.close();
}
} catch (IOException e) {
logger.error("關閉content異常" + e.toString(), e);
}
try {
if (null != in) {
in.close();
}
} catch (IOException e) {
logger.error("關閉in異常" + e.toString(), e);
}
}
return resultString;
}
}
/**
* 通過httpClient批量上傳文件
*
* @param url 請求的URL
* @param headers 請求頭參數
* @param params 參數
* @param paths 文件路徑(key文件名稱，value路徑)
* @param timeout 超時時間
* @return
*/
public static String UploadFilesByHttpClient(String url, Map<String, String> headers, Map<String, String> params, Map<String, String> paths, Integer timeout) {
String resultString = "";
CloseableHttpClient httpClient = HttpClients.createDefault();
CloseableHttpResponse response = null;
InputStream content = null;
BufferedReader in = null;
try {
// 1.創建http post請求
HttpPost httpPost = new HttpPost(url);
// 2.設置超時時間
int timeoutTmp = DEFULT_TIMEOUT;
if (timeout != null) {
timeoutTmp = timeout;
}
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(timeoutTmp)
.setConnectionRequestTimeout(timeoutTmp).setSocketTimeout(timeoutTmp).build();
httpPost.setConfig(requestConfig);
// 3.設置文件信息
// HttpMultipartMode.RFC6532參數的設定是為避免文件名為中文時亂碼
MultipartEntityBuilder builder = MultipartEntityBuilder.create().setMode(HttpMultipartMode.RFC6532);
builder.setCharset(Charset.forName("UTF-8"));
// 上傳文件的路徑
for (Map.Entry<String, String> m : paths.entrySet()) {
File file = new File(m.getValue() + File.separator + m.getKey());
builder.addBinaryBody("files", file, ContentType.MULTIPART_FORM_DATA, m.getKey());
}
// 4.設置參數信息
ContentType contentType = ContentType.create("text/plain", Charset.forName("UTF-8"));
for (Map.Entry<String, String> param : params.entrySet()) {
builder.addTextBody(param.getKey(), param.getValue(), contentType);
}
HttpEntity entity = builder.build();
httpPost.setEntity(entity);
// 5.設置頭信息
if (headers != null) {
for (String key : headers.keySet()) {
httpPost.setHeader(key, headers.get(key));
}
}
// 6.執行http請求
response = httpClient.execute(httpPost);
if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
resultString = EntityUtils.toString(response.getEntity(), Consts.UTF_8);
}
} catch (Exception e) {
logger.error("上傳文件失敗：", e);
} finally {
try {
if (null != httpClient) {
httpClient.close();
}
} catch (IOException e) {
logger.error("關閉httpClient異常" + e.toString(), e);
}
try {
if (null != content) {
content.close();
}
} catch (IOException e) {
logger.error("關閉content異常" + e.toString(), e);
}
try {
if (null != in) {
in.close();
}
} catch (IOException e) {
logger.error("關閉in異常" + e.toString(), e);
}
}
return resultString;
}
3、擴展
上面的工具類，方法都攜帶瞭token和超時時間，假如接口用不到可以做接口拓展。例如：
/**
* 調用http get請求
*
* @param url
* @param params
* @return
*/
public static String doGet(String url, Map<String, Object> params) {
return doGet(url, null, params, null);
}
如果涉及到put請求和delete請求，跟上面都差不多，隻不過創建請求的時候改為:
HttpDelete httpDelete = new HttpDelete(); HttpPut httpPut = new HttpPut();
到此這篇關於Java HttpClient用法的示例詳解的文章就介紹到這瞭,更多相關Java HttpClient內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- HttpClient詳細使用示例代碼
- spring集成httpclient配置的詳細過程
- 使用HTTPclient保持長連接
- 解決使用httpclient傳遞json數據亂碼的問題
- Java 使用 HttpClient 發送 GET請求和 POST請求