目錄:
內容分塊
? ? ? ? ?HTTP報文可以攜帶和請求或響應相關的內容實體。實體可以在一些請求和響應中找到,因為它們也是可選的。使用了實體的請求被稱為封閉實體請求。HTTP規范定義了兩種封閉實體的方法:POST和PUT。響應通常期望包含一個內容實體。這個規則也有特例,比如HEAD方法的響應和204 NoContent,304 Not Modified和205 Reset Content響應。
HttpClient根據其內容出自何處區分三種類型的實體:
streamed流式
????????內容從流中獲得,或者在運行中產生。特別是這種分類包含從HTTP響應中獲取的實體。流式實體是不可重復生成的。
self-contained自我包含式
????????內容在內存中或通過獨立的連接或其它實體中獲得。自我包含式的實體是可以重復生成的。這種類型的實體會經常用于封閉HTTP請求的實體。
wrapping包裝式
????????內容從另外一個實體中獲得。
????????當從一個HTTP響應中獲取流式內容時,這個區別對于連接管理很重要。對于由應用程序創建而且只使用HttpClient發送的請求實體,流式和自我包含式的不同就不那么重要了。這種情況下,建議考慮如流式這種不能重復的實體,和可以重復的自我包含式實體。
重復實體
實體可以重復,意味著它的內容可以被多次讀取。這就僅僅是自我包含式的實體了(像ByteArrayEntity或StringEntity)。
使用HTTP實體
????????一個實體既可以代表二進制內容又可以代表字符內容,同時也支持字符編碼。實體是在使用封閉內容執行請求,或當請求已經成功執行,或當響應體結果發送到客戶端時創建的。
????????要從實體中讀取內容,可以通過HttpEntity#getContent()方法從輸入流中獲取,這會返回一個java.io.InputStream對象,或者提供一個輸出流到HttpEntity#writeTo(OutputStream)方法中,這會一次返回所有寫入到給定流中的內容。
????????當實體通過一個收到的報文獲取時,HttpEntity#getContentType()方法和?HttpEntity#getContentLength()方法可以用來讀取通用的元數據,如Content-Type和Content-Length頭部信息(如果它們是可用的)。因為頭部信息Content-Type可以包含對文本MIME類型的字符編碼,比如text/plain或text /html,HttpEntity#getContentEncoding()方法用來讀取這個信息。如果頭部信息不可用,那么就返回長度-1,而對于內容類型返回NULL。如果頭部信息Content-Type是可用的,那么就會返回一個Header對象。
StringEntity entity =new?StringEntity("important message","UTF-8");
System.out.println(entity.getContentType());
System.out.println(entity.getContentLength());
System.out.println(ContentType.getOrDefault(entity));
System.out.println(EntityUtils.toString(entity));
System.out.println(EntityUtils.toByteArray(entity).length);
輸出:Content-Type: text/plain; charset=UTF-8
17
text/plain; charset=UTF-8
important message
17
確保低級別資源釋放
????????當完成一個響應實體,那么保證所有實體內容已經被完全消耗是很重要的,所以連接可以安全的放回到連接池中,而且可以通過連接管理器對后續的請求重用連接。處理這個操作的最方便的方法是調用HttpEntity#consumeContent()方法來消耗流中的任意可用內容。HttpClient探測到內容流尾部已經到達后,會立即會自動釋放低層連接,并放回到連接管理器。HttpEntity#consumeContent()方法調用多次也是安全的。
????????也可能會有特殊情況,當整個響應內容的一小部分需要獲取,消耗剩余內容而損失性能,還有重用連接的代價太高,則可以僅僅通過調用HttpUriRequest#abort()方法來中止請求。
HttpGet httpGet =new?HttpGet("http://www.baidu.com");
HttpResponse response = client.execute(httpGet);
HttpEntity entity = response.getEntity();
if?(entity !=null) {
InputStream instream = entity.getContent();
int?byteOne = instream.read();
int?byteTwo = instream.read();
// Do not need the rest
httpGet.abort();
}
連接不會被重用,但是由它持有的所有級別的資源將會被正確釋放。
消耗實體內容
????????推薦消耗實體內容的方式是使用它的HttpEntity#getContent()或HttpEntity#writeTo(OutputStream)方法。HttpClient也自帶EntityUtils類,這會暴露出一些靜態方法,這些方法可以更加容易地從實體中讀取內容或信息。代替直接讀取?java.io.InputStream,也可以使用這個類中的方法以字符串/字節數組的形式獲取整個內容體。然而,EntityUtils的使用是強烈不鼓勵的,除非響應實體源自可靠的HTTP服務器和已知的長度限制。
HttpGet httpGet =new?HttpGet("http://localhost/");
HttpResponse response = client.execute(httpGet);
HttpEntity entity = response.getEntity();
if?(entity !=null) {
long?len = entity.getContentLength();
if?(len != -1 && len < 2048) {
System.out.println(EntityUtils.toString(entity));
}?else?{
// Stream content out
}
}
????????在一些情況下可能會不止一次的讀取實體。此時實體內容必須以某種方式在內存或磁盤上被緩沖起來。最簡單的方法是通過使用BufferedHttpEntity類來包裝源實體完成。這會引起源實體內容被讀取到內存的緩沖區中。在其它所有方式中,實體包裝器將會得到源實體。
HttpGet httpGet =new?HttpGet("http://localhost/");
HttpResponse response = client.execute(httpGet);
HttpEntity entity = response.getEntity();
if?(entity !=null) {
entity =?new?BufferedHttpEntity(entity);
}
生成實體內容
????????HttpClient提供一些類,它們可以用于生成通過HTTP連接獲得內容的有效輸出流。為了封閉實體從HTTP請求中獲得的輸出內容,那些類的實例可以和封閉如POST和PUT請求的實體相關聯。HttpClient為很多公用的數據容器,比如字符串,字節數組,輸入流和文件提供了一些類:StringEntity,ByteArrayEntity,InputStreamEntity和FileEntity。
File file =new?File("somefile.txt");
ContentType contentType = ContentType.create("text/plain","UTF-8");
FileEntity entity =new?FileEntity(file, contentType);
HttpPost httpPost =new?HttpPost("http://localhost/action.do");
httpPost.setEntity(entity);
????????請注意InputStreamEntity是不可重復的,因為它僅僅能從低層數據流中讀取一次內容。通常來說,我們推薦實現一個定制的HttpEntity類,這是自我包含式的,用來代替使用通用的InputStreamEntity。FileEntity也是一個很好的起點。
動態內容實體
????????通常來說,HTTP實體需要基于特定的執行上下文來動態地生成。通過使用EntityTemplate實體類和ContentProducer接口,HttpClient提供了動態實體的支持。內容生成器是按照需求生成它們內容的對象,將它們寫入到一個輸出流中。它們是每次被請求時來生成內容。所以用EntityTemplate創建的實體通常是自我包含而且可以重復的。
ContentProducer cp =new?ContentProducer() {
public?void?writeTo(OutputStream outstream)?throws?IOException {
Writer writer =?new?OutputStreamWriter(outstream,"UTF-8");
writer.write("");
writer.write(" ");
writer.write(" important stuff");
writer.write(" ");
writer.write("");
writer.flush();
}
};
HttpEntity entity =new?EntityTemplate(cp);
HttpPost httppost =new?HttpPost("http://localhost/handler.do");
httppost.setEntity(entity);
HTML表單
????????許多應用程序需要頻繁模擬提交一個HTML表單的過程,比如,為了來記錄一個Web應用程序或提交輸出數據。HttpClient提供了特殊的實體類UrlEncodedFormEntity來這個滿足過程。
List fromParams =new?ArrayList();
fromParams.add(new?BasicNameValuePair("param1","value1"));
fromParams.add(new?BasicNameValuePair("param2","中文參數值"));
UrlEncodedFormEntity entity =new?UrlEncodedFormEntity(fromParams,"UTF-8");
HttpPost httpPost =new?HttpPost("http://localhost/handler.do");
httpPost.setEntity(entity);
UrlEncodedFormEntity實例將會使用URL編碼來編碼參數,生成如下的內容:
param1=value1?m2=%E4%B8%AD%E6%96%87%E5%8F%82%E6%95%B0%E5%80%BC
內容分塊
????????通常,我們推薦讓HttpClient選擇基于被傳遞的HTTP報文屬性的最適合的編碼轉換。這是可能的,但是,設置HttpEntity#setChunked()方法為true是通知HttpClient分塊編碼的首選。請注意HttpClient將會使用標識作為提示。當使用的HTTP協議版本,如HTTP/1.0版本,不支持分塊編碼時,這個值會被忽略。
StringEntity entity =new?StringEntity("important message",
"text/plain; charset=\"UTF-8\"");
entity.setChunked(true);
HttpPost httppost =new?HttpPost("http://localhost/acrtion.do");
httppost.setEntity(entity);