HttpClient詳細使用示例

XSMforever 2019-05-20

展開全文

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

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

HttpClient的主要功能：

實現(xiàn)了所有 HTTP 的方法（GET、POST、PUT、HEAD、DELETE、HEAD、OPTIONS 等）
支持 HTTPS 協(xié)議
支持代理服務(wù)器（Nginx等）等
支持自動（跳轉(zhuǎn)）轉(zhuǎn)向
……

進入正題

環(huán)境說明：Eclipse、JDK1.8、SpringBoot

準備環(huán)節(jié)

第一步：在pom.xml中引入HttpClient的依賴

第二步：引入fastjson依賴

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

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

詳細使用示例

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

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

GET無參：

HttpClient發(fā)送示例：

    /**
	 * GET---無參測試
	 *
	 * @date 2018年7月13日 下午4:18:50
	 */
	@Test
	public void doGetTestOne() {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 創(chuàng)建Get請求
		HttpGet httpGet = new HttpGet("http://localhost:12345/doGetControllerOne");
		// 響應(yīng)模型
		CloseableHttpResponse response = null;
		try {
			// 由客戶端執(zhí)行(發(fā)送)Get請求
			response = httpClient.execute(httpGet);
			// 從響應(yīng)模型中獲取響應(yīng)實體
			HttpEntity responseEntity = response.getEntity();
			System.out.println("響應(yīng)狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				System.out.println("響應(yīng)內(nèi)容長度為:" + responseEntity.getContentLength());
				System.out.println("響應(yīng)內(nèi)容為:" + 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();
			}
		}
	}

對應(yīng)接收示例：

GET有參(方式一：直接拼接URL)：

HttpClient發(fā)送示例：

    /**
	 * GET---有參測試 (方式一:手動在url后面加上參數(shù))
	 *
	 * @date 2018年7月13日 下午4:19:23
	 */
	@Test
	public void doGetTestWayOne() {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 參數(shù)
		StringBuffer params = new StringBuffer();
		try {
			// 字符數(shù)據(jù)最好encoding以下;這樣一來，某些特殊字符才能傳過去(如:某人的名字就是“&”,不encoding的話,傳不過去)
			params.append("name=" + URLEncoder.encode("&", "utf-8"));
			params.append("&");
			params.append("age=24");
		} catch (UnsupportedEncodingException e1) {
			e1.printStackTrace();
		}
		// 創(chuàng)建Get請求
		HttpGet httpGet = new HttpGet("http://localhost:12345/doGetControllerTwo" + "?" + params);
		// 響應(yīng)模型
		CloseableHttpResponse response = null;
		try {
			// 配置信息
			RequestConfig requestConfig = RequestConfig.custom()
					// 設(shè)置連接超時時間(單位毫秒)
					.setConnectTimeout(5000)
					// 設(shè)置請求超時時間(單位毫秒)
					.setConnectionRequestTimeout(5000)
					// socket讀寫超時時間(單位毫秒)
					.setSocketTimeout(5000)
					// 設(shè)置是否允許重定向(默認為true)
					.setRedirectsEnabled(true).build();
			// 將上面的配置信息 運用到這個Get請求里
			httpGet.setConfig(requestConfig);
			// 由客戶端執(zhí)行(發(fā)送)Get請求
			response = httpClient.execute(httpGet);
			// 從響應(yīng)模型中獲取響應(yīng)實體
			HttpEntity responseEntity = response.getEntity();
			System.out.println("響應(yīng)狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				System.out.println("響應(yīng)內(nèi)容長度為:" + responseEntity.getContentLength());
				System.out.println("響應(yīng)內(nèi)容為:" + 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();
			}
		}
	}

對應(yīng)接收示例：

GET有參(方式二：使用URI獲得HttpGet)：

HttpClient發(fā)送示例：

    /**
	 * GET---有參測試 (方式二:將參數(shù)放入鍵值對類中,再放入URI中,從而通過URI得到HttpGet實例)
	 *
	 * @date 2018年7月13日 下午4:19:23
	 */
	@Test
	public void doGetTestWayTwo() {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 參數(shù)
		URI uri = null;
		try {
			// 將參數(shù)放入鍵值對類NameValuePair中,再放入集合中
			List<NameValuePair> params = new ArrayList<>();
			params.add(new BasicNameValuePair("name", "&"));
			params.add(new BasicNameValuePair("age", "18"));
			// 設(shè)置uri信息,并將參數(shù)集合放入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();
		}
		// 創(chuàng)建Get請求
		HttpGet httpGet = new HttpGet(uri);
		// 響應(yīng)模型
		CloseableHttpResponse response = null;
		try {
			// 配置信息
			RequestConfig requestConfig = RequestConfig.custom()
					// 設(shè)置連接超時時間(單位毫秒)
					.setConnectTimeout(5000)
					// 設(shè)置請求超時時間(單位毫秒)
					.setConnectionRequestTimeout(5000)
					// socket讀寫超時時間(單位毫秒)
					.setSocketTimeout(5000)
					// 設(shè)置是否允許重定向(默認為true)
					.setRedirectsEnabled(true).build();
			// 將上面的配置信息 運用到這個Get請求里
			httpGet.setConfig(requestConfig);
			// 由客戶端執(zhí)行(發(fā)送)Get請求
			response = httpClient.execute(httpGet);
			// 從響應(yīng)模型中獲取響應(yīng)實體
			HttpEntity responseEntity = response.getEntity();
			System.out.println("響應(yīng)狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				System.out.println("響應(yīng)內(nèi)容長度為:" + responseEntity.getContentLength());
				System.out.println("響應(yīng)內(nèi)容為:" + 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();
			}
		}
	}

對應(yīng)接收示例：

POST無參：

HttpClient發(fā)送示例：

    /**
	 * POST---無參測試
	 *
	 * @date 2018年7月13日 下午4:18:50
	 */
	@Test
	public void doPostTestOne() {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 創(chuàng)建Post請求
		HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerOne");
		// 響應(yīng)模型
		CloseableHttpResponse response = null;
		try {
			// 由客戶端執(zhí)行(發(fā)送)Post請求
			response = httpClient.execute(httpPost);
			// 從響應(yīng)模型中獲取響應(yīng)實體
			HttpEntity responseEntity = response.getEntity();
			System.out.println("響應(yīng)狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				System.out.println("響應(yīng)內(nèi)容長度為:" + responseEntity.getContentLength());
				System.out.println("響應(yīng)內(nèi)容為:" + 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();
			}
		}
	}

對應(yīng)接收示例：

POST有參(普通參數(shù))：

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

HttpClient發(fā)送示例：

    /**
	 * POST---有參測試(普通參數(shù))
	 *
	 * @date 2018年7月13日 下午4:18:50
	 */
	@Test
	public void doPostTestFour() {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 參數(shù)
		StringBuffer params = new StringBuffer();
		try {
			// 字符數(shù)據(jù)最好encoding以下;這樣一來，某些特殊字符才能傳過去(如:某人的名字就是“&”,不encoding的話,傳不過去)
			params.append("name=" + URLEncoder.encode("&", "utf-8"));
			params.append("&");
			params.append("age=24");
		} catch (UnsupportedEncodingException e1) {
			e1.printStackTrace();
		}
		// 創(chuàng)建Post請求
		HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerFour" + "?" + params);
		// 設(shè)置ContentType(注:如果只是傳普通參數(shù)的話,ContentType不一定非要用application/json)
		httpPost.setHeader("Content-Type", "application/json;charset=utf8");
		// 響應(yīng)模型
		CloseableHttpResponse response = null;
		try {
			// 由客戶端執(zhí)行(發(fā)送)Post請求
			response = httpClient.execute(httpPost);
			// 從響應(yīng)模型中獲取響應(yīng)實體
			HttpEntity responseEntity = response.getEntity();
			System.out.println("響應(yīng)狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				System.out.println("響應(yīng)內(nèi)容長度為:" + responseEntity.getContentLength());
				System.out.println("響應(yīng)內(nèi)容為:" + 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();
			}
		}
	}

對應(yīng)接收示例：

POST有參(對象參數(shù))：

先給出User類

HttpClient發(fā)送示例：

	/**
	 * POST---有參測試(對象參數(shù))
	 *
	 * @date 2018年7月13日 下午4:18:50
	 */
	@Test
	public void doPostTestTwo() {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 創(chuàng)建Post請求
		HttpPost httpPost = new HttpPost("http://localhost:12345/doPostControllerTwo");
		User user = new User();
		user.setName("潘曉婷");
		user.setAge(18);
		user.setGender("女");
		user.setMotto("姿勢要優(yōu)雅~");
		// 我這里利用阿里的fastjson，將Object轉(zhuǎn)換為json字符串;
		// (需要導入com.alibaba.fastjson.JSON包)
		String jsonString = JSON.toJSONString(user);
		StringEntity entity = new StringEntity(jsonString, "UTF-8");
		// post請求是將參數(shù)放在請求體里面?zhèn)鬟^去的;這里將entity放入post請求體中
		httpPost.setEntity(entity);
		httpPost.setHeader("Content-Type", "application/json;charset=utf8");
		// 響應(yīng)模型
		CloseableHttpResponse response = null;
		try {
			// 由客戶端執(zhí)行(發(fā)送)Post請求
			response = httpClient.execute(httpPost);
			// 從響應(yīng)模型中獲取響應(yīng)實體
			HttpEntity responseEntity = response.getEntity();
			System.out.println("響應(yīng)狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				System.out.println("響應(yīng)內(nèi)容長度為:" + responseEntity.getContentLength());
				System.out.println("響應(yīng)內(nèi)容為:" + 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();
			}
		}
	}

對應(yīng)接收示例：

POST有參(普通參數(shù) + 對象參數(shù))：

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

先給出User類：

HttpClient發(fā)送示例：

	/**
	 * POST---有參測試(普通參數(shù) + 對象參數(shù))
	 *
	 * @date 2018年7月13日 下午4:18:50
	 */
	@Test
	public void doPostTestThree() {
		// 獲得Http客戶端(可以理解為:你得先有一個瀏覽器;注意:實際上HttpClient與瀏覽器是不一樣的)
		CloseableHttpClient httpClient = HttpClientBuilder.create().build();
		// 創(chuàng)建Post請求
		// 參數(shù)
		URI uri = null;
		try {
			// 將參數(shù)放入鍵值對類NameValuePair中,再放入集合中
			List<NameValuePair> params = new ArrayList<>();
			params.add(new BasicNameValuePair("flag", "4"));
			params.add(new BasicNameValuePair("meaning", "這是什么鬼？"));
			// 設(shè)置uri信息,并將參數(shù)集合放入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");
		// 創(chuàng)建user參數(shù)
		User user = new User();
		user.setName("潘曉婷");
		user.setAge(18);
		user.setGender("女");
		user.setMotto("姿勢要優(yōu)雅~");
		// 將user對象轉(zhuǎn)換為json字符串，并放入entity中
		StringEntity entity = new StringEntity(JSON.toJSONString(user), "UTF-8");
		// post請求是將參數(shù)放在請求體里面?zhèn)鬟^去的;這里將entity放入post請求體中
		httpPost.setEntity(entity);
		httpPost.setHeader("Content-Type", "application/json;charset=utf8");
		// 響應(yīng)模型
		CloseableHttpResponse response = null;
		try {
			// 由客戶端執(zhí)行(發(fā)送)Post請求
			response = httpClient.execute(httpPost);
			// 從響應(yīng)模型中獲取響應(yīng)實體
			HttpEntity responseEntity = response.getEntity();
			System.out.println("響應(yīng)狀態(tài)為:" + response.getStatusLine());
			if (responseEntity != null) {
				System.out.println("響應(yīng)內(nèi)容長度為:" + responseEntity.getContentLength());
				System.out.println("響應(yīng)內(nèi)容為:" + 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();
			}
		}
	}