Struts2-文件下載

以下是在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中必須返回一個輸入流。因爲下載的時候，本身就是一個從服務器端將文件輸入過來的操作
/***************************************************************************************/