Struts2控制文件的上传与下载

Struts2控制文件上传与下载的几个注意事项：

（1）必须将表单的method设置为post，将enctype设置为multipart/from-data。只有这样，浏览器才会把用户选择文件的二进制数据发送给数据。

（2）Struts2默认使用的是Jakarta的Common-FileUpload的文件上传框架，因此，如果需要使用Struts2的文件上传功能，则需要在web应用中增加两个JAR文件，即commons-io-2.2.jar和commons-fileupload-1.3.1.jar。

一. 文件上传

（1）文件上传页面

<form action="upload" enctype="multipart/form-data" method="post">
    <input name="upload" type="file">
    <input type="submit" value="submit">
</form>

（2）处理上传请求的Action

public class FileUploadAction extends ActionSupport{
    //封装上传文件域
    private File upload;

    //上传文件类型
    private String uploadContentType;

    //上传文件名
    private String uploadFileName;

    //上传文件的保存路径，在Struts.xml中配置
    private String savePath;

    public File getUpload() {
        return upload;
    }
    public void setUpload(File upload) {
        this.upload = upload;
    }
    public String getUploadContentType() {
        return uploadContentType;
    }
    public void setUploadContentType(String uploadContentType) {
        this.uploadContentType = uploadContentType;
    }
    public String getUploadFileName() {
        return uploadFileName;
    }
    public void setUploadFileName(String uploadFileName) {
        this.uploadFileName = uploadFileName;
    }
    public String getSavePath() {
        return ServletActionContext.getServletContext().getRealPath(savePath);
    }
    public void setSavePath(String savePath) {
        this.savePath = savePath;
    }

    public String execute() throws IOException
    {
        //获取文件的输出流
        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);
        }
        return SUCCESS;
    }
}

（3）利用拦截器实现文件过滤

通过配置拦截器，可以方便地控制上传文件的类型，大小。如果文件类型不符合，则会返回input视图。Struts2中文件上传的拦截器是fileUpload。

配置fileUpload拦截器时，可以为其指定两个参数：

• allowedTypes: 该参数指定允许上传的文件类型
• maximumSize: 该参数指定允许上传文件的大小，单位是字节。

另外，特别注意，为了使fileUpload拦截器生效，需要显示在其之后配置defaultStack的拦截器。

Struts.xml 配置

<action name="upload" class="com.bigdata.action.FileUploadAction">
    <interceptor-ref name="fileUpload">
        <param name="allowedTypes">
            application/octet-stream,application/zip,application/x-zip-compressed,
            application/x-rar-compressed
        </param>
        <param name="maximumSize">20000000</param>
    </interceptor-ref>
    <interceptor-ref name="defaultStack" />
    <param name="savePath">/data</param>
    <result name="success">/jsp/index.jsp</result>
    <result name="input">/uploadForm.jsp</result>
</action>

二. 文件下载

Struts2的文件下载Action与普通的Action并没有什么太大的不同，仅仅是该Action需要提供一个返回InputStream流的方法，该输入流代表了被下载文件的入口，同时在配置文件中配置Action的result类型为stream。

Action类的实现：

public class FileDownloadAction extends ActionSupport{
    private String inputPath;
    private String filename;

    public String getFilename() {
        return filename;
    }
    public void setFilename(String filename) {
        this.filename = filename;
    }
    public String getInputPath() {
        return inputPath;
    }
    public void setInputPath(String inputPath){
        this.inputPath = inputPath;
    }
    /*
    定义一个返回InputStream的方法
    该方法将被作为下载文件的入口，
    且需要配置Stream类型结果时指定inputName参数
    inputName参数的值就是该方法去掉get前缀，首字母小写的字符串
    */
    public InputStream getTargetFile() throws IOException{
        String path = ServletActionContext.getServletContext().getRealPath(inputPath);
        //下载文件名如果包含中文需要转码，避免出现乱码
        String name = new String(filename.getBytes("ISO8859-1"),"UTF-8");
        //下载文件的路径
        String filePath = path + "\\" + name;
        File file = new File(filePath);
        return FileUtils.openInputStream(file);
    }

    //设置下载文件的名称
    public String getDownloadName(){
        String downloadName = filename;
        try {
            downloadName = new String(downloadName.getBytes(),"ISO8859-1");
        } catch (UnsupportedEncodingException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return downloadName;
    }
}

Struts.xml的配置

配置下载文件的Action时，需要配置一个类型为stream的结果，需要指定如下4个属性。

• contentType： 指定被下载文件的文件类型
• inputName： 指定被下载文件的入口输入流
• contentDisposition: 指定下载的文件名
• bufferSize: 指定下载文件时的缓冲大小

<action name="download" class="com.bigdata.action.FileDownloadAction">
    <param name="inputPath">/data</param>
    <result type="stream" name="success">
        <param name="contentType">application/octet-stream</param>
        <param name="inputName">targetFile</param>
        <param name="contentDisposition">attachment;filename="${downloadName}"</param>
    </result>
    <result name="login">/jsp/login.jsp</result>
</action>

三. 文件下载取消时出现异常

在struts2中使用result里type="stream"的结果类型时，当在“下载提示窗口”中点击“取消按钮”时，总是报出“java.lang.IllegalStateException”异常。

异常原因分析：

1. 配置其中result标签下的各个参数
2. 从服务器中获取输入流，并同时与客户端建立输出流（服务器与客户端链接通过Socket进行连接）
3. 当点击“保存”或“打开”时，开始传输数据。如果点击“取消”，关闭所有的流。这里要注意的是，但是实际发现Socket并没有断开！并且流也没有关闭！这一点非常重要！所以在JSP容器通过Response获取输出流之前，前面的流并没有关闭，所以会造成该异常的报出。

异常解决办法：

1. 下载插件struts2-sunspoter-stream-1.0.jar，并复制在/WEB-INF/lib下。

GitHub下载地址：https://github.com/41zone/StreamResultX

2. 在Struts.xml 中配置：

<result-types>

     <result-type  name="streamx"     class="com.sunspoter.lib.web.struts2.dispatcher.StreamResultX"/>

</result-types>

3. 在下载的Action中配置result的类型为streamx：

<action name="download" class="com.bigdata.action.FileDownloadAction">
    <param name="inputPath">/data</param>
    <result type="streamx" name="success">
        <param name="contentType">application/octet-stream</param>
        <param name="inputName">targetFile</param>
        <param name="contentDisposition">attachment;filename="${downloadName}"</param>
    </result>
    <result name="login">/jsp/login.jsp</result>
</action>