手把手教你利用easyexcel导出数据【附带源码】

一、前言

​        项目开发过程中，免不了必要数据导出功能，常见的导出工具包有poi，easypoi，easyexcel，它们各有优缺点，简要来说：

• poi：功能强大，利用起来相对复杂，大数据时大概导致内存溢出
  
• easypoi：基于poi实现，功能强大，简单易用，大数据时大概导致内存溢出，小数据量时推荐
  
• easyexcel：基于poi实现，性能更优，大数据量时推荐
  
• 本文只介绍easyexcel，并介绍常见题目比如字典、样式的办理方案
  

二、业务流程

​        介绍数据导出业务流程之前，先梳理下数据导出，什么是数据导出，为什么必要数据导出？
​        我们都知道数据存储在数据库中，数据库中的数据可以通过前端页面或者APP出现给利用者，其实通过excel将数据导出也是一种出现方式，而且可以通过excel对数据做更复杂的处理惩罚。
​        前面说了，excel导出和前端页面、APP一样都是一种出现方式，所以前端页面和APP在将数据出现给用户的过程中遇到的题目，像属性转换（数据库存储的name，要出现给利用者名称）、字典转换（数据库存储的1/0，要出现给利用者启用/停用）等等题目，excel导出一样会遇到。下面介绍下数据出现必须要经过业务流程

• 获取必要导出的数据集合
  
• 数据属性和自然语言映射关系，将数据对象的属性转为利用者可以理解的自然语言
  
• 数据字典值和自然语言映射关系，将属性的字典值转为利用者可以理解的自然语言（非字典值，是什么值就出现什么值）
  
• 数据样式和自然语言样式映射关系，将数据样式转为利用者可以理解的自然语言样式
  
• 设置表格样式
  
• 将数据集合按照上述映射关系和表格样式，写入到excel中
  
• 用户下载excel
  

三、实现

1、引入easyexcel、fastjson、lombok包

1. <dependency>
2.     <groupId>com.alibaba</groupId>
3.     <artifactId>easyexcel</artifactId>
4.     <version>4.0.3</version>
5. </dependency>
7. <dependency>
8.     <groupId>com.alibaba</groupId>
9.     <artifactId>fastjson</artifactId>
10.     <version>1.2.46</version>
11. </dependency>
13. <dependency>
14.     <groupId>org.projectlombok</groupId>
15.     <artifactId>lombok</artifactId>
16.     <version>1.18.0</version>
17. </dependency>

复制代码

2、创建Json工具类

1. package com.yu.demo.tools;
3. import com.alibaba.fastjson.JSON;
4. import com.fasterxml.jackson.core.type.TypeReference;
6. import java.lang.reflect.Type;
7. import java.util.Map;
9. /**
10. * JSON工具类
11. *
12. * @author admin
13. */
14. public abstract class JsonUtil {
15.     private JsonUtil() {
16.     }
18.     public final static Type MAP_INTEGER_STRING = new TypeReference<Map<Integer, String>>() {
19.     }.getType();
21.     /**
22.      * json串转Map(Map的value类型一致时使用)
23.      *
24.      * @param jsonString json串
25.      * @return 对象
26.      */
27.     public static <K, V> Map<K, V> json2Map(String jsonString, Type type) {
28.         return JSON.parseObject(jsonString, type);
29.     }
31. }

复制代码

3、创建自定义字典转换注解

1. package com.yu.demo.tools;
3. import java.lang.annotation.*;
5. @Target({ElementType.FIELD})
6. @Retention(RetentionPolicy.RUNTIME)
7. @Documented
8. public @interface DictSource {
9.     /**
10.      * 字典类型主键
11.      */
12.     String dictTypeId() default "";
14.     /**
15.      * 字典内容json串
16.      */
17.     String dictContentJson() default "";
19. }

复制代码

4、创建字典转换实现类

