简洁、快速、节约内存的Excel处理工具EasyExcel

欢迎光临我的博客查看最新文章: https://river106.cn

1、简介

EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。
他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。
EasyExcel基于POI进行封装优化，降低内存使用，再大的excel也不会出现内存溢出，让使用更加简单方便。

官网： https://easyexcel.opensource.alibaba.com/
github： https://github.com/alibaba/easyexcel

2、读取Excel

EasyExcel需引入如下依赖：

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

示例中还需引入其他依赖：

<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.8</version>
</dependency><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.60</version>
</dependency>

示例Excel表格demo1.xlsx如下：

读取Excel数据的对象：

@Data
@HeadRowHeight(20)
@ColumnWidth(20)
public class DemoData {@ExcelProperty("字符串标题")private String string;@ExcelProperty("日期标题")private Date date;@ExcelProperty("数字标题")private Double doubleData;@ExcelIgnoreprivate String ignore;
}

ExcelProperty注解：用于匹配excel和实体类；
ExcelIgnore注解：默认所有字段都会和excel去匹配，加了这个注解会忽略该字段；
HeadRowHeight注解：标注在类上，表头高
ColumnWidth注解：标注在类或字段上，列宽

@Slf4j
public class EasyExcelReadTest {@Testpublic void syncRead() {String fileName = "demo1.xlsx";// 这里需要指定读用哪个class去读，然后读取第一个sheet 同步读取会自动finishList<DemoData> list = EasyExcel.read(fileName).head(DemoData.class).sheet().doReadSync();for (DemoData data : list) {log.info("读取到数据:{}", JSON.toJSONString(data));}// 这里也可以不指定class，返回一个list，然后读取第一个sheet 同步读取会自动finishList<Map<Integer, String>> listMap = EasyExcel.read(fileName).sheet().doReadSync();for (Map<Integer, String> data : listMap) {// 返回每条数据的键值对 表示所在的列 和所在列的值log.info("读取到数据:{}", JSON.toJSONString(data));}}/*** 最简单的读*/@Testpublic void simpleRead() {// 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去// 写法1：String fileName = "demo1.xlsx";// 这里 需要指定读用哪个class去读，然后读取第一个sheet，文件流会自动关闭EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();// 写法2：try (ExcelReader excelReader = EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).build()) {// 构建一个sheet 这里可以指定名字或者noReadSheet readSheet = EasyExcel.readSheet(0).build();// 读取一个sheetexcelReader.read(readSheet);}}}

读监听器：

/*** 模板的读取类** 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去*/
@Slf4j
public class DemoDataListener extends AnalysisEventListener<DemoData> {/*** 每隔5条存储数据库，实际使用中可以1000条，然后清理list，方便内存回收*/private static final int BATCH_COUNT = 5;private List<DemoData> list = new ArrayList<>();private DemoService demoService;public DemoDataListener() {// 这里是demo，所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数demoService = new DemoService();}public DemoDataListener(DemoService demoService) {this.demoService = demoService;}/*** 这个每一条数据解析都会来调用** @param data* @param context*/@Overridepublic void invoke(DemoData data, AnalysisContext context) {log.info("解析到一条数据:{}", JSON.toJSONString(data));list.add(data);// 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOMif (list.size() >= BATCH_COUNT) {saveData();// 存储完成清理 listlist.clear();}}/*** 所有数据解析完成了都会来调用** @param context*/@Overridepublic void doAfterAllAnalysed(AnalysisContext context) {// 这里也要保存数据，确保最后遗留的数据也存储到数据库saveData();log.info("所有数据解析完成！");}/*** 加上存储数据库*/private void saveData() {log.info("{}条数据，开始存储数据库！", list.size());demoService.save(list);log.info("存储数据库成功！");}
}

业务层数据处理：

public class DemoService {public void save(List<DemoData> list) {// 这里写入数据库}
}

3、写入Excel

@Slf4j
public class EasyExcelWriteTest {@Testpublic void writeExcel() {EasyExcel.write("demo1.xlsx", DemoData.class).sheet("模板").doWrite(data());}private List<DemoData> data() {List<DemoData> list = new ArrayList<DemoData>();for (int i = 0; i < 10; i++) {DemoData data = new DemoData();data.setString("字符串" + i);data.setDate(new Date());data.setDoubleData(0.56);list.add(data);}return list;}
}

4、Web上传下载

@Controller
public class UploadDownController {@Autowiredprivate DemoService demoService;/*** 文件下载（失败了会返回一个有部分数据的Excel）*/@GetMapping("download")public void download(HttpServletResponse response) throws IOException {// 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postmanresponse.setContentType("application/vnd.ms-excel");response.setCharacterEncoding("utf-8");// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");EasyExcel.write(response.getOutputStream(), DemoData.class).sheet("模板").doWrite(data());}/*** 文件下载并且失败的时候返回json（默认失败了会返回一个有部分数据的Excel）** @since 2.1.1*/@GetMapping("downloadFailedUsingJson")public void downloadFailedUsingJson(HttpServletResponse response) throws IOException {// 这里注意有同学反应使用swagger会导致各种问题，请直接用浏览器或者用postmantry {response.setContentType("application/vnd.ms-excel");response.setCharacterEncoding("utf-8");// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");// 这里需要设置不关闭流EasyExcel.write(response.getOutputStream(), DemoData.class).autoCloseStream(Boolean.FALSE).sheet("模板").doWrite(data());} catch (Exception e) {// 重置responseresponse.reset();response.setContentType("application/json");response.setCharacterEncoding("utf-8");Map<String, String> map = new HashMap<String, String>();map.put("status", "failure");map.put("message", "下载文件失败" + e.getMessage());response.getWriter().println(JSON.toJSONString(map));}}/*** 文件上传*/@PostMapping("upload")@ResponseBodypublic String upload(MultipartFile file) throws IOException {EasyExcel.read(file.getInputStream(), DemoData.class, new DemoDataListener(demoService)).sheet().doRead();return "success";}private List<DemoData> data() {List<DemoData> list = new ArrayList<>();for (int i = 0; i < 10; i++) {DemoData data = new DemoData();data.setString("字符串" + 0);data.setDate(new Date());data.setDoubleData(0.56);list.add(data);}return list;}
}

Excel上传时，获取Excel数据，我们也可以封装个工具类ExcelUtils:

@Slf4j
public class ExcelUtils {public static <T> List<T> getExcelModelData(final InputStream inputStream, Class<T> clazz) {if (null == inputStream) {throw new NullPointerException("the inputStream is null!");}ExcelReaderBuilder result = EasyExcel.read(inputStream, clazz, null);ExcelReaderSheetBuilder sheet1 = result.sheet();List<T> resultData = sheet1.doReadSync();return resultData;}
}

上传的代码也可改为如下：

@PostMapping("upload")
@ResponseBody
public String upload(MultipartFile file) throws IOException {List<DemoData> excelModelData = ExcelUtils.getExcelModelData(file.getInputStream(), DemoData.class);demoService.save(excelModelData);return "success";
}

其他示例可参考：
EasyExcel Demo

API参考：
EasyExcel API

简洁、快速、节约内存的Excel处理工具EasyExcel相关推荐

Excel解析工具easyexcel全面探索
1. Excel解析工具easyexcel全面探索 1.1. 简介之前我们想到Excel解析一般是使用POI,但POI存在一个严重的问题,就是非常消耗内存.所以阿里人员对它进行了重写从而诞生了eas ...
wireshark合并多个文件_小技巧：快速合并多个excel文件（收藏版）
我们在日常工作或科研中,总会遇到需要汇总多个excel的情况,若仅仅是几个表格,大多人会直接复制,若有上百个表格呢? 那么小编就告诉大家一个稍微简洁一点的方法,将多个单独的excel表格快速合 ...
java excel 插件开发工具_程序员常用的15 种开发者工具推荐
程序员常用的15 种开发者工具推荐:Java 线上诊断工具 Arthas.IDE 插件 Cloud Toolkit.混沌实验注入工具 ChaosBlade.Java 代码规约扫描插件.应用实时监控工具 ...
Excel数据分析工具：PowerPivot
数据分析有三大作用: 现状分析原因分析预测分析大多数情况下,用Excel的数据透视表进行汇总分析即可,但数据量一大,Excel就跑不动了,那可以采用Access数据库和Microsoft Que ...
阿里出品Excel工具EasyExcel使用小结
前提笔者做小数据和「零号提数工具人」已经有一段时间,服务的对象是运营和商务的大佬,一般要求导出的数据是Excel文件,考虑到初创团队机器资源十分有限的前提下,选用了阿里出品的Excel工具EasyE ...
拨测工具_您可以拨多少钱？快速简单地介绍有用的工具。
拨测工具 by Miguel Bustamante 通过Miguel Bustamante 您可以卷曲多少? 快速简单地介绍有用的工具. (How much can you cURL? A quick ...
创建节约内存的JavaBean
点击上方"方志朋",选择"置顶公众号" 技术文章第一时间送达! 来源:http://u6.gg/swLPg 编写Java代码的时候,大多数情况下,我们很少关注一 ...
虚拟机常用的内存查看与分析工具
内存查看与分析工具,下面是日常监控可以使用的一些工具, 在调试时应用比较多的是堆栈信息,查看这篇文章: Java Thread Dump 性能分析 gc日志输出在jvm启动参数中加入 1 2 3 4 ...
「starter推荐」简单高效 Excel 导出工具
点击上方好好学java ,选择星标公众号重磅资讯.干货,第一时间送达今日推荐:牛人 20000 字的 Spring Cloud 总结,太硬核了~ 作者:冷冷gg 链接:https://jue ...