Java使用HttpClient詳細示例

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等)等
  • 支持自動(跳轉)轉向
  • ……

進入正題

環境說明: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();
			}
		}
	}

對應接收示例:

對評論區關註度較高的問題進行相關補充:

提示:如果想要知道完整的具體的代碼及測試細節,可去下面給的項目代碼托管鏈接,將項目clone下來進行觀察。如果需要運行測試,可以先啟動該SpringBoot項目,然後再運行相關test方法,進行測試。

解決響應亂碼問題(示例):

進行HTTPS請求並進行(或不進行)證書校驗(示例):

使用示例:

相關方法詳情(非完美封裝):

/**
 * 根據是否是https請求,獲取HttpClient客戶端
 *
 * TODO 本人這裡沒有進行完美封裝。對於 校不校驗校驗證書的選擇,本人這裡是寫死
 *      在代碼裡面的,你們在使用時,可以靈活二次封裝。
 *
 * 提示: 此工具類的封裝、相關客戶端、服務端證書的生成,可參考我的這篇博客:
 *      <linked>https://blog.csdn.net/justry_deng/article/details/91569132</linked>
 *
 *
 * @param isHttps 是否是HTTPS請求
 *
 * @return  HttpClient實例
 * @date 2019/9/18 17:57
 */
private CloseableHttpClient getHttpClient(boolean isHttps) {
   CloseableHttpClient httpClient;
   if (isHttps) {
      SSLConnectionSocketFactory sslSocketFactory;
      try {
         /// 如果不作證書校驗的話
         sslSocketFactory = getSocketFactory(false, null, null);
 
         /// 如果需要證書檢驗的話
         // 證書
         //InputStream ca = this.getClass().getClassLoader().getResourceAsStream("client/ds.crt");
         // 證書的別名,即:key。 註:cAalias隻需要保證唯一即可,不過推薦使用生成keystore時使用的別名。
         // String cAalias = System.currentTimeMillis() + "" + new SecureRandom().nextInt(1000);
         //sslSocketFactory = getSocketFactory(true, ca, cAalias);
      } catch (Exception e) {
         throw new RuntimeException(e);
      }
      httpClient = HttpClientBuilder.create().setSSLSocketFactory(sslSocketFactory).build();
      return httpClient;
   }
   httpClient = HttpClientBuilder.create().build();
   return httpClient;
}
 
/**
 * HTTPS輔助方法, 為HTTPS請求 創建SSLSocketFactory實例、TrustManager實例
 *
 * @param needVerifyCa
 *         是否需要檢驗CA證書(即:是否需要檢驗服務器的身份)
 * @param caInputStream
 *         CA證書。(若不需要檢驗證書,那麼此處傳null即可)
 * @param cAalias
 *         別名。(若不需要檢驗證書,那麼此處傳null即可)
 *         註意:別名應該是唯一的, 別名不要和其他的別名一樣,否者會覆蓋之前的相同別名的證書信息。別名即key-value中的key。
 *
 * @return SSLConnectionSocketFactory實例
 * @throws NoSuchAlgorithmException
 *         異常信息
 * @throws CertificateException
 *         異常信息
 * @throws KeyStoreException
 *         異常信息
 * @throws IOException
 *         異常信息
 * @throws KeyManagementException
 *         異常信息
 * @date 2019/6/11 19:52
 */
