1. 程式人生 > >Apache HttpClient使用詳解

Apache HttpClient使用詳解

轉載地址:http://eksliang.iteye.com/blog/2191017

Http協議的重要性相信不用我多說了,HttpClient相比傳統JDK自帶的URLConnection,增加了易用性和靈活性(具體區別,日後我們再討論),它不僅是客戶端傳送Http請求變得容易,而且也方便了開發人員測試介面(基於Http協議的),即提高了開發的效率,也方便提高程式碼的健壯性。因此熟練掌握HttpClient是很重要的必修內容,掌握HttpClient後,相信對於Http協議的瞭解會更加深入。

一、簡介

HttpClient是Apache Jakarta Common下的子專案,用來提供高效的、最新的、功能豐富的支援HTTP協議的客戶端程式設計工具包,並且它支援HTTP協議最新的版本和建議。HttpClient已經應用在很多的專案中,比如Apache Jakarta上很著名的另外兩個開源專案Cactus和HTMLUnit都使用了HttpClient。

二、特性

1. 基於標準、純淨的java語言。實現了Http1.0和Http1.1

2. 以可擴充套件的面向物件的結構實現了Http全部的方法(GET, POST, PUT, DELETE, HEAD, OPTIONS, and TRACE)。

3. 支援HTTPS協議。

4. 通過Http代理建立透明的連線。

5. 利用CONNECT方法通過Http代理建立隧道的https連線。

6. Basic, Digest, NTLMv1, NTLMv2, NTLM2 Session, SNPNEGO/Kerberos認證方案。

7. 外掛式的自定義認證方案。

8. 便攜可靠的套接字工廠使它更容易的使用第三方解決方案。

9. 連線管理器支援多執行緒應用。支援設定最大連線數,同時支援設定每個主機的最大連線數,發現並關閉過期的連線。

10. 自動處理Set-Cookie中的Cookie。

11. 外掛式的自定義Cookie策略。

12. Request的輸出流可以避免流中內容直接緩衝到socket伺服器。

13. Response的輸入流可以有效的從socket伺服器直接讀取相應內容。

14. 在http1.0和http1.1中利用KeepAlive保持持久連線。

15. 直接獲取伺服器傳送的response code和 headers。

16. 設定連線超時的能力。

17. 實驗性的支援http1.1 response caching。

18. 原始碼基於Apache License 可免費獲取

三、使用方法

       Mavn座標

Java程式碼  收藏程式碼
  1. <dependency>  
  2.     <groupId>org.apache.httpcomponents</groupId>  
  3.     <artifactId>httpclient</artifactId>  
  4.     <version>4.3.4</version>  
  5. </dependency>  

使用HttpClient傳送請求、接收響應很簡單,一般需要如下幾步即可。

1. 建立HttpClient物件。

2. 建立請求方法的例項,並指定請求URL。如果需要傳送GET請求,建立HttpGet物件;如果需要傳送POST請求,建立HttpPost物件。

3. 如果需要傳送請求引數,可呼叫HttpGet、HttpPost共同的setParams(HetpParams params)方法來新增請求引數;對於HttpPost物件而言,也可呼叫setEntity(HttpEntity entity)方法來設定請求引數。

4. 呼叫HttpClient物件的execute(HttpUriRequest request)傳送請求,該方法返回一個HttpResponse。

5. 呼叫HttpResponse的getAllHeaders()、getHeaders(String name)等方法可獲取伺服器的響應頭;呼叫HttpResponse的getEntity()方法可獲取HttpEntity物件,該物件包裝了伺服器的響應內容。程式可通過該物件獲取伺服器的響應內容。

6. 釋放連線。無論執行方法是否成功,都必須釋放連線

