Struts2 文件上传

浏览数：29 / 时间：2015年06月09日

一、使用Struts2实现文件上传

1：fileUpload拦截器

使用Struts2来实现文件上传，需要使用Struts2预定义的fileUpload拦截器。示例如下：

java代码：

<package name="struts-default" abstract="true">
…
<interceptors>
…
<interceptor name="fileUpload"
ss="org.apache.struts2.interceptor.FileUploadInterceptor"/>
…
<interceptor-stack name="defaultStack">
…
<interceptor-ref name="fileUpload"/>
…
</interceptor-stack>
</interceptors>
<default-interceptor-ref name="defaultStack"/>
</package>

　　上面列出了struts-default.xml中跟fileUpload拦截器有关的部分。首先，Struts2有一个预定义拦截器叫 fileUpload；然后，defaultStack拦截器栈引用了fileUpload拦截器；最后，struts-default包又将 defaultStack拦截器声明为自己的默认拦截器引用。

因此，如果我们的包继承了struts-default包，而我们的Action类又没有声明自己的拦截器引用的话，使用的就是defaultStack拦截器栈，从而引用了fileUpload拦截器。

2：实现上传页面

如果一个表单中，包含了文件上传的表单域，则一定要把整个表单enctype属性设置为multipart/form-data。形如：

java代码：

<%@ page language="java" contentType="text/html; charset=gb2312"
pageEncoding="gb2312"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
<title>Insert title here</title>
</head>
<body>
<form action="/helloworld/uploadAction.action" method="post"
enctype="multipart/form-data">
文件名称：<input type="text" name="fileName"><br>
文件：<input type="file" name="myFile"><br>
<input type="submit" value="提交">
</form>
</body>
</html>

在这个文件里，指定了<form>元素的enctype属性为multipart/form-data，还用了一个type为file的输入域，它会在页面上生成一个文件选择框。

3：实现文件上传Action

这个Action和其他的Action没有太多特殊之处，使用一个String属性fileName来准备接收前一个页面的fileName文本框的值，然后使用一个File属性myFile来准备接收前一个页面的myFile文件框传过来的文件的值。

在execute方法中，我们可以随意存储上传的文件，本例只是把它放到了e盘的temp目录下，并以传入的fileName作为保存的文件名。

java代码：

public class UploadAction extends ActionSupport{
private String fileName;
private File myFile;
public String getFileName() {
return fileName;
}
public void setFileName(String fileName) {
this.fileName = fileName;
}
public File getMyFile() {
return myFile;
}
public void setMyFile(File myFile) {
this.myFile = myFile;
}
public String execute()throws Exception{
//先把上传过来的文件存放到e盘temp目录下，以传入的fileName为名字
OutputStream output = null;
InputStream input = null;
try{
output = new FileOutputStream("e:/temp/"+fileName);
//建立一个1k大小的缓冲区
byte[] bs = new byte[1024];
//将上传过来的文件输出到output中
input = new FileInputStream(myFile);
int length = 0;
//length=input.read(bs)这句话中，length=-1代表了读到文件结尾
while ((length=input.read(bs))>0){
output.write(bs, 0, length);
}
}finally{
input.close();
output.close();
}
return SUCCESS;
}
}

　　注：如何操作上传的文件，完全是I/O的知识，为了保持实例的简单，只是采用了最简单的方式，把内容存放在一个绝对路径表示的文件里面，当然还可以将上传的文件存储在web服务器上，甚至数据库中。

4：映射这个Action

在struts.xml中对这个Action进行配置，可以看到没有任何特异之处，只是指出了Action名称和对应的实现类，以及上传之后要跳转到的页面。

java代码：

<package name="helloworld" extends="struts-default">
<action name="uploadAction" class="cn.javass.fileupload.UploadAction">
<result>/fileupload/success.jsp</result>
</action>
</package>

5：上传之后的页面

由于上传的文件在Action中已经被正确处理了，所以这个上传之后的页面没有任何特殊的作用，只是显示一下，表示上传成功了，示例代码如下：

java代码：

<%@ page language="java" contentType="text/html; charset=gb2312"
pageEncoding="gb2312"%>
<%@taglib prefix="s" uri="/struts-tags" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
<title>Insert title here</title>
</head>
<body>
成功上传文件<s:property value="fileName"/>
</body>
</html>

运行测试一下，在文件上传页面选择要上传的文件，然后点击提交按钮，会发现文件会上传，并以我们指定的文件名称保存到我们指定的文件夹下去了。

二、获取文件的更多信息

Struts2支持用更多的属性来获取有关上传文件的真实文件名和文件类型。

比如：表单中包含了一个叫xyz的文件域，也就是类似于<input type=”file” name=”xyz”，那么可以用三个属性来获取上传文件的信息：

File类型的属性xyz用来获取文件内容。
String类型的属性xyzFileName用来获取文件的真实文件名。
String类型的属性xyzContentType属性用来获取文件的类型。

将处理上传文件的Action类修改一下，添加两个属性：myFileFileName和myFileContentType，以及他们对应的getter/setter方法，来尝试获得文件的真实文件名和文件类型。

另外，保存文件的时候，也使用文件的真实名称：

java代码：

