目錄:
HTTPClient根據(jù)其內(nèi)容出自何處區(qū)分三種類型的實體
內(nèi)容分塊
? ? ? ? ?HTTP報文可以攜帶和請求或響應(yīng)相關(guān)的內(nèi)容實體碰纬。實體可以在一些請求和響應(yīng)中找到,因為它們也是可選的。使用了實體的請求被稱為封閉實體請求薄坏。HTTP規(guī)范定義了兩種封閉實體的方法:POST和PUT笆制。響應(yīng)通常期望包含一個內(nèi)容實體。這個規(guī)則也有特例,比如HEAD方法的響應(yīng)和204 NoContent锻弓,304 Not Modified和205 Reset Content響應(yīng)掩宜。
HttpClient根據(jù)其內(nèi)容出自何處區(qū)分三種類型的實體:
streamed流式
????????內(nèi)容從流中獲得蔫骂,或者在運行中產(chǎn)生。特別是這種分類包含從HTTP響應(yīng)中獲取的實體牺汤。流式實體是不可重復(fù)生成的辽旋。
self-contained自我包含式
????????內(nèi)容在內(nèi)存中或通過獨立的連接或其它實體中獲得。自我包含式的實體是可以重復(fù)生成的檐迟。這種類型的實體會經(jīng)常用于封閉HTTP請求的實體补胚。
wrapping包裝式
????????內(nèi)容從另外一個實體中獲得。
????????當從一個HTTP響應(yīng)中獲取流式內(nèi)容時追迟,這個區(qū)別對于連接管理很重要溶其。對于由應(yīng)用程序創(chuàng)建而且只使用HttpClient發(fā)送的請求實體,流式和自我包含式的不同就不那么重要了敦间。這種情況下瓶逃,建議考慮如流式這種不能重復(fù)的實體,和可以重復(fù)的自我包含式實體廓块。
重復(fù)實體
實體可以重復(fù)厢绝,意味著它的內(nèi)容可以被多次讀取。這就僅僅是自我包含式的實體了(像ByteArrayEntity或StringEntity)带猴。
使用HTTP實體
????????一個實體既可以代表二進制內(nèi)容又可以代表字符內(nèi)容昔汉,同時也支持字符編碼。實體是在使用封閉內(nèi)容執(zhí)行請求浓利,或當請求已經(jīng)成功執(zhí)行挤庇,或當響應(yīng)體結(jié)果發(fā)送到客戶端時創(chuàng)建的。
????????要從實體中讀取內(nèi)容贷掖,可以通過HttpEntity#getContent()方法從輸入流中獲取嫡秕,這會返回一個java.io.InputStream對象,或者提供一個輸出流到HttpEntity#writeTo(OutputStream)方法中苹威,這會一次返回所有寫入到給定流中的內(nèi)容昆咽。
????????當實體通過一個收到的報文獲取時,HttpEntity#getContentType()方法和?HttpEntity#getContentLength()方法可以用來讀取通用的元數(shù)據(jù),如Content-Type和Content-Length頭部信息(如果它們是可用的)掷酗。因為頭部信息Content-Type可以包含對文本MIME類型的字符編碼调违,比如text/plain或text /html,HttpEntity#getContentEncoding()方法用來讀取這個信息泻轰。如果頭部信息不可用技肩,那么就返回長度-1,而對于內(nèi)容類型返回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
確保低級別資源釋放
????????當完成一個響應(yīng)實體泳挥,那么保證所有實體內(nèi)容已經(jīng)被完全消耗是很重要的然痊,所以連接可以安全的放回到連接池中,而且可以通過連接管理器對后續(xù)的請求重用連接屉符。處理這個操作的最方便的方法是調(diào)用HttpEntity#consumeContent()方法來消耗流中的任意可用內(nèi)容剧浸。HttpClient探測到內(nèi)容流尾部已經(jīng)到達后,會立即會自動釋放低層連接矗钟,并放回到連接管理器唆香。HttpEntity#consumeContent()方法調(diào)用多次也是安全的。
????????也可能會有特殊情況真仲,當整個響應(yīng)內(nèi)容的一小部分需要獲取袋马,消耗剩余內(nèi)容而損失性能,還有重用連接的代價太高秸应,則可以僅僅通過調(diào)用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();
}
連接不會被重用,但是由它持有的所有級別的資源將會被正確釋放软啼。
消耗實體內(nèi)容
????????推薦消耗實體內(nèi)容的方式是使用它的HttpEntity#getContent()或HttpEntity#writeTo(OutputStream)方法桑谍。HttpClient也自帶EntityUtils類,這會暴露出一些靜態(tài)方法祸挪,這些方法可以更加容易地從實體中讀取內(nèi)容或信息锣披。代替直接讀取?java.io.InputStream,也可以使用這個類中的方法以字符串/字節(jié)數(shù)組的形式獲取整個內(nèi)容體贿条。然而雹仿,EntityUtils的使用是強烈不鼓勵的,除非響應(yīng)實體源自可靠的HTTP服務(wù)器和已知的長度限制整以。
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
}
}
????????在一些情況下可能會不止一次的讀取實體胧辽。此時實體內(nèi)容必須以某種方式在內(nèi)存或磁盤上被緩沖起來。最簡單的方法是通過使用BufferedHttpEntity類來包裝源實體完成公黑。這會引起源實體內(nèi)容被讀取到內(nèi)存的緩沖區(qū)中邑商。在其它所有方式中摄咆,實體包裝器將會得到源實體。
HttpGet httpGet =new?HttpGet("http://localhost/");
HttpResponse response = client.execute(httpGet);
HttpEntity entity = response.getEntity();
if?(entity !=null) {
entity =?new?BufferedHttpEntity(entity);
}
生成實體內(nèi)容
????????HttpClient提供一些類人断,它們可以用于生成通過HTTP連接獲得內(nèi)容的有效輸出流吭从。為了封閉實體從HTTP請求中獲得的輸出內(nèi)容,那些類的實例可以和封閉如POST和PUT請求的實體相關(guān)聯(lián)恶迈。HttpClient為很多公用的數(shù)據(jù)容器涩金,比如字符串,字節(jié)數(shù)組蝉绷,輸入流和文件提供了一些類: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是不可重復(fù)的,因為它僅僅能從低層數(shù)據(jù)流中讀取一次內(nèi)容佳晶。通常來說桅狠,我們推薦實現(xiàn)一個定制的HttpEntity類,這是自我包含式的轿秧,用來代替使用通用的InputStreamEntity中跌。FileEntity也是一個很好的起點。
動態(tài)內(nèi)容實體
????????通常來說菇篡,HTTP實體需要基于特定的執(zhí)行上下文來動態(tài)地生成漩符。通過使用EntityTemplate實體類和ContentProducer接口,HttpClient提供了動態(tài)實體的支持驱还。內(nèi)容生成器是按照需求生成它們內(nèi)容的對象嗜暴,將它們寫入到一個輸出流中。它們是每次被請求時來生成內(nèi)容议蟆。所以用EntityTemplate創(chuàng)建的實體通常是自我包含而且可以重復(fù)的闷沥。
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表單
????????許多應(yīng)用程序需要頻繁模擬提交一個HTML表單的過程,比如咐容,為了來記錄一個Web應(yīng)用程序或提交輸出數(shù)據(jù)舆逃。HttpClient提供了特殊的實體類UrlEncodedFormEntity來這個滿足過程。
List fromParams =new?ArrayList();
fromParams.add(new?BasicNameValuePair("param1","value1"));
fromParams.add(new?BasicNameValuePair("param2","中文參數(shù)值"));
UrlEncodedFormEntity entity =new?UrlEncodedFormEntity(fromParams,"UTF-8");
HttpPost httpPost =new?HttpPost("http://localhost/handler.do");
httpPost.setEntity(entity);
UrlEncodedFormEntity實例將會使用URL編碼來編碼參數(shù)戳粒,生成如下的內(nèi)容:
param1=value1?m2=%E4%B8%AD%E6%96%87%E5%8F%82%E6%95%B0%E5%80%BC
內(nèi)容分塊
????????通常路狮,我們推薦讓HttpClient選擇基于被傳遞的HTTP報文屬性的最適合的編碼轉(zhuǎn)換。這是可能的蔚约,但是奄妨,設(shè)置HttpEntity#setChunked()方法為true是通知HttpClient分塊編碼的首選。請注意HttpClient將會使用標識作為提示炊琉。當使用的HTTP協(xié)議版本展蒂,如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);