碼上快樂

相關內容    簡體    繁體

HttpClient類詳解

本文轉載自   查看原文   2019-08-22 09:31   417    java

 

文章鏈接：https://blog.csdn.net/justry_deng/article/details/81042379

 

HTTP 協議可能是現在 Internet 上使用得最多、最重要的協議了，越來越多的 Java 應用程序需要直接通過 HTTP 協議來訪問網絡資源。雖然在 JDK 的 java net包中已經提供了訪問 HTTP 協議的基本功能，但是對於大部分應用程序來說，JDK 庫本身提供的功能還不夠豐富和靈活。HttpClient 是 Apache Jakarta Common 下的子項目，用來提供高效的、最新的、功能豐富的支持 HTTP 協議的客戶端編程工具包，並且它支持 HTTP 協議最新的版本和建議。

        HTTP和瀏覽器有點像，但卻不是瀏覽器。很多人覺得既然HttpClient是一個HTTP客戶端編程工具，很多人把他當做瀏覽器來理解，但是其實HttpClient不是瀏覽器，它是一個HTTP通信庫，因此它只提供一個通用瀏覽器應用程序所期望的功能子集，最根本的區別是HttpClient中沒有用戶界面，瀏覽器需要一個渲染引擎來顯示頁面，並解釋用戶輸入，例如鼠標點擊顯示頁面上的某處，有一個布局引擎，計算如何顯示HTML頁面，包括級聯樣式表和圖像。javascript解釋器運行嵌入HTML頁面或從HTML頁面引用的javascript代碼。來自用戶界面的事件被傳遞到javascript解釋器進行處理。除此之外，還有用於插件的接口，可以處理Applet，嵌入式媒體對象（如pdf文件，Quicktime電影和Flash動畫）或ActiveX控件（可以執行任何操作）。HttpClient只能以編程的方式通過其API用於傳輸和接受HTTP消息。

HttpClient的主要功能：

實現了所有 HTTP 的方法（GET、POST、PUT、HEAD、DELETE、HEAD、OPTIONS 等）
支持 HTTPS 協議
支持代理服務器（Nginx等）等
支持自動（跳轉）轉向
……
進入正題

環境說明：Eclipse、JDK1.8、SpringBoot

准備環節
第一步：在pom.xml中引入HttpClient的依賴


第二步：引入fastjson依賴


注：本人引入此依賴的目的是，在后續示例中，會用到“將對象轉化為json字符串的功能”，也可以引其他有此功能的依賴。 

注：SpringBoot的基本依賴配置，這里就不再多說了。

詳細使用示例
聲明：此示例中，以JAVA發送HttpClient(在test里面單元測試發送的)；也是以JAVA接收的（在controller里面接收的）。

聲明：下面的代碼，本人親測有效。

GET無參：
HttpClient發送示例：

