Spring Boot 集成 EasyExcel 导出 Excel 文件【复杂表头】

媒介：
Excel 导出在项目开发中是一个非经常见的业务场景，通过 Java 相干的类库可以轻松实现 Excel 的读写利用，常见的类库有 Apache POI、EasyPoi 和 EasyExcel，本篇我们要分享的是利用 EasyExcel 完成复杂表头的 Excel 导出，渴望可以资助到有须要的朋侪。
模拟业务场景
假设有一个 Excel 的导出需求，表头如下：

对于这种比力复杂的表头假如实用 Apache POI 来实现会比力的贫困，这里我们利用 EasyExcel 来实现，将会比力简单。
Spring Boot 集成 EasyExcel
Spring Boot 集成 EasyExcel 着实就是引入依靠即可利用，pom.xml 引入依靠如下：

1. <dependency>
2.         <groupId>com.alibaba</groupId>
3.         <artifactId>easyexcel</artifactId>
4.         <version>3.2.1</version>
5. </dependency>

复制代码

EasyExcel Github 地点
EasyExcel 在 Github 上有 33K Stars，是阿里巴巴开源的，但很遗憾，迩来公布停更了，未来将渐渐进入维护模式，将继承修复 Bug，但不再自动新增功能，据相识，EasyExcel 作者玉箫客岁已经从阿里去职，迩来他公布启动 EasyExcel-Plus 项目，称这个新版本将在原有的根本上进一步提升性能和扩展功能。
创建 VO 类
在字段名上加上 @ExcelProperty 注解就可以实现上面我们这种较为复杂的 Excel 表头，创建实体类如下：

1. package com.my.study.pojo.vo;
3. import com.alibaba.excel.annotation.ExcelProperty;
4. import com.alibaba.excel.annotation.write.style.ColumnWidth;
5. import io.swagger.annotations.ApiModelProperty;
6. import lombok.Data;
8. /**
9. * @ClassName： InterviewInformationVO
10. * @Author: Author
11. * @Date: 2024/11/13 19:31
12. * @Description:
13. */
14. @Data
15. @ColumnWidth(20)
16. public class InterviewInformationVO {
18.     @ApiModelProperty("姓名")
19.     @ExcelProperty(index = 0, value = {"面试记录表", "姓名"})
20.     @ColumnWidth(15)
21.     private String name;
23.     @ApiModelProperty("年龄")
24.     @ExcelProperty(index = 1, value = {"面试记录表", "基本信息", "年龄"})
25.     @ColumnWidth(15)
26.     private int age;
28.     @ApiModelProperty("性别")
29.     @ExcelProperty(index = 2, value = {"面试记录表", "基本信息", "性别"})
30.     @ColumnWidth(15)
31.     private String sex;
33.     @ApiModelProperty("籍贯")
34.     @ExcelProperty(index = 3, value = {"面试记录表", "基本信息", "籍贯"})
35.     @ColumnWidth(15)
36.     private String nativePlace;
38.     @ApiModelProperty("自我评价")
39.     @ExcelProperty(index = 4, value = {"面试记录表", "自我评价"})
40.     @ColumnWidth(15)
41.     private String selfEvaluation;
43.     @ApiModelProperty("沟通能力分")
44.     @ExcelProperty(index = 5, value = {"面试记录表", "一轮面试","面试官A","沟通能力分"})
45.     @ColumnWidth(15)
46.     private int cmmunicationAkillsScore1A;
48.     @ApiModelProperty("专业能力分")
49.     @ExcelProperty(index = 6, value = {"面试记录表", "一轮面试","面试官A","专业能力分"})
50.     @ColumnWidth(15)
51.     private int professionalAbilityScore1A;
53.     @ApiModelProperty("沟通能力分")
54.     @ExcelProperty(index = 7, value = {"面试记录表", "一轮面试","面试官B","沟通能力分"})
55.     @ColumnWidth(15)
56.     private int cmmunicationAkillsScore1B;
58.     @ApiModelProperty("专业能力分")
59.     @ExcelProperty(index = 8, value = {"面试记录表", "一轮面试","面试官B","专业能力分"})
60.     @ColumnWidth(15)
61.     private int professionalAbilityScore1B;
63.     @ApiModelProperty("沟通能力分")
64.     @ExcelProperty(index = 9, value = {"面试记录表", "二轮面试","面试官A","沟通能力分"})
65.     @ColumnWidth(15)
66.     private int cmmunicationAkillsScore2A;
68.     @ApiModelProperty("专业能力分")
69.     @ExcelProperty(index = 10, value = {"面试记录表", "二轮面试","面试官A","专业能力分"})
70.     @ColumnWidth(15)
71.     private int professionalAbilityScore2A;
73.     @ApiModelProperty("沟通能力分")
74.     @ExcelProperty(index = 11, value = {"面试记录表", "二轮面试","面试官B","沟通能力分"})
75.     @ColumnWidth(15)
76.     private int cmmunicationAkillsScore2B;
78.     @ApiModelProperty("专业能力分")
79.     @ExcelProperty(index = 12, value = {"面试记录表", "二轮面试","面试官B","专业能力分"})
80.     @ColumnWidth(15)
81.     private int professionalAbilityScore2B;
83. }