四.post跟get請求示例
Java程式碼  收藏程式碼
  1. package com.ickes;  
  2. import java.util.ArrayList;  
  3. import java.util.List;  
  4. import org.apache.http.HttpEntity;  
  5. import org.apache.http.NameValuePair;  
  6. import org.apache.http.client.entity.UrlEncodedFormEntity;  
  7. import org.apache.http.client.methods.CloseableHttpResponse;  
  8. import org.apache.http.client.methods.HttpGet;  
  9. import org.apache.http.client.methods.HttpPost;  
  10. import org.apache.http.entity.StringEntity;  
  11. import org.apache.http.impl.client.CloseableHttpClient;  
  12. import org.apache.http.impl.client.HttpClients;  
  13. import org.apache.http.message.BasicNameValuePair;  
  14. import org.apache.http.protocol.HTTP;  
  15. import org.apache.http.util.EntityUtils;  
  16. public class HttpClientDemo {  
  17.     public static void main(String[] args) throws Exception  {   
  18.         get();  
  19.     }  
  20.     /** 
  21.      * post方式提交json程式碼 
  22.      * @throws Exception  
  23.      */  
  24.     public static void postJson() throws Exception{  
  25.         //建立預設的httpClient例項.   
  26.         CloseableHttpClient httpclient = null;  
  27.         //接收響應結果  
  28.         CloseableHttpResponse response = null;  
  29.         try {  
  30.             //建立httppost  
  31.             httpclient = HttpClients.createDefault();    
  32.             String url ="http://192.168.16.36:8081/goSearch/gosuncn/deleteDocs.htm";  
  33.             HttpPost httpPost = new HttpPost(url);  
  34.             httpPost.addHeader(HTTP.CONTENT_TYPE,"application/x-www-form-urlencoded");  
  35.             //引數  
  36.             String json ="{'ids':['html1','html2']}";  
  37.             StringEntity se = new StringEntity(json);  
  38.             se.setContentEncoding("UTF-8");  
  39.             se.setContentType("application/json");//傳送json需要設定contentType  
  40.             httpPost.setEntity(se);  
  41.             response = httpclient.execute(httpPost);  
  42.             //解析返結果  
  43.             HttpEntity entity = response.getEntity();   
  44.             if(entity != null){  
  45.                 String resStr = EntityUtils.toString(entity, "UTF-8");      
  46.                 System.out.println(resStr);  
  47.             }  
  48.         } catch (Exception e) {  
  49.             throw e;  
  50.         }finally{  
  51.             httpclient.close();  
  52.             response.close();  
  53.         }  
  54.     }  
  55.      /**  
  56.      * post方式提交表單(模擬使用者登入請求)  
  57.      * @throws Exception  
  58.      */    
  59.     public static void postForm() throws Exception  {    
  60.         // 建立預設的httpClient例項.      
  61.         CloseableHttpClient httpclient = null;  
  62.         //傳送請求  
  63.         CloseableHttpResponse response = null;  
  64.         try {  
  65.             httpclient = HttpClients.createDefault();    
  66.             // 建立httppost      
  67.             String url= "http://localhost:8080/search/ajx/user.htm";  
  68.             HttpPost httppost = new HttpPost(url);    
  69.             // 建立引數佇列      
  70.             List<NameValuePair> formparams = new ArrayList<NameValuePair>();    
  71.             formparams.add(new BasicNameValuePair("username""admin"));    
  72.             formparams.add(new BasicNameValuePair("password""123456"));  
  73.             //引數轉碼  
  74.             UrlEncodedFormEntity uefEntity = new UrlEncodedFormEntity(formparams, "UTF-8");    
  75.             httppost.setEntity(uefEntity);   
  76.             response = httpclient.execute(httppost);    
  77.             HttpEntity entity = response.getEntity();    
  78.             if (entity != null) {    
  79.                   System.out.println(EntityUtils.toString(entity, "UTF-8"));    
  80.             }    
  81.             //釋放連線  
  82.         } catch (Exception e) {  
  83.             throw e;  
  84.         }finally{  
  85.              httpclient.close();  
  86.              response.close();  
  87.         }  
  88.     }    
  89.     /**  
  90.      * 傳送 get請求  
  91.      * @throws Exception  
  92.      */    
  93.     public static void get() throws Exception {    
  94.         CloseableHttpClient httpclient = null;  
  95.         CloseableHttpResponse response = null;  
  96.         try {  
  97.             httpclient = HttpClients.createDefault();    
  98.             // 建立httpget.      
  99.             HttpGet httpget = new HttpGet("http://www.baidu.com/");    
  100.             // 執行get請求.      
  101.             response = httpclient.execute(httpget);    
  102.             // 獲取響應實體      
  103.             HttpEntity entity = response.getEntity();    
  104.             // 列印響應狀態      
  105.             System.out.println(response.getStatusLine().getStatusCode());    
  106.             if (entity != null) {    
  107.                 // 列印響應內容      
  108.                 System.out.println("Response content: " + EntityUtils.toString(entity));    
  109.             }  
  110.         } catch (Exception e) {  
  111.             throw e;  
  112.         }finally{  
  113.             httpclient.close();  
  114.             response.close();  
  115.         }  
  116.     }  
  117. }  