/**
* GET---無參測試
*
* @date 2018年7月13日 下午4:18:50
*/
@Test
public void doGetTestOne() {
// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
CloseableHttpClient httpClient = HttpClientBuilder.create().build();
// 創建Get請求
HttpGet httpGet = new HttpGet("http://localhost:12345/doGetControllerOne");

// 響應模型
CloseableHttpResponse response = null;
try {
// 由客戶端執行(發送)Get請求
response = httpClient.execute(httpGet);
// 從響應模型中獲取響應實體
HttpEntity responseEntity = response.getEntity();
System.out.println("響應狀態為:" + response.getStatusLine());
if (responseEntity != null) {
System.out.println("響應內容長度為:" + responseEntity.getContentLength());
System.out.println("響應內容為:" + EntityUtils.toString(responseEntity));
}
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
// 釋放資源
if (httpClient != null) {
httpClient.close();
}
if (response != null) {
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
對應接收示例：

 

GET有參(方式一：直接拼接URL)：
HttpClient發送示例：

/**
* GET---有參測試 (方式一:手動在url后面加上參數)
*
* @date 2018年7月13日 下午4:19:23
*/
@Test
public void doGetTestWayOne() {
// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
CloseableHttpClient httpClient = HttpClientBuilder.create().build();

// 參數
StringBuffer params = new StringBuffer();
try {
// 字符數據最好encoding以下;這樣一來，某些特殊字符才能傳過去(如:某人的名字就是“&”,不encoding的話,傳不過去)
params.append("name=" + URLEncoder.encode("&", "utf-8"));
params.append("&");
params.append("age=24");
} catch (UnsupportedEncodingException e1) {
e1.printStackTrace();
}

// 創建Get請求
HttpGet httpGet = new HttpGet("http://localhost:12345/doGetControllerTwo" + "?" + params);
// 響應模型
CloseableHttpResponse response = null;
try {
// 配置信息
RequestConfig requestConfig = RequestConfig.custom()
// 設置連接超時時間(單位毫秒)
.setConnectTimeout(5000)
// 設置請求超時時間(單位毫秒)
.setConnectionRequestTimeout(5000)
// socket讀寫超時時間(單位毫秒)
.setSocketTimeout(5000)
// 設置是否允許重定向(默認為true)
.setRedirectsEnabled(true).build();

// 將上面的配置信息 運用到這個Get請求里
httpGet.setConfig(requestConfig);

// 由客戶端執行(發送)Get請求
response = httpClient.execute(httpGet);

// 從響應模型中獲取響應實體
HttpEntity responseEntity = response.getEntity();
System.out.println("響應狀態為:" + response.getStatusLine());
if (responseEntity != null) {
System.out.println("響應內容長度為:" + responseEntity.getContentLength());
System.out.println("響應內容為:" + EntityUtils.toString(responseEntity));
}
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
// 釋放資源
if (httpClient != null) {
httpClient.close();
}
if (response != null) {
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
對應接收示例：

 

GET有參(方式二：使用URI獲得HttpGet)：
HttpClient發送示例：

/**
* GET---有參測試 (方式二:將參數放入鍵值對類中,再放入URI中,從而通過URI得到HttpGet實例)
*
* @date 2018年7月13日 下午4:19:23
*/
@Test
public void doGetTestWayTwo() {
// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
CloseableHttpClient httpClient = HttpClientBuilder.create().build();

// 參數
URI uri = null;
try {
// 將參數放入鍵值對類NameValuePair中,再放入集合中
List<NameValuePair> params = new ArrayList<>();
params.add(new BasicNameValuePair("name", "&"));
params.add(new BasicNameValuePair("age", "18"));
// 設置uri信息,並將參數集合放入uri;
// 注:這里也支持一個鍵值對一個鍵值對地往里面放setParameter(String key, String value)
uri = new URIBuilder().setScheme("http").setHost("localhost")
.setPort(12345).setPath("/doGetControllerTwo")
.setParameters(params).build();
} catch (URISyntaxException e1) {
e1.printStackTrace();
}
// 創建Get請求
HttpGet httpGet = new HttpGet(uri);

// 響應模型
CloseableHttpResponse response = null;
try {
// 配置信息
RequestConfig requestConfig = RequestConfig.custom()
// 設置連接超時時間(單位毫秒)
.setConnectTimeout(5000)
// 設置請求超時時間(單位毫秒)
.setConnectionRequestTimeout(5000)
// socket讀寫超時時間(單位毫秒)
.setSocketTimeout(5000)
// 設置是否允許重定向(默認為true)
.setRedirectsEnabled(true).build();

// 將上面的配置信息 運用到這個Get請求里
httpGet.setConfig(requestConfig);

// 由客戶端執行(發送)Get請求
response = httpClient.execute(httpGet);

// 從響應模型中獲取響應實體
HttpEntity responseEntity = response.getEntity();
System.out.println("響應狀態為:" + response.getStatusLine());
if (responseEntity != null) {
System.out.println("響應內容長度為:" + responseEntity.getContentLength());
System.out.println("響應內容為:" + EntityUtils.toString(responseEntity));
}
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
// 釋放資源
if (httpClient != null) {
httpClient.close();
}
if (response != null) {
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
對應接收示例：

 

POST無參：
HttpClient發送示例：

/**
* POST---無參測試
*
* @date 2018年7月13日 下午4:18:50
*/
@Test
public void doPostTestOne() {

// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
CloseableHttpClient httpClient = HttpClientBuilder.create().build();

// 創建Post請求
HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerOne");
// 響應模型
CloseableHttpResponse response = null;
try {
// 由客戶端執行(發送)Post請求
response = httpClient.execute(httpPost);
// 從響應模型中獲取響應實體
HttpEntity responseEntity = response.getEntity();

System.out.println("響應狀態為:" + response.getStatusLine());
if (responseEntity != null) {
System.out.println("響應內容長度為:" + responseEntity.getContentLength());
System.out.println("響應內容為:" + EntityUtils.toString(responseEntity));
}
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
// 釋放資源
if (httpClient != null) {
httpClient.close();
}
if (response != null) {
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
對應接收示例：

 

POST有參(普通參數)：
注：POST傳遞普通參數時，方式與GET一樣即可，這里以直接在url后綴上參數的方式示例。

HttpClient發送示例：

/**
* POST---有參測試(普通參數)
*
* @date 2018年7月13日 下午4:18:50
*/
@Test
public void doPostTestFour() {

// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
CloseableHttpClient httpClient = HttpClientBuilder.create().build();

// 參數
StringBuffer params = new StringBuffer();
try {
// 字符數據最好encoding以下;這樣一來，某些特殊字符才能傳過去(如:某人的名字就是“&”,不encoding的話,傳不過去)
params.append("name=" + URLEncoder.encode("&", "utf-8"));
params.append("&");
params.append("age=24");
} catch (UnsupportedEncodingException e1) {
e1.printStackTrace();
}

// 創建Post請求
HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerFour" + "?" + params);

// 設置ContentType(注:如果只是傳普通參數的話,ContentType不一定非要用application/json)
httpPost.setHeader("Content-Type", "application/json;charset=utf8");

// 響應模型
CloseableHttpResponse response = null;
try {
// 由客戶端執行(發送)Post請求
response = httpClient.execute(httpPost);
// 從響應模型中獲取響應實體
HttpEntity responseEntity = response.getEntity();

System.out.println("響應狀態為:" + response.getStatusLine());
if (responseEntity != null) {
System.out.println("響應內容長度為:" + responseEntity.getContentLength());
System.out.println("響應內容為:" + EntityUtils.toString(responseEntity));
}
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
// 釋放資源
if (httpClient != null) {
httpClient.close();
}
if (response != null) {
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
對應接收示例：

 

POST有參(對象參數)：
先給出User類

 

HttpClient發送示例：

/**
* POST---有參測試(對象參數)
*
* @date 2018年7月13日 下午4:18:50
*/
@Test
public void doPostTestTwo() {

// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
CloseableHttpClient httpClient = HttpClientBuilder.create().build();

// 創建Post請求
HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerTwo");
User user = new User();
user.setName("潘曉婷");
user.setAge(18);
user.setGender("女");
user.setMotto("姿勢要優雅~");
// 我這里利用阿里的fastjson，將Object轉換為json字符串;
// (需要導入com.alibaba.fastjson.JSON包)
String jsonString = JSON.toJSONString(user);

StringEntity entity = new StringEntity(jsonString, "UTF-8");

// post請求是將參數放在請求體里面傳過去的;這里將entity放入post請求體中
httpPost.setEntity(entity);

httpPost.setHeader("Content-Type", "application/json;charset=utf8");

// 響應模型
CloseableHttpResponse response = null;
try {
// 由客戶端執行(發送)Post請求
response = httpClient.execute(httpPost);
// 從響應模型中獲取響應實體
HttpEntity responseEntity = response.getEntity();

System.out.println("響應狀態為:" + response.getStatusLine());
if (responseEntity != null) {
System.out.println("響應內容長度為:" + responseEntity.getContentLength());
System.out.println("響應內容為:" + EntityUtils.toString(responseEntity));
}
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
// 釋放資源
if (httpClient != null) {
httpClient.close();
}
if (response != null) {
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
對應接收示例：

 

POST有參(普通參數 + 對象參數)：
注：POST傳遞普通參數時，方式與GET一樣即可，這里以通過URI獲得HttpPost的方式為例。

先給出User類：

 

HttpClient發送示例：

/**
* POST---有參測試(普通參數 + 對象參數)
*
* @date 2018年7月13日 下午4:18:50
*/
@Test
public void doPostTestThree() {

// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
CloseableHttpClient httpClient = HttpClientBuilder.create().build();

// 創建Post請求
// 參數
URI uri = null;
try {
// 將參數放入鍵值對類NameValuePair中,再放入集合中
List<NameValuePair> params = new ArrayList<>();
params.add(new BasicNameValuePair("flag", "4"));
params.add(new BasicNameValuePair("meaning", "這是什么鬼？"));
// 設置uri信息,並將參數集合放入uri;
// 注:這里也支持一個鍵值對一個鍵值對地往里面放setParameter(String key, String value)
uri = new URIBuilder().setScheme("http").setHost("localhost").setPort(12345)
.setPath("/doPostControllerThree").setParameters(params).build();
} catch (URISyntaxException e1) {
e1.printStackTrace();
}

HttpPost httpPost = new HttpPost(uri);
// HttpPost httpPost = new
// HttpPost("http://localhost:12345/doPostControllerThree1");

// 創建user參數
User user = new User();
user.setName("潘曉婷");
user.setAge(18);
user.setGender("女");
user.setMotto("姿勢要優雅~");

// 將user對象轉換為json字符串，並放入entity中
StringEntity entity = new StringEntity(JSON.toJSONString(user), "UTF-8");

// post請求是將參數放在請求體里面傳過去的;這里將entity放入post請求體中
httpPost.setEntity(entity);

httpPost.setHeader("Content-Type", "application/json;charset=utf8");

// 響應模型
CloseableHttpResponse response = null;
try {
// 由客戶端執行(發送)Post請求
response = httpClient.execute(httpPost);
// 從響應模型中獲取響應實體
HttpEntity responseEntity = response.getEntity();

System.out.println("響應狀態為:" + response.getStatusLine());
if (responseEntity != null) {
System.out.println("響應內容長度為:" + responseEntity.getContentLength());
System.out.println("響應內容為:" + EntityUtils.toString(responseEntity));
}
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
// 釋放資源
if (httpClient != null) {
httpClient.close();
}
if (response != null) {
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
對應接收示例：

 

 

提示：使用HttpClient時，可以視情況將其寫為工具類。如：Github上Star非常多的一個HttpClient的工具類是
           httpclientutil。本人在這里也推薦使用該工具類，因為該工具類的編寫者封裝了很多功能在里面，如果
           不是有什么特殊的需求的話，完全可以不用造輪子，可以直接使用該工具類。使用方式很簡單，可詳
           見https://github.com/Arronlong/httpclientutil。
————————————————
版權聲明：本文為CSDN博主「justry_deng」的原創文章，遵循CC 4.0 by-sa版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/justry_deng/article/details/81042379


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 HttpClient 詳解 HttpClient詳解 HttpClient工具類 HttpClient工具類 httpClient工具類 HttpClient工具類 httpclient 傳 file MultipartPostMethod類 HttpClient使用詳解 HttpClient使用詳解 HttpClient使用詳解 (一)
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM