Apache FileUpload文件上傳組件API解析

2019-11-11 04:38:00

字體：大中小

來源：轉載

供稿：網友

Apache FileUpload文件上傳組件API解析

文章來源：http://java.chinaitlab.com/net/822353.htmlJava Web開發人員可以使用Apache文件上傳組件來接收瀏覽器上傳的文件，該組件由多個類共同組成，但是，對于使用該組件來編寫文件上傳功能的Java Web開發人員來說，只需要了解和使用其中的三個類：DiskFileUpload、FileItem和FileUploadException。這三個類全部位于org.apache.commons.fileupload包中。　　1. DiskFileUpload類　　DiskFileUpload類是Apache文件上傳組件的核心類，應用程序開發人員通過這個類來與Apache文件上傳組件進行交互。但現在Apache建議使用ServletFileUpload類，兩個類的方法類似。下面介紹DiskFileUpload類中的幾個常用的重要方法?！　?.1．setSizeMax方法　　setSizeMax方法用于設置請求消息實體內容的最大允許大小，以防止客戶端故意通過上傳特大的文件來塞滿服務器端的存儲空間，單位為字節。其完整語法定義如下：　　public void setSizeMax（long sizeMax）　　如果請求消息中的實體內容的大小超過了setSizeMax方法的設置值，該方法將會拋出FileUploadException異常?！　?.2．setSizeThreshold方法　　Apache文件上傳組件在解析和處理上傳數據中的每個字段內容時，需要臨時保存解析出的數據。因為Java虛擬機默認可以使用的內存空間是有限的（筆者測試不大于100M），超出限制時將會發生“java.lang.OutOfMemoryError”錯誤，如果上傳的文件很大，例如上傳800M的文件，在內存中將無法保存該文件內容，Apache文件上傳組件將用臨時文件來保存這些數據；但如果上傳的文件很小，例如上傳600個字節的文件，顯然將其直接保存在內存中更加有效。setSizeThreshold方法用于設置是否使用臨時文件保存解析出的數據的那個臨界值，該方法傳入的參數的單位是字節。其完整語法定義如下：　　public void setSizeThreshold(int sizeThreshold)　　1.3. setRepositoryPath方法　　setRepositoryPath方法用于設置setSizeThreshold方法中提到的臨時文件的存放目錄，這里要求使用絕對路徑。其完整語法定義如下：　　public void setRepositoryPath(String repositoryPath)　　如果不設置存放路徑，那么臨時文件將被儲存在"java.io.tmpdir"這個JVM環境屬性所指定的目錄中，tomcat 5.5.9將這個屬性設置為了“<tomcat安裝目錄>/temp/”目錄?！　?.4. parseRequest方法　　parseRequest 方法是DiskFileUpload類的重要方法，它是對HTTP請求消息進行解析的入口方法，如果請求消息中的實體內容的類型不是“multipart/form-data”，該方法將拋出FileUploadException異常。parseRequest 方法解析出FORM表單中的每個字段的數據，并將它們分別包裝成獨立的FileItem對象，然后將這些FileItem對象加入進一個List類型的集合對象中返回。parseRequest 方法的完整語法定義如下：　　public List parseRequest(HttpServletRequest req)　　parseRequest 方法還有一個重載方法，該方法集中處理上述所有方法的功能，其完整語法定義如下：　　parseRequest(HttpServletRequest req,int sizeThreshold,long sizeMax,　　String path)　　這兩個parseRequest方法都會拋出FileUploadException異常。　　1.5. isMultipartContent方法　　isMultipartContent方法方法用于判斷請求消息中的內容是否是“multipart/form-data”類型，是則返回true，否則返回false。isMultipartContent方法是一個靜態方法，不用創建DiskFileUpload類的實例對象即可被調用，其完整語法定義如下：　　public static final boolean isMultipartContent(HttpServletRequest req)　　1.6. setHeaderEncoding方法　　由于瀏覽器在提交FORM表單時，會將普通表單中填寫的文本內容傳遞給服務器，對于文件上傳字段，除了傳遞原始的文件內容外，還要傳遞其文件路徑名等信息，如后面的圖1.3所示。不管FORM表單采用的是“application/x-www-form-urlencoded”編碼，還是“multipart/form-data”編碼，它們僅僅是將各個FORM表單字段元素內容組織到一起的一種格式，而這些內容又是由某種字符集編碼來表示的。關于瀏覽器采用何種字符集來編碼FORM表單字段中的內容，請參看筆者編著的《深入體驗java Web開發內幕——核心基礎》一書中的第6.9.2的講解，“multipart/form-data”類型的表單為表單字段內容選擇字符集編碼的原理和方式與“application/x-www-form-urlencoded”類型的表單是相同的。FORM表單中填寫的文本內容和文件上傳字段中的文件路徑名在內存中就是它們的某種字符集編碼的字節數組形式，Apache文件上傳組件在讀取這些內容時，必須知道它們所采用的字符集編碼，才能將它們轉換成正確的字符文本返回?！　τ跒g覽器上傳給WEB服務器的各個表單字段的描述頭內容，Apache文件上傳組件都需要將它們轉換成字符串形式返回，setHeaderEncoding 方法用于設置轉換時所使用的字符集編碼，其原理與筆者編著的《深入體驗java Web開發內幕——核心基礎》一書中的第6.9.4節講解的ServletRequest.setCharacterEncoding方法相同。setHeaderEncoding 方法的完整語法定義如下：　　public void setHeaderEncoding(String encoding)　　其中，encoding參數用于指定將各個表單字段的描述頭內容轉換成字符串時所使用的字符集編碼。　　注意：如果讀者在使用Apache文件上傳組件時遇到了中文字符的亂碼問題，一般都是沒有正確調用setHeaderEncoding方法的原因。　　2. FileItem類　　FileItem類用來封裝單個表單字段元素的數據，一個表單字段元素對應一個FileItem對象，通過調用FileItem對象的方法可以獲得相關表單字段元素的數據。FileItem是一個接口，在應用程序中使用的實際上是該接口一個實現類，該實現類的名稱并不重要，程序可以采用FileItem接口類型來對它進行引用和訪問，為了便于講解，這里將FileItem實現類稱之為FileItem類。FileItem類還實現了Serializable接口，以支持序列化操作?！　τ凇癿ultipart/form-data”類型的FORM表單，瀏覽器上傳的實體內容中的每個表單字段元素的數據之間用字段分隔界線進行分割，兩個分隔界線間的內容稱為一個分區，每個分區中的內容可以被看作兩部分，一部分是對表單字段元素進行描述的描述頭，另外一部是表單字段元素的主體內容，如圖1.3所示。　　圖 1.3　　主體部分有兩種可能性，要么是用戶填寫的表單內容，要么是文件內容。FileItem類對象實際上就是對圖1.3中的一個分區的數據進行封裝的對象，它內部用了兩個成員變量來分別存儲描述頭和主體內容，其中保存主體內容的變量是一個輸出流類型的對象。當主體內容的大小小于DiskFileUpload.setSizeThreshold方法設置的臨界值大小時，這個流對象關聯到一片內存，主體內容將會被保存在內存中。當主體內容的數據超過DiskFileUpload.setSizeThreshold方法設置的臨界值大小時，這個流對象關聯到硬盤上的一個臨時文件，主體內容將被保存到該臨時文件中。臨時文件的存儲目錄由DiskFileUpload.setRepositoryPath方法設置，臨時文件名的格式為“upload_00000005（八位或八位以上的數字）.tmp”這種形式，FileItem類內部提供了維護臨時文件名中的數值不重復的機制，以保證了臨時文件名的唯一性。當應用程序將主體內容保存到一個指定的文件中時，或者在FileItem對象被垃圾回收器回收時，或者Java虛擬機結束時，Apache文件上傳組件都會嘗試刪除臨時文件，以盡量保證臨時文件能被及時清除?！　∠旅娼榻BFileItem類中的幾個常用的方法：　　2.1. isFormField方法　　isFormField方法用于判斷FileItem類對象封裝的數據是否屬于一個普通表單字段，還是屬于一個文件表單字段，如果是普通表單字段則返回true，否則返回false。該方法的完整語法定義如下：　　public boolean isFormField()　　2.2. getName方法　　getName方法用于獲得文件上傳字段中的文件名，對于圖1.3中的第三個分區所示的描述頭，getName方法返回的結果為字符串“C:/bg.gif”。如果FileItem類對象對應的是普通表單字段，getName方法將返回null。即使用戶沒有通過網頁表單中的文件字段傳遞任何文件，但只要設置了文件表單字段的name屬性，瀏覽器也會將文件字段的信息傳遞給服務器，只是文件名和文件內容部分都為空，但這個表單字段仍然對應一個FileItem對象，此時，getName方法返回結果為空字符串""，讀者在調用Apache文件上傳組件時要注意考慮這個情況。getName方法的完整語法定義如下：　　public String getName()　　注意：如果用戶使用Windows系統上傳文件，瀏覽器將傳遞該文件的完整路徑，如果用戶使用linux或者Unix系統上傳文件，瀏覽器將只傳遞該文件的名稱部分?！　?.3．getFieldName方法　　getFieldName方法用于返回表單字段元素的name屬性值，也就是返回圖1.3中的各個描述頭部分中的name屬性值，例如“name=p1”中的“p1”。getFieldName方法的完整語法定義如下：　　public String getFieldName()　　2.4. write方法　　write方法用于將FileItem對象中保存的主體內容保存到某個指定的文件中。如果FileItem對象中的主體內容是保存在某個臨時文件中，該方法順利完成后，臨時文件有可能會被清除。該方法也可將普通表單字段內容寫入到一個文件中，但它主要用途是將上傳的文件內容保存在本地文件系統中。其完整語法定義如下：　　public void write(File file)　　2.5．getString方法　　getString方法用于將FileItem對象中保存的主體內容作為一個字符串返回，它有兩個重載的定義形式：　　public java.lang.String getString()　　public java.lang.String getString(java.lang.String encoding)　　throws java.io.UnsupportedEncodingException　　前者使用缺省的字符集編碼將主體內容轉換成字符串，后者使用參數指定的字符集編碼將主體內容轉換成字符串。如果在讀取普通表單字段元素的內容時出現了中文亂碼現象，請調用第二個getString方法，并為之傳遞正確的字符集編碼名稱。　　2.6. getContentType方法　　getContentType 方法用于獲得上傳文件的類型，對于圖1.3中的第三個分區所示的描述頭，getContentType方法返回的結果為字符串“image/gif”，即“Content-Type”字段的值部分。如果FileItem類對象對應的是普通表單字段，該方法將返回null。getContentType 方法的完整語法定義如下：　　public String getContentType()　　2.7. isInMemory方法　　isInMemory方法用來判斷FileItem類對象封裝的主體內容是存儲在內存中，還是存儲在臨時文件中，如果存儲在內存中則返回true，否則返回false。其完整語法定義如下：　　public boolean isInMemory()　　2.8. delete方法　　delete方法用來清空FileItem類對象中存放的主體內容，如果主體內容被保存在臨時文件中，delete方法將刪除該臨時文件。盡管Apache組件使用了多種方式來盡量及時清理臨時文件，但系統出現異常時，仍有可能造成有的臨時文件被永久保存在了硬盤中。在有些情況下，可以調用這個方法來及時刪除臨時文件。其完整語法定義如下：　　public void delete()　　3. FileUploadException類　　在文件上傳過程中，可能發生各種各樣的異常，例如網絡中斷、數據丟失等等。為了對不同異常進行合適的處理，Apache文件上傳組件還開發了四個異常類，其中FileUploadException是其他異常類的父類，其他幾個類只是被間接調用的底層類，對于Apache組件調用人員來說，只需對FileUploadException異常類進行捕獲和處理即可?！　?. ServletRequestContext　　ServletRequestContext類提供訪問request的方法。實現RequestContext接口。

上一篇：JAX-WS與JAX-RS區別是什么？

下一篇：js中split的一點注意事項