以下是在Struts2中下载文件时,相关DownloadAction的配置信息
- <action name="download" class="com.jadyer.action.DownloadAction">
- <result name="success" type="stream">
- <param name="contentType">application/vnd.ms-powerpoint</param>
- <param name="contentDisposition">filename="Struts2.ppt"</param>
- <param name="inputName">downloadFile</param>
- </result>
- </action>
type默认为dispatcher。在处理文件下载的操作时,必须将type显式设置为stream类型
stream主要向浏览器发送InputStream对象,通常用来处理下载文件,还可用于返回AJAX数据
接下来就需要设置StreamResult类的三个重要的属性,如下所示
contentType属性用来指定下载文件的类型,同样可以在Tomcat6.0.20//conf//web.xml文件中查看MIME Type Mappings
contentDisposition属性用来设定显示的文件名,这是在点击下载链接时显示在提示框中的文件名
同时它的值的filename=" "所设定的name值也是下载到本地之后的文件的名字
并且它的写法是固定的filename=" ",这是由HTTP协议所规范的
inputName属性的值需严格遵守JavaBean规范,它对应着Action中返回inputStream的方法名
假设inputName设为downFile,则Action中必定有一个返回inputStream的getDownFile()方法
另外contentDisposition属性可以设定两个值,它的第一个值用来设定文件打开方式,默认的是inline即在浏览器中打开
也可设定attachment,如<param name="contentDisposition">attachment;filename="Struts2.ppt"</param>
即无论是什么类型的文件,哪怕是TXT,它也会弹出一个下载框,供用户选择打开或下载
废话少说,直接上代码
首先是web.xml文件
- <?xml version="1.0" encoding="UTF-8"?>
- <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
- http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
- <filter>
- <filter-name>struts2</filter-name>
- <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>struts2</filter-name>
- <url-pattern>/*</url-pattern>
- </filter-mapping>
- </web-app>
然后是用于提供文件下载按钮的index.jsp页面
- <%@ page pageEncoding="UTF-8"%>
- <input type="button" value="Struts2的文件下载【Struts2的stream拦截器的简便应用】" οnclick="javascript:window.location='download.action';"/>
然后是Struts2中的配置文件struts.xml
- <?xml version="1.0" encoding="UTF-8" ?>
- <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.1//EN"
- "http://struts.apache.org/dtds/struts-2.1.dtd">
- <struts>
- <package name="struts2.1" extends="struts-default">
- <action name="download" class="com.jadyer.action.DownloadAction">
- <result name="success" type="stream">
- <param name="contentType">application/vnd.ms-powerpoint</param>
- <param name="contentDisposition">attachment;filename="Struts2.ppt"</param>
- <param name="inputName">downloadFile</param>
- </result>
- </action>
- </package>
- </struts>
最后是用来处理文件下载的核心操作的DownloadAction.java
- package com.jadyer.action;
- import java.io.InputStream;
- import org.apache.struts2.ServletActionContext;
- import com.opensymphony.xwork2.ActionSupport;
- @SuppressWarnings("serial")
- public class DownloadAction extends ActionSupport {
- public InputStream getDownloadFile() throws Exception {
- return ServletActionContext.getServletContext().getResourceAsStream("/upload/Struts2.ppt");
- }//getDownloadFile()方法返回的必须是InputStream。getResourceAsStream()方法可以通过流的方式将资源输出
- @Override
- public String execute() throws Exception {
- return SUCCESS;
- }
- }
- /*************【Struts2的文件下载的实现方式】*********************************************/
- //如果直接写一个链接链到所要下载的文件上的话,对于有的时候,默认的会自动在浏览器里面打开
- //这种情况非常不利于我们的文件下载和权限控制。因此,我们实现文件下载时都不会采用这种方式
- //我们所采用的是标准HTTP协议的方式,输出二进制的流,导致浏览器认识这个流,它再进行文件下载
- //实际上这种方式是跟输出有关的,当点击下载链接时,会产生下载的一个信息。它是跟result有关的
- //所以就到struts-default.xml中查看<result-type/>结果类型
- //其中<result-type name="stream" class="org.apache.struts2.dispatcher.StreamResult"/>
- //事实上,这里的StreamResult类是专门用来执行文件下载的
- /*************【每一次下载文件时,控制台都会提示socket异常】***********************************/
- //报错信息为java.net.SocketException:Connection reset by peer: socket write error
- //下载本身也是socket操作,于是抛出该异常。实际上这个异常可以忽略掉。每次下载的时候,都会抛出该异常
- //在getDownloadFile()方法上throws Exception之后,控制台上就不会再报告这个异常信息啦
- /*************【用于处理文件下载的StreamResult类的源代码片段】********************************/
- //这里显示的是org.apache.struts2.dispatcher.StreamResult类的源代码片段
- //public class StreamResult extends StrutsResultSupport{
- //protected String contentType = "text/plain";
- //protected String contentLength;
- //protected String contentDisposition = "inline";
- //protected String inputName = "inputStream";
- //protected InputStream inputStream;
- //protected int bufferSize = 1024;
- /*************【浅析StreamResult类的三个重要属性】******************************************/
- //这里我们主要关注一下StreamResult类的三个属性:contentType、contentDisposition、inputName
- //这些属性都是通过在struts.xml配置之后,由Struts2自动注入到对象里面去的
- //其中contentType用来指定下载的文件的类型,contentDisposition用来指定下载文件的名字
- //另外bufferSize用来设定下载文件时的缓冲区大小,默认为1KB,通常按照默认的1KB就可以了
- //实际上这些属性完全是根据HTTP协议得来的。HTTP协议就规定了下载文件的时候,需要使用到这些属性
- //其中最关键的就是protected String inputName属性,它是用来指定真正下载的文件的IO流
- //因此DownloadAction中必须返回一个输入流。因为下载的时候,本身就是一个从服务器端将文件输入过来的操作
- /***************************************************************************************/