文件上传简述
struts2的文件上传没有使用Servlet 3.0 API,所以struts2的文件上传还需要依赖于Common-FileUpload、COS等文件上传组件。
为了能上传文件,必须将表单的method设置为POST,将enctype设置为multipart/form-data,需添加 < input type=“file”> 字段。这样,浏览器才会把用户选择文件的二进制数据发送给服务器。
设置了enctype为multipart/form-data,浏览器将采用二进制流的方式处理表单数据,Servlet 3.0规范的HttpServletRequest已经提供了方法来处理文件上传,但这种上传需要在Servlet中完成,而struts2则提供了更简单的封装。
struts2并未提供自己的请求解析器,因此,struts2不会自己处理multipart/form-data的请求,它需要调用其他上传框架来解析二进制请求数据。但在struts2原有的上传解析器上做进一步封装,更加简化了文件上传。
struts2的struts.properties配置文件中,看到下面这段配置代码,它们主要用于配置struts2上传文件时的上传解析器。
#指定使用COS的文件上传解析器
#struts.multipart.parser=cos
#指定使用Pell的文件上传解析器
#struts.multipart.parser=pell
#struts2默认使用Jakarta的Common-FileUpload的文件上传解析器
struts.multipart.parser=jakarta
struts2的封装隔离了底层文件组件的区别,开发者只要在此处配置文件上传所使用的解析器,就可以在不同文件上传框架之间切换。
struts2默认使用的是Jakarta的Common-FileUpload的文件上传框架,所以如果需要使用struts的文件上传功能,则需要在Web应用中增加commoms-io-2.2.jar和commons-fileupload-1.3.1.jar这两个jar包,将struts2项目lib下的这两个文件复制到Web应用的WEB-INF\lib路径下。
struts2默认使用Jakarta的Common-FileUpload的文件上传,是因为它们都是Apache组织下的项目,但并不一定只能使用Jakarta的Common-FileUpload文件上传,也可以在Web应用中使用COS、Pell的文件上传支持。对于开发者而言,使用哪种文件上传支持,只需要修改struts.multipart.parse常量,并在Web应用中增加相应上传项目的类库即可。
struts2的文件上传支持在原有的文件项目做了进一步封装,简化了文件上传的代码实现,取消了不同上传项目上的编程差异。
文件上传实现
下面以struts2默认的文件上传支持为例,使用 FileUpload 拦截器和 Jakarta Commons FileUpload 组件完成文件的上传。
步骤:
1. 在 Jsp 页面的文件上传表单里使用 file 标签. 如果需要一次上传多个文件, 就必须使用多个 file 标签, 但它们的名字必须是相同的
2. 在 Action 中新添加 3 个和文件上传相关的属性. 这 3 个属性的名字必须是以下格式
[File Name] : File -被上传的文件。例如:data
[File Name]ContentType : String -上传文件的文件类型。例如:dataContentType
[File Name]FileName : String -上传文件的文件名。例如:dataFileName
如果上上传多个文件, 可以使用 List。
假设如下图所示的文件上传页面,其中包括两个表单域:文标题和文件域,为了完成文件上传,应该讲这两个表单域所在表单的enctype属性设置为“multipart/form-data”。
该页面代码如下。
<%@ page contentType="text/html; charset=GBK" language="java" errorPage="" %>
<%@taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>简单的文件上传</title>
</head>
<body>
<s:form action="upload"
enctype="multipart/form-data">
<s:textfield name="title" label="文件标题"/>
<s:file name="upload" label="选择文件"/>
<s:submit value="上传"/>
</s:form>
</body>
</html>
上面使用了struts2的标签库来生成上传文件的表单,其中< s:file…/>用于生成一个文件上传域。当该页面提交请求时,请求发送到upload.action,这是struts2的一个Action。
struts2的Action无须负责处理HttpServletRequest请求,struts2的Action已经与Servlet API彻底分离了,struts2框架负责解析HttpServletRequest请求中的参数,包括文件域,struts2使用File类型来封装文件域。
public class UploadAction extends ActionSupport{
// 封装文件标题请求参数的属性
private String title;
// 封装上传文件域的属性
private File upload;
// 封装上传文件类型的属性
private String uploadContentType;
// 封装上传文件名的属性
private String uploadFileName;
// 直接在struts.xml文件中配置的属性
private String savePath;
// 接受struts.xml文件配置值的方法
public void setSavePath(String value){
this.savePath = value;
}
// 获取上传文件的保存位置
private String getSavePath() throws Exception{
return ServletActionContext.getServletContext()
.getRealPath(savePath);
}
// title的setter和getter方法
public void setTitle(String title){
this.title = title;
}
public String getTitle(){
return (this.title);
}
// upload的setter和getter方法
public void setUpload(File upload){
this.upload = upload;
}
public File getUpload(){
return (this.upload);
}
// uploadContentType的setter和getter方法
public void setUploadContentType(String uploadContentType){
this.uploadContentType = uploadContentType;
}
public String getUploadContentType(){
return (this.uploadContentType);
}
// uploadFileName的setter和getter方法
public void setUploadFileName(String uploadFileName){
this.uploadFileName = uploadFileName;
}
public String getUploadFileName(){
return (this.uploadFileName);
}
@Override
public String execute() throws Exception{
// 以服务器的文件保存地址和原文件名建立上传文件输出流
FileOutputStream fos = new FileOutputStream(getSavePath() + "\\" + getUploadFileName());
FileInputStream fis = new FileInputStream(getUpload());
byte[] buffer = new byte[1024];
int len = 0;
while ((len = fis.read(buffer)) > 0){
fos.write(buffer , 0 , len);
}
fos.close();
return SUCCESS;
}
}
这里的Action与一般Action类似,提供了upload和title两个成员变量,分别对应两个表单域的name属性,用于封装两个表单域的请求参数。
另外,这里Action中还包含了uploadFileName和uploadContentType两个成员变量,用于封装上传文件的文件名、上传文件的文件类型。Action类直接通过File类型属性直接封装了上传文件的文件内容,但这个File属性无法获取上传文件的文件名和文件类型,所以struts2将文件域中包含的文件名和文件类型的信息封装到uploadName和uploadContentType成员变量中。可以理解成:如果表单中包含一个name属性为xxx的文件域,则对应Action需要使用三个成员变量来封装该文件域的信息。
>类型为File的xxx成员变量封装了该文件域对应的文件内容。
>类型为String的xxxFileName成员变量封装了该文件域对应的文件的文件名。
>类型为String的xxxContentType成员变量封装了该文件域对应的文件的文件类型。
通过上面的三个成员变量,可以简单地实现文件上传,所有在execute()方法中,可以直接通过调用getXxx()方法来获取上传文件的文件名、、文件类型和文件内容。
另外上面的Action中还包含了一个savePath成员变量,该成员变量的值通过配置文件来设置,从而允许动态设置该成员变量的值。
struts2的Action中的属性,除了能封装HTTP请求参数外,也可以封装Action的处理结果,还通过在struts2配置文件中进行配置,接受struts2框架的注入,允许在配置文件中为该属性动态指定。
文件上传的Action的配置
struts2文件上传的Action的配置与普通Action的配置类似,一样指定该Action的name,和该Action的实现类,同时为Action配置< result…/>元素。区别之处在于,该Action还配置了一个< param…/>,该元素用于为该Action的属性动态分配属性值。
<?xml version="1.0" encoding="GBK"?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
"http://struts.apache.org/dtds/struts-2.3.dtd">
<struts>
<!-- 设置该应用使用的字符集 -->
<constant name="struts.i18n.encoding" value="GBK"/>
<package name="lee" extends="struts-default">
<!-- 配置处理文件上传的Action -->
<action name="upload" class="org.crazyit.app.action.UploadAction">
<!-- 动态设置Action的属性值 -->
<param name="savePath">/uploadFiles</param>
<!-- 配置Struts 2默认的视图页面 -->
<result>/WEB-INF/content/succ.jsp</result>
</action>
<action name="*">
<result>/WEB-INF/content/{1}.jsp</result>
</action>
</package>
</struts>
配置了该Web应用后,如果在表单页面中输入文件标题,并浏览需要上传的文件,然后单击“上传”按钮,该请求将被UploadAction处理,处理后转入succ.jsp页面,该页面使用了简单的struts2标签来显示上传的图片。succ.jsp页面的代码如下。
<%@ page contentType="text/html; charset=GBK" language="java" errorPage="" %>
<%@taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>上传成功</title>
</head>
<body>
上传成功!<br/>
文件标题:<s:property value=" + title"/><br/>
文件为:<img src="<s:property value="‘uploadFiles/‘
+ uploadFileName"/>"/><br/>
</body>
</html>
上面示例上传时把文件保存到服务器时该文件的文件名依然没有发生改变。实际项目中,会因为多个用户并发上传时可能发生文件名相同的情形,一般建议使用java.util.UUID工具类来生成唯一的文件名。
可见struts2实现文件上传挺简单的,只要将文件域与Action中一个类型为File的成员变量关联,就可以轻松访问到上传文件的文件内容。
struts2实现文件上传的编程关键,在于使用三个成员变量来封装文件域,分别用于封装该文件的文件名、该文件的文件类型、该文件的文件内容。