private static SSLConnectionSocketFactory getSocketFactory(boolean needVerifyCa, InputStream caInputStream, String cAalias)
      throws CertificateException, NoSuchAlgorithmException, KeyStoreException,
      IOException, KeyManagementException {
   X509TrustManager x509TrustManager;
   // https請求,需要校驗證書
   if (needVerifyCa) {
      KeyStore keyStore = getKeyStore(caInputStream, cAalias);
      TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
      trustManagerFactory.init(keyStore);
      TrustManager[] trustManagers = trustManagerFactory.getTrustManagers();
      if (trustManagers.length != 1 || !(trustManagers[0] instanceof X509TrustManager)) {
         throw new IllegalStateException("Unexpected default trust managers:" + Arrays.toString(trustManagers));
      }
      x509TrustManager = (X509TrustManager) trustManagers[0];
      // 這裡傳TLS或SSL其實都可以的
      SSLContext sslContext = SSLContext.getInstance("TLS");
      sslContext.init(null, new TrustManager[]{x509TrustManager}, new SecureRandom());
      return new SSLConnectionSocketFactory(sslContext);
   }
   // https請求,不作證書校驗
   x509TrustManager = new X509TrustManager() {
      @Override
      public void checkClientTrusted(X509Certificate[] arg0, String arg1) {
      }
 
      @Override
      public void checkServerTrusted(X509Certificate[] arg0, String arg1) {
         // 不驗證
      }
 
      @Override
      public X509Certificate[] getAcceptedIssuers() {
         return new X509Certificate[0];
      }
   };
   SSLContext sslContext = SSLContext.getInstance("TLS");
   sslContext.init(null, new TrustManager[]{x509TrustManager}, new SecureRandom());
   return new SSLConnectionSocketFactory(sslContext);
}
 
/**
 * 獲取(密鑰及證書)倉庫
 * 註:該倉庫用於存放 密鑰以及證書
 *
 * @param caInputStream
 *         CA證書(此證書應由要訪問的服務端提供)
 * @param cAalias
 *         別名
 *         註意:別名應該是唯一的, 別名不要和其他的別名一樣,否者會覆蓋之前的相同別名的證書信息。別名即key-value中的key。
 * @return 密鑰、證書 倉庫
 * @throws KeyStoreException 異常信息
 * @throws CertificateException 異常信息
 * @throws IOException 異常信息
 * @throws NoSuchAlgorithmException 異常信息
 * @date 2019/6/11 18:48
 */
private static KeyStore getKeyStore(InputStream caInputStream, String cAalias)
      throws KeyStoreException, CertificateException, IOException, NoSuchAlgorithmException {
   // 證書工廠
   CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509");
   // 秘鑰倉庫
   KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
   keyStore.load(null);
   keyStore.setCertificateEntry(cAalias, certificateFactory.generateCertificate(caInputStream));
   return keyStore;
}

application/x-www-form-urlencoded表單請求(示例):

發送文件(示例):

準備工作:

如果想要靈活方便的傳輸文件的話,除瞭引入org.apache.httpcomponents基本的httpclient依賴外再額外引入org.apache.httpcomponents的httpmime依賴。
P.S.:即便不引入httpmime依賴,也是能傳輸文件的,不過功能不夠強大。

在pom.xml中額外引入:

<!--
     如果需要靈活的傳輸文件,引入此依賴後會更加方便
-->
<dependency>
	<groupId>org.apache.httpcomponents</groupId>
	<artifactId>httpmime</artifactId>
	<version>4.5.5</version>
</dependency>

發送端是這樣的:

/**
 *
 * 發送文件
 *
 * multipart/form-data傳遞文件(及相關信息)
 *
 * 註:如果想要靈活方便的傳輸文件的話,
 *    除瞭引入org.apache.httpcomponents基本的httpclient依賴外
 *    再額外引入org.apache.httpcomponents的httpmime依賴。
 *    追註:即便不引入httpmime依賴,也是能傳輸文件的,不過功能不夠強大。
 *
 */