1. package com.yu.demo.tools;
3. import com.alibaba.excel.converters.Converter;
4. import com.alibaba.excel.enums.CellDataTypeEnum;
5. import com.alibaba.excel.metadata.GlobalConfiguration;
6. import com.alibaba.excel.metadata.data.WriteCellData;
7. import com.alibaba.excel.metadata.property.ExcelContentProperty;
8. import org.apache.poi.util.StringUtil;
11. import java.lang.reflect.Field;
12. import java.util.Map;
15. public class IntegerDictConverter implements Converter<Integer> {
17.     @Override
18.     public CellDataTypeEnum supportExcelTypeKey() {
19.         return CellDataTypeEnum.STRING;
20.     }
22.     @Override
23.     public WriteCellData<?> convertToExcelData(Integer value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
24.         //属性值为空时，直接返回
25.         if (value == null) {
26.             //为空时的处理，与前端展示保持一致即可
27.             return new WriteCellData<>("");
28.         }
29.         //获取添加@ExcelProperty注解且converter = IntegerDictConverter.class的属性
30.         Field field = contentProperty.getField();
31.         //获取该属性的DictConverter注解信息
32.         DictSource dictSource = field.getAnnotation(DictSource.class);
33.         //配置了converter = IntegerDictConverter.class的属性，但是没有添加DictSource注解的直接返回
34.         if (dictSource == null) {
35.             return new WriteCellData<>(String.valueOf(value));
36.         }
37.         //获取配置的dictTypeId
38.         String dictTypeId = dictSource.dictTypeId();
39.         //获取配置的dictContentJson
40.         String dictContentJson = dictSource.dictContentJson();
41.         //判断dictTypeId是否为空
42.         boolean nullDictType = StringUtil.isBlank(dictTypeId);
43.         //判断nullDictContentJson是否为空
44.         boolean nullDictContentJson = StringUtil.isBlank(dictContentJson);
45.         //字典配置都为空时，将属性值转为字符串直接返回
46.         if (nullDictType && nullDictContentJson) {
47.             return new WriteCellData<>(String.valueOf(value));
48.         }
49.         //优先使用dictTypeId处理转换
50.         if (!nullDictType) {
51.             //通过dictTypeId获取字典内容集合：List<DictContent> dictContents = dictContentService.listByDictTypeId(dictTypeId);//主键是数值的，将dictTypeId转为数值
52.             //遍历字典内容，匹配属性值与字典值：value.equals(dictContent.getValue())
53.             //匹配成功后获取字典名称返回：return new WriteCellData<>(dictContent.getName());
54.             //如果没有匹配成功使用dictContentJson处理转换
55.         }
56.         if (!nullDictContentJson) {
57.             Map<Integer, String> dictContentMap = JsonUtil.json2Map(dictContentJson, JsonUtil.MAP_INTEGER_STRING);
58.             String cnName = dictContentMap.get(value);
59.             if (StringUtil.isNotBlank(cnName)) {
60.                 return new WriteCellData<>(cnName);
61.             }
62.         }
63.         //没有转换成功时使用默认属性值
64.         return new WriteCellData<>(String.valueOf(value));
65.     }
66. }

复制代码

5、创建数据对象类

1. package com.yu.demo.web.easyexcel.entity;
3. import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
4. import com.alibaba.excel.annotation.ExcelProperty;
5. import com.alibaba.excel.annotation.format.DateTimeFormat;
6. import com.alibaba.excel.annotation.write.style.ColumnWidth;
7. import com.alibaba.excel.converters.date.DateStringConverter;
8. import com.yu.demo.web.easyexcel.component.DictSource;
9. import com.yu.demo.web.easyexcel.component.IntegerDictConverter;
10. import lombok.Getter;
11. import lombok.Setter;
12. import lombok.ToString;
14. import java.util.Date;
16. @Setter
17. @Getter
18. @ToString
19. //类上添加@ExcelIgnoreUnannotated时，属性没有@ExcelProperty注解时不导出
20. //类上未添加@ExcelIgnoreUnannotated，属性没有@ExcelProperty注解时也导出
21. @ExcelIgnoreUnannotated
22. public class User {
24.     /**
25.      * 名称
26.      */
27.     @ExcelProperty("名称")
28.     private String name;
29.     /**
30.      * 密码
31.      * 类添加@ExcelIgnoreUnannotated，属性未添加@ExcelProperty，不导出
32.      */
33.     private String password;
34.     /**
35.      * 生日
36.      * 日期样式处理
37.      * 1.使用@DateTimeFormat设置导出样式
38.      * 2.使用DateStringConverter处理导出
39.      */
40.     @DateTimeFormat("yyyy-MM-dd HH:mm:ss")
41.     @ExcelProperty(value = "生日", converter = DateStringConverter.class)
42.     private Date birthday;
43.     /**
44.      * 性别
45.      * 字典转换处理
46.      */
47.     @ColumnWidth(7)//指定列宽度，优先级高于LongestMatchColumnWidthStyleStrategy
48.     @ExcelProperty(value = "性别", converter = IntegerDictConverter.class)
49.     @DictSource(dictContentJson = "{0:'女',1:'男',2:'保密'}")
50.     private Integer sex;
52. }

复制代码

6、创建多sheet页封装对象

1. package com.yu.demo.tools;
3. import lombok.Getter;
4. import lombok.Setter;
5. import lombok.ToString;
7. import java.util.List;
10. /**
11. * excel导入导出数据对象
12. */
13. @Setter
14. @Getter
15. @ToString
16. public class SheetEntity<T> {
18.     /**
19.      * sheet页名称（导出参数）
20.      * 可以为空，为空时，单sheet页没有名称，多sheet页序号为名称
21.      */
22.     private String sheetName;
23.     /**
24.      * 数据类型（导入导出参数）
25.      */
26.     private Class<T> head;
27.     /**
28.      * 数据（导出参数）
29.      */
30.     private List<T> data;
32. }

复制代码

7、创建Excel导出工具类

​        导出的数据有如下三种及其说明

• 通过全路径文件名导出，easyexcel通过全路径文件名创建文件，将数据写入文件，当路径不存在时报错，适合场景：一次导出，多次下载
  
• 通过文件导出，将数据写入文件，当路径不存在报错，适合场景：一次导出，多次下载
  
• 通过输出流导出，将数据写入输出流，适合场景：导出一次下载一次
  

1. package com.yu.demo.tools;
3. import com.alibaba.excel.EasyExcel;
4. import com.alibaba.excel.ExcelWriter;
5. import com.alibaba.excel.support.ExcelTypeEnum;
6. import com.alibaba.excel.write.builder.ExcelWriterBuilder;
7. import com.alibaba.excel.write.handler.WriteHandler;
8. import com.alibaba.excel.write.metadata.WriteSheet;
9. import com.alibaba.excel.write.metadata.style.WriteCellStyle;
10. import com.alibaba.excel.write.style.HorizontalCellStyleStrategy;
11. import com.alibaba.excel.write.style.column.LongestMatchColumnWidthStyleStrategy;
12. import org.apache.poi.ss.usermodel.HorizontalAlignment;
13. import org.apache.poi.ss.usermodel.VerticalAlignment;
14. import org.apache.poi.util.StringUtil;
16. import java.io.File;
17. import java.io.OutputStream;
18. import java.util.List;
20. /**
21. * excel导入导出工具类（easyExcel实现）
22. * easyPoi：并发量和数据量都不大时推荐，定制化的导出支持非常的丰富
23. * easyExcel：高并发、大数据量时推荐
24. */
25. public abstract class ExcelUtil {
26.     // 设置居中对齐的样式
27.     private static final WriteCellStyle CONTENT_WRITE_CELL_STYLE;
28.     private static final WriteHandler HORIZONTAL_CELL_STYLE_STRATEGY;
30.     static {
31.         CONTENT_WRITE_CELL_STYLE = new WriteCellStyle();
32.         //水平居中
33.         CONTENT_WRITE_CELL_STYLE.setHorizontalAlignment(HorizontalAlignment.CENTER);
34.         //垂直居中
35.         CONTENT_WRITE_CELL_STYLE.setVerticalAlignment(VerticalAlignment.CENTER);
36.         HORIZONTAL_CELL_STYLE_STRATEGY = new HorizontalCellStyleStrategy(null, CONTENT_WRITE_CELL_STYLE);
37.     }
39.     private ExcelUtil() {
40.     }
43.     /**
44.      * 使用EasyExcel导出
45.      *
46.      * @param fullFileName 文件路径+文件名+后缀（文件已存在时覆盖）
47.      * @param sheetName    sheet名称（为空时使用默认值0）
48.      * @param head         数据类型（为空时没有表头，只有数据）
49.      * @param exportData   需要导出的数据（为空时，没有数据）
50.      */
51.     public static void exportByEasyExcel(String fullFileName, String sheetName, Class<?> head, List<?> exportData) {
52.         File targetFile = new File(fullFileName);
53.         // 判断文件父目录是否存在
54.         if (!targetFile.getParentFile().exists()) {
55.             boolean mkdirResult = targetFile.getParentFile().mkdirs();
56.             if (!mkdirResult) {
57.                 return;
58.             }
59.         }
60.         ExcelWriterBuilder excelWriterBuilder = EasyExcel.write(targetFile, head);
61.         if (fullFileName.endsWith(ExcelTypeEnum.XLS.getValue())) {
62.             excelWriterBuilder.excelType(ExcelTypeEnum.XLS);
63.         } else if (fullFileName.endsWith(ExcelTypeEnum.CSV.getValue())) {
64.             excelWriterBuilder.excelType(ExcelTypeEnum.CSV);
65.         } else {
66.             excelWriterBuilder.excelType(ExcelTypeEnum.XLSX);
67.         }
68.         excelWriterBuilder
69.                 //设置列按最大长度调整
70.                 .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
71.                 //设置水平垂直居中
72.                 .registerWriteHandler(HORIZONTAL_CELL_STYLE_STRATEGY)
73.                 .sheet(sheetName)
74.                 .doWrite(exportData);
75.     }
77.     /**
78.      * 使用EasyExcel导出
79.      *
80.      * @param outputStream 输出流
81.      * @param sheetName    sheet名称（为空时使用默认值0）
82.      * @param head         数据类型（为空时没有表头，只有数据）
83.      * @param exportData   需要导出的数据（为空时，没有数据）
84.      */
85.     public static void exportByEasyExcel(OutputStream outputStream, ExcelTypeEnum excelType, String sheetName, Class<?> head, List<?> exportData) {
86.         EasyExcel.write(outputStream, head)
87.                 .excelType(excelType)
88.                 //设置列按最大长度调整，非线程安全，每次都需要new
89.                 .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
90.                 //设置水平垂直居中
91.                 .registerWriteHandler(HORIZONTAL_CELL_STYLE_STRATEGY)
92.                 .sheet(sheetName)
93.                 .doWrite(exportData);
94.     }
96.     /**
97.      * 使用EasyExcel导出多sheet页数据
98.      *
99.      * @param outputStream  输出流
100.      * @param sheetEntities 导出数据对象集合
101.      */
102.     public static void exportByEasyExcel(OutputStream outputStream, ExcelTypeEnum excelType, List<SheetEntity<?>> sheetEntities) {
103.         ExcelWriterBuilder excelWriterBuilder = EasyExcel.write(outputStream).excelType(excelType);
104.         writeSheets(excelWriterBuilder, sheetEntities);
105.     }
107.     private static void writeSheets(ExcelWriterBuilder excelWriterBuilder, List<SheetEntity<?>> sheetEntities) {
108.         excelWriterBuilder
109.                 .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
110.                 .registerWriteHandler(HORIZONTAL_CELL_STYLE_STRATEGY);
111.         ExcelWriter excelWriter = excelWriterBuilder.build();
112.         for (int i = 0; i < sheetEntities.size(); i++) {
113.             SheetEntity<?> sheetEntity = sheetEntities.get(i);
114.             Class<?> head = sheetEntity.getHead();
115.             List<?> exportData = sheetEntity.getData();
116.             String sheetName = StringUtil.isBlank(sheetEntity.getSheetName()) ? String.valueOf(i + 1) : sheetEntity.getSheetName();
117.             WriteSheet writeSheet = EasyExcel.writerSheet(i + 1, sheetName).head(head).build();
118.             excelWriter.write(exportData, writeSheet);
119.         }
120.         excelWriter.finish();
121.     }
123. }

复制代码

8、创建测试类

1. package com.yu.demo.web.easyexcel.web;
3. import com.alibaba.excel.support.ExcelTypeEnum;
4. import com.yu.demo.web.easyexcel.entity.SheetEntity;
5. import com.yu.demo.web.easyexcel.entity.User;
6. import com.yu.demo.web.easyexcel.util.ExcelUtil;
7. import org.springframework.beans.factory.annotation.Value;
8. import org.springframework.http.HttpHeaders;
9. import org.springframework.web.bind.annotation.GetMapping;
10. import org.springframework.web.bind.annotation.RequestMapping;
11. import org.springframework.web.bind.annotation.RestController;
13. import javax.annotation.PostConstruct;
14. import javax.servlet.http.HttpServletResponse;
15. import java.io.IOException;
16. import java.net.URLEncoder;
17. import java.nio.charset.StandardCharsets;
18. import java.util.ArrayList;
19. import java.util.Date;
20. import java.util.List;
22. @RestController
23. @RequestMapping("user")
24. public class UserController {
25.     @Value("${download.path}")
26.     private String filePath;
27.     private List<User> users;
28.     private List<SheetEntity<?>> sheetEntities;
30.     @PostConstruct
31.     public void init() {
32.         users = new ArrayList<>(5);
33.         for (int i = 0; i < 5; i++) {
34.             User user = new User();
35.             user.setName(i + "号用户");
36.             user.setPassword(String.valueOf(i * 1000));
37.             user.setBirthday(new Date());
38.             user.setSex(i % 3);
39.             users.add(user);
40.         }
41.         sheetEntities = new ArrayList<>(2);
42.         for (int i = 0; i < 2; i++) {
43.             SheetEntity<User> sheetEntity = new SheetEntity<>();
44.             sheetEntity.setSheetName(i + "号sheet");
45.             sheetEntity.setHead(User.class);
46.             sheetEntity.setData(users);
47.             sheetEntities.add(sheetEntity);
48.         }
49.     }
51.     /**
52.      * 单sheet页通过全路径文件名导出测试接口（也可以通过文件流导出）
53.      * 返回文件名，前端通过web路径+文件名下载文件
54.      */
55.     @GetMapping("/filePath")
56.     public String filePath() {
57.         String fileName = "用户.xlsx";
58.         String fullFileName = filePath + fileName;
59.         ExcelUtil.exportByEasyExcel(fullFileName, "用户", User.class, users);
60.         return fileName;
61.     }
63.     /**
64.      * 多sheet页通过文件流导出（也可以通过全路径文件名导出）
65.      */
66.     @GetMapping("/download")
67.     public void download(HttpServletResponse response) throws IOException {
68.         String fileName = "用户";
69.         response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
70.         response.setCharacterEncoding(StandardCharsets.UTF_8.name());
71.         String encodeFileName = URLEncoder.encode(fileName, "UTF-8").replaceAll("\\+", "%20");
72.         response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment;filename=*=utf-8''" + encodeFileName + ExcelTypeEnum.XLSX.getValue());
73.         ExcelUtil.exportByEasyExcel(response.getOutputStream(), ExcelTypeEnum.XLSX, sheetEntities);
74.     }
75. }

复制代码

9、application.yml中添加文件下载路径配置

1. download:
2.   #配置文件下载路径
3.   path: C:\Users\Administrator\Desktop
4. spring:
5.   web:
6.     resources:
7.       static-locations:
8.         #注册文件下载路径
9.         - file:${download.path}
10.         #系统默认配置
11.         - classpath:/META-INF/resources/
12.         - classpath:/resources/
13.         - classpath:/static/
14.         - classpath:/public/

复制代码

四、接口测试

1、启动项目

2、利用全路径文件名方式导出

• 访问接口地址：http://localhost:8080/user/filePath
  

• 访问下载文件地址：http://localhost:8080/用户.xlsx
  

3、利用文件流方式导出

• 访问接口地址：http://localhost:8080/user/download
  

五、总结

• 利用Entity对象作为关系映射的载体，利用@ExcelProperty注解映射属性名称，并可以指定转换器、序号等信息；利用@DateTimeFormat注解和指定转换器设置时间格式；利用自定义注解@DictSource注解和指定转换器转换字典值
  
• 利用@ColumnWidth或其同目录下的其他注解、WriteHandler设置Excel样式
  
• 利用全路径文件名、文件、文件流作为数据导出的载体导出数据。
  
• SpringBoot集成easyexcel数据导出案例下载
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。