springboot2.X 整合 easyexcel 2.X (附带模板导出工具类)

快来打我* 2022-11-07 01:44 289阅读 0赞

# 前置 #

*  EasyExcel 是 alibaba 开源的 Excel 处理工具 建议先阅读官方文档 : [easyexcel官方文档][easyexcel]
 *  常规使用 官方文档已经写的很清楚了 这里不在概述
 *  本篇文章 内容关于模板导出

# 一、依赖导入 #

<dependency>
 			<groupId>com.alibaba</groupId>
 			<artifactId>easyexcel</artifactId>
 			<version>2.2.6</version>
 		</dependency>

# 二、准备工作 #

### 1) 编写模板导出数据实体 ###

这里使用 lombok 简化实体代码

/**
 * easyexcel 导出工具所用 构建对象
 * @see EasyExcelUtil
 * @author LionLi
 */
 @Data
 @NoArgsConstructor
 @Accessors(chain = true)
 public class EasyExcelObj {
 
 // 导出的文件名
 private String exportName;
 // 模板的文件名
 private String templateName;
 // 导出到具体路径
 private String exportPath;
 // 单 list 
 private Object[] data;
 // 多 list 使用 此属性填充
 private Map<String,Object> multiListMap;
 
 }

### 2) 编写模板导出工具类 ###

(模板导出坑还是蛮多的) 这里作者规避掉了一些

/**
 * easyexcel 模板导出工具
 * @author LionLi
 */
 public class EasyExcelUtil {
 
 // 系统桌面路径
 public static final String HOME_PATH = FileSystemView.getFileSystemView().getHomeDirectory().getPath();
 // classpath 路径
 public static final String CLASS_PATH = EasyExcelUtil.class.getResource("/").getPath();
 // classpath 下 excel 文件存储路径
 public static final String SAVE_PATH = "excel" + File.separator;
 // 文件后缀
 public static final String SUFFIX = ".xlsx";
 
 public static String export(EasyExcelObj easyExcelObj) {
 String path = easyExcelObj.getExportPath();
 // 如果导出路径为空 默认使用系统桌面路径
 if (StringUtils.isBlank(path)) {
 path = HOME_PATH;
 }
 // 导出路径
 String exportPath = path + File.separator + easyExcelObj.getExportName() + SUFFIX;
 // 模板所在位置路径
 String templateFileName = CLASS_PATH + SAVE_PATH + easyExcelObj.getTemplateName() + SUFFIX;
 
 ExcelWriter excelWriter = EasyExcel.write(exportPath).withTemplate(templateFileName).build();
 WriteSheet writeSheet = EasyExcel.writerSheet().build();
 if (easyExcelObj.getData() != null) {
 // 单表多数据导出 模板格式为 {.属性}
 for (Object d : easyExcelObj.getData()) {
 excelWriter.fill(d, writeSheet);
 }
 } else if (easyExcelObj.getMultiListMap() != null) {
 // 多表多数据导出
 for (Map.Entry<String, Object> map : easyExcelObj.getMultiListMap().entrySet()) {
 // 设置列表后续还有数据
 FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
 if (map.getValue() instanceof Collection) {
 // 多表导出必须使用 FillWrapper 模板格式为 {key.属性}
 excelWriter.fill(new FillWrapper(map.getKey(), (Collection<?>)map.getValue()), fillConfig, writeSheet);
 } else {
 excelWriter.fill(map.getValue(),writeSheet);
 }
 }
 } else {
 throw new IllegalArgumentException("数据为空");
 }
 // 结束构建
 excelWriter.finish();
 return exportPath;
 }
 }

### 3) 准备 excel 模板 ###

单 列表 多数据 模板

<table> 
 <tbody> 
 <tr> 
 <td colspan="5" style="text-align:center;vertical-align:middle;">{title}导出</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">测试数据</td> 
 <td colspan="4" style="text-align:center;vertical-align:middle;">测试集</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">测试1</td> 
 <td style="vertical-align:bottom;">测试2</td> 
 <td style="vertical-align:bottom;">测试3</td> 
 <td style="vertical-align:bottom;">测试4</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">测试</td> 
 <td style="vertical-align:bottom;">{test1}</td> 
 <td style="vertical-align:bottom;">{test2}</td> 
 <td style="vertical-align:bottom;">{test3}</td> 
 <td style="vertical-align:bottom;">{test4}</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 </tr> 
 <tr> 
 <td colspan="5" style="text-align:center;vertical-align:middle;">列表数据</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">名称</td> 
 <td style="vertical-align:bottom;">测试1</td> 
 <td style="vertical-align:bottom;">测试2</td> 
 <td style="vertical-align:bottom;">测试3</td> 
 <td style="vertical-align:bottom;">测试4</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">{.name}</td> 
 <td style="vertical-align:bottom;">{.list1}</td> 
 <td style="vertical-align:bottom;">{.list2}</td> 
 <td style="vertical-align:bottom;">{.list3}</td> 
 <td style="vertical-align:bottom;">{.list4}</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">下角{testTest}</td> 
 </tr> 
 </tbody> 
</table>

多列表 多数据 模板

