基于struts2--实现文件上传下载
1. 文件的上传:
1). 表单需要注意的 3 点
①. method="post" ②. enctype="mulitipart/form-data" ③. <s:file name=""></s:file>
2). Struts2 的文件上传实际上使用的是 Commons FileUpload 组件, 所以需要导入
commons-fileupload-1.3.jar
commons-io-2.0.1.jar
3). Struts2 进行文件上传需要使用 FileUpload 拦截器
4). 基本的文件的上传: 直接在 Action 中定义如下 3 个属性, 并提供对应的 getter 和 setter (注意：变量的命名)
5). 使用 IO 流进行文件的上传即可. （同时上传多个文件）
6). 一次传多个文件怎么办 ?
若传递多个文件, 则上述的 3 个属性, 可以改为 List 类型! 多个文件域的 name 属性值需要一致. （注意每个变量名的命名规则）
7). 可以对上传的文件进行限制吗 ? 例如扩展名, 内容类型, 上传文件的大小 ? 若可以, 则若出错, 显示什么错误消息呢 ? 消息可以定制吗 ?
可以的!
可以通过配置 FileUploadInterceptor 拦截器的参数的方式来进行限制
maximumSize (optional) - 默认的最大值为 2M. 上传的单个文件的最大值
allowedTypes (optional) - 允许的上传文件的类型. 多个使用 , 分割
allowedExtensions (optional) - 允许的上传文件的扩展名. 多个使用 , 分割.
注意: 在 org.apache.struts2 下的 default.properties 中有对上传的文件总的大小的限制. 可以使用常量的方式来修改该限制
定制错误消息. 可以在国际化资源文件中定义如下的消息:
struts.messages.error.uploading - 文件上传出错的消息
问题: 此种方式定制的消息并不完善. 可以参考 org.apache.struts2 下的 struts-messages.properties, 可以提供更多的定制信息.
2). 具体使用细节参看 struts-2.3.15.3-all/struts-2.3.15.3/docs/WW/docs/stream-result.html
3). 可以为 stream 的 result 设定如下参数
contentType: 结果类型 (default = text/plain)
contentLength: 下载的文件的长度
contentDisposition: 设定 Content-Dispositoin 响应头. 该响应头指定接应是一个文件下载类型, 一般取值为 attachment;filename="document.pdf".
(default = "attachment;filename=ajax.html").
inputName: 指定文件输入流的 getter 定义的那个属性的名字. (default = inputStream).
bufferSize: 缓存的大小. (default = 1024).
allowCaching: 是否允许使用缓存 (default = true)
contentCharSet: 指定下载的字符集
4). 以上参数可以在 Action 中以 getter 方法的方式提供，也可以通过参数配置.
> 在不刷新表单页面的前提下:
>> 多次点击提交按钮
>> 已经提交成功, 按 "回退" 之后, 再点击 "提交按钮".
>> 在控制器响应页面的形式为转发情况下，若已经提交成功, 然后点击 "刷新(F5)"
> 注意:
>> 若刷新表单页面, 再提交表单不算重复提交
>> 若使用的是 redirect 的响应类型, 已经提交成功后, 再点击 "刷新", 不是表单的重复提交
2). 表单重复提交的危害:
> 加重了服务器的负担
> 可能导致错误操作.
这个标签必须嵌套在 form 标签的内部使用, 它将在表单里插入一个隐藏字段并把标记值（隐藏域的字段的值）保存在HttpSession 对象里.
Token 标签必须与 Token 或 TokenSession 拦截器配合使用, 这两个拦截器都能对标记进行处理.
> 生成一个隐藏域
> 在 session 添加一个属性值
> 隐藏域的值和 session 的属性值是一致的.
II. 使用 Token 或 TokenSession 拦截器.
> 这两个拦截器均不在默认的拦截器栈中, 所以需要手工配置一下（注意：在配置Token 和 TokenSession拦截器的时候放在defaultStack拦截器的前面，以次来提高性能）
> 若使用 Token 拦截器, 则需要配置一个 name=invalid.token 的 result （注意：配置的是result的name属性，而不是type属性）
例如：<result name="invalid.token">/token_error.jsp</result>
> 都是解决表单重复提交问题的
> 使用 token 拦截器会转到 invalid.token 这个 result
> 使用 tokenSession 拦截器则还会响应那个目标页面, 但不会执行 tokenSession 的后续拦截器（也就是说，Action类的方法不会被执行）. 就像什么都没发生过一样!
IV. 使用token拦截器的时候，可以使用 s:actionerror 标签来显示重复提交的错误消息.
4. 自定义拦截器
1). 具体步骤
I. 定义一个拦截器的类
> 可以实现 Interceptor 接口，也可以继承 AbstractInterceptor 抽象类
MyInterceptor.java
package com.lym.struts2.interceptor;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.AbstractInterceptor;
public class MyInterceptor extends AbstractInterceptor {
/**
* 自定义拦截器需要添加 ActionInvocation 的 invoke()方法来调用其他的拦截器，
* 也可以不调用 ActionInvocation 的 invoke() 方法，直接返回结果. 那么后续的拦截器和 Action 方法将不会被调用.
* Struts 会渲染自定义拦截器 intercept 方法返回值对应的 result
*/
private static final long serialVersionUID = 1L;
@Override
public String intercept(ActionInvocation arg0) throws Exception {
System.out.println("before interceptor...");
String result = arg0.invoke();
System.out.println("after interceptor...");
return result;
}
}
II. 在 struts.xml 文件配置.
> 可以在action中使用自定义的拦截器，也可以把自定义拦截器添加到默认拦截器栈中来使用。
<interceptors>
<interceptor name="hello" class="com.atguigu.struts2.interceptors.MyInterceptor"></interceptor>
</interceptors>
<!-- 在action中使用自定义拦截器 -->
<action name="testToken" class="com.atguigu.struts2.token.app.TokenAction">
<interceptor-ref name="hello"></interceptor-ref>
<interceptor-ref name="defaultStack"></interceptor-ref>
<result>/success.jsp</result>
<result name="invalid.token">/token-error.jsp</result>
</action>
<!-- 把自定义拦截器添加到拦截器栈中 -->
<interceptors>
<!-- 自定义拦截器 -->
<interceptor name="hello" class="com.lym.struts2.interceptor.MyInterceptor"></interceptor>
<interceptor-stack name="lym">
<interceptor-ref name="hello"></interceptor-ref>
<interceptor-ref name="defaultStack">
<param name="fileUpload.maximumSize">2097152</param>
<param name="fileUpload.allowedTypes">text/html,text/xml,text/plain,application/octet-stream</param>
</interceptor-ref>
</interceptor-stack>
</interceptors>
<!-- 注意：拦截器配置好后别忘了使用 -->
<default-interceptor-ref name="lym"></default-interceptor-ref>
III. 注意: 在自定义的拦截器中可以选择不调用 ActionInvocation 的 invoke() 方法. 那么后续的拦截器和 Action 方法将不会被调用.
Struts 会渲染自定义拦截器 intercept 方法返回值对应的 result
1). 表单需要注意的 3 点
①. method="post" ②. enctype="mulitipart/form-data" ③. <s:file name=""></s:file>
<s:form action="testUpload" theme="simple" enctype="multipart/form-data" method="post"> <s:fielderror name="file"></s:fielderror> <s:actionerror/> <s:text name="file"/><s:file name="file"></s:file> <br> <s:text name="desc"/><s:textfield name="desc[0]"></s:textfield> <br><br> <s:submit></s:submit> </s:form>
2). Struts2 的文件上传实际上使用的是 Commons FileUpload 组件, 所以需要导入
commons-fileupload-1.3.jar
commons-io-2.0.1.jar
3). Struts2 进行文件上传需要使用 FileUpload 拦截器
4). 基本的文件的上传: 直接在 Action 中定义如下 3 个属性, 并提供对应的 getter 和 setter (注意：变量的命名)
//文件对应的 File 对象 private File [fileFieldName]; //文件类型 private String [fileFieldName]ContentType; //文件名 private String [fileFieldName]FileName;
5). 使用 IO 流进行文件的上传即可. （同时上传多个文件）
ServletContext servletContext = ServletActionContext.getServletContext();
//
// for (int i = 0; i < file.size(); i++) {
// String dir = servletContext.getRealPath("/file/"+fileFileName.get(i));
// System.out.println(dir);
// byte [] buffer = new byte[1024];
//
// try {
// FileOutputStream out = new FileOutputStream(dir);
// FileInputStream in = new FileInputStream(file.get(i));
// int len=0;
// while((len =in.read(buffer))!=-1){//此处(len =in.read(buffer))一定不要忘记用括号括起来，否则报错
// out.write(buffer, 0, len);
// }
//
// in.close();
// out.close();
// } catch (Exception e) {
// e.printStackTrace();
// }
// }
6). 一次传多个文件怎么办 ?
若传递多个文件, 则上述的 3 个属性, 可以改为 List 类型! 多个文件域的 name 属性值需要一致. （注意每个变量名的命名规则）
private List<File> file; private List<String> fileContentType; private List<String> fileFileName; private List<String> desc;
7). 可以对上传的文件进行限制吗 ? 例如扩展名, 内容类型, 上传文件的大小 ? 若可以, 则若出错, 显示什么错误消息呢 ? 消息可以定制吗 ?
可以的!
可以通过配置 FileUploadInterceptor 拦截器的参数的方式来进行限制
maximumSize (optional) - 默认的最大值为 2M. 上传的单个文件的最大值
allowedTypes (optional) - 允许的上传文件的类型. 多个使用 , 分割
allowedExtensions (optional) - 允许的上传文件的扩展名. 多个使用 , 分割.
<!-- 通过配置FileUploadInterceptor 拦截器的参数来限制上传文件 --> <interceptors> <interceptor-stack name="lym"> <interceptor-ref name="defaultStack"> <!-- 文件一次上传的总大小为2MB --> <param name="fileUpload.maximumSize">2097152</param> <!-- 上传文件的内容类型，多个类型之间用逗号分隔 --> <param name="fileUpload.allowedTypes">text/html,text/xml,text/plain</param> <!-- 上传文件的扩展名，多个扩展名之间用逗号分隔(注意：扩展名前面没有点) --> <param name="fileUpload.allowedExtensions">html,xml,jar,txt</param> </interceptor-ref> </interceptor-stack> </interceptors> <!-- 注意：拦截器配置好后别忘了使用 --> <default-interceptor-ref name="lym"></default-interceptor-ref>
注意: 在 org.apache.struts2 下的 default.properties 中有对上传的文件总的大小的限制. 可以使用常量的方式来修改该限制
<!-- 修改上传文件的总大小 --> <constant name="struts.multipart.maxSize" value="10000000" />
定制错误消息. 可以在国际化资源文件中定义如下的消息:
struts.messages.error.uploading - 文件上传出错的消息
struts.messages.error.file.too.large - 文件超过最大值的消息
struts.messages.error.content.type.not.allowed - 文件内容类型不合法的消息
struts.messages.error.file.extension.not.allowed - 文件扩展名不合法的消息问题: 此种方式定制的消息并不完善. 可以参考 org.apache.struts2 下的 struts-messages.properties, 可以提供更多的定制信息.
2. 文件的下载:
1). Struts2 中使用 type="stream" 的 result 进行下载即可<!-- 文件下载 --> <action name="testDownload" class="com.lym.struts2.download.app.DownloadAction"> <result type="stream"> <param name="bufferSize">2048</param> <param name="contentType">text/html</param> </result> </action>
2). 具体使用细节参看 struts-2.3.15.3-all/struts-2.3.15.3/docs/WW/docs/stream-result.html
3). 可以为 stream 的 result 设定如下参数
contentType: 结果类型 (default = text/plain)
contentLength: 下载的文件的长度
contentDisposition: 设定 Content-Dispositoin 响应头. 该响应头指定接应是一个文件下载类型, 一般取值为 attachment;filename="document.pdf".
(default = "attachment;filename=ajax.html").
inputName: 指定文件输入流的 getter 定义的那个属性的名字. (default = inputStream).
bufferSize: 缓存的大小. (default = 1024).
allowCaching: 是否允许使用缓存 (default = true)
contentCharSet: 指定下载的字符集
4). 以上参数可以在 Action 中以 getter 方法的方式提供，也可以通过参数配置.
<param name="bufferSize">2048</param> <param name="contentType">text/html</param>
3. 表单的重复提交问题
1). 什么是表单的重复提交> 在不刷新表单页面的前提下:
>> 多次点击提交按钮
>> 已经提交成功, 按 "回退" 之后, 再点击 "提交按钮".
>> 在控制器响应页面的形式为转发情况下，若已经提交成功, 然后点击 "刷新(F5)"
> 注意:
>> 若刷新表单页面, 再提交表单不算重复提交
>> 若使用的是 redirect 的响应类型, 已经提交成功后, 再点击 "刷新", 不是表单的重复提交
2). 表单重复提交的危害:
> 加重了服务器的负担
> 可能导致错误操作.
3). Struts2 解决表单的重复提交问题:
I. 在 s:form 中添加 s:token 子标签：
Struts 提供的 token 标签可以用来生成一个独一无二的标记.这个标签必须嵌套在 form 标签的内部使用, 它将在表单里插入一个隐藏字段并把标记值（隐藏域的字段的值）保存在HttpSession 对象里.
Token 标签必须与 Token 或 TokenSession 拦截器配合使用, 这两个拦截器都能对标记进行处理.
> 生成一个隐藏域
> 在 session 添加一个属性值
> 隐藏域的值和 session 的属性值是一致的.
II. 使用 Token 或 TokenSession 拦截器.
> 这两个拦截器均不在默认的拦截器栈中, 所以需要手工配置一下（注意：在配置Token 和 TokenSession拦截器的时候放在defaultStack拦截器的前面，以次来提高性能）
> 若使用 Token 拦截器, 则需要配置一个 name=invalid.token 的 result （注意：配置的是result的name属性，而不是type属性）
例如：<result name="invalid.token">/token_error.jsp</result>
> 若使用 TokenSession 拦截器, 则不需要配置任何其它的 result
<!-- 解决表单的重复提交问题的拦截器配置 --> <action name="testToken" class="com.lym.struts2.token.app.TokenAction"> <!-- 因为defaultStack拦截器栈中没有token拦截器，所以此处需要自己手动的配一个拦截器 --> <!-- <interceptor-ref name="token"></interceptor-ref> --> <interceptor-ref name="tokenSession"></interceptor-ref> <interceptor-ref name="defaultStack"></interceptor-ref> <result>/success.jsp</result> <result name="invalid.token">/token_error.jsp</result> </action>III. Token VS TokenSession
> 都是解决表单重复提交问题的
> 使用 token 拦截器会转到 invalid.token 这个 result
> 使用 tokenSession 拦截器则还会响应那个目标页面, 但不会执行 tokenSession 的后续拦截器（也就是说，Action类的方法不会被执行）. 就像什么都没发生过一样!
IV. 使用token拦截器的时候，可以使用 s:actionerror 标签来显示重复提交的错误消息.
该错误消息可以在国际化资源文件中覆盖. 该消息可以在 struts-messages.properties 文件中找到
struts.messages.invalid.token=The form has already been processed or no token was supplied, please try again.
4. 自定义拦截器
1). 具体步骤
I. 定义一个拦截器的类
> 可以实现 Interceptor 接口，也可以继承 AbstractInterceptor 抽象类
MyInterceptor.java
package com.lym.struts2.interceptor;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.AbstractInterceptor;
public class MyInterceptor extends AbstractInterceptor {
/**
* 自定义拦截器需要添加 ActionInvocation 的 invoke()方法来调用其他的拦截器，
* 也可以不调用 ActionInvocation 的 invoke() 方法，直接返回结果. 那么后续的拦截器和 Action 方法将不会被调用.
* Struts 会渲染自定义拦截器 intercept 方法返回值对应的 result
*/
private static final long serialVersionUID = 1L;
@Override
public String intercept(ActionInvocation arg0) throws Exception {
System.out.println("before interceptor...");
String result = arg0.invoke();
System.out.println("after interceptor...");
return result;
}
}
II. 在 struts.xml 文件配置.
> 可以在action中使用自定义的拦截器，也可以把自定义拦截器添加到默认拦截器栈中来使用。
<interceptors>
<interceptor name="hello" class="com.atguigu.struts2.interceptors.MyInterceptor"></interceptor>
</interceptors>
<!-- 在action中使用自定义拦截器 -->
<action name="testToken" class="com.atguigu.struts2.token.app.TokenAction">
<interceptor-ref name="hello"></interceptor-ref>
<interceptor-ref name="defaultStack"></interceptor-ref>
<result>/success.jsp</result>
<result name="invalid.token">/token-error.jsp</result>
</action>
<!-- 把自定义拦截器添加到拦截器栈中 -->
<interceptors>
<!-- 自定义拦截器 -->
<interceptor name="hello" class="com.lym.struts2.interceptor.MyInterceptor"></interceptor>
<interceptor-stack name="lym">
<interceptor-ref name="hello"></interceptor-ref>
<interceptor-ref name="defaultStack">
<param name="fileUpload.maximumSize">2097152</param>
<param name="fileUpload.allowedTypes">text/html,text/xml,text/plain,application/octet-stream</param>
</interceptor-ref>
</interceptor-stack>
</interceptors>
<!-- 注意：拦截器配置好后别忘了使用 -->
<default-interceptor-ref name="lym"></default-interceptor-ref>
III. 注意: 在自定义的拦截器中可以选择不调用 ActionInvocation 的 invoke() 方法. 那么后续的拦截器和 Action 方法将不会被调用.
Struts 会渲染自定义拦截器 intercept 方法返回值对应的 result
