MVC模式下基于SSH三大框架的java web项目excel表格的导出(不依赖另外的jar包)

最近工作中碰到了需要将web页面的表格内容导出到excel表格并下载到本地的需求。以下是在利用网上资源、与同事探讨下，完成的代码。

• 首先我们需要有定义好的实体类。以下是截取了项目中用到的部分代码。

public class QyggDocuments implements java.io.Serializable {

    private static final long serialVersionUID = -2543382529255041149L;
    
    private String id;                //主键id
    private String fileName;        //文件名称
    private String fileContentType;    //文件类型
    private String filePath;        //文件路径
    private String fileSize;        //文件大小
    private String commonId;        //外键(总任务主键或者企业任务主键)
    private String reportUserCode;    //填报人编码
    private String reportUserName;    //填报人名称
    private String entName;            //企业名称

    // Constructors

    /** default constructor */
    public QyggDocuments() {
    }

    /** minimal constructor */
    public QyggDocuments(String id) {
        this.id = id;
    }

    /** full constructor */
    public QyggDocuments(String id, String fileName, String fileContentType, String filePath, String fileSize, String commonId,
            String reportUserCode, String reportUserName, String entName) {
        this.id = id;
        this.fileName = fileName;
        this.fileContentType = fileContentType;
        this.filePath = filePath;
        this.fileSize = fileSize;
        this.commonId = commonId;
        this.reportUserCode = reportUserCode;
        this.reportUserName = reportUserName;
        this.entName = entName;
    }

    // Property accessors

    public String getId() {
        return this.id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getFileName() {
        return this.fileName;
    }

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

    public String getFileContentType() {
        return this.fileContentType;
    }

    public void setFileContentType(String fileContentType) {
        this.fileContentType = fileContentType;
    }

    public String getFilePath() {
        return this.filePath;
    }

    public void setFilePath(String filePath) {
        this.filePath = filePath;
    }

    public String getFileSize() {
        return this.fileSize;
    }

    public void setFileSize(String fileSize) {
        this.fileSize = fileSize;
    }

    public String getCommonId() {
        return this.commonId;
    }

    public void setCommonId(String commonId) {
        this.commonId = commonId;
    }

    public String getReportUserCode() {
        return this.reportUserCode;
    }

    public void setReportUserCode(String reportUserCode) {
        this.reportUserCode = reportUserCode;
    }

    public String getReportUserName() {
        return this.reportUserName;
    }

    public void setReportUserName(String reportUserName) {
        this.reportUserName = reportUserName;
    }

    public String getEntName() {
        return this.entName;
    }

    public void setEntName(String entName) {
        this.entName = entName;
    }

}

• 其次，在dao、daoImpl、service、serviceImpl各层加入相应的获取对象的方法。本文只列举出service层代码，dao层请自行编写。

service

public interface QyggReportService {
        /**
     * 查询附件
     * @param commonId
     * @return
     */
    public QyggDocuments queryDocuments(String commonId);
}    

serviceImpl

public class QyggReportServiceImpl implements QyggReportService {
    @Autowired
    private IBaseDAO baseDAO;
    /**
     * 查询附件
     * @param commonId
     * @return
     */
    @SuppressWarnings("unchecked")
    public QyggDocuments queryDocuments(String commonId) {
        StringBuffer hql = new StringBuffer();
        hql.append(" from QyggDocuments A where A.commonId = ? ");
        List<QyggDocuments> list = baseDAO.getObjectByCondtions(hql.toString(), new Object[]{commonId}, "A", QyggDocuments.class);
        if(!CommonUtil.isNullOrSizeZero(list)){
            return list.get(0);
        }
        return new QyggDocuments();
    }
}

下面是以上代码用到的CommonUtil的源码

public class CommonUtil {
    /**
     * 判断集合是否为空,或者长度为0
     * 
     * @param coll
     * @return 集合为Null，或者长度为0,返回 true;否则返回false
     */
    @SuppressWarnings("unchecked")
    public static boolean isNullOrSizeZero(Collection coll) {
        if (coll == null || coll.size() == 0)
            return true;
        return false;
    }
}

• 接下来是Action源码

public class ReformSchemeDateAction extends ActionSupport {
    private static final long serialVersionUID = 8360690879427965177L;
    private static Logger log = Logger.getLogger(ReformSchemeDateAction.class);
    
    @Autowired
    private QyggReportService qyggReportService;
    
    //--------
    private QyggDocuments documents;
    private String fileName;
    private InputStream inputStream;
    private String taskSn;
    
