Java上傳文件API匯總

一、FileItem接口

Fileltem接口用于封裝單個表單字段元素的數據，一個表單字段元素對應一個Fileltem對象。為了便于講解，在此將Fileltem的實現類稱為Fileltem類，Fileltem類實現了Serializable接口，因此，支持序列化操作。在FiIeItem類中人素的方法，具體如下。

1. boolean isFormField()方法

isFormField()方法用于判斷FileItem類對象封裝的數據是一個普通文本表單字段，還是一個文件表單字段，如果是普通表單字段則返回true，否則返回false。

2.String getName()方法

getName()方法用于獲得文件上傳字段中的文件名。如果FileItem類對象對應的是普通表單字段，getName()方法將返回null，否則，只要瀏覽器將文件的字段信息傳遞給服務器，getName()方法就會返回一個字符串類型的結果，如“C:\Sunset.jpg”。

需要注意的是，通過不同瀏覽器上傳的文件，獲取到的完整路徑和名稱都是不一樣的。例如，用戶使用IE瀏覽器上傳文件，獲取到的就是完整的路徑“C:\Sunset.jpg”，如果使用其他瀏覽器，比如火狐，獲取到的僅僅是文件名，沒有路徑，如“Sunset.jpg”。

3.String getFieldName()方法

getFieldName()方法用于獲得表單字段元素描述頭的name屬性值，也是表單標簽name屬性的值，例如“name=file1”中的“file1”。

4. void write(File file)方法

write()方法用于將Fileltem對象中保存的主體內容保存到某個指定的文件中。如果FileItem對象中的主體內容是保存在某個臨時文件中，那么該方法順利完成后，臨時文件有可能會被清除。另外，該方法也可將普通表單字段內容寫入到一個文件中，但它主要用于將上傳的文件內容保存到本地文件系統(tǒng)中。

5.String getString()方法

getString()方法用于將Fileltem對象中保存的數據流內容以一個字符串返回，它有兩個重載的定義形式;

(1) public String getString(）

(2) public String getString(java.lang.String encoding)

在上面重載的兩個方法中，前者使用默認的字符集編碼將主體內容轉換成字符串，后者使用參數指足的子付集編碼將主體內容轉換成字符串。需要注意的是，如果在讀取普通表單字段無系內谷時出現中文亂碼現象，請調用第二個getString)方法，并為之傳遞正確的字符集編碼名稱。

倘名外Rssicod.sayThelos oninte .emelblait pait2 )moilelssto molleli

6. String getContentType()方法

getContentType()方法用于獲得上傳文件的類型，即表單字段元素描述頭屬性“Content-Type”的值，如"image/jpeg”。如果FileItem類對象對應的是普通表單字段，該方法將返回null。

7.boolean islnMemory()方法

isInMemory()方法用來判斷FileItem對象封裝的數據內容是存儲在內存中，還是存儲在臨時文件中，如果存儲在內存中則返回true，否則返回false。

8. void delete()方法

delete()方法用來清空FileItem類對象中存放的主體內容，如果主體內容被保存在臨時文件中，delete()方法將刪除該臨時文件。需要注意的是，盡管Fileltem對象被垃圾收集器收集時會自動清除臨時文件，但應該及時調用delete()方法清除臨時文件，從而釋放系統(tǒng)存儲資源，以防系統(tǒng)出現異常，導致臨時文件被永久地保存在硬盤中。

9. InputStream getlnputStream()方法

getInputStream()方法以流的形式返回上傳文件的數據內容。

10. long getSize()方法

getSize()方法返回該上傳文件的大小(以子節(jié)為單)。

二、DiskFileltemFactory類

DiskFileltemFactory類用于將請求消息實體中的每一個文件封裝成單獨的Fileltem對象。如果卜傳的文件比較小。將直接保存在內存中，如果上傳的文件比較大，則會以臨時文件的形式，保存在磁盤的臨時文件夾中。默認情況下，文件保存在內存還是硬盤臨時文件夾的臨界值是10240，即10KB。接下來，首先了解一下DiskFileItemFactory類的兩個構造方法:

DiskFileItemFactory()

采用默認臨界值和系統(tǒng)臨時文件夾構造文件項工廠對象

DiskFileItemFactory(int sizeThreshold，Filerepository)

采用參數指定臨界值和系統(tǒng)臨時文件夾構造文件項工廠對象

上面DiskFileltemFactory類的兩個構造方法，其中，第二個構造方法需要傳遞兩個參數，參數sizeThreshold代表文件保存在內還是磁盤臨時文件夾的臨界值，參數repository表示臨時文件的存儲路徑。

接下來，針對DiskFileItemFactory類的常用方法進行詳細講解，具體如下所示。

1. Fileltem createltem(String fieldName， String contentType，boolean isFormField，String fileName)方法

該方法用于將請求消息實體創(chuàng)建成Fileltem類型的實例對象。需要注意的是，該方法是FileUpload組件在解析請求時內部自動調用，無須管理。

