struts 文件下载 annotation 注解版

【本文简介】

本文将简单介绍使用 struts2 ，通过零配置和 annotation 实现文件下载功能。

【文件夹结构】

【web.xml有关struts的配置】

    <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>*.action</url-pattern>
    </filter-mapping>
    <filter-mapping>
        <filter-name>struts2</filter-name>
        <url-pattern>*.jsp</url-pattern>
    </filter-mapping>

【访问的对应的url】

以上的web.xml配置导致下面的访问地址的方法名有要加：.action

http://localhost:8080/TestBySSH/download!testDownload.action?fileName=file1.txt

【action代码】

 package com.modelsystem.action;

 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.InputStream;

 import org.apache.struts2.convention.annotation.Namespace;
 import org.apache.struts2.convention.annotation.ParentPackage;
 import org.apache.struts2.convention.annotation.Result;
 import org.apache.struts2.convention.annotation.ResultPath;
 import org.apache.struts2.convention.annotation.Results;

 /**
  * @描述 struts 文件下载 annotation 注解版
  * @作者   小M
  * @博客 http://www.cnblogs.com/xiaoMzjm/
  * @时间 2014/07/30
  */
 @ParentPackage("struts-default")
 @Namespace("/")
 @ResultPath(value = "/")
 @Results({
         @Result(params = {
                 // 下载的文件格式
                 "contentType", "application/octet-stream",
                 // 调用action对应的方法
                 "inputName", "inputStream",
                 // HTTP协议，使浏览器弹出下载窗口
                 "contentDisposition", "attachment;filename=\"${fileName}\"",
                 // 文件大小
                 "bufferSize", "10240"},
                 // result 名
                 name = "download",
                 // result 类型
                 type = "stream")
 })
 public class DownloadAction extends BaseAction{

     private static final long serialVersionUID = 1L;

     /**
      * 下载文件名
      * 对应annotation注解里面的${fileName}，struts 会自动获取该fileName
      */
     private String fileName;   

     public String getFileName() {
         return fileName;
     }   

     public void setFileName(String fileName) {
         this.fileName = fileName;
     }  

     /**
      * 下载文件应访问该地址
      * 对应annotation注解里面的 name = "download"
      */
     public String testDownload() {
         return "download";
     }   

     /**
      * 获取下载流
      * 对应 annotation 注解里面的 "inputName", "inputStream"
      * 假如 annotation 注解改为 "inputName", "myStream"，则下面的方法则应改为：getMyStream
      * @return InputStream
      */
     public InputStream getInputStream() {   

         // 文件所放的文件夹 ， 有关路径问题，请参考另一篇博文：http://www.cnblogs.com/xiaoMzjm/p/3878758.html
         String path = getServletContext().getRealPath("/")+"\\DownLoadFile\\";

         // 下载路径
         String downLoadPath = path + fileName;

         // 输出
         try {
             return new FileInputStream(downLoadPath);
         } catch (FileNotFoundException e) {
             e.printStackTrace();
         }
         return null;
     }
 }