复制代码

留意看我利用在段上的注解 @ExcelProperty(index = 5, value = {“口试记录表”, “一轮口试”,“口试官A”,“沟通本领分”})，这简单的一行就实现了表头的归并处理处罚。
导出代码
导出我们选择利用输出流的方式直接返回，固然也可以导出到指定位置，代码如下：

1. package com.my.study.controller;
3. import cn.hutool.core.date.DateUtil;
4. import com.alibaba.excel.EasyExcel;
5. import com.my.study.pojo.vo.InterviewInformationVO;
6. import io.swagger.annotations.Api;
7. import io.swagger.annotations.ApiOperation;
8. import lombok.extern.slf4j.Slf4j;
9. import org.springframework.web.bind.annotation.PostMapping;
10. import org.springframework.web.bind.annotation.RequestMapping;
11. import org.springframework.web.bind.annotation.RestController;
13. import javax.servlet.http.HttpServletResponse;
14. import java.io.File;
15. import java.io.IOException;
16. import java.net.URLEncoder;
17. import java.util.ArrayList;
18. import java.util.Date;
19. import java.util.List;
21. /**
22. * @ClassName： MyExcelController
23. * @Author: Author
24. * @Date: 2024/11/13 19:19
25. * @Description:
26. */
27. @RestController
28. @RequestMapping("/excel")
29. @Api(tags = {"【Excel 导出控制层】"})
30. @Slf4j
31. public class MyExcelController {
33.     @PostMapping("/export")
34.     public void export(HttpServletResponse response) {
35.         try {
36.             List<InterviewInformationVO> exportList = new ArrayList<>();
37.             buildInterviewInformation(exportList);
38.             // 文件名中文名需要转义
39.             String fileName = URLEncoder.encode("面试记录表-" + DateUtil.format(new Date(), "yyyyMMddHHmmss"), "UTF-8");
40.             response.setContentType("application/x-download;charset=utf-8");
41.             response.addHeader("Content-Disposition", "attachment;filename=" + fileName + ".xlsx");
42.             EasyExcel.write(response.getOutputStream(), InterviewInformationVO.class).sheet("sheet1").doWrite(exportList);
43.         } catch (IOException e) {
44.             log.error("面试记录表导出失败,失败原因：{}", e.getMessage());
45.             e.printStackTrace();
46.         }
47.     }
49.     public void buildInterviewInformation(List<InterviewInformationVO> exportList) {
50.         InterviewInformationVO interviewInformationVO = new InterviewInformationVO();
51.         interviewInformationVO.setName("张三");
52.         interviewInformationVO.setAge(25);
53.         interviewInformationVO.setSex("男");
54.         interviewInformationVO.setNativePlace("湖北");
55.         interviewInformationVO.setSelfEvaluation("我是一个工作狂");
56.         interviewInformationVO.setCmmunicationAkillsScore1A(90);
57.         interviewInformationVO.setCmmunicationAkillsScore1B(85);
58.         interviewInformationVO.setProfessionalAbilityScore1A(90);
59.         interviewInformationVO.setProfessionalAbilityScore1B(90);
60.         interviewInformationVO.setCmmunicationAkillsScore1A(85);
61.         interviewInformationVO.setCmmunicationAkillsScore1B(80);
62.         interviewInformationVO.setProfessionalAbilityScore1A(75);
63.         interviewInformationVO.setProfessionalAbilityScore1B(80);
64.         exportList.add(interviewInformationVO);
65.     }
66.        
67. }

复制代码

触发导出，效果如下：

实现了我们开始说的表头效果，导出效果符合预期。
我们并没有写多少代码，就完成了看起来比力复杂的表头，这就是 EasyExcel 带来效果，当前 EasyExcel 在内存管理上也有显着的上风。
方式二实现表头
上面我们利用注解的方式实现了表头效果，下面我们利用代码的方式完成表头功能，代码如下：

