Java 复杂excel报表导出

Posted 2021-01-21 liaochong

html2excel，是转换HTML表格为Excel的工具包，支持.xls、.xlsx格式，支持对背景色、边框、字体等进行个性化设置。

github：https://github.com/liaochong/html2excel

maven引用：

<dependency>
    <groupId>com.github.liaochong</groupId>
    <artifactId>html2excel</artifactId>
    <version>1.2.0</version>
</dependency>

优点：

• 使用html作为模板，学习成本几乎为零；
• 可生成任意复杂表格：本工具使用迭代单元格方式进行excel绘制，可生成任意复杂度excel；
• 屏蔽POI操作：不直接操作过重的POI；
• 支持常用背景色、边框、字体等样式设置：具体参见详情部分；
• 支持.XLS、.XLSX：支持生成.xls、.xlsx后缀的excel；
• 支持多种模板引擎：支持Freemarker、Groovy、Beetl等常用模板引擎，默认内置Beetl模板引擎（推荐引擎，Beetl文档）；
• 提供默认模板引擎，直接输出简单excel：无需编写任何html，已内置默认模板，可直接根据POJO数据列表输出；
• 支持一次生成多sheet：以table作为sheet单元，支持一份excel文档中多sheet；

可选模板：

1. 以下模板引擎除Beetl外默认均未被引入，使用者可根据自身需要选择在pom.xml中声明引入；
2. 以下模板引擎版本为最低版本号；

<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>2.7.23</version>
</dependency>

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.23</version>
</dependency>

<dependency>
    <groupId>org.codehaus.groovy</groupId>
    <artifactId>groovy-templates</artifactId>
    <version>2.4.13</version>
</dependency>

示例：

1. 已存在html文件，使用这种方式时，html文件不局限于放在项目的classpath下
   

   // get html file
   File htmlFile = new File("/Users/liaochong/Downloads/example.html");
   // read the html file and use default excel style to create excel
   Workbook workbook = HtmlToExcelFactory.readHtml(htmlFile).useDefaultStyle().build();
   // this is a example,you can write the workbook to any valid outputstream
   OutputStream writer = new FileOutputStream(new File("/Users/liaochong/Downloads/excel.xlsx"));
   workbook.write(writer);

2. 默认模板引擎使用（暂不支持继承属性）
   

   // title
   List<String> titles = new ArrayList<>();
   titles.add("姓名");
   titles.add("年龄");
   
   // field display order
   List<String> order = new ArrayList<>();
   order.add("name");
   order.add("age");
   
   // display data
   TestDO testDO = new TestDO();
   testDO.setName("张三");
   TestDO testDO1 = new TestDO();
   testDO1.setName("李四");
   
   TestDO testDO2 = new TestDO();
   testDO2.setName("王五");
   testDO2.setAge(15);
   TestDO testDO3 = new TestDO();
   testDO3.setName("陈六");
   testDO3.setAge(25);
   
   List<TestDO> dataList = new ArrayList<>();
   dataList.add(testDO);
   dataList.add(testDO1);
   dataList.add(testDO2);
   dataList.add(testDO3);
   
   Workbook workbook = DefaultExcelBuilder.getInstance().sheetName("default example").fieldDisplayOrder(order).build(dataList);

3. 使用freemarker等模板引擎，具体请参照项目中的example
   

   /**
        * use non-default-style excel builder
        *
        * @param response response
        */
       @GetMapping("/freemarker/build")
       public void build(HttpServletResponse response) {
           ExcelBuilder excelBuilder = new FreemarkerExcelBuilder();
           Workbook workbook = excelBuilder.template("/templates/freemarker_template.ftl").build(new HashMap<>());
   
           response.setCharacterEncoding(CharEncoding.UTF_8);
           response.addHeader("Content-Disposition", "attachment;filename=" + new String("freemarker_excel.xlsx".getBytes()));
           try {
               workbook.write(response.getOutputStream());
           } catch (IOException e) {
               e.printStackTrace();
           }
       }
   
       /**
        * use default-style excel builder
        *
        * @param response response
        */
       @GetMapping("/freemarker/default_style/build")
       public void buildWithDefaultStyle(HttpServletResponse response) {
           ExcelBuilder excelBuilder = new FreemarkerExcelBuilder();
           Workbook workbook = excelBuilder.template("/templates/freemarker_template.ftl").useDefaultStyle().build(new HashMap<>());
   
           response.setCharacterEncoding(CharEncoding.UTF_8);
           response.addHeader("Content-Disposition", "attachment;filename=" + new String("freemarker_excel.xlsx".getBytes()));
           try {
               workbook.write(response.getOutputStream());
           } catch (IOException e) {
               e.printStackTrace();
           }
       }