五、SSL跟上傳檔案例項
Java程式碼  收藏程式碼
  1. package com.test;  
  2. import java.io.File;  
  3. import java.io.FileInputStream;  
  4. import java.io.IOException;  
  5. import java.io.UnsupportedEncodingException;  
  6. import java.security.KeyManagementException;  
  7. import java.security.KeyStore;  
  8. import java.security.KeyStoreException;  
  9. import java.security.NoSuchAlgorithmException;  
  10. import java.security.cert.CertificateException;  
  11. import java.util.ArrayList;  
  12. import java.util.List;  
  13. import javax.net.ssl.SSLContext;  
  14. import org.apache.http.HttpEntity;  
  15. import org.apache.http.NameValuePair;  
  16. import org.apache.http.ParseException;  
  17. import org.apache.http.client.ClientProtocolException;  
  18. import org.apache.http.client.entity.UrlEncodedFormEntity;  
  19. import org.apache.http.client.methods.CloseableHttpResponse;  
  20. import org.apache.http.client.methods.HttpGet;  
  21. import org.apache.http.client.methods.HttpPost;  
  22. import org.apache.http.conn.ssl.SSLConnectionSocketFactory;  
  23. import org.apache.http.conn.ssl.SSLContexts;  
  24. import org.apache.http.conn.ssl.TrustSelfSignedStrategy;  
  25. import org.apache.http.entity.ContentType;  
  26. import org.apache.http.entity.mime.MultipartEntityBuilder;  
  27. import org.apache.http.entity.mime.content.FileBody;  
  28. import org.apache.http.entity.mime.content.StringBody;  
  29. import org.apache.http.impl.client.CloseableHttpClient;  
  30. import org.apache.http.impl.client.HttpClients;  
  31. import org.apache.http.message.BasicNameValuePair;  
  32. import org.apache.http.util.EntityUtils;  
  33. import org.junit.Test;  
  34. public class HttpClientTest {  
  35.     @Test  
  36.     public void jUnitTest() {  
  37.         ssl();  
  38.     }  
  39.     /** 
  40.      * HttpClient連線SSL 
  41.      */  
  42.     public void ssl() {  
  43.         CloseableHttpClient httpclient = null;  
  44.         try {  
  45.             KeyStore trustStore = KeyStore.getInstance(KeyStore.getDefaultType());  
  46.             FileInputStream instream = new FileInputStream(new File("d:\\tomcat.keystore"));  
  47.             try {  
  48.                 // 載入keyStore d:\\tomcat.keystore    
  49.                 trustStore.load(instream, "123456".toCharArray());  
  50.             } catch (CertificateException e) {  
  51.                 e.printStackTrace();  
  52.             } finally {  
  53.                 try {  
  54.                     instream.close();  
  55.                 } catch (Exception ignore) {  
  56.                 }  
  57.             }  
  58.             // 相信自己的CA和所有自簽名的證書  
  59.             SSLContext sslcontext = SSLContexts.custom().loadTrustMaterial(trustStore, new TrustSelfSignedStrategy()).build();  
  60.             // 只允許使用TLSv1協議  
  61.             SSLConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(sslcontext, new String[] { "TLSv1" }, null,  
  62.                     SSLConnectionSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER);  
  63.             httpclient = HttpClients.custom().setSSLSocketFactory(sslsf).build();  
  64.             // 建立http請求(get方式)  
  65.             HttpGet httpget = new HttpGet("https://localhost:8443/myDemo/Ajax/serivceJ.action");  
  66.             System.out.println("executing request" + httpget.getRequestLine());  
  67.             CloseableHttpResponse response = httpclient.execute(httpget);  
  68.             try {  
  69.                 HttpEntity entity = response.getEntity();  
  70.                 System.out.println("----------------------------------------");  
  71.                 System.out.println(response.getStatusLine());  
  72.                 if (entity != null) {  
  73.                     System.out.println("Response content length: " + entity.getContentLength());  
  74.                     System.out.println(EntityUtils.toString(entity));  
  75.                     EntityUtils.consume(entity);  
  76.                 }  
  77.             } finally {  
  78.                 response.close();  
  79.             }  
  80.         } catch (ParseException e) {  
  81.             e.printStackTrace();  
  82.         } catch (IOException e) {  
  83.             e.printStackTrace();  
  84.         } catch (KeyManagementException e) {  
  85.             e.printStackTrace();  
  86.         } catch (NoSuchAlgorithmException e) {  
  87.             e.printStackTrace();  
  88.         } catch (KeyStoreException e) {  
  89.             e.printSta