struts2文件上传

在 Struts 2中实现文件上传 前一阵子有些朋友在电子邮件中问关于 Struts 2实现文件上传的问， 所以今天我们就来讨论一下这个问题。 实现原理 Struts 2是通过 Commons FileUpload文件上传。Commons FileUpload通过将 HTTP的数据保存到临时文件夹，然后 Struts使用 fileUpload 拦截器将文件绑定到 Action的实例中。从而我们就能够以本地文件方式的操作浏览器上传的文件。 具体实现 前段时间 Apache发布了 Struts 2.0.6 GA，所以本文的实现是以该版本的 Struts作为框架的。以下是例子所依赖类包的列： 1 依赖类包的列表 首先，创建文件上传页面 FileUpload.jsp，内容如下： <% @ page language = " java " contentType = " text/html; charset=utf-8 " pageEncoding = " utf-8 " %> <% @ taglib prefix = " s " uri = " /struts-tags " %> < html xmlns ="http://www.w3.org/1999/xhtml" > < head > < title > Struts 2 File Upload < body > < s:form action ="fileUpload" method ="POST" enctype ="multipart/form-data" > < s:file name ="myFile" label ="Image File" /> < s:textfield name ="caption" label ="Caption" /> < s:submit /> 清单 2 FileUpload.jsp 在 FileUpload.jsp中，先将表单的提交方式设为 POST，然后将 enctype设为multipart/form-data，这并没有什么特别之处。接下来， 标志将文件上传控件绑定到 Action的myFile属性。 其次是 FileUploadAction.java代码： package tutorial; import java.io.BufferedInputStream; import java.io.BufferedOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.InputStream; import java.io.OutputStream; import java.util.Date; import org.apache.struts2.ServletActionContext; import com.opensymphony.xwork2.ActionSupport; public class FileUploadAction extends ActionSupport { private static final long serialVersionUID = 572146812454l ; private static final int BUFFER_SIZE = 16 * 1024 ; private File myFile; private String contentType; private String fileName; private String imageFileName; private String caption; public void setMyFileContentType(String contentType) { this .contentType = contentType; } public void setMyFileFileName(String fileName) { this .fileName = fileName; } public void setMyFile(File myFile) { this .myFile = myFile; } public String getImageFileName() { return imageFileName; } public String getCaption() { return caption; } public void setCaption(String caption) { this .caption = caption; } private static void copy(File src, File dst) { try { InputStream in = null ; OutputStream out = null ; try { in = new BufferedInputStream( new FileInputStream(src), BUFFER_SIZE); out = new BufferedOutputStream( new FileOutputStream(dst), BUFFER_SIZE); byte [] buffer = new byte [BUFFER_SIZE]; while (in.read(buffer) > 0 ) { out.write(buffer); } } finally { if ( null != in) { in.close(); } if ( null != out) { out.close(); } } } catch (Exception e) { e.printStackTrace(); } } private static String getExtention(String fileName) { int pos = fileName.lastIndexOf( " . " ); return fileName.substring(pos); } @Override public String execute() { imageFileName = new Date().getTime() + getExtention(fileName); File imageFile = new File(ServletActionContext.getServletContext().getRealPath( " /UploadImages " ) + " / " + i mageFileName); copy(myFile, imageFile); return SUCCESS; } } 清单 3 tutorial/FileUploadAction.java 在 FileUploadAction中我分别写了 setMyFileContentType、setMyFileFileName、setMyFile和 setCaption四个 Setter方法，后两者很容 易明白，分别对应 FileUpload.jsp中的和标志。但是前两者并没有显式地与任何的页面标志绑定，那么它们的值又是从 何而来的呢？其实，标志不仅仅是绑定到myFile，还有myFileContentType（上传文件的 MIME类型）和myFileFileName（上传 文件的文件名，该文件名不包括文件的路径）。因此，对应 Action类里面的 xxx、xxxContentType和 xxxFileName 三个属性。 FileUploadAction作用是将浏览器上传的文件拷贝到WEB应用程序的 UploadImages文件夹下，新文件的名称是由系统时间与上传文件的后缀 组成，该名称将被赋给 imageFileName属性，以便上传成功的跳转页面使用。 下面我们就来看看上传成功的页面： <% @ page language = " java " contentType = " text/html; charset=utf-8 " pageEncoding = " utf-8 " %> <% @ taglib prefix = " s " uri = " /struts-tags " %> < html xmlns ="http://www.w3.org/1999/xhtml" > < head > < title > Struts 2 File Upload < body > < div style ="padding: 3px; border: solid 1px #cccccc; text-align: center" > < img src ='UploadImages/ ' /> < br /> < s:property value ="caption" /> 清单 4 ShowUpload.jsp ShowUpload.jsp获得 imageFileName，将其 UploadImages组成 URL，从而将上传的图像显示出来。 然后是 Action的配置文件： < struts > < package name ="fileUploadDemo" extends ="struts-default" > < action name ="fileUpload" class ="tutorial.FileUploadAction" > < interceptor-ref name ="fileUploadStack" /> < result name ="success" > /ShowUpload.jsp 清单 5 struts.xml fileUpload Action显式地应用 fileUploadStack的拦截器。 最后是 web.xml配置文件： < web-app id ="WebApp_9" version ="2.4" xmlns ="http://java.sun.com/xml/ns/j2ee" xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation ="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" > < display-name > Struts 2 Fileupload < filter > < filter-name > struts-cleanup < filter-class > org.apache.struts2.dispatcher.ActionContextCleanUp < filter > < filter-name > struts2 < filter-class > org.apache.struts2.dispatcher.FilterDispatcher < filter-mapping > < filter-name > struts-cleanup < url-pattern > /* < filter-mapping > < filter-name > struts2 < url-pattern > /* < welcome-file-list > < welcome-file > index.html 清单 6 WEB-INF/web.xml 发布运行应用程序，在浏览器地址栏中键入：http://localhost:8080/Struts2_Fileupload/FileUpload.jsp，出现图示页面： 清单 7 FileUpload页面 选择图片文件，填写 Caption并按下 Submit按钮提交，出现图示页面： 清单 8 上传成功页面 更多配置 在运行上述例子，如果您留心一点的话，应该会发现服务器控制台有如下输出： Mar 20 , 2007 4 : 08 : 43 PM org.apache.struts2.dispatcher.Dispatcher getSaveDir INFO: Unable to find 'struts.multipart.saveDir' property setting. Defaulting to javax.servlet.context.tempdir Mar 20 , 2007 4 : 08 : 43 PM org.apache.struts2.interceptor.FileUploadInterceptor intercept INFO: Removing file myFile C:\Program Files\Tomcat 5.5 \work\Catalina\localhost\Struts2_Fileupload\upload_251447c2_11 16e355841__7ff7_00000006.tmp 清单 9 服务器控制台输出 上述信息告诉我们，struts.multipart.saveDir没有配置。struts.multipart.saveDir用于指定存放临时文件的文件夹，该配置写在 struts.properties文件中。例如，如果在 struts.properties文件加入如下代码： struts.multipart.saveDir = /tmp 清单 10 struts配置 这样上传的文件就会临时保存到你根目录下的 tmp文件夹中（一般为 c:\tmp），如果此文件夹不存在，Struts 2会自动创建一个。 错误处理 上述例子实现的图片上传的功能，所以应该阻止用户上传非图片类型的文件。在 Struts 2中如何实现这点呢？其实这也很简单，对上述例子作如 下修改即可。 首先修改 FileUpload.jsp，在与之间加入“”，用于在页面上输出错误信息。 然后修改 struts.xml文件，将 Action fileUpload的定义改为如下所示： < action name ="fileUpload" class ="tutorial.FileUploadAction" > < interceptor-ref name ="fileUpload" > < param name ="allowedTypes" > image/bmp,image/png,image/gif,image/jpeg < interceptor-ref name ="defaultStack" /> < result name ="input" > /FileUpload.jsp < result name ="success" > /ShowUpload.jsp 清单 11 修改后的配置文件 显而易见，起作用就是 fileUpload拦截器的 allowTypes参数。另外，配置还引入 defaultStack它会帮我们添加验证等功能，所以在出错之后会 跳转到名称为“input”的结果，也即是 FileUpload.jsp。 发布运行应用程序，出错时，页面如下图所示： 清单 12 出错提示页面 上面的出错提示是 Struts 2默认的，大多数情况下，我们都需要自定义和国际化这些信息。通过在全局的国际资源文件中加入 “struts.messages.error.content.type.not.allowed=The file you uploaded is not a image”，可以实现以上提及的需求。对此有疑问的朋 友可以参考我之前的文章《在 Struts 2.0中国际化(i18n)您的应用程序》。 实现之后的出错页面如下图所示： 清单 13 自定义出错提示页面 同样的做法，你可以使用参数“maximumSize”来限制上传文件的大小，它对应的字符资源名为：“struts.messages.error.file.too.large”。 字符资源“struts.messages.error.uploading”用提示一般的上传出错信息。 多文件上传 与单文件上传相似，Struts 2实现多文件上传也很简单。你可以将多个绑定 Action的数组或列表。如下例所示。 < s:form action ="doMultipleUploadUsingList" method ="POST" enctype ="multipart/form-data" > < s:file label ="File (1)" name ="upload" /> < s:file label ="File (2)" name ="upload" /> < s:file label ="FIle (3)" name ="upload" /> < s:submit /> 清单 14 多文件上传 JSP代码片段 如果你希望绑定到数组，Action的代码应类似： private File[] uploads; private String[] uploadFileNames; private String[] uploadContentTypes; public File[] getUpload() { return this .uploads; } public void setUpload(File[] upload) { this .uploads = upload; } public String[] getUploadFileName() { return this .uploadFileNames; } public void setUploadFileName(String[] uploadFileName) { this .uploadFileNames = uploadFileName; } public String[] getUploadContentType() { return this .uploadContentTypes; } public void setUploadContentType(String[] uploadContentType) { this .uploadContentTypes = uploadContentType; } 清单 15 多文件上传数组绑定 Action代码片段 如果你想绑定到列表，则应类似： private List < File > uploads = new ArrayList < File > (); private List < String > uploadFileNames = new ArrayList < String > (); private List < String > uploadContentTypes = new ArrayList < String > (); public List < File > getUpload() { return this .uploads; } public void setUpload(List < File > uploads) { this .uploads = uploads; } public List < String > getUploadFileName() { return this .uploadFileNames; } public void setUploadFileName(List < String > uploadFileNames) { this .uploadFileNames = uploadFileNames; } public List < String > getUploadContentType() { return this .uploadContentTypes; } public void setUploadContentType(List < String > contentTypes) { this .uploadContentTypes = contentTypes; } 清单 16 多文件上传列表绑定 Action代码片段 总结 在 Struts 2中实现文件上传的确是轻而易举，您要做的只是使用与 Action的属性绑定。这又一次有力地证明了 Struts 2的简单易用。