当前页面: 开发资料首页 → JSP 专题 → 使用JSF和MyFaces实现文件上载
摘要: 使用JSF和MyFaces实现文件上载
Web浏览器为我们利用Web应用程序发送文件提供了一条简单的途径,但是当前版本的Java Web标准(servlets、JSP和JSF)却无法为我们提供任何帮助。幸运的是,有一些第三方框架组件(例如Apache Commons File Upload、 Apache MyFaces和Oracle ADF Faces)实现了这种特性,它们都暴露了简单的API和定制的标记(tag)。
本文的前面一部分介绍文件上载操作是如何实现的,解释了MyFaces和通用文件上载(前者在内部使用了后者)。我们了解这些开放源代码框架组件的内部工作方式是非常重要的,因为只有这样我们才能高效率地使用它们,才能根据自己的需要对它们进行修改。本文的第二部分将介绍一个简单的应用程序,它让用户使用web浏览器上载文件。
基于Web的文件上载
我们把"上载"这个专业术语用得有点过滥了。Web管理员在自己的站点上发布文件的时候,它会说自己"上载"了一个文件。Web开发者在建立HTML窗体和脚本,让普通用户通过web浏览器发送一个文件的时候,他也会说自己实现了文件"上载"功能。
这两种含义在某些方面是重叠的,因为web管理员可能使用基于web的界面来发布文件(页面、图像、脚本等等)。免费提供个人web站点的公司(例如Yahoo),实现基于web的文件上载功能的目的是为了让人们上载自己的页面。它允许任何一个拥有web浏览器和互联网访问能力的个人发布一个小型的web站点。但是,目前有一些更好的、可用于发布web内容的方式,例如FTP或安全FTP。在这种情况下,你可以利用专用的应用程序(例如FTP客户端)代替web浏览器把自己的内容上载到web服务器上。
本文从web开发者的角度来讨论文件上载的问题。例如,一个基于web的邮件应用程序(例如Yahoo邮件),就实现了文件上载,因为只有这样,用户才能够发送那些带有附件的消息。另一个比较好的例子是找工作的web站点,它允许用户把自己的简历发送给招聘人员。本文的示例应用程序计算上载文件的散列值。你可以在自己的应用程序中对上载的文件进行任意的处理,例如把它们的内容存储在数据库中或把它们作为邮件附件发送。现在,让我们看看如何在web应用程序中实现文件上载吧。
一个HTML窗体中可以包含一个或多个<input type="file">元素,浏览器把它们作为输入字段来显示(呈现),在这些字段中允许用户输入文件路径。在每个文件输入字段的后面,web浏览器会添加一个按钮,它会打开一个文件对话框,让用户选择一个文件(代替输入路径):
图1:包含文件输入字段的web窗体
当用户点击窗体的"提交(Submit)"按钮的时候,web浏览器对窗体的数据进行编码,其中包括被选中的文件、文件名(或路径)和窗体的其它一些参数。接着,浏览器把编码后的数据发送给web服务器,web服务器把这些数据传递给<form>标记的action属性所指定的脚本来处理。如果你开发一个Java web应用程序,那么操作脚本可能是一个servlet(小服务程序)或JSP页面。
由于窗体数据默认的编码方式和默认的GET方法都不适合文件上载,所以包含文件输入字段的窗体必须在<form>标记中指定multipart/form-data编码方式和POST方法:
<form enctype="multipart/form-data" method="POST" action="...">
...
<input type="file" name="...">
...
</form>
但是事情并非这么简单,因为实现servlet和JSP规范的应用程序服务器不一定能够处理multipart/form-data编码方式。因此,你必须分析请求的输入流,例如Apache通用文件上载就是一个小型的Java程序包,它让你能够从编码的数据中获取被上载文件的内容。这个程序包的API是很灵活的,它允许你把小文件存储在内存中,把大文件存储在磁盘的临时目录中。你可以指定一个文件大小的阀值,大于这个值的文件都会被写到磁盘上,而不会保留在内存中,而且你还可以规定允许的被上载文件的最大大小。
前面提到的org.apache.commons.fileupload程序包包含一个叫作DiskFileUpload的类,它的parseRequest()方法获取HttpServletRequest参数,并返回org.apache.commons.fileupload.FileItem实例列表。编码后的窗体数据从servlet请求的getInputStream()方法所返回的数据流流中读取。FileItem这个名字容易使人误解,因为这个接口的实例同时表现了被上载的文件和正常的请求参数。
通用文件上载程序包所提供的API赋予了你访问分解后的窗体数据的权利,但是servlet请求的getParameter()和getParameterValues()方法却无法工作。这是一个难题,因为在输入字段、检查框、单选框和列表框后台运行的JSF组件需要调用这两个方法。我们可以利用Servlets API提供的两个特性(过滤器和请求包装器)来解决这个问题。下一部分描述了Apache MyFaces如何实现过滤器,添加了大量必要的对文件上载的支持,而不会中断已有的JSF组件。此外,MyFaces为JavaBeans提供了API,同时还提供了一个定制的JSF组件,它表现为<input type="file">元素。
配置JSF和MyFaces扩展
目前,JSF规范的主要实现是JSF参考实现(RI),与此同时,Apache提供了另外一个实现,就是MyFaces。当然可能存在其它一些JSF实现,但是JSF RI和MyFaces是其中最流行的两个。很多开发者更喜欢前者,因为Sun把它称为"官方的"实现,但是,MyFaces拥有一些有趣的扩展(例如对上载文件操作的支持)。如果你愿意,可以把MyFaces扩展与Sun的JSF RI一起使用。你只需要把myfaces-extensions.jar文件、JSF RI的JAR文件和commons-fileupload-1.0.jar文件一起放到自己的web应用程序的WEB-INF/lib目录中就可以了。下面是需要的JAR文件:
JSF 1.1 RI jsf-api.jarjsf-impl.jar
JSTL 1.1 RI jstl.jarstandard.jar
MyFaces扩展 myfaces-extensions.jar
Apache Commons(供JSF和MyFaces 扩展使用) commons-collections.jarcommons-digester.jarcommons-beanutils.jarcommons-logging.jarcommons-fileupload-1.0.jar
<?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>
<%@ 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" >
...
<x:inputFileUpload id="myFileId"
value="#{myBean.myFile}"
storage="file"
required="true"/>
...
</h:form>
</f:view>
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如何在通用文件上载的帮助下支持文件上载的。现在我们来看一个实际的利用了这种特性的应用程序。JSF窗体(MyForm.jsp)让用户选择一个文件和一个报文摘要算法,后台bean( MyBean.java)使用这个算法计算出一个散列值,显示在另外一个web页面(MyResult.jsp)中。这些页面和后台bean通过一个JSF配置文件(faces-config.xml)结合在一起。
MyForm.jsp页面
这个JSF窗体使用了MyFaces的<x:inputFileUpload>标记,同时还使用了其它一些标准的JSF标记来呈现标签、消息、包含报文摘要算法的下拉列表、使用JSF表达式(#{myBean.processMyFile})指定了处理被上载文件的操作方法的命令按钮:
<%@ 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>
package com.devsphere.articles.jsfupload;
import org.apache.myfaces.custom.fileupload.UploadedFile;
...
public class MyBean {
private UploadedFile myFile;
private String myParam;
private String myResult;
public UploadedFile getMyFile() {
return myFile;
}
public void setMyFile(UploadedFile myFile) {
this.myFile = myFile;
}
public String getMyParam() {
return myParam;
}
public void setMyParam(String myParam) {
this.myParam = myParam;
}
public String getMyResult() {
return myResult;
}
public void setMyResult(String myResult) {
this.myResult = 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;
}
}
}
<?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>
<%@ 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>