<table style="width:324.02pt;"> 
 <tbody> 
 <tr> 
 <td colspan="3" style="text-align:center;vertical-align:middle;width:324pt;">{title1}</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">测试1</td> 
 <td style="vertical-align:bottom;">测试2</td> 
 <td style="vertical-align:bottom;">测试3</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">{data1.test1}</td> 
 <td style="vertical-align:bottom;">{data1.test2}</td> 
 <td style="vertical-align:bottom;">{data1.test3}</td> 
 </tr> 
 <tr> 
 <td colspan="3" style="text-align:center;vertical-align:middle;">{title2}</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">测试1</td> 
 <td style="vertical-align:bottom;">测试2</td> 
 <td style="vertical-align:bottom;">测试3</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">{data2.test1}</td> 
 <td style="vertical-align:bottom;">{data2.test2}</td> 
 <td style="vertical-align:bottom;">{data2.test3}</td> 
 </tr> 
 <tr> 
 <td colspan="3" style="text-align:center;vertical-align:middle;">{title3}</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">测试1</td> 
 <td style="vertical-align:bottom;">测试2</td> 
 <td style="vertical-align:bottom;">测试3</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">{data3.test1}</td> 
 <td style="vertical-align:bottom;">{data3.test2}</td> 
 <td style="vertical-align:bottom;">{data3.test3}</td> 
 </tr> 
 <tr> 
 <td colspan="3" style="text-align:center;vertical-align:middle;">{title4}</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">测试1</td> 
 <td style="vertical-align:bottom;">测试2</td> 
 <td style="vertical-align:bottom;">测试3</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">{data4.test1}</td> 
 <td style="vertical-align:bottom;">{data4.test2}</td> 
 <td style="vertical-align:bottom;">{data4.test3}</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 </tr> 
 <tr> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">&nbsp;</td> 
 <td style="vertical-align:bottom;">作者{author}</td> 
 </tr> 
 </tbody> 
</table>

讲模板放置在 项目 resources/excel/ 目录下

![20210310165518672.png][]

# 三、编写测试接口 #

### 1) 单列表多数据测试 ###

编写controller

/**
 * 测试 easyexcel 模板导出
 *
 * @author Lion Li
 */
 @RestController
 @RequestMapping("/excelTest")
 public class EasyExcelTestController {
 
 @Data
 @AllArgsConstructor
 class TestObj {
 private String name;
 private String list1;
 private String list2;
 private String list3;
 private String list4;
 }
 
 /**
 * 单列表多数据
 */
 @PostMapping("/exportOne")
 public String export() {
 Map<String,String> map = new HashMap<>();
 map.put("title","单列表多数据");
 map.put("test1","数据测试1");
 map.put("test2","数据测试2");
 map.put("test3","数据测试3");
 map.put("test4","数据测试4");
 map.put("testTest","666");
 List<TestObj> list = new ArrayList<>();
 list.add(new TestObj("单列表测试1","列表测试1","列表测试2","列表测试3","列表测试4"));
 list.add(new TestObj("单列表测试2","列表测试5","列表测试6","列表测试7","列表测试8"));
 list.add(new TestObj("单列表测试3","列表测试9","列表测试10","列表测试11","列表测试12"));
 EasyExcelObj obj = new EasyExcelObj()
 .setExportName("单列表多数据导出")
 .setTemplateName("单列表多数据")
 .setExportPath("D:")
 .setData(new Object[]{map,list});
 return EasyExcelUtil.export(obj);
 }
 
 }

发送请求

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70][]

查看结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70 1][]

### 2) 多列表多数据测试 ###

编写controller

/**
 * 测试 easyexcel 模板导出
 *
 * @author Lion Li
 */
 @RestController
 @RequestMapping("/excelTest")
 public class EasyExcelTestController {
 
 @Data
 @AllArgsConstructor
 class TestObj {
 private String test1;
 private String test2;
 private String test3;
 }
 
 /**
 * 多列表多数据
 */
 @PostMapping("/exportMuliti")
 public String export() {
 Map<String,String> map = new HashMap<>();
 map.put("title1","标题1");
 map.put("title2","标题2");
 map.put("title3","标题3");
 map.put("title4","标题4");
 map.put("author","Lion Li");
 List<TestObj> list1 = new ArrayList<>();
 list1.add(new TestObj("list1测试1","list1测试2","list1测试3"));
 list1.add(new TestObj("list1测试4","list1测试5","list1测试6"));
 list1.add(new TestObj("list1测试7","list1测试8","list1测试9"));
 List<TestObj> list2 = new ArrayList<>();
 list2.add(new TestObj("list2测试1","list2测试2","list2测试3"));
 list2.add(new TestObj("list2测试4","list2测试5","list2测试6"));
 List<TestObj> list3 = new ArrayList<>();
 list3.add(new TestObj("list3测试1","list3测试2","list3测试3"));
 List<TestObj> list4 = new ArrayList<>();
 list4.add(new TestObj("list4测试1","list4测试2","list4测试3"));
 list4.add(new TestObj("list4测试4","list4测试5","list4测试6"));
 list4.add(new TestObj("list4测试7","list4测试8","list4测试9"));
 list4.add(new TestObj("list4测试10","list4测试11","list4测试12"));
 Map<String,Object> multiListMap = new HashMap<>();
 multiListMap.put("map",map);
 multiListMap.put("data1",list1);
 multiListMap.put("data2",list2);
 multiListMap.put("data3",list3);
 multiListMap.put("data4",list4);
 EasyExcelObj obj = new EasyExcelObj()
 .setExportName("多列表多数据导出")
 .setTemplateName("多列表多数据")
 .setExportPath("D:")
 .setMultiListMap(multiListMap);
 return EasyExcelUtil.export(obj);
 }
 
 }

发送请求

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70 2][]

查看结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70 3][]

[easyexcel]: https://www.yuque.com/easyexcel/doc/easyexcel
[20210310165518672.png]: /images/20221023/90f293d1fe6b434dbb58604d86f1db98.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70]: /images/20221023/589f11c98ce74efea7ed15672f2fc087.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70 1]: /images/20221023/e171299eaf9344328c9046b761194030.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70 2]: /images/20221023/8f8cf3187f554e4599f93e6e7e1179c3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDQ2MTI4MQ_size_16_color_FFFFFF_t_70 3]: /images/20221023/4605ac3b6d5a4bb5b4f8a5d3bae375de.png