用JSF和MyFaces上傳文件
作者：Andrei Cioroianu
翻譯：RR00
email:di_feng_ro@hotmail.com
版權聲明：可以任意轉載，轉載時請務必以超鏈接形式標明文章原始出處和作者信息及本聲明
英文原文地址:
http://www.onjava.com/pub/a/onjava/2005/07/13/jsfupload.html中文地址:
http://www.matrix.org.cn/resource/article/43/43703_JSF_MyFaces_Upload.html關鍵詞： JSF MyFaces Upload
用戶可以很方便使用瀏覽器上傳文件，但是當前的Java Web標準（如servlets, JSP, and JSF）并沒有提供任何上傳的功能。幸好第三方框架，比如 Apache Commons File Upload, Apache MyFaces, and Oracle ADF Faces，提供了簡單的API和客戶標簽，實現了這個功能。文章的前半部分將介紹上傳組件是如何工作的，你將看到MyFaces and Commons File Upload 的部分源碼（實際上，前者采用的是后者的代碼）。了解這些源碼的內在機制將使我們更有效的使用這些框架，并且可以根據需要修改他們！在文章的后半部分，介紹了一個讓用戶通過瀏覽器上傳文件的例子。
基于WEB的文件上傳“上傳”這個詞的使用比較廣泛。一個web管理員在他的主頁發布了一個文件，他可以說他上傳了一個文件；當一個網絡工程師創建了一個HTML form和一些腳本使普通用戶可以通過瀏覽器上傳文件，他說他實現了上傳的功能。
這兩種方式之中有些共同的地方，因為一個web管理員可以通過一個基于web的接口來發布文件（頁面，圖像，腳本等等）。那些免費提供個人主頁的公司，比如yahoo，實現了基于web的文件上傳功能，因為客戶需要上傳頁面。這樣任何人只要接入網絡，就可以通過瀏覽器發布他的個人站點。但是，還有許多更好的方式讓你發布你的網頁內容，比如FTP或secure FTP。在這種情況下，你就需要一個對應的應用程序，比如FTP客戶端，而不是瀏覽器來發布你的網站。
這篇文章將從網絡開發者的角度來討論文件上傳。一個基于web的mail應用程序，比如yahoo mail,實現了上傳功能，這樣用戶才能發送信息和附件。另一個好的例子是一個job網站必須讓你能夠發送簡歷給招聘人員。在你的應用程序中，你可以對上傳的文件作任何你想做的事情，比如把這些文件的內容儲存到數據庫中或者把他們當作附件發送出去。這篇文章的例子計算了上傳文件的hash值?，F在，讓我們看看如何在一個web應用程序中實現上傳功能。
一個html表單包含一個或多個<input type="file"> 元素，這個元素將在頁面上生成文件輸入框，用戶可以在這里填寫文件路徑。用戶點擊輸入字段后面的瀏覽(browse)按鈕后，會彈出一個對話框讓用戶選擇路徑：
當用戶點擊表單的Sumbit按鈕，瀏覽器對表單數據進行編碼，其中包括文件的內容，名字，路徑以及其他的表單參數。然后，瀏覽器把編碼過的數據傳遞給web服務器，服務器再把這些數據傳遞給相應的頁面，比如<form>標簽里的action屬性值。如果是java網絡應用程序，action屬性值可能是個servlet或者是個jsp頁面。
因為默認的表單編碼和get方法不適合上傳文件，所以一個包含文件輸入框的表單必須定義編碼為multipart/form-data ，并且在<form>標簽里使用POST方法：
<form enctype="multipart/form-data" method="POST" action="...">
????...
????<input type="file" name="...">
????...
</form>
但是，事情并不象看起來那么簡單，實現了servlet and JSP 標準的應用服務器并沒有被要求處理 multipart/form-data編碼。所以你需要一個解析器來處理請求的輸入流,比如Apache Commons File Upload組件，它是個java包，能從已編碼的數據中讀取出上傳文件的內容。這個包的API很靈活，允許你把小文件存在內存里而大文件儲存在磁盤上一個臨時文件夾里。你不但可以定義大文件和小文件的界限，還可以定義上傳文件所占空間的最大值。
org.apache.commons.fileupload里有個DiskFileUpload類，它的parseRequest()函數獲得一個HttpServletRequest，返回一個List，其中包含了org.apache.commons.fileupload.FileItem的實例。servlet請求的getInputStream()函數返回一個數據流，已編譯的表單數據就是從這里讀取出來的。FileItem很容易讓人誤解，因為這個接口的實例不僅包括上傳文件,還有其他的請求參數。
Commons File Upload 包提供的API可以解析數據，但是servlet請求的getParameter()函數和getParameterValues()函數卻不能工作。因為這兩個函數被運行在常用的輸入框, 復選框, 單選按鈕, 和下拉列表后面的標準JSF組件調用，所以這個問題需要解決。Servlets API提供的兩個功能(filters和request wrappers) 可以解決這個問題。下面的章節描述了在沒有破壞原有JSF結構的情況下，Apache MyFaces 如何實現了一個filter功能，從而添加了更多需要的支持。另外，MyFaces提供的API可以創建javaBean，和生成<input type="file">元素的JSF組件相對應。
配置 JSF 和MyFaces Extensions目前最主要的實現JSF規范的框架有JSF Reference Implementation (RI)以及Apache提供的MyFaces。雖然還有別的，但這兩個是最流行的。很多開發者更傾向于JSF RI，因為這是來自于sun的官方產品。但MyFaces有一些有趣的擴展的功能，比如上傳文件。如果你喜歡，你可以同時使用MyFaces的擴展功能和JSF RI。你只需要把myfaces-extensions.jar和JSF RI的jar文件以及 commons-fileupload-1.0.jar 放在web應用程序的WEB-INF/lib 目錄下即可。下面是你需要的jar文件：
org.apache.myfaces.component.html.util包的MultipartRequestWrapper類創建了MyFaces和Commons File Upload連接的橋梁。這個類繼承了HttpServletRequestWrapper，重寫了getParameterMap(), getParameterNames(), getParameter(), 和getParameterValues() 函數，所以他們能正確處理multipart/form-data 編碼數據。另外，MultipartRequestWrapper提供的兩個函數，getFileItem() 和getFileItems(),使你可以通過org.apache.commons.fileupload.FileItem 接口訪問上傳文件。
MyFaces的 ExtensionsFilter 類在org.apache.myfaces.component.html.util 包里，當它發現multipart/form-data編碼的時候，它會創建 MultipartRequestWrapper 的實例。所以你不需理會他是如何解析表單數據的，但是知道它是如何開始解析對你想要修改上傳文件的處理方式是有用的。在一個傳統的應用程序中，你只需要在web.xml描述符中配置好ExtensionsFilter ，它就能在JSF的FacesServlet之前截獲HTTP請求：
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE web-app PUBLIC
????"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
????"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
????<context-param>
????????<param-name>javax.faces.STATE_SAVING_METHOD</param-name>
????????<param-value>client</param-value>
????</context-param>
????<servlet>
????????<servlet-name>FacesServlet</servlet-name>
????????<servlet-class>
????????????javax.faces.webapp.FacesServlet
????????</servlet-class>
????????<load-on-startup>1</load-on-startup>
????</servlet>
????<servlet-mapping>
????????<servlet-name>FacesServlet</servlet-name>
????????<url-pattern>/faces/*</url-pattern>
????</servlet-mapping>
????<servlet-mapping>
????????<servlet-name>FacesServlet</servlet-name>
????????<url-pattern>*.faces</url-pattern>
????</servlet-mapping>
????<filter>
????????<filter-name>ExtensionsFilter</filter-name>
????????<filter-class>
????????????org.apache.myfaces.component.html.util.ExtensionsFilter
????????</filter-class>
????????<init-param>
????????????<param-name>uploadMaxFileSize</param-name>
????????????<param-value>10m</param-value>
????????</init-param>
????????<init-param>
????????????<param-name>uploadThresholdSize</param-name>
????????????<param-value>100k</param-value>
????????</init-param>
????</filter>
????<filter-mapping>
????????<filter-name>ExtensionsFilter</filter-name>
????????<servlet-name>FacesServlet</servlet-name>
????</filter-mapping>
????<welcome-file-list>
????????<welcome-file>index.jsp</welcome-file>
????</welcome-file-list>
</web-app>
前面例子中，filter的兩個參數告訴MyFaces把小于100K的文件保存在內存中，而對于大于10M的文件則忽略。大小在uploadThresholdSize值和uploadMaxFileSize值之間的文件則作為臨時文件存在硬盤上。如果你上傳很大的文件，當前的MyFaces版本會忽略所有的表單數據，就好象你提交了一個空表單。如果你想把上傳失敗的消息告訴用戶，你就得修改MyFaces中MultipartRequestWrapper類的源碼。讓我們找到捕獲SizeLimitExceededException的地方，并使用FacesContext.getCurrentInstance().addMessage()來警告用戶。
正如前面所說的，MyFaces Extensions 里有個能在JSF頁面里使用的上傳組件。下面的章節將說明如何使用。
為了在web頁面里使用JSF和MyFaces，你必須使用<%@taglib%>指令聲明他們的標簽庫。
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://myfaces.apache.org/extensions" prefix="x"%>
JSF的<h:form>標簽沒有method屬性，因為它只支持post方法，但他有enctype屬性，當你想上傳文件時，你可以用它來定義表單數據的編碼類型：
<f:view>
????<h:form id="MyForm" enctype="multipart/form-data" >
????????...
????????<x:inputFileUpload id="myFileId"
????????????value="#{myBean.myFile}"
????????????storage="file"
????????????required="true"/>
????????...
????</h:form>
</f:view>
MyFaces的<x:inputFileUpload> 標簽讓你定義UI組件的屬性，它將在前臺生成<input type="file"> 元素。包org.apache.myfaces.custom.fileupload 包含了控制UI結構的HtmlInputFileUpload類，它的renderer (HtmlFileUploadRenderer), 處理用戶標簽的類 (HtmlInputFileUploadTag),??UploadedFile 接口, 以及別的幫助類。 HtmlInputFileUpload 類 繼承了標準的JSF HtmlInputText 組件 ，重寫了幾個函數。HtmlFileUploadRenderer負責創建 HTML 標簽以及從MultipartRequestWrapper類返回FileItem(前面提過)。
MyFaces提供了自己的UploadedFile接口讀取上傳文件的內容，文件類型，名字以及大小，而不是讓你直接訪問由Commons File Upload組件創建的FileItem實例。你的JSF表單背后的bean必須有一個UploadedFile屬性。下面的例子中，UI組件的值通過JSF表達式(#{myBean.myFile})綁定到一個bean屬性中。JSF框架將取得HtmlInputFileUpload 組件的值，這是個UploadedFile實例，并把它傳送到背后bean的屬性中。
import org.apache.myfaces.custom.fileupload.UploadedFile;
...
public class MyBean {
????private UploadedFile myFile;
????public UploadedFile getMyFile() {
????????return myFile;
????}
????public void setMyFile(UploadedFile myFile) {
????????this.myFile = myFile;
????}
????...
}
我們應該知道MyFaces有兩個實現 UploadedFile接口的類:UploadedFileDefaultMemoryImpl和UploadedFileDefaultFileImpl。當<x:inputFileUpload>標簽沒有storage屬性或這個屬性值為memory時，使用前一個類。當storage屬性值為file時用后一個。
類UploadedFileDefaultMemoryImp從一個FileItem實例中取得上傳文件的內容以及它的名字，大小，文件類型，并把這些信息儲存在一個私有屬性里。所以即使Commons File Upload 把文件存在磁盤上，這個實現UploadedFile接口的類仍把上傳文件的內容儲存在內存里，浪費系統資源。
類UploadedFileDefaultFileImpl使用一個非序列化域(transient field)來保存一個對FileItem實例的引用。只有當getInputStream()被調用時，才通過這個引用讀取上傳文件的內容。這個類節省了內存空間，但如果它被序列化了，當其被反序列化后，你無法取得文件的內容。所以，支持上傳文件表單的bean不應保存在session 域中，因為應用服務器在應用程序重起或服務器關閉時要對session bean序列化。
如果你想讓它們高效的工作，可以把背后的bean保存在request域并且在<x:inputFileUpload>中定義 storage="file"節省內存資源。你可以在UploadedFileDefaultFileImpl添加一個序列化上傳文件的函數writeObject()，這樣可以解決序列化的問題。為了使這個類更有效率，相應的readObject() 應該創建臨時文件而不是從內存中讀取它的內容。
應用程序例子前面的章節中，我們描述了MyFaces如何使用Commons File Upload支持上傳文件功能。現在讓我們來看一個使用這個功能的例子。一個JSF表單(MyForm.jsp）讓用戶選擇文件以及message-digest algorithm，支持的bean(MyBean.java)計算要在別的頁面(MyResult.jsp)顯示的hash值。這些頁面以及支持的bean和一個JSF配置文件(faces-config.xml)相關聯。
MyForm.jsp頁面這里的JSF表單使用MyFaces的<x:inputFileUpload>標簽，以及一些標準JSF標簽,這些JSF標簽將在頁面生成labels,messages,以及一個包含message-digest algorithms的下拉列表，還有一個使用了JSF表達式的命令按鈕，這個按鈕用來定義處理上傳文件的action方法。
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://myfaces.apache.org/extensions" prefix="x"%>
<f:view>
<h:form id="MyForm" enctype="multipart/form-data" >
????<h:messages globalOnly="true" styleClass="message"/>
????<h:panelGrid columns="3" border="0" cellspacing="5">
????????<h:outputLabel for="myFileId" value="File: "/>
????????<x:inputFileUpload id="myFileId"
????????????value="#{myBean.myFile}"
????????????storage="file"
????????????required="true"/>
????????<h:message for="myFileId"/>
????????<h:outputLabel for="myParamId" value="Param: "/>
????????<h:selectOneMenu id="myParamId"
????????????????value="#{myBean.myParam}"
????????????????required="true">
????????????<f:selectItem itemLabel="" itemValue=""/>
????????????<f:selectItem itemLabel="MD5" itemValue="MD5"/>
????????????<f:selectItem itemLabel="SHA-1" itemValue="SHA-1"/>
????????????<f:selectItem itemLabel="SHA-256" itemValue="SHA-256"/>
????????????<f:selectItem itemLabel="SHA-384" itemValue="SHA-384"/>
????????????<f:selectItem itemLabel="SHA-512" itemValue="SHA-512"/>
????????</h:selectOneMenu>
????????<h:message for="myParamId"/>
????????<h:outputText value=" "/>
????????<h:commandButton value="Submit"
????????????action="#{myBean.processMyFile}"/>
????????<h:outputText value=" "/>
????</h:panelGrid>
</h:form>
</f:view>
processMyFile() 函數通過一個輸入流取得上傳文件的內容，這個輸入流是通過調用myFile.getInputStream()函數返回的。hash值是使用java.security.MessageDigest計算出來的，然后這個值被轉換成一個string,用myResult屬性儲存。
package com.devsphere.articles.jsfupload;
...
import javax.faces.application.FacesMessage;
import javax.faces.context.FacesContext;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.io.*;
public class MyBean {
????...
????public String processMyFile() {
????????try {
????????????MessageDigest md
????????????????= MessageDigest.getInstance(myParam);
????????????InputStream in = new BufferedInputStream(
????????????????myFile.getInputStream());
????????????try {
????????????????byte[] buffer = new byte[64 * 1024];
????????????????int count;
????????????????while ((count = in.read(buffer)) > 0)
????????????????????md.update(buffer, 0, count);
????????????} finally {
????????????????in.close();
????????????}
????????????byte hash[] = md.digest();
????????????StringBuffer buf = new StringBuffer();
????????????for (int i = 0; i < hash.length; i++) {
????????????????int b = hash[i] & 0xFF;
????????????????int c = (b >> 4) & 0xF;
????????????????c = c < 10 ? '0' + c : 'A' + c - 10;
????????????????buf.append((char) c);
????????????????c = b & 0xF;
????????????????c = c < 10 ? '0' + c : 'A' + c - 10;
????????????????buf.append((char) c);
????????????}
????????????myResult = buf.toString();
????????????return "OK";
????????} catch (Exception x) {
????????????FacesMessage message = new FacesMessage(
????????????????FacesMessage.SEVERITY_FATAL,
????????????????x.getClass().getName(), x.getMessage());
????????????FacesContext.getCurrentInstance().addMessage(
????????????????null, message);
????????????return null;
????????}
????}
}
faces-config.xml 文件這個JSF配置文件定義了支持的bean在request域以及一個導航規則：
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE faces-config PUBLIC
????"-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.1//EN"
????"http://java.sun.com/dtd/web-facesconfig_1_1.dtd">
<faces-config>
????<managed-bean>
????????<managed-bean-name>myBean</managed-bean-name>
????????<managed-bean-class>
????????????com.devsphere.articles.jsfupload.MyBean
????????</managed-bean-class>
????????<managed-bean-scope>request</managed-bean-scope>
????</managed-bean>
????<navigation-rule>
????????<from-view-id>/MyForm.jsp</from-view-id>
????????<navigation-case>
????????????<from-outcome>OK</from-outcome>
????????????<to-view-id>/MyResult.jsp</to-view-id>
????????</navigation-case>
????</navigation-rule>
</faces-config>
MyResult.jsp 頁面這個web頁面顯示了關于上傳文件和hash值的一些信息：
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<f:view>
????<h:panelGrid columns="2" border="0" cellspacing="5">
????????<h:outputText value="FileName:"/>
????????<h:outputText value="#{myBean.myFile.name}"/>
????????<h:outputText value="FileSize:"/>
????????<h:outputText value="#{myBean.myFile.size}"/>
????????<h:outputText value="Param:"/>
????????<h:outputText value="#{myBean.myParam}"/>
????????<h:outputText value="Result:"/>
????????<h:outputText value="#{myBean.myResult}"/>
????</h:panelGrid>
</f:view>
事實上，顯示的文件名字可能是在客戶端文件系統的完整路徑，正如在下面的瀏覽器中看到的：
圖2. 結果圖
總結在很多情況下，用戶需要通過他們的瀏覽器上傳文件，但在服務器方面并沒有處理這些文件的良好方式。把小文件保存在內存里是可以接受的，但把大文件保存在臨時文件里會讓情況復雜。MyFaces讓你選擇的解決方法對你的應用程序很有幫助，但這個框架有幾個小問題：當你已不再需要某個臨時文件時，它卻不讓你刪除；文件名有時候是文件路徑；并且用戶上傳過大文件時它沒有任何警告信息。但這些bug是可以修復的，因為源碼可以修改的。這篇文章已經說明哪些地方的代碼可以提高。不過，你可能會發現，對于很多應用程序來說，原有的MyFaces就已經足夠了。這篇文章的例子是在JSF 1.1.01, MyFaces 1.0.9,和 Commons File Upload 1.0下測試的。
資源本文的范例代碼:
JavaServer Faces :http://java.sun.com/j2ee/javaserverfaces/
Apache MyFaces (參見: CodeZoo: MyFaces) :http://myfaces.apache.org/
Oracle ADF Faces:http://
www.oracle.com/technology/products/jdev/htdocs/partners/addins/exchange/jsf/index.html
Commons FileUpload:http://jakarta.apache.org/commons/fileupload/
Andrei Cioroianu 是Devsphere的創始人，分別在ONJava, JavaWorld, 及 Java Developer's Journal??上發表了許多文章。