2. setSizeThreshold(int sizeThreshold)和getSizeThreshold()方法

setSizeThreshold(int sizeThreshold)方法用于設置是否將上傳文件以臨時文件的形式保存在磁盤的臨界值。當Apache文件上傳組件解析上傳的數據時，需要將解析后的數據臨時保存，以便后續(xù)對數據進一步處理。由于Java虛擬機可使用的內存空間是有限的，因此，需要根據上傳文件的大小決定文件的保存位置。例如，一個800MB的文件，是無法在內存中臨時保存的，這時，Apache文件上傳組件可以采用臨時文件的方式來保存這些數據。但是，如果上傳的文件很小，只有600KB，顯然將其保存在內存中是比較好的選擇。另外，對應的getSizeThreshold()方法用來獲取此臨界值。

3. setRepository(File repository)和getRepository()方法

如果上傳文件的大小大于setSizeThreshold()方法設置的臨界值，這時，可以采用setRepository()方法，將上傳的文件以臨時文件的形式保存在指定的目錄下。在默認情況下，采用的是系統(tǒng)默認的臨時文件路徑，可以通過以下方式獲取。

System.getProperty("java.io.tmpdir")

另外，對應的getRepository()方法用于獲取臨時文件。

三、ServletFileUpload類

ServletFileUpload類是Apache組件處理文件上傳的核心高級類，通過使用parseRequest(HttpServletRequest)方法可以將HTML中每個表單提交的數據封裝成個Fileltem對象，然后以List列表的形式返回。接下來，首先看一下ServletFileUpload類的構造方法如下所示：

ServletFileUpload()

構造一個未初始化的ServletFileUpload實例對象

ServletFileUpload(FileItemFactory fileItemFactory)

根據參數指定的FileItemFactory對象創(chuàng)建一個ServletFileUpload對象

由于在文件上傳過程中，FileltemFactory類必須設置，因此，在使用第一個構造方法創(chuàng)建ServletFileUpload對象時，首先需要在解析請求之前調用setFileltemFactory()方法設置fileltemFactory屬性。

了解了ServletFileUpload對象的創(chuàng)建，接下來，學習一下ServletFileUpload類的方法，具體如下。

1. setSizeMax(long sizeMax)和getSizeMax()方法

setSizeMax()方法繼承自FileUploadBase類，用于設置請求消息實體內容(即所有上數據)的最大尺寸限制，以防止客戶端惡意上傳超大文件來浪費服務器端的存儲空間。其中，參數sizeMax以字節(jié)為單位。

另外，對應的getSizeMax()方法用于讀取請求消息實體內容所允許的最大值。

2.setFileSizeMax(long fileSizeMax)方法

setFileSizeMax()方法繼承自FileUploadBase類，用于設置單個上傳文件的最大尺限制，以防止客戶端惡意上傳超大文件來浪費服務器端的存儲空間。其中，參數fileSizeMax是以字節(jié)為單位。

另外，對應的getFileSizeMax()方法用于獲取單個上傳文件所允許的最大值。

3. parseRequest(javax.servlet.http.HttpServletRequest req)

parseRequest()方法是ServletFileUpload類的重要方法，它是對HTTP請求消息體內容進行解析的入口。它解析出FORM表單中的每個字段的數據，并將它們分別包裝成獨立的Fileltem對象，然后將這些Fileltem對象加入進一個 List類型的集合對象中返回。

4. getltemlterator(HttpServletRequest request)

getItemIterator()方法和parseRequest()方法基本相同。但是getItemIterator()方法返回的是一個迭代器，該迭代器中保存的不是Fileltem對象，而是FileltemStream對象果希望進一步提高性能，可以采用getItemIterator()方法，直接獲得每一個文件項的數據輸人流，做底層處理;如果性能不是問題，希望代碼簡單，則采用parseRequest()方法即可。

5. isMultipartContent(HttpServletRequest req)

isMultipartContent()方法用于判斷請求消息中的內容是否是multipart/form-data類型，如果是，則返回true，否則返回false。需要注意的是，isMultipartContent()方法是靜態(tài)方法，不用創(chuàng)建ServletFileUpload類的實例對象即可被調用。

6. getFileltemFactory()和setFileltemFactory(FileltemFactory factory)

這兩個方法繼承自FileUpload類，分別用于讀取和設置fileltemFactory屬性。

7. setHeaderEncoding(String encoding)方法和getHeaderEncoding()方法

這兩個方法繼承自FileUploadBase類，用于設置和讀取字符編碼。需要注意的是，如果沒有使用setHeaderEncoding()設置字符編碼，則getHeaderEncoding()方法返回null，上傳組件會采用HttDServletRequest設置的字符編碼。但是，如果HttpServletRequest的字符編碼和為null，這時，上傳組件將采用系統(tǒng)默認的字符編碼。獲取系統(tǒng)默認字符編碼的方式如下所示：

System.getProperty("file.encoding")