Springboot+Easyexcel将数据写入模板文件并导出Excel_easyexcel模板写入

Springboot+Easyexcel将数据写入模板文件并导出Excel

Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，一个3M的excel用POI sax解析依然需要100M左右内存，改用easyexcel可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便。

本文使用easyexcel对excel文件进行操作，来实现数据以excel形式导出的功能。

需求背景：

针对用户选择的数据，利用现有的excel模板，实现批量导出的功能。比如CSDN也有类似的批量导出数据功能，这里需要导出时，按照模板文件的字段导出。

现有模板字段：

实现方式：springboot+easyexcel

一、导入依赖

<!--lombok-->
<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
</dependency>


<!--操作excel工具包-->
<dependency>
	<groupId>com.alibaba</groupId>
	<artifactId>easyexcel</artifactId>
	<version>3.0.5</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13

二、根据excel表头创建对应的实体类Pojo

ExcelTitile实体类

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class ExcelTitle {

    @ExcelProperty(value="事件名称", index=0)
    private String eventName;

    @ExcelProperty(value="需求负责人", index=1)
    private String prdManager;

    @ExcelProperty(value="技术负责人", index=2)
    private String techManager;

    @ExcelProperty(value="文档链接", index=3)
    private String prdDocs;

    @ExcelProperty(value="数据链接", index=4)
    private String statsDocs;

    @ExcelProperty(value="统计口径", index=5)
    private String reportCaliber;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

这里采用了@ExcelProperty的注解，其中value表示列名，index表示列名的索引值。@Data 注解的主要作用是提高代码的简洁，使用这个注解可以省去代码中大量的get()、 set()、 toString()等方法；

三、Controller类接收请求

@RequestMapping(value = "/bulkOutput", method = RequestMethod.GET)
    public ResultBean bulkOutput(HttpServletResponse response) {
		
        // 重要! 设置返回格式是excel形式
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        // 设置编码格式
        response.setCharacterEncoding("utf-8");
        // 设置URLEncoder.encode 防止中文乱码
        String fileName = null;
        try {
            fileName = URLEncoder.encode("数据批量导出", "UTF-8").replaceAll("\\+", "%20");
        // 设置响应头
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");


        List<ExcelTitle> bulkOutputData = wildEventService.getBulkOutputData();
		
        // 模板文件保存在springboot项目的resources/static下
        Resource resource = new ClassPathResource("static/数据批量导出模板.xlsx");

        ExcelWriter excelWriter = EasyExcel.write(response.getOutputStream())
            							   .withTemplate(resource.getInputStream())	// 利用模板的输出流
            							   .build();
        // 写入模板文件的第一个sheet 索引0    
        WriteSheet writeSheet = EasyExcel.writerSheet(0).build();
		
        // 将数据写入到模板文件的对应sheet中
        excelWriter.write(bulkOutputData, writeSheet);
        excelWriter.finish();
        } catch (UnsupportedEncodingException e) {
            return ResultBean.errorService(e.getMessage());
        } catch (IOException e) {
            return ResultBean.errorService(e.getMessage());
        }
        return ResultBean.success("数据导出成功!");
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

上述代码中，首先对response进行了设置，设置了返回类型，响应头，以及导出下载时的文件名称。接下来，利用Resource resource = new ClassPathResource("static/数据批量导出模板.xlsx"); 读取项目下的模板文件，并调用easyexcel的写入方法。这里write(response.getOutputStream())表示写入response的输出流，即将文件返回给客户端进行下载。withTemplate(resource.getInputStream())表示读取模板文件进行写入。最后调用 WriteSheet writeSheet = EasyExcel.writerSheet(0).build();将苏剧写入模板文件的第一个sheet中(索引从0开始)。

四、Service层获取待写入数据

这里为了简易期间，构造一些数据如下

import com.example.demo.Pojo.ExcelTitle;
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.List;

@Service
public class BulkOutputService {

    public List<ExcelTitle> getOutputData()
    {

        List<ExcelTitle> resultList = new ArrayList<>();

        // 第一行数据
        ExcelTitle t1 = new ExcelTitle();
        t1.setEventName("测试数据1");
        t1.setTechManager("张三");
        t1.setPrdManager("张三");
        t1.setPrdDocs("http://prdDocs.com");
        t1.setStatsDocs("http://statsDocs.com");
        t1.setReportCaliber("reportCaliber");

        // 第二行数据
        ExcelTitle t2 = new ExcelTitle();
        t2.setEventName("测试数据2");
        t2.setTechManager("李四");
        t2.setPrdManager("李四");
        t2.setPrdDocs("http://prdDocs.com");
        t2.setStatsDocs("http://statsDocs.com");
        t2.setReportCaliber("reportCaliber");

        resultList.add(t1);
        resultList.add(t2);

        return resultList;
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

这里构造了两行简易数据，实际场景中只需要根据自己的数据做替换就可以了。

有了上述步骤，就可以接下来执行代码查看导出效果了。

效果展示

启动springboot程序，在浏览器中输入请求: http://localhost:8080/bulkOutput，可以发现返回的excel文件被浏览器下载，打开后内容如下：

可以看到，数据根据模板格式写入了文件，并以excel的形式导出。初步完成了我们预定的场景。

总结

本次实现的功能是利用现有模板，将数据批量导出成excel，借助于easyexcel来实现操作excel的功能。最重要的功能模块是Controller里的内容。

需要注意

1. 需要加上response的响应类型和响应头来使得返回请求返回excel文件

2. 写到Web流时，这里的ContentType和CharacterEncoding不要乱码，否则很容易乱码或者文件损坏

3. 使用EasyExcel.withTemplate引入模板的输入流