Java 使用 HttpClient 發送 GET請求和 POST請求
概述
日常工作中，我們經常會有發送 HTTP 網絡請求的需求，概括下我們常見的發送 HTTP 請求的需求內容：
- 可以發送基本的 GET/POST/PUT/DELETE 等請求；
- HTTP請求，可以附帶認證，包括基本的 用戶名/密碼 認證，以及 Bearer Token 認證；
- 請求可以自定義 超時時間；
- HTTP請求可以帶參數，也可以不帶參數；
- HTTP請求返回結果，可以直接傳入一個 Class，這樣結果就不用二次解析；
- 請求的路徑可以是 url，也可以是 Uri；
針對以上常見的 HTTP 請求，在 HttpClient 的基礎上做瞭二次封裝，可以直接簡單、高效地發送HTTP請求。
本文所使用的的 HttpClient 版本為 4.5.3，pom依賴如下：
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.3</version>
</dependency>
認證方式
HTTP請求中，常用的認證方式包括：
- 用戶名 + 密碼 認證
- Bearer Token 認證
其實這些認證的本質，都是通過在 HTTP Request Header 中，添加固定的參數，如下格式：
Authorization: token字符串
上面的Authorization 就是 HTTP Header 的 key，而 token字符串 就是具體的認證方式中需要傳遞的參數。
我們將所有的認證方式，都抽象為 Auth 類，並定義方法 getAuth 方法，由具體的子類去實現，返回自定義認證方式中所需要的token字符串。
基礎認證Auth
public interface Auth {
String getAuth();
}
用戶名密碼認證
BasicAuth，用於做用戶名和密碼認證，代碼如下：
public class BasicAuth implements Auth {
private String username;
private String password;
public BasicAuth(String username, String password) {
this.username = username;
this.password = password;
}
@Override
public String getAuth() {
String auth = String.format("%s:%s", this.username, this.password);
byte[] encodedAuth = Base64.encodeBase64(auth.getBytes(StandardCharsets.ISO_8859_1));
return "Basic " + new String(encodedAuth);
}
}
Bearer Token 認證
BearerAuth，用於做 Bearer Token認證，代碼如下：
public class BearerAuth implements Auth {
private String token;
public BearerAuth(String token) {
this.token = token;
}
@Override
public String getAuth() {
return "Bearer " + this.token;
}
}
上面介紹瞭兩種常用的認證方式，如果有其他的認證方式，實現 Auth 接口的 getAuth 方法即可。
這個 Auth 我們會在真正發送 HTTP 請求時用到。
配置超時
HttpClient中，通過 setDefaultRequestConfig 來設置請求的參數配置，包括請求超時時間等。
生成 RequestConfig
/**
* 設置 HTTP 請求超時時間
*
* @param connectTimeout tcp 連接超時時間
* @param readTimeout 讀取數據超時時間
* @return
*/
private RequestConfig getRequestConfig(int connectTimeout, int readTimeout) {
return RequestConfig.custom()
.setConnectTimeout(connectTimeout)
.setConnectionRequestTimeout(connectTimeout)
.setSocketTimeout(readTimeout)
.build();
}
設置超時時間
HttpClientBuilder.create()
.setDefaultRequestConfig(requestConfig)
.build();
到這裡，HttpClient所需要做的一些配置，基本就結束瞭，下面將展示完整的代碼示例。
完整代碼 HttpRequestClient
import com.google.gson.Gson;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.apache.http.HttpHeaders;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
import org.springframework.http.HttpMethod;
import java.io.IOException;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
/**
* @author wxweven
*/
@Slf4j
public class HttpRequestClient {
// 默認 連接/讀取數據 超時時間都是 10s
private static final int DEFAULT_CONNECT_TIMEOUT = 10_000;
private static final int DEFAULT_READ_TIMEOUT = 10_000;
private static final Gson GSON = new Gson();
private Auth auth;
private HttpClient httpClient;
// 用戶名密碼認證，默認的超時時間(10s)
public HttpRequestClient(String username, String password) {
this(username, password,
DEFAULT_CONNECT_TIMEOUT,
DEFAULT_READ_TIMEOUT
);
}
// 用戶名密碼認證，自定義超時時間
public HttpRequestClient(String username, String password,
int connectTimeout, int readTimeout) {
this.auth = new BasicAuth(username, password);
this.httpClient = HttpClientBuilder.create()
.setDefaultRequestConfig(getRequestConfig(connectTimeout, readTimeout))
.build();
}
// BearerToken 認證，默認的超時時間(10s)
public HttpRequestClient(String bearerToken) {
this(bearerToken,
DEFAULT_CONNECT_TIMEOUT,
DEFAULT_READ_TIMEOUT
);
}
// BearerToken 認證，自定義超時時間
public HttpRequestClient(String bearerToken,
int connectTimeout, int readTimeout) {
this.auth = new BearerAuth(bearerToken);
this.httpClient = HttpClientBuilder.create()
.setDefaultRequestConfig(getRequestConfig(connectTimeout, readTimeout))
.build();
}
/**
* 設置 HTTP 請求超時時間
*
* @param connectTimeout tcp 連接超時時間
* @param readTimeout 讀取數據超時時間
* @return
*/
private RequestConfig getRequestConfig(int connectTimeout, int readTimeout) {
return RequestConfig.custom()
.setConnectTimeout(connectTimeout)
.setConnectionRequestTimeout(connectTimeout)
.setSocketTimeout(readTimeout)
.build();
}
/**
* 發送 GET 請求，不帶參數
*
* @param url
* @return
*/
public String doGet(String url) {
return doGet(url, new HashMap<>());
}
/**
* 發送 GET 請求，不帶參數
*
* @param uri
* @return
*/
public String doGet(URI uri) {
return doGet(uri, new HashMap<>());
}
/**
* 發送 GET 請求，K-V 形式參數
*
* @param url
* @param params
* @return
*/
public String doGet(String url, Map<String, String> params) {
RequestBuilder reqBuilder = RequestBuilder.get(url);
return doGet(reqBuilder, params);
}
/**
* 發送 GET 請求，K-V 形式參數
*
* @param uri
* @param params
* @return
*/
public String doGet(URI uri, Map<String, String> params) {
RequestBuilder reqBuilder = RequestBuilder.get(uri);
return doGet(reqBuilder, params);
}
public String doGet(RequestBuilder reqBuilder, Map<String, String> params) {
reqBuilder.addHeader(HttpHeaders.AUTHORIZATION, auth.getAuth());
for (Map.Entry<String, String> entry : params.entrySet()) {
reqBuilder.addParameter(entry.getKey(), entry.getValue());
}
try {
HttpResponse resp = httpClient.execute(reqBuilder.build());
return EntityUtils.toString(resp.getEntity(), StandardCharsets.UTF_8);
} catch (IOException e) {
log.error("doGet 異常: reqBuilder={}, params={}", reqBuilder, params, e);
return null;
}
}
/***
* 發送 GET 請求，不帶參數，返回指定類型的 class
* @param url 請求的 url
* @param responseType 返回類型
* @param <T>
* @return
*/
public <T> T getForObject(String url, Class<T> responseType) {
RequestBuilder reqBuilder = RequestBuilder.get(url);
return getForObject(reqBuilder, responseType);
}
/***
* 發送 GET 請求，不帶參數，返回指定類型的 class
* @param uri 請求的 uri
* @param responseType 返回類型
* @param <T>
* @return
*/
public <T> T getForObject(URI uri, Class<T> responseType) {
RequestBuilder reqBuilder = RequestBuilder.get(uri);
return getForObject(reqBuilder, responseType);
}
public <T> T getForObject(RequestBuilder reqBuilder, Class<T> responseType) {
reqBuilder.addHeader(HttpHeaders.AUTHORIZATION, auth.getAuth());
try {
HttpResponse resp = httpClient.execute(reqBuilder.build());
String result = EntityUtils.toString(resp.getEntity(), StandardCharsets.UTF_8);
return GSON.fromJson(result, responseType);
} catch (IOException e) {
log.error("getForObject 異常: reqBuilder={}, responseType={}", reqBuilder, responseType, e);
return null;
}
}
/**
* 發送 POST 請求，JSON 形式
*
* @param url
* @param json json字符串
* @return
*/
public String doPost(String url, String json) {
try {
HttpResponse resp = this.exchange(HttpMethod.POST, url, json);
return EntityUtils.toString(resp.getEntity(), StandardCharsets.UTF_8);
} catch (IOException e) {
log.error("doPost 異常: url={}, json={}", url, json, e);
return null;
}
}
/**
* 發送 POST 請求，JSON 形式，返回 HttpResponse
*
* @param url
* @param json json字符串
* @return
*/
public HttpResponse doPostResp(String url, String json) {
return this.exchange(HttpMethod.POST, url, json);
}
/**
* 發送 PUT 請求，JSON 形式
*
* @param url
* @param json json字符串
* @return
*/
public HttpResponse doPut(String url, String json) {
return this.exchange(HttpMethod.PUT, url, json);
}
/**
* 發送 PUT 請求，JSON 形式
*
* @param url
* @param json json字符串
* @return
*/
public HttpResponse doDelete(String url, String json) {
return this.exchange(HttpMethod.DELETE, url, json);
}
public HttpResponse exchange(HttpMethod method, String url, String json) {
RequestBuilder reqBuilder = RequestBuilder.create(method.toString())
.setUri(url)
.addHeader(HttpHeaders.AUTHORIZATION, auth.getAuth())
.addHeader("Accept", ContentType.APPLICATION_JSON.toString())
.addHeader("Content-type", ContentType.APPLICATION_JSON.toString());
if (StringUtils.isNotBlank(json)) {
reqBuilder.setEntity(new StringEntity(json, ContentType.APPLICATION_JSON));
}
try {
return httpClient.execute(reqBuilder.build());
} catch (IOException e) {
log.error("doPost 異常: url={}, json={}", url, json, e);
return null;
}
}
}
到此這篇關於Java 使用 HttpClient 發送 GET請求和 POST請求的文章就介紹到這瞭,更多相關Java HttpClient GET請求和 POST請求內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- spring集成httpclient配置的詳細過程
- Java利用httpclient通過get、post方式調用https接口的方法
- 關於RestTemplate的使用深度解析
- Java HttpClient用法的示例詳解
- HttpClient詳細使用示例代碼