    public String expData() throws UnsupportedEncodingException{
        setFileName(URLEncoder.encode("企业改制填报表.xls", "UTF-8"));
        
        // 单行数据源
        Map<String, Map<String, String>> olines = new HashMap<String, Map<String, String>>();
        Map<String, List<Map<String, String>>> mlines = new HashMap<String, List<Map<String, String>>>();
        try{
            documents = qyggReportService.queryDocuments(taskSn);
        }catch(Exception e1){
            e1.printStackTrace();
            return "error";
        }
        
        olines.put("QyggDocuments", XlsExportHelper.transBean2Map(documents, new String[] { "createTime", "updateTime" }));
        
        // -----------------------------------------测试数据

        try {
            TSheet cis = new TSheetImpl();
            // String newFilePath = cis.copyWorkbook(filePath, null);

            log.debug("企业改制填报数据导出, 读取模板....");
            InputStream is = ServletActionContext.getServletContext().getResourceAsStream("/WEB-INF/xlsTemplate/qygg/reformScheme_01.xls");

            log.debug("企业改制填报数据导出, 打开文件....");
            // 打开文件
            cis.openWorkbook(is);

            // 设置数据源
            cis.setDataSource(olines, mlines);

            // 处理模板数据
            cis.fillSheet();

            log.debug("企业改制填报数据导出, 数据输出....");
            // 数据输出
            ByteArrayOutputStream output = new ByteArrayOutputStream();
            cis.saveWorkbook(output);
            log.debug("企业改制填报数据导出, 文件成功输出");

            byte[] ba = output.toByteArray();
            inputStream = new ByteArrayInputStream(ba);
            output.flush();
            output.close();

            return "success";

        } catch (TSheetException e) {
            log.debug("企业改制填报数据导出, 出现异常!!!");
            e.printStackTrace();
        } catch (IOException e) {
            log.debug("企业改制填报数据导出, 出现异常, 数据读写异常!!!");
            e.printStackTrace();
        }
        
        return "error";
    }
    
    /*getter and setter*/
    public QyggDocuments getDocuments() {
        return documents;
    }
    public void setDocuments(QyggDocuments documents) {
        this.documents = documents;
    }
    public String getFileName() {
        return fileName;
    }
    public void setFileName(String fileName) {
        this.fileName = fileName;
    }
    public InputStream getInputStream() {
        return inputStream;
    }
    public void setInputStream(InputStream inputStream) {
        this.inputStream = inputStream;
    }

    public String getTaskSn() {
        return taskSn;
    }

    public void setTaskSn(String taskSn) {
        this.taskSn = taskSn;
    }
}

这是上面用到的XlsExportHelper文件源码

/**
 * xls导出辅助
 * @author yep
 *
 */
public class XlsExportHelper {
    private static final long serialVersionUID = 5081817158639576516L;
    private static Logger log = Logger.getLogger(BigPrejectDateAction.class);
    /**
     * Bean --> Map
     * 
     * @param obj
     * @param ignore
     *            等于null将没有忽略
     * @return
     */
    public static Map<String, String> transBean2Map(Object obj, String[] ignore) {

        if (obj == null) {
            return null;
        }
        Map<String, String> map = new HashMap<String, String>();
        try {
            BeanInfo beanInfo = Introspector.getBeanInfo(obj.getClass());
            PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();
            
            Field[] fields = obj.getClass().getDeclaredFields();
            for (Field field : fields) {
                field.setAccessible(true);    //修改访问权限
                if (field.getType() == String.class) {
                    Object value = field.get(obj);
                    String v ="";
                    if (value!=null) v = value.toString();
                    map.put(field.getName(), v);
                    
                } else if (field.getType() == Date.class) {
                    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
                    Object value = field.get(obj);
                    String v = "";
                    if (value!=null) v =sdf.format(value);
                    map.put(field.getName(), v);
                    
                } else if (field.getType() == Integer.class 
                        || field.getType() == Long.class  
                        || field.getType() == Float.class  
                        || field.getType() == Double.class  
                        || field.getType() == Character.class  
                        || field.getType() == Short.class ) {
                    Object value = field.get(obj);
                    String v = String.valueOf(value);
                    map.put(field.getName(), v);
                    
                } else {
                    log.error("transBean2Map: 类型暂时不支持, " + field.getType().getName());
                }
            }
        } catch (Exception e) {
            log.debug("transBean2Map Error " + e);
        }

        return map;

    }
}

• 前台页面部分的源码就不需要展示给大家了，大家添加好导出按钮访问对应的action即可。以下是struts与spring的xml文件配置

struts配置

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN" "http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
    <!-- xls导出 -->
    <package name="ReformSchemeDateAction" namespace="/qygg/report"
        extends="root-struts">
        <action name="ReformSchemeDateAction!*" class="ReformSchemeDateAction"
            method="{1}">
            <result name="success" type="stream">
                <param name="inputName">inputStream</param>
                <param name="bufferSize">4096</param>
                <param name="contentType">application/vnd.ms-excel</param>
                <param name="contentDisposition">attachment;filename="${fileName}"</param>
            </result>
        </action>
    </package>
</struts>

xml配置

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:aop="http://www.springframework.org/schema/aop"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:util="http://www.springframework.org/schema/util"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd
        http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-2.5.xsd
    "
    default-lazy-init="false">
    
    <!-- 表导出 -->    
    <bean id="ReformSchemeDateAction" class="gov.bjsasac.commons.export.action.ReformSchemeDateAction" scope="prototype"></bean>
</beans>

• 以下，是excel表格的填充格式

  最后,由于刚开始撰写技术类博客，因水平有限难免有不足之处，望大家指正。希望这篇博文可以帮助到大家！