HttpURLConnection與HttpClient淺析
1. GET請求與POST請求
HTTP協議是現在Internet上使用得最多、最重要的協議了,越來越多的Java應用程序需要直接通過HTTP協議來訪問網絡資源。
在介紹HttpURLConnection前,我們還是再來說一下URL請求最常用的兩種方式:GET請求與POST請求。
GET請求的數據會附在URL之后(就是把數據放置在HTTP協議頭中),以?分割URL和傳輸數據,參數之間以&相連,如:http://localhost:8080/test.do?name=test&password=123456。
GET請求發送的參數如果數據是英文字母或數字,則按原樣發送,如果是空格,則轉換為+,如果是中文或其他字符,則直接把字符串用BASE64加密,得出如 %E4%BD%A0%E5%A5%BD
這類似的字符串,其中%XX中的XX為該符號以16進制表示的ASCII。
POST請求的參數不是放在URL字符串里面,而是放在HTTP請求的正文內,請求的參數被封裝起來以流的形式發送給服務端。
對於GET方式提交數據的大小,HTTP協議並沒有硬性限制,但某些瀏覽器及服務器會對它進行限制,如IE對URL長度的限制是2083字節(2K+35)。理論上POST也沒有限制,可傳較大量的數據。
POST的安全性要比GET的安全性高。比如:通過GET提交數據,用戶名和密碼將明文出現在URL上,因為登錄頁面有可能被瀏覽器緩存,如果其他人查看瀏覽器的歷史紀錄,那么別人就可以拿到你的賬號和密碼了,除此之外,使用GET提交數據還可能會造成Cross-site request forgery(CSRF,跨站請求偽造)攻擊。
一般來說,Get是向服務器索取數據的一種請求,而Post是向服務器提交數據的一種請求。
2. HttpURLConnection簡介
在JDK的java.net包中已經提供了訪問HTTP協議的基本功能的類:HttpURLConnection。
HttpURLConnection是Java的標准類,它繼承自URLConnection,可用於向指定網站發送GET請求、POST請求。它在URLConnection的基礎上提供了如下便捷的方法:
int getResponseCode(); // 獲取服務器的響應代碼。 String getResponseMessage(); // 獲取服務器的響應消息。 String getResponseMethod(); // 獲取發送請求的方法。 void setRequestMethod(String method); // 設置發送請求的方法。
3. HttpURLConnection的使用
3.1 使用GET方式訪問HTTP
1 package com.qf.demo; 2 3 import java.io.BufferedReader; 4 import java.io.IOException; 5 import java.io.InputStreamReader; 6 import java.net.HttpURLConnection; 7 import java.net.URL; 8 9 /** 10 * GET請求示例 11 * 12 * @author 戴同學 13 * 14 */ 15 public class GetDemo { 16 17 public static void main(String[] args) { 18 try { 19 // 1. 得到訪問地址的URL 20 URL url = new URL( 21 "http://localhost:8080/Servlet/do_login.do?username=test&password=123456"); 22 // 2. 得到網絡訪問對象java.net.HttpURLConnection 23 HttpURLConnection connection = (HttpURLConnection) url 24 .openConnection(); 25 /* 3. 設置請求參數(過期時間,輸入、輸出流、訪問方式),以流的形式進行連接 */ 26 // 設置是否向HttpURLConnection輸出 27 connection.setDoOutput(false); 28 // 設置是否從httpUrlConnection讀入 29 connection.setDoInput(true); 30 // 設置請求方式 31 connection.setRequestMethod("GET"); 32 // 設置是否使用緩存 33 connection.setUseCaches(true); 34 // 設置此 HttpURLConnection 實例是否應該自動執行 HTTP 重定向 35 connection.setInstanceFollowRedirects(true); 36 // 設置超時時間 37 connection.setConnectTimeout(3000); 38 // 連接 39 connection.connect(); 40 // 4. 得到響應狀態碼的返回值 responseCode 41 int code = connection.getResponseCode(); 42 // 5. 如果返回值正常,數據在網絡中是以流的形式得到服務端返回的數據 43 String msg = ""; 44 if (code == 200) { // 正常響應 45 // 從流中讀取響應信息 46 BufferedReader reader = new BufferedReader( 47 new InputStreamReader(connection.getInputStream())); 48 String line = null; 49 50 while ((line = reader.readLine()) != null) { // 循環從流中讀取 51 msg += line + "\n"; 52 } 53 reader.close(); // 關閉流 54 } 55 // 6. 斷開連接,釋放資源 56 connection.disconnect(); 57 58 // 顯示響應結果 59 System.out.println(msg); 60 } catch (IOException e) { 61 e.printStackTrace(); 62 } 63 } 64 }
3.2 使用POST方式訪問HTTP
1 package com.qf.demo; 2 3 import java.io.BufferedReader; 4 import java.io.IOException; 5 import java.io.InputStreamReader; 6 import java.io.OutputStream; 7 import java.net.HttpURLConnection; 8 import java.net.MalformedURLException; 9 import java.net.URL; 10 11 /** 12 * POST請求示例 13 * 14 * @author 戴同學 15 * 16 */ 17 public class PostDemo { 18 19 public static void main(String[] args) { 20 try { 21 // 1. 獲取訪問地址URL 22 URL url = new URL("http://localhost:8080/Servlet/do_login.do"); 23 // 2. 創建HttpURLConnection對象 24 HttpURLConnection connection = (HttpURLConnection) url 25 .openConnection(); 26 /* 3. 設置請求參數等 */ 27 // 請求方式 28 connection.setRequestMethod("POST"); 29 // 超時時間 30 connection.setConnectTimeout(3000); 31 // 設置是否輸出 32 connection.setDoOutput(true); 33 // 設置是否讀入 34 connection.setDoInput(true); 35 // 設置是否使用緩存 36 connection.setUseCaches(false); 37 // 設置此 HttpURLConnection 實例是否應該自動執行 HTTP 重定向 38 connection.setInstanceFollowRedirects(true); 39 // 設置使用標准編碼格式編碼參數的名-值對 40 connection.setRequestProperty("Content-Type", 41 "application/x-www-form-urlencoded"); 42 // 連接 43 connection.connect(); 44 /* 4. 處理輸入輸出 */ 45 // 寫入參數到請求中 46 String params = "username=test&password=123456"; 47 OutputStream out = connection.getOutputStream(); 48 out.write(params.getBytes()); 49 out.flush(); 50 out.close(); 51 // 從連接中讀取響應信息 52 String msg = ""; 53 int code = connection.getResponseCode(); 54 if (code == 200) { 55 BufferedReader reader = new BufferedReader( 56 new InputStreamReader(connection.getInputStream())); 57 String line; 58 59 while ((line = reader.readLine()) != null) { 60 msg += line + "\n"; 61 } 62 reader.close(); 63 } 64 // 5. 斷開連接 65 connection.disconnect(); 66 67 // 處理結果 68 System.out.println(msg); 69 } catch (MalformedURLException e) { 70 e.printStackTrace(); 71 } catch (IOException e) { 72 e.printStackTrace(); 73 } 74 } 75 }
3.3 說明
- HttpURLConnection對象不能直接構造,需要通過URL類中的openConnection()方法來獲得。
- HttpURLConnection的connect()函數,實際上只是建立了一個與服務器的TCP連接,並沒有實際發送HTTP請求。HTTP請求實際上直到我們獲取服務器響應數據(如調用getInputStream()、getResponseCode()等方法)時才正式發送出去。
- 對HttpURLConnection對象的配置都需要在connect()方法執行之前完成。
- HttpURLConnection是基於HTTP協議的,其底層通過socket通信實現。如果不設置超時(timeout),在網絡異常的情況下,可能會導致程序僵死而不繼續往下執行。
- HTTP正文的內容是通過OutputStream流寫入的, 向流中寫入的數據不會立即發送到網絡,而是存在於內存緩沖區中,待流關閉時,根據寫入的內容生成HTTP正文。
- 調用getInputStream()方法時,返回一個輸入流,用於從中讀取服務器對於HTTP請求的返回信息。
- 我們可以使用HttpURLConnection.connect()方法手動的發送一個HTTP請求,但是如果要獲取HTTP響應的時候,請求就會自動的發起,比如我們使用HttpURLConnection.getInputStream()方法的時候,所以完全沒有必要調用connect()方法。
4. HttpClient簡介
在一般情況下,如果只是需要向Web站點的某個簡單頁面提交請求並獲取服務器響應,HttpURLConnection完全可以勝任。但在絕大部分情況下,Web站點的網頁可能沒這么簡單,這些頁面並不是通過一個簡單的URL就可訪問的,可能需要用戶登錄而且具有相應的權限才可訪問該頁面。在這種情況下,就需要涉及Session、Cookie的處理了,如果打算使用HttpURLConnection來處理這些細節,當然也是可能實現的,只是處理起來難度就大了。
為了更好地處理向Web站點請求,包括處理Session、Cookie等細節問題,Apache開源組織提供了一個HttpClient項目,看它的名稱就知道,它是一個簡單的HTTP客戶端(並不是瀏覽器),可以用於發送HTTP請求,接收HTTP響應。但不會緩存服務器的響應,不能執行HTML頁面中嵌入的Javascript代碼;也不會對頁面內容進行任何解析、處理。
簡單來說,HttpClient就是一個增強版的HttpURLConnection,HttpURLConnection可以做的事情HttpClient全部可以做;HttpURLConnection沒有提供的有些功能,HttpClient也提供了,但它只是關注於如何發送請求、接收響應,以及管理HTTP連接。
5. HttpClient的使用
使用HttpClient發送請求、接收響應很簡單,只要如下幾步即可。
- 創建HttpClient對象。
- 如果需要發送GET請求,創建HttpGet對象;如果需要發送POST請求,創建HttpPost對象。
- 如果需要發送請求參數,可調用HttpGet、HttpPost共同的setParams(HttpParams params)方法來添加請求參數;對於HttpPost對象而言,也可調用setEntity(HttpEntity entity)方法來設置請求參數。
- 調用HttpClient對象的execute(HttpUriRequest request)發送請求,執行該方法返回一個HttpResponse。
- 調用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可獲取服務器的響應頭;調用HttpResponse的getEntity()方法可獲取HttpEntity對象,該對象包裝了服務器的響應內容。程序可通過該對象獲取服務器的響應內容。
5.1 使用GET方式訪問HTTP
1 package com.qf.client; 2 3 import java.io.IOException; 4 5 import org.apache.http.HttpEntity; 6 import org.apache.http.client.ClientProtocolException; 7 import org.apache.http.client.methods.CloseableHttpResponse; 8 import org.apache.http.client.methods.HttpGet; 9 import org.apache.http.impl.client.CloseableHttpClient; 10 import org.apache.http.impl.client.HttpClientBuilder; 11 import org.apache.http.util.EntityUtils; 12 13 /** 14 * GET請求示例 15 * 16 * @author 戴同學 17 * 18 */ 19 public class GetDemo { 20 21 public static void main(String[] args) { 22 // 1. 創建HttpClient對象 23 CloseableHttpClient httpClient = HttpClientBuilder.create().build(); 24 // 2. 創建HttpGet對象 25 HttpGet httpGet = new HttpGet( 26 "http://localhost:8080/Servlet/do_login.do?username=test&password=123456"); 27 CloseableHttpResponse response = null; 28 try { 29 // 3. 執行GET請求 30 response = httpClient.execute(httpGet); 31 System.out.println(response.getStatusLine()); 32 // 4. 獲取響應實體 33 HttpEntity entity = response.getEntity(); 34 // 5. 處理響應實體 35 if (entity != null) { 36 System.out.println("長度:" + entity.getContentLength()); 37 System.out.println("內容:" + EntityUtils.toString(entity)); 38 } 39 } catch (ClientProtocolException e) { 40 e.printStackTrace(); 41 } catch (IOException e) { 42 e.printStackTrace(); 43 } finally { 44 // 6. 釋放資源 45 try { 46 response.close(); 47 httpClient.close(); 48 } catch (IOException e) { 49 e.printStackTrace(); 50 } 51 } 52 } 53 }
5.2 使用POST方式訪問HTTP
1 package com.qf.client; 2 3 import java.io.IOException; 4 import java.io.UnsupportedEncodingException; 5 import java.util.ArrayList; 6 import java.util.List; 7 8 import org.apache.http.HttpEntity; 9 import org.apache.http.NameValuePair; 10 import org.apache.http.client.ClientProtocolException; 11 import org.apache.http.client.entity.UrlEncodedFormEntity; 12 import org.apache.http.client.methods.CloseableHttpResponse; 13 import org.apache.http.client.methods.HttpPost; 14 import org.apache.http.impl.client.CloseableHttpClient; 15 import org.apache.http.impl.client.HttpClientBuilder; 16 import org.apache.http.message.BasicNameValuePair; 17 import org.apache.http.util.EntityUtils; 18 19 /** 20 * POST請求測試 21 * 22 * @author 戴同學 23 * 24 */ 25 public class PostDemo { 26 27 public static void main(String[] args) { 28 // 1. 創建HttpClient對象 29 CloseableHttpClient httpClient = HttpClientBuilder.create().build(); 30 // 2. 創建HttpPost對象 31 HttpPost post = new HttpPost( 32 "http://localhost:8080/Servlet/do_login.do"); 33 // 3. 設置POST請求傳遞參數 34 List<NameValuePair> params = new ArrayList<NameValuePair>(); 35 params.add(new BasicNameValuePair("username", "test")); 36 params.add(new BasicNameValuePair("password", "12356")); 37 try { 38 UrlEncodedFormEntity entity = new UrlEncodedFormEntity(params); 39 post.setEntity(entity); 40 } catch (UnsupportedEncodingException e) { 41 e.printStackTrace(); 42 } 43 // 4. 執行請求並處理響應 44 try { 45 CloseableHttpResponse response = httpClient.execute(post); 46 HttpEntity entity = response.getEntity(); 47 if (entity != null){ 48 System.out.println("響應內容:"); 49 System.out.println(EntityUtils.toString(entity)); 50 } 51 response.close(); 52 } catch (ClientProtocolException e) { 53 e.printStackTrace(); 54 } catch (IOException e) { 55 e.printStackTrace(); 56 } finally { 57 // 釋放資源 58 try { 59 httpClient.close(); 60 } catch (IOException e) { 61 e.printStackTrace(); 62 } 63 } 64 } 65 }
5.3 說明
HttpClient相比傳統JDK自帶的URLConnection,增加了易用性和靈活性,它不僅使客戶端發送HTTP請求變得容易,而且也方便了開發人員測試接口(基於Http協議的),即提高了開發的效率,也方便提高代碼的健壯性。