1. package com.my.study.controller;
3. import cn.hutool.core.date.DateUtil;
4. import com.alibaba.excel.EasyExcel;
5. import com.my.study.pojo.vo.InterviewInformationVO;
6. import io.swagger.annotations.Api;
7. import io.swagger.annotations.ApiOperation;
8. import lombok.extern.slf4j.Slf4j;
9. import org.springframework.web.bind.annotation.PostMapping;
10. import org.springframework.web.bind.annotation.RequestMapping;
11. import org.springframework.web.bind.annotation.RestController;
13. import javax.servlet.http.HttpServletResponse;
14. import java.io.File;
15. import java.io.IOException;
16. import java.net.URLEncoder;
17. import java.util.ArrayList;
18. import java.util.Date;
19. import java.util.List;
21. /**
22. * @ClassName： MyExcelController
23. * @Author: Author
24. * @Date: 2024/11/13 19:19
25. * @Description:
26. */
27. @RestController
28. @RequestMapping("/excel")
29. @Api(tags = {"【Excel 导出控制层】"})
30. @Slf4j
31. public class MyExcelController {
33.    @PostMapping("/export2")
34.     public void export(HttpServletResponse response) {
35.         try {
36.             List<InterviewInformationVO> exportList = new ArrayList<>();
37.             buildInterviewInformation(exportList);
38.             // 文件名中文名需要转义
39.             String fileName = URLEncoder.encode("面试记录表-" + DateUtil.format(new Date(), "yyyyMMddHHmmss"), "UTF-8");
40.             response.setContentType("application/x-download;charset=utf-8");
41.             response.addHeader("Content-Disposition", "attachment;filename=" + fileName + ".xlsx");
42.             //EasyExcel.write(response.getOutputStream(), InterviewInformationVO.class).sheet("sheet1").doWrite(exportList);
43.             EasyExcel.write(response.getOutputStream())
44.                     // 这里放入动态头
45.                     .head(generateExcelHead())
46.                     .sheet()
47.                     // 这里传入数据
48.                     .doWrite(new ArrayList<>());
49.             //导出到指定位置
50.             /*EasyExcel.write("d:\interview_information.xlsx")
51.                     // 这里放入动态头
52.                     .head(generateExcelHead())
53.                     .sheet()
54.                     // 这里传入数据
55.                     .doWrite(new ArrayList<>());*/
56.         } catch (IOException e) {
57.             log.error("面试记录表导出失败,失败原因：{}", e.getMessage());
58.             e.printStackTrace();
59.         }
60.     }
62.     private static List<List<String>> generateExcelHead() {
63.         List<List<String>> result = new ArrayList<>();
64.         List<String> head0 = new ArrayList<>();
65.         head0.add("面试记录表");
66.         head0.add("姓名");
67.         result.add(head0);
69.         List<String> head1 = new ArrayList<>();
70.         head1.add("面试记录表");
71.         head1.add("基本信息");
72.         head1.add("年龄");
73.         result.add(head1);
75.         List<String> head2 = new ArrayList<>();
76.         head2.add("面试记录表");
77.         head2.add("基本信息");
78.         head2.add("性别");
79.         result.add(head2);
81.         List<String> head3 = new ArrayList<>();
82.         head3.add("面试记录表");
83.         head3.add("基本信息");
84.         head3.add("籍贯");
85.         result.add(head3);
87.         List<String> head4 = new ArrayList<>();
88.         head4.add("面试记录表");
89.         head4.add("自我评价");
90.         result.add(head4);
92.         List<String> head5 = new ArrayList<>();
93.         head5.add("面试记录表");
94.         head5.add("一轮面试");
95.         head5.add("面试官A");
96.         head5.add("沟通能力分");
97.         result.add(head5);
99.         List<String> head6 = new ArrayList<>();
100.         head6.add("面试记录表");
101.         head6.add("一轮面试");
102.         head6.add("面试官A");
103.         head6.add("专业能力分");
104.         result.add(head6);
106.         List<String> head7 = new ArrayList<>();
107.         head7.add("面试记录表");
108.         head7.add("一轮面试");
109.         head7.add("面试官B");
110.         head7.add("沟通能力分");
111.         result.add(head7);
113.         List<String> head8 = new ArrayList<>();
114.         head8.add("面试记录表");
115.         head8.add("一轮面试");
116.         head8.add("面试官B");
117.         head8.add("专业能力分");
118.         result.add(head8);
120.         List<String> head9 = new ArrayList<>();
121.         head9.add("面试记录表");
122.         head9.add("二轮面试");
123.         head9.add("面试官A");
124.         head9.add("沟通能力分");
125.         result.add(head9);
127.         List<String> head10 = new ArrayList<>();
128.         head10.add("面试记录表");
129.         head10.add("二轮面试");
130.         head10.add("面试官A");
131.         head10.add("专业能力分");
132.         result.add(head10);
134.         List<String> head11 = new ArrayList<>();
135.         head11.add("面试记录表");
136.         head11.add("二轮面试");
137.         head11.add("面试官B");
138.         head11.add("沟通能力分");
139.         result.add(head11);
141.         List<String> head12 = new ArrayList<>();
142.         head12.add("面试记录表");
143.         head12.add("二轮面试");
144.         head12.add("面试官B");
145.         head12.add("专业能力分");
146.         result.add(head12);
148.         return result;
149.     }
150.        
151. }

复制代码

触发导出效果如下：

导出效果符合预期，利用代码来实现表头也很轻易，但个人更喜欢利用注解来实现。
总结：本篇简单分享利用 EasyExcel 来实现较为复杂的表头导出 Excel，感谢 EasyExcel 作者的开源，也等候 EasyExcel-Plus 的发布（预计 11月尾发布），本篇的分享渴望可以资助到有须要的朋侪。
如有不精确的地方欢迎各位指出改正。