public class UploadAction extends ActionSupport{
private String fileName;
private File myFile;
private String myFileFileName;
private String myFileContentType;
public String getMyFileFileName() {
return myFileFileName;
}
public void setMyFileFileName(String myFileFileName) {
this.myFileFileName = myFileFileName;
}
public String getMyFileContentType() {
return myFileContentType;
}
public void setMyFileContentType(String myFileContentType) {
this.myFileContentType = myFileContentType;
}
public String getFileName() {
return fileName;
}
public void setFileName(String fileName) {
this.fileName = fileName;
}
public File getMyFile() {
return myFile;
}
public void setMyFile(File myFile) {
this.myFile = myFile;
}
public String execute()throws Exception{
System.out.println("用户传入的文件名："+fileName);
System.out.println("上传文件的真实文件名："+myFileFileName);
System.out.println("上传文件的类型："+myFileContentType);
System.out.println("这个文件的文件名是什么?"+myFile.getName());
//把上传过来的文件存放到e盘temp目录下，以真实的文件名作为名字
OutputStream output = null;
InputStream input = null;
try{
output = new FileOutputStream("e:/temp/"+myFileFileName);
//建立一个1k大小的缓冲区
byte[] bs = new byte[1024];
//将上传过来的文件输出到output中
input = new FileInputStream(myFile);
int length = 0;
//length=input.read(bs)这句话中，length=-1代表了读到文件结尾
while ((length=input.read(bs))>0){
output.write(bs, 0, length);
}
}finally{
input.close();
output.close();
}
return SUCCESS;
}
}

运行测试一下，后台输出为：

用户传入的文件名：aaa
上传文件的真实文件名：filelist.xml
上传文件的类型：text/xml
这个文件的文件名是什么?upload__5ab75acc_12c5f17ac7a__8000_00000001.tmp

注意其中“这个文件的文件名是什么?”，代码写的是输出myFile这个File对象的名字，由于myFile对象封装了上传文件的内容，因而某些朋友就认为这个文件就是我们上传的文件，从而认为它的getName方法就是返回的上传的这个文件的名字。

这是错误的，这个myFile文件是Struts2在上传过程中生成的临时文件，它的内容与上传文件相同，但是名字并不相同，它的名字是由 Struts2临时生成的，形如“upload__5ab75acc_12c5f17ac7a__8000_00000001.tmp”这样的。

三、限制文件的大小及类型

在文件上传的时候，有可能需要对文件的大小和类型做出限制。Struts2支持直接在fileUpload拦截器上设置参数来进行限制。

在引用fileUpload拦截器的时候，可以指定三个参数(指定<param>子元素)：

allowedTypes：指定允许上传的文件的类型，如果存在多种类型，以逗号隔开。注意：这里添的不是文件的扩展名，而是对应的ContentType，如果不知道某种文件的ContentType可以先上传一下试试，在后台输出ContentType来。
maximumSize：指定允许上传的文件的最大字节数。
allowedExtensions：指定允许上传的文件的扩展名。

如果上传的文件不满足以上的参数指定的条件，则会跳转到一个叫input的<result>上，一般input都会指回到提交之前的页面，也就是文件上传页面。

参数非常简单，但是配置比较怪异，fileUpload拦截器虽然在defaultStack拦截器栈上已经引用了，但是还可以在defaultStack拦截器栈之前再引用一次，然后在这次引用上指定参数，示例代码如下：

java代码：

<package name="helloworld" extends="struts-default">
<action name="uploadAction" class="cn.javass.fileupload.UploadAction">
<interceptor-ref name="fileUpload">
<param name="allowedTypes">text/plain</param>
<param name="maximumSize">1000</param>
</interceptor-ref>
<interceptor-ref name="defaultStack"/>
<result name="input">/fileupload/fileupload.jsp</result>
<result>/fileupload/success.jsp</result>
</action>
</package>

观察以上的<action>元素，要额外注意两点：

这个Action应该先引用fileUpload拦截器，然后引用defaultStack拦截器栈。
这个Action中还要有一个叫input的<result>，以备上传不成功时，Struts2跳转到提交前的页面。

还要稍微修改一下login.jsp，来显示不满足限制条件时的错误信息。只需要在合适的地方加上<s:fielderror/>来显示错误信息即可。

java代码：

<%@ page language="java" contentType="text/html; charset=gb2312"
pageEncoding="gb2312"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
<title>Insert title here</title>
</head>
<body>
<%@taglib prefix="s" uri="/struts-tags" %>
<s:fielderror/>
<form action="/helloworld/uploadAction.action" method="post"
enctype="multipart/form-data">
文件名称：<input type="text" name="fileName"><br>
文件：<input type="file" name="myFile"><br>
<input type="submit" value="提交">
</form>
</body>
</html>

四、上传超大的文件

Struts2在实现文件上传的时候，还有一个小问题，那就是默认上传文件的大小是不能超过2097152字节的。这个配置在struts2- core-2.1.8.1.jar文件里面，“\org\apache\struts2”文件夹下的default.properties文件里面，配置如下：

java代码：

struts.multipart.maxSize=2097152

先来测试一下，看看是不是有这个问题。到文件上传页面，选择一个超过上述字节数的文件来上传看看，点击提交按钮，后台输出错误如下：

java代码：

org.apache.commons.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (3402567) exceeds the configured maximum (2097152)
at org.apache.commons.fileupload.FileUploadBase$FileItemIteratorImpl.<init>(FileUploadBase.java:914)
......

注意上面的那句话，明确告诉我们，上传的文件大小为3402567，大于配置的最大值2097152字节。

那么该怎么办呢？

方法很简单，只要覆盖这个默认设置就可以了，有两种方式，一种是在Struts.properties里面配置，另外一种就是在 struts.xml里面配置。这里就以在struts.xml来配置为例，只要在struts.xml中加入如下的常量定义，示例代码如下：

java代码：