SpringBoot集成EasyExcel实现Excel下载

一、背景

为什么会用Easyexcel来做Excel下载

项目中的Excel导入功能刚做好，领导又来了：这次要导出功能。我导入才刚整明白呢，你又来了。但是没有办法，领导才是衣食父母嘛，只有干了。

阿里巴巴语雀团队对EasyExcel是这样介绍的

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

• 这篇文章很多地方都与上传的文章相同，只是controller有所变动，因为是同一个框架嘛。

二、集成EasyExcel

1、 在pom.xml中添加EasyExcel依赖

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

2、创建EasyExcel映射实体类

1. import com.alibaba.excel.annotation.ExcelProperty;
2. ​
3. public class ExcelEntity {
4. // ExcelProperty中的参数要对应Excel中的标题
5. @ExcelProperty("ID")
6. private int ID;
7. ​
8. @ExcelProperty("NAME")
9. private String name;
10. ​
11. @ExcelProperty("AGE")
12. private int age;
13. ​
14. public ExcelEntity() {
15. }
16. ​
17. public ExcelEntity(int ID, String name, int age) {
18. this.ID = ID;
19. this.name = name;
20. this.age = age;
21. }
22. ​
23. public int getID() {
24. return ID;
25. }
26. ​
27. public void setID(int ID) {
28. this.ID = ID;
29. }
30. ​
31. public String getName() {
32. return name;
33. }
34. ​
35. public void setName(String name) {
36. this.name = name;
37. }
38. ​
39. public int getAge() {
40. return age;
41. }
42. ​
43. public void setAge(int age) {
44. this.age = age;
45. }
46. }

3、创建controller

• 这里必须设置setContentType以及setHeader两个东西，否则下载出来的文件会有问题。

1. import com.alibaba.excel.EasyExcel;
2. import com.alibaba.excel.ExcelReader;
3. import org.slf4j.Logger;
4. import org.slf4j.LoggerFactory;
5. import org.springframework.web.bind.annotation.*;
6. import org.springframework.web.multipart.MultipartFile;
7. ​
8. import java.io.IOException;
9. import java.io.InputStream;
10. import java.util.List;
11. ​
12. @RestController
13. @CrossOrigin
14. @RequestMapping("/loggerItem")
15. public class LoggerItemController {
16. ​
17. ​
18. @GetMapping("/download")
19. public void downLoad(HttpServletResponse response){
20. // 设置响应类型为excel
21. response.setContentType("application/vnd.ms-excel");
22. /*
23. * 设置响应头以及文件名称
24. * Content-disposition 是 MIME 协议的扩展，MIME 协议指示 MIME 用户代理如何显示附加的文件。
25. * 浏览器接收到头时，它会激活文件下载对话框
26. * attachment 附件
27. * filename 附件名
28. */
29. response.setHeader("Content-Disposition", "attachment;filename=aaa.xlsx");
30. ​
31. try {
32. // 从HttpServletResponse中获取OutputStream输出流
33. ServletOutputStream outputStream = response.getOutputStream();
34. /*
35. * EasyExcel 有多个不同的read方法，适用于多种需求
36. * 这里调用EasyExcel中通过OutputStream流方式输出Excel的write方法
37. * 它会返回一个ExcelWriterBuilder类型的返回值
38. * ExcelWriterBuilde中有一个doWrite方法，会输出数据到设置的Sheet中
39. */
40. EasyExcel.write(outputStream,ExcelEntity.class).sheet("测试数据").doWrite(UploadExcelListener.list);
41. } catch (IOException e) {
42. e.printStackTrace();
43. }
44. }
45. }

5、application.yml配置

这里的文件上传大小，如果单做导出的话可以不用配，由于我这里需要上传数据进行测试，所以进行了配置

1. server:
2. # 指定端口号
3. port: 8080
4. spring:
5. servlet:
6. multipart:
7. # 配置单个上传文件大小
8. file-size-threshold: 100Mb
9. # 配置总上传大小
10. max-request-size: 300M

6、测试

我们先搞一个简单的Excel，上传上去用来测试

 

然后通过Postman模拟发送上传请求，上传测试文件

• 选择Post请求并输入请求地址
• 在下面选择Body
• Key的框中输入controller中的请求的方法中的参数，后面的下拉框中选择File
• VALUE框中有一个Select File ，点击后选择自己刚才创建的测试的Excel
• 最后点击Send发送请求

然后在浏览器中发送下载请求

成功下载。

三、EasyExcel中的write方法汇总

1. /**
2. * Build excel the write
3. *
4. * @return
5. */
6. public static ExcelWriterBuilder write() {
7. return new ExcelWriterBuilder();
8. }
9. ​
10. /**
11. * Build excel the write
12. *
13. * @param file
14. * File to write
15. * @return Excel writer builder
16. */
17. public static ExcelWriterBuilder write(File file) {
18. return write(file, null);
19. }
20. ​
21. /**
22. * Build excel the write
23. *
24. * @param file
25. * File to write
26. * @param head
27. * Annotate the class for configuration information
28. * @return Excel writer builder
29. */
30. public static ExcelWriterBuilder write(File file, Class head) {
31. ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder();
32. excelWriterBuilder.file(file);
33. if (head != null) {
34. excelWriterBuilder.head(head);
35. }
36. return excelWriterBuilder;
37. }
38. ​
39. /**
40. * Build excel the write
41. *
42. * @param pathName
43. * File path to write
44. * @return Excel writer builder
45. */
46. public static ExcelWriterBuilder write(String pathName) {
47. return write(pathName, null);
48. }
49. ​
50. /**
51. * Build excel the write
52. *
53. * @param pathName
54. * File path to write
55. * @param head
56. * Annotate the class for configuration information
57. * @return Excel writer builder
58. */
59. public static ExcelWriterBuilder write(String pathName, Class head) {
60. ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder();
61. excelWriterBuilder.file(pathName);
62. if (head != null) {
63. excelWriterBuilder.head(head);
64. }
65. return excelWriterBuilder;
66. }
67. ​
68. /**
69. * Build excel the write
70. *
71. * @param outputStream
72. * Output stream to write
73. * @return Excel writer builder
74. */
75. public static ExcelWriterBuilder write(OutputStream outputStream) {
76. return write(outputStream, null);
77. }
78. ​
79. /**
80. * Build excel the write
81. *
82. * @param outputStream
83. * Output stream to write
84. * @param head
85. * Annotate the class for configuration information.
86. * @return Excel writer builder
87. */
88. public static ExcelWriterBuilder write(OutputStream outputStream, Class head) {
89. ExcelWriterBuilder excelWriterBuilder = new ExcelWriterBuilder();
90. excelWriterBuilder.file(outputStream);
91. if (head != null) {
92. excelWriterBuilder.head(head);
93. }
94. return excelWriterBuilder;
95. }

所有的方法都在这儿了，其实如果看不懂到底应该调用哪一个write方法的话，可以以根据自己所能得到的参数来判断。

四、扩展

• 导出到本地Excel

 

---

平时上班比较忙，操作过程中如果遇到什么问题，可以评论提问，我看到了的话，有时间基本上都会回复的(前提是我会，哈哈哈)。

其实百度才是最好的老师。