@Test
public void test4() {
   CloseableHttpClient httpClient = HttpClientBuilder.create().build();
   HttpPost httpPost = new HttpPost("http://localhost:12345/file");
   CloseableHttpResponse response = null;
   try {
      MultipartEntityBuilder multipartEntityBuilder = MultipartEntityBuilder.create();
      // 第一個文件
      String filesKey = "files";
      File file1 = new File("C:\\Users\\JustryDeng\\Desktop\\back.jpg");
      multipartEntityBuilder.addBinaryBody(filesKey, file1);
      // 第二個文件(多個文件的話,使用同一個key就行,後端用數組或集合進行接收即可)
      File file2 = new File("C:\\Users\\JustryDeng\\Desktop\\頭像.jpg");
      // 防止服務端收到的文件名亂碼。 我們這裡可以先將文件名URLEncode,然後服務端拿到文件名時在URLDecode。就能避免亂碼問題。
      // 文件名其實是放在請求頭的Content-Disposition裡面進行傳輸的,如其值為form-data; name="files"; filename="頭像.jpg"
      multipartEntityBuilder.addBinaryBody(filesKey, file2, ContentType.DEFAULT_BINARY, URLEncoder.encode(file2.getName(), "utf-8"));
      // 其它參數(註:自定義contentType,設置UTF-8是為瞭防止服務端拿到的參數出現亂碼)
      ContentType contentType = ContentType.create("text/plain", Charset.forName("UTF-8"));
      multipartEntityBuilder.addTextBody("name", "鄧沙利文", contentType);
      multipartEntityBuilder.addTextBody("age", "25", contentType);
 
      HttpEntity httpEntity = multipartEntityBuilder.build();
      httpPost.setEntity(httpEntity);
 
      response = httpClient.execute(httpPost);
      HttpEntity responseEntity = response.getEntity();
      System.out.println("HTTPS響應狀態為:" + response.getStatusLine());
      if (responseEntity != null) {
         System.out.println("HTTPS響應內容長度為:" + responseEntity.getContentLength());
         // 主動設置編碼,來防止響應亂碼
         String responseStr = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8);
         System.out.println("HTTPS響應內容為:" + responseStr);
      }
   } catch (ParseException | IOException e) {
      e.printStackTrace();
   } finally {
      try {
         // 釋放資源
         if (httpClient != null) {
            httpClient.close();
         }
         if (response != null) {
            response.close();
         }
      } catch (IOException e) {
         e.printStackTrace();
      }
   }
}

接收端是這樣的:

發送流(示例):

發送端是這樣的:

/**
 *
 * 發送流
 *
 */
@Test
public void test5() {
   CloseableHttpClient httpClient = HttpClientBuilder.create().build();
   HttpPost httpPost = new HttpPost("http://localhost:12345/is?name=鄧沙利文");
   CloseableHttpResponse response = null;
   try {
      InputStream is = new ByteArrayInputStream("流啊流~".getBytes());
      InputStreamEntity ise = new InputStreamEntity(is);
      httpPost.setEntity(ise);
 
      response = httpClient.execute(httpPost);
      HttpEntity responseEntity = response.getEntity();
      System.out.println("HTTPS響應狀態為:" + response.getStatusLine());
      if (responseEntity != null) {
         System.out.println("HTTPS響應內容長度為:" + responseEntity.getContentLength());
         // 主動設置編碼,來防止響應亂碼
         String responseStr = EntityUtils.toString(responseEntity, StandardCharsets.UTF_8);
         System.out.println("HTTPS響應內容為:" + responseStr);
      }
   } catch (ParseException | IOException e) {
      e.printStackTrace();
   } finally {
      try {
         // 釋放資源
         if (httpClient != null) {
            httpClient.close();
         }
         if (response != null) {
            response.close();
         }
      } catch (IOException e) {
         e.printStackTrace();
      }
   }
}

接收端是這樣的:

再次提示:如果想要自己進行測試,可去下面給的項目代碼托管鏈接,將項目clone下來,然後先啟動該SpringBoot項目,然後再運行相關test方法,進行測試。

工具類提示:使用HttpClient時,可以視情況將其寫為工具類。如:Github上Star非常多的一個HttpClient的工具類是httpclientutil。本人在這裡也推薦使用該工具類,因為該工具類的編寫者封裝瞭很多功能在裡面,如果不是有什麼特殊的需求的話,完全可以不用造輪子,可以直接使用該工具類。使用方式很簡單,可詳見https://github.com/Arronlong/httpclientutil。

以上所述是小編給大傢介紹的Java使用HttpClient詳細示例,希望對大傢有所幫助。在此也非常感謝大傢對WalkonNet網站的支持!

推薦閱讀: