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

news/2025/3/19 20:47:35/文章来源:https://www.cnblogs.com/sanxiaolq/p/18502691

一、前言

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

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

二、业务流程

​ 介绍数据导出业务流程之前，先梳理下数据导出，什么是数据导出，为什么需要数据导出？

​ 我们都知道数据存储在数据库中，数据库中的数据可以通过前端页面或者APP呈现给使用者，其实通过excel将数据导出也是一种呈现方式，而且可以通过excel对数据做更复杂的处理。

​ 前面说了，excel导出和前端页面、APP一样都是一种呈现方式，所以前端页面和APP在将数据呈现给用户的过程中遇到的问题，像属性转换（数据库存储的name，要呈现给使用者名称）、字典转换（数据库存储的1/0，要呈现给使用者启用/停用）等等问题，excel导出一样会遇到。下面介绍下数据呈现必须要经过业务流程

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

三、实现

1、引入easyexcel、fastjson、lombok包

<!--easy excel-->
<dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>4.0.3</version>
</dependency>
<!--fastjson-->
<dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.46</version>
</dependency>
<!--工具-->
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.0</version>
</dependency>

2、创建Json工具类

package com.yu.demo.tools;import com.alibaba.fastjson.JSON;
import com.fasterxml.jackson.core.type.TypeReference;import java.lang.reflect.Type;
import java.util.Map;/*** JSON工具类** @author admin*/
public abstract class JsonUtil {private JsonUtil() {}public final static Type MAP_INTEGER_STRING = new TypeReference<Map<Integer, String>>() {}.getType();/*** json串转Map(Map的value类型一致时使用)** @param jsonString json串* @return 对象*/public static <K, V> Map<K, V> json2Map(String jsonString, Type type) {return JSON.parseObject(jsonString, type);}}

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

package com.yu.demo.tools;import java.lang.annotation.*;@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DictSource {/*** 字典类型主键*/String dictTypeId() default "";/*** 字典内容json串*/String dictContentJson() default "";}

4、创建字典转换实现类

package com.yu.demo.tools;import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.GlobalConfiguration;
import com.alibaba.excel.metadata.data.WriteCellData;
import com.alibaba.excel.metadata.property.ExcelContentProperty;
import org.apache.poi.util.StringUtil;import java.lang.reflect.Field;
import java.util.Map;public class IntegerDictConverter implements Converter<Integer> {@Overridepublic CellDataTypeEnum supportExcelTypeKey() {return CellDataTypeEnum.STRING;}@Overridepublic WriteCellData<?> convertToExcelData(Integer value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {//属性值为空时，直接返回if (value == null) {//为空时的处理，与前端展示保持一致即可return new WriteCellData<>("");}//获取添加@ExcelProperty注解且converter = IntegerDictConverter.class的属性Field field = contentProperty.getField();//获取该属性的DictConverter注解信息DictSource dictSource = field.getAnnotation(DictSource.class);//配置了converter = IntegerDictConverter.class的属性，但是没有添加DictSource注解的直接返回if (dictSource == null) {return new WriteCellData<>(String.valueOf(value));}//获取配置的dictTypeIdString dictTypeId = dictSource.dictTypeId();//获取配置的dictContentJsonString dictContentJson = dictSource.dictContentJson();//判断dictTypeId是否为空boolean nullDictType = StringUtil.isBlank(dictTypeId);//判断nullDictContentJson是否为空boolean nullDictContentJson = StringUtil.isBlank(dictContentJson);//字典配置都为空时，将属性值转为字符串直接返回if (nullDictType && nullDictContentJson) {return new WriteCellData<>(String.valueOf(value));}//优先使用dictTypeId处理转换if (!nullDictType) {//通过dictTypeId获取字典内容集合：List<DictContent> dictContents = dictContentService.listByDictTypeId(dictTypeId);//主键是数值的，将dictTypeId转为数值//遍历字典内容，匹配属性值与字典值：value.equals(dictContent.getValue())//匹配成功后获取字典名称返回：return new WriteCellData<>(dictContent.getName());//如果没有匹配成功使用dictContentJson处理转换}if (!nullDictContentJson) {Map<Integer, String> dictContentMap = JsonUtil.json2Map(dictContentJson, JsonUtil.MAP_INTEGER_STRING);String cnName = dictContentMap.get(value);if (StringUtil.isNotBlank(cnName)) {return new WriteCellData<>(cnName);}}//没有转换成功时使用默认属性值return new WriteCellData<>(String.valueOf(value));}
}

5、创建数据对象类

package com.yu.demo.web.easyexcel.entity;import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.format.DateTimeFormat;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.converters.date.DateStringConverter;
import com.yu.demo.web.easyexcel.component.DictSource;
import com.yu.demo.web.easyexcel.component.IntegerDictConverter;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;import java.util.Date;@Setter
@Getter
@ToString
//类上添加@ExcelIgnoreUnannotated时，属性没有@ExcelProperty注解时不导出
//类上未添加@ExcelIgnoreUnannotated，属性没有@ExcelProperty注解时也导出
@ExcelIgnoreUnannotated
public class User {/*** 名称*/@ExcelProperty("名称")private String name;/*** 密码* 类添加@ExcelIgnoreUnannotated，属性未添加@ExcelProperty，不导出*/private String password;/*** 生日* 日期样式处理* 1.使用@DateTimeFormat设置导出样式* 2.使用DateStringConverter处理导出*/@DateTimeFormat("yyyy-MM-dd HH:mm:ss")@ExcelProperty(value = "生日", converter = DateStringConverter.class)private Date birthday;/*** 性别* 字典转换处理*/@ColumnWidth(7)//指定列宽度，优先级高于LongestMatchColumnWidthStyleStrategy@ExcelProperty(value = "性别", converter = IntegerDictConverter.class)@DictSource(dictContentJson = "{0:'女',1:'男',2:'保密'}")private Integer sex;}

6、创建多sheet页封装对象

package com.yu.demo.tools;import lombok.Getter;
import lombok.Setter;
import lombok.ToString;import java.util.List;/*** excel导入导出数据对象*/
@Setter
@Getter
@ToString
public class SheetEntity<T> {/*** sheet页名称（导出参数）* 可以为空，为空时，单sheet页没有名称，多sheet页序号为名称*/private String sheetName;/*** 数据类型（导入导出参数）*/private Class<T> head;/*** 数据（导出参数）*/private List<T> data;}

7、创建Excel导出工具类

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

  • 通过全路径文件名导出，easyexcel通过全路径文件名创建文件，将数据写入文件，当路径不存在时报错，适合场景：一次导出，多次下载
  • 通过文件导出，将数据写入文件，当路径不存在报错，适合场景：一次导出，多次下载
  • 通过输出流导出，将数据写入输出流，适合场景：导出一次下载一次
package com.yu.demo.tools;import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.alibaba.excel.write.builder.ExcelWriterBuilder;
import com.alibaba.excel.write.handler.WriteHandler;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.style.WriteCellStyle;
import com.alibaba.excel.write.style.HorizontalCellStyleStrategy;
import com.alibaba.excel.write.style.column.LongestMatchColumnWidthStyleStrategy;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.VerticalAlignment;
import org.apache.poi.util.StringUtil;import java.io.File;
import java.io.OutputStream;
import java.util.List;/*** excel导入导出工具类（easyExcel实现）* easyPoi：并发量和数据量都不大时推荐，定制化的导出支持非常的丰富* easyExcel：高并发、大数据量时推荐*/
public abstract class ExcelUtil {// 设置居中对齐的样式private static final WriteCellStyle CONTENT_WRITE_CELL_STYLE;private static final WriteHandler HORIZONTAL_CELL_STYLE_STRATEGY;static {CONTENT_WRITE_CELL_STYLE = new WriteCellStyle();//水平居中CONTENT_WRITE_CELL_STYLE.setHorizontalAlignment(HorizontalAlignment.CENTER);//垂直居中CONTENT_WRITE_CELL_STYLE.setVerticalAlignment(VerticalAlignment.CENTER);HORIZONTAL_CELL_STYLE_STRATEGY = new HorizontalCellStyleStrategy(null, CONTENT_WRITE_CELL_STYLE);}private ExcelUtil() {}/*** 使用EasyExcel导出** @param fullFileName 文件路径+文件名+后缀（文件已存在时覆盖）* @param sheetName    sheet名称（为空时使用默认值0）* @param head         数据类型（为空时没有表头，只有数据）* @param exportData   需要导出的数据（为空时，没有数据）*/public static void exportByEasyExcel(String fullFileName, String sheetName, Class<?> head, List<?> exportData) {File targetFile = new File(fullFileName);// 判断文件父目录是否存在if (!targetFile.getParentFile().exists()) {boolean mkdirResult = targetFile.getParentFile().mkdirs();if (!mkdirResult) {return;}}ExcelWriterBuilder excelWriterBuilder = EasyExcel.write(targetFile, head);if (fullFileName.endsWith(ExcelTypeEnum.XLS.getValue())) {excelWriterBuilder.excelType(ExcelTypeEnum.XLS);} else if (fullFileName.endsWith(ExcelTypeEnum.CSV.getValue())) {excelWriterBuilder.excelType(ExcelTypeEnum.CSV);} else {excelWriterBuilder.excelType(ExcelTypeEnum.XLSX);}excelWriterBuilder//设置列按最大长度调整.registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())//设置水平垂直居中.registerWriteHandler(HORIZONTAL_CELL_STYLE_STRATEGY).sheet(sheetName).doWrite(exportData);}/*** 使用EasyExcel导出** @param outputStream 输出流* @param sheetName    sheet名称（为空时使用默认值0）* @param head         数据类型（为空时没有表头，只有数据）* @param exportData   需要导出的数据（为空时，没有数据）*/public static void exportByEasyExcel(OutputStream outputStream, ExcelTypeEnum excelType, String sheetName, Class<?> head, List<?> exportData) {EasyExcel.write(outputStream, head).excelType(excelType)//设置列按最大长度调整，非线程安全，每次都需要new.registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())//设置水平垂直居中.registerWriteHandler(HORIZONTAL_CELL_STYLE_STRATEGY).sheet(sheetName).doWrite(exportData);}/*** 使用EasyExcel导出多sheet页数据** @param outputStream  输出流* @param sheetEntities 导出数据对象集合*/public static void exportByEasyExcel(OutputStream outputStream, ExcelTypeEnum excelType, List<SheetEntity<?>> sheetEntities) {ExcelWriterBuilder excelWriterBuilder = EasyExcel.write(outputStream).excelType(excelType);writeSheets(excelWriterBuilder, sheetEntities);}private static void writeSheets(ExcelWriterBuilder excelWriterBuilder, List<SheetEntity<?>> sheetEntities) {excelWriterBuilder.registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()).registerWriteHandler(HORIZONTAL_CELL_STYLE_STRATEGY);ExcelWriter excelWriter = excelWriterBuilder.build();for (int i = 0; i < sheetEntities.size(); i++) {SheetEntity<?> sheetEntity = sheetEntities.get(i);Class<?> head = sheetEntity.getHead();List<?> exportData = sheetEntity.getData();String sheetName = StringUtil.isBlank(sheetEntity.getSheetName()) ? String.valueOf(i + 1) : sheetEntity.getSheetName();WriteSheet writeSheet = EasyExcel.writerSheet(i + 1, sheetName).head(head).build();excelWriter.write(exportData, writeSheet);}excelWriter.finish();}}

8、创建测试类

package com.yu.demo.web.easyexcel.web;import com.alibaba.excel.support.ExcelTypeEnum;
import com.yu.demo.web.easyexcel.entity.SheetEntity;
import com.yu.demo.web.easyexcel.entity.User;
import com.yu.demo.web.easyexcel.util.ExcelUtil;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpHeaders;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.annotation.PostConstruct;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;@RestController
@RequestMapping("user")
public class UserController {@Value("${download.path}")private String filePath;private List<User> users;private List<SheetEntity<?>> sheetEntities;@PostConstructpublic void init() {users = new ArrayList<>(5);for (int i = 0; i < 5; i++) {User user = new User();user.setName(i + "号用户");user.setPassword(String.valueOf(i * 1000));user.setBirthday(new Date());user.setSex(i % 3);users.add(user);}sheetEntities = new ArrayList<>(2);for (int i = 0; i < 2; i++) {SheetEntity<User> sheetEntity = new SheetEntity<>();sheetEntity.setSheetName(i + "号sheet");sheetEntity.setHead(User.class);sheetEntity.setData(users);sheetEntities.add(sheetEntity);}}/*** 单sheet页通过全路径文件名导出测试接口（也可以通过文件流导出）* 返回文件名，前端通过web路径+文件名下载文件*/@GetMapping("/filePath")public String filePath() {String fileName = "用户.xlsx";String fullFileName = filePath + fileName;ExcelUtil.exportByEasyExcel(fullFileName, "用户", User.class, users);return fileName;}/*** 多sheet页通过文件流导出（也可以通过全路径文件名导出）*/@GetMapping("/download")public void download(HttpServletResponse response) throws IOException {String fileName = "用户";response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");response.setCharacterEncoding(StandardCharsets.UTF_8.name());String encodeFileName = URLEncoder.encode(fileName, "UTF-8").replaceAll("\\+", "%20");response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment;filename=*=utf-8''" + encodeFileName + ExcelTypeEnum.XLSX.getValue());ExcelUtil.exportByEasyExcel(response.getOutputStream(), ExcelTypeEnum.XLSX, sheetEntities);}
}

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

download:#配置文件下载路径path: C:\Users\Administrator\Desktop
spring:web:resources:static-locations:#注册文件下载路径- file:${download.path}#系统默认配置- classpath:/META-INF/resources/- classpath:/resources/- classpath:/static/- classpath:/public/

四、接口测试

1、启动项目

启动项目

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

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

访问接口地址

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

访问下载文件地址

3、使用文件流方式导出

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

访问接口地址

五、总结

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

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/821730.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

python-help()获取关于对象的帮助信息

python-help()获取关于对象的帮助信息

help(len)
阅读更多...
bypass waf测试_rce

bypass waf测试_rce

前言 以下验证绕过效果都使用开源雷池waf 知己知彼百战百胜，想bypass waf还是得先了解waf waf是什么 WAF（WebApplicationFirewall，WEB应用防火墙）会过滤和监测 Web 应用程序与互联网之间的 HTTP/HTTPS 流量，以此来保护 Web 应用程序安全。它通常会保护 Web 应用程序免受各…
阅读更多...
如何炼就 AI 原住民的“自我修养”丨通义灵码走进北京大学创新课堂

如何炼就 AI 原住民的“自我修养”丨通义灵码走进北京大学创新课堂

AI时代的到来已成为不争的事实，当代大学生及年轻一代正成为这一新时代的原住民。10 月 11 日晚，通义灵码走进北京大学信息科学技术学院第二十六期“知存讲座”，阿里巴巴通义实验室算法专家、通义灵码算法负责人黎槟华先生受邀进行了以“AI 时代原住民的成长之路”为主题的报…
阅读更多...
安娜的档案zlibrary24h搜书电子书免费下载网站推荐

安娜的档案zlibrary24h搜书电子书免费下载网站推荐

安娜的档案(Anna’s Archive) “安娜的档案(Anna’s Archive)”是一个影子图书馆搜索引擎，它保存了世界上大约5%的书籍资源，包含书籍、论文、漫画和杂志等多种类型。该网站使用完全免费，用户可以在筛选功能里挑选语言版本和文件格式，资源字符清晰，质量较高。此外，“安娜的…
阅读更多...
实验三 C语言函数应用编程

实验三 C语言函数应用编程

一、实验目的能正确使用C语法规则定义，声明，调用函数 能正确编写递归函数 针对具体问题场景，合理抽象出独立的功能模块，正确定义函数并使用，使得代码更具可读性，可维护性 针对具体问题场景，能正确，合理使用全局变量和局部static变量，解决实际问题 二、实验准备1，函数…
阅读更多...
还不知道怎么做报表？一文教会你简单还免费的报表制作方法

还不知道怎么做报表？一文教会你简单还免费的报表制作方法

在当今数据驱动的商业环境中，报表制作已经成为企业管理和决策中不可或缺的部分。然而，许多人面对复杂的报表制作流程可能感到无从下手。幸运的是，本文将教你如何一款完全免费的报表工具——山海鲸报表，无论你是初学者还是数据分析的老手，这篇文章都能帮你掌握快速上手、简…
阅读更多...
HarmonyOS：给您的应用添加通知（2）

HarmonyOS：给您的应用添加通知（2）

★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★➤博客园地址：为敢技术（https://www.cnblogs.com/strengthen/ ）➤GitHub地址：https://github.com/strengthen➤原文地址：https://www.cnblogs.com/strengthen/p/18502243➤如果链接不是为敢技术的博…
阅读更多...
家谱树题解

家谱树题解

(ACM比赛时忘了拓扑怎么写时代尻古) 假设有一个 DAG 图，那么如何写出它的拓扑排序呢？这里说一种比较常用的方法： 1.从 DAG 图中选择一个没有前驱（即入度为0）的顶点并输出。 2.从图中删除该顶点和所有以它为起点的有向边。 3.重复 1 和 2 直到当前的 DAG 图为空或当前图中不…
阅读更多...
♿交换序列题解♿

♿交换序列题解♿

以下将状态 \(K\)，\(E\)，\(Y\) 用数字0,1,2表示。考虑 \(dp\) 我们设 \(dp[a][b][c][d]\) 表示 \(K\) 用了 \(a\) 次，\(E\) 用了 \(b\) 次，\(Y\) 用了 \(c\) 次，总共交换了 \(d\) 次， 前缀和 $sum[i][j] $表示到第 \(j\) 位有几个字母 \(i\) 记录一个 \(loc[i][j]\)表示第…
阅读更多...
鸿蒙NEXT应用上架与分发步骤详解

鸿蒙NEXT应用上架与分发步骤详解

大家好，我是 V 哥。今天的文章来聊一聊HarmonyOS NEXT应用上架。当你开发、调试完HarmonyOS应用/元服务，就可以前往AppGallery Connect申请上架，华为审核通过后，用户即可在华为应用市场获取您的HarmonyOS应用/元服务。 HarmonyOS会通过数字证书与Profile文件等签名信息来保…
阅读更多...
云端软件对企业管理有什么好处

云端软件对企业管理有什么好处

云端软件对企业管理有以下好处：一、提高信息共享与协作效率；二、降低IT成本与维护难度；三、增强数据安全与备份能力；四、实时监控与分析业务数据；五、提升企业管理灵活性与可扩展性。提高信息共享与协作效率源于云端软件打破了传统办公的地域和时间限制。一、提高信息共享…
阅读更多...
HTML(网页)打包EXE软件的一机一码网络验证(生成卡密)使用说明和介绍

HTML(网页)打包EXE软件的一机一码网络验证(生成卡密)使用说明和介绍

HTML(网页)打包EXE软件1.9.97版本中, 新增了网络验证功能, 它可以给打包生成的EXE文件添加网络验证功能, 即添加卡密, 打包后的EXE文件用户首次打开使用时, 会提示需要输入激活码(卡密), 输入正确后才可以正常使用. 本文主要介绍该功能如何使用HTML转EXE的网络验证使用步骤说明…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023