FreeMarker之大数据量Excel生成

1、背景

研究始于Web内需要导出Excel，且不分页或分批次下载。待数据量过多，Apache POI不能很好的兼顾此场景。原因始于POI写Excel需要完整写完一个Exce内部结构才可以write。

2、简介

FreeMarker是一种Java模板引擎，可以根据指定模板生成文件。且Excel支持已Xml数据格式（Ps：word也是可以）。

这里将一个Excel模板分成N个片段，类似写文本文件那样输出Excel。先输出Excel头部内容，再生成每个Sheet的数据内容部分。继而可实现一个Excel，分段查询，分段生成，分段输出。服务端生成一部分，客户端下载一部分。即可简化代码，也可降低服务端压力。

但这也是有弊端的：

因分页查询，期间可能出现新增或删除数据，将会造成Excel有重复数据或少数据。

3、实现方案

1、引入FreeMarker

    org.freemarker
    freemarker
    2.3.23

注：SpringBoot 有 FreeMarker 的自定装配类：FreeMarkerAutoConfiguration，需要手动忽略。

2、工具类：FreeMarkerExportUtils

/**
 * FreeMarker Excel导出工具类

 *
 * Example: 

 * // 构建下载

 * FreeMarkerExportUtils.buildDownload(fileName);

 * // 输出数据

 * FreeMarkerExportUtils.writeExcel(templateHeadName, Arrays.asList());

 * // 关闭输出流

 * FreeMarkerExportUtils.flush();

 *
 * @author wangzhuhua
 * @date 2018/08/26 下午1:39
 *
 **/
public class FreeMarkerExportUtils {

   /** 当前输出流 */
   private static ThreadLocal writerThreadLocal = new ThreadLocal<>();
   /** 默认编码 */
   private final static String DefaultCharset = "UTF-8";
   /** 模板绑定属性名称 */
   private final static String TemplatePropName = "data";
   /** 这里注意的是利用类加载器动态获得模板文件的位置 */
   private static final String TemplateFolder = "freemarker";
   /** 配置信息,代码本身写的还是很可读的,就不过多注解了 */
   private static Configuration configuration;

   static {
      configuration = new Configuration(Configuration.getVersion());
      configuration.setClassLoaderForTemplateLoading(FreeMarkerExportUtils.class.getClassLoader(),
            "/" + TemplateFolder);
      configuration.setDefaultEncoding(DefaultCharset);
      configuration.setWhitespaceStripping(false);
   }

   private FreeMarkerExportUtils() {
   }

  /**
     * 构建Excel
     * 
     * @param fileName
     *            文件名称
     *
     * @throws Exception
     *             构建异常
     */
    public static void buildDownload(String fileName) throws Exception {
        Writer writer = WriterThreadLocal.get();
        if (writer == null) {
            // 输出头部信息
            HttpServletResponse response = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes())
                    .getResponse();

            response.reset();
            response.setContentType("application/octet-stream;");
            response.setHeader("Content-disposition",
                    "attachment; filename=" + new String((fileName + ".zip").getBytes(DefaultCharset), "ISO8859-1"));
            response.setCharacterEncoding(DefaultCharset);

            ZipOutputStream zipOutputStream = new ZipOutputStream(new BufferedOutputStream(response.getOutputStream()));
            //设置压缩方法
            zipOutputStream.setMethod(ZipOutputStream.DEFLATED);
            zipOutputStream.putNextEntry(new ZipEntry(fileName + ".xls"));
            writer = new OutputStreamWriter(zipOutputStream, DefaultCharset);

            // 当前输出流
            WriterThreadLocal.set(writer);
        }
    }

   /**
    * 写Excel
    * 
    * @param templateName
    *            模板名称
    * @param obj
    *            模板参数
    * @throws Exception
    *             输出异常
    */
   public static void writeExcel(String templateName, Object obj) throws Exception {
      Writer writer = writerThreadLocal.get();
      if (writer == null) {
         throw new RuntimeException("请先调用buildDownload!");
      }

      // 模板参数
      Map params = new HashMap<>(BigDecimal.ONE.intValue());
      params.put(TemplatePropName, obj);
      writeTemplate(params, templateName);
   }

   /**
    * flush
    */
   public static void flush() throws IOException {
      writerThreadLocal.get().flush();
      writerThreadLocal.get().close();
   }

   /**
    * 利用FreeMarker输出模板
    *
    * @param obj
    *            待替换属性对象
    * @param templateName
    *            freemarker模板名称
    * @throws Exception
    */
   public static void writeTemplate(Object obj, String templateName) throws Exception {
      // 获取模板
      Template freemarkerTemplate = configuration.getTemplate(templateName);
      // 输出内容
      freemarkerTemplate.process(obj, writerThreadLocal.get());
   }

}

3、调用示例

// 以下为示例代码
String fileName = "测试导出";
String templateHeadName = "test/test_head.ftl";
String templateContentName = "test/test_content.ftl";
String templateFootName = "test/test_foot.ftl";
// 构建下载
FreeMarkerExportUtils.buildDownload(fileName);

// 头部
FreeMarkerExportUtils.writeExcel(templateHeadName, Arrays.asList());
// 内容
for (int i = 0; i < 5; i++) {
   // 行数据
   List