我去,还在这样读写 excel 这也太低效了吧,好办法来了
点击上方 好好学java ,选择 星标 公众号
重磅资讯、干货,第一时间送达
今日推荐:牛人 20000 字的 Spring Cloud 总结,太硬核了~
作者:楼下小黑哥
链接:https://www.cnblogs.com/goodAndyxublog/p/12683641.html
前言
博文地址:https://sourl.cn/SsD3AM
最近读者小 H 给小黑哥发来私信:
小黑哥,最近我在负责公司报表平台开发,需要导出报表到 excel 中。每次使用 POI 开发,都要写长长的一坨代码,好几次因为没加入判空判断,导致生成失败。想跟你请教下有没有更加高效一点读写 excel 方法?
使用过 poi 的开发同学可能都有此体会,每次都要写一坨代码,最后的代码如下面一样:
这样的代码是不是又臭又长?当字段数量多的时候,一不小心还容易写错。小黑哥还记得当初使用 poi 导出一个二十多字段的 excel,不断复制粘贴,行号一不小心就写错了,那叫个一个心酸。
今天小黑哥就来推荐一个阿里开源的项目『EasyExcel』,带大家彻底告别上面又长又臭的代码,彻底解决这个问题。
EasyExcel
EasyExcel 是一个阿里出品的开源项目 ,看名字就能看出这个项目是为了让你更加简单的操作 Excel。另外 EasyExcel 还解决了poi 内存溢出问题,修复了一些并发情况下一些 bug。
github 地址:https://github.com/alibaba/easyexcel
截止小黑哥写文章时,已有 13.6k star 数据,可见这个项目还是深受大家欢迎。
废话不多说,我们直接进入源码实战环节。
首先我们需要引入 EasyExcel pom 依赖:
<dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>2.1.6</version>
</dependency>
这里建议大家使用 2.0 以上的正式版本,不要再使用 1.0 的老版本,两者使用 API 差别很大。另外 beta 版本可能会存在某些 bug,大家谨慎使用。
普通方式
一行代码生成 Excel
// 写法1
String fileName = "temp/" + "test" + System.currentTimeMillis() + ".xlsx";
EasyExcel.write(fileName).head(head())// 设置表头.sheet("模板")// 设置 sheet 的名字// 自适应列宽.registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()).doWrite(dataList());// 写入数据
生成 excel 代码特别简单,这里使用链式语句,一行代码直接搞定生成代码。代码中再也不用我们指定行号,列号了。
上面代码中使用自适应列宽的策略。
下面我们来看下表头与标题如何生成。
创建表头
/*** 创建表头,可以创建复杂的表头** @return*/
private static List<List<String>> head() {List<List<String>> list = new ArrayList<List<String>>();// 第一列表头List<String> head0 = new ArrayList<String>();head0.add("第一列");head0.add("第一列第二行");// 第二列表头List<String> head1 = new ArrayList<String>();head1.add("第一列");head1.add("第二列第二行");// 第三列List<String> head2 = new ArrayList<String>();head2.add("第一列");head2.add("第三列第二行");list.add(head0);list.add(head1);list.add(head2);return list;
}
上面每个 List<String>
代表一列的数据,集合内每个数据将会顺序写入这列每一行。如果每一列的相同行数的内容相同,将会自动合并单元格。通过这个规则,我们创建复杂的表头。
最终创建表头如下:
写入表体数据
private static List dataList() {List<List<Object>> list = new ArrayList<List<Object>>();for (int i = 0; i < 10; i++) {List<Object> data = new ArrayList<Object>();data.add("点赞+" + i);// date 将会安装 yyyy-MM-dd HH:mm:ss 格式化data.add(new Date());data.add(0.56);list.add(data);}return list;
}
表体数据然后也是使用 List<List<Object>>
,但是与表头规则不一样。
每个 List<Object>
代表一行的数据,数据将会按照顺序写入每一列中。
集合中数据 EasyExcel 将会按照默认的格式化转换输出,比如 date
类型数据就将会按照 yyyy-MM-dd HH:mm:ss
格式化。
如果需要转化成其他格式,建议直接将数据格式化成字符串加入 List,不要通过 EasyExcel 转换。
最终效果如下:
看完这个是不是想立刻体验一下?等等,上面使用方式还是有点繁琐,使用 EasyExcel 还可以更快。我们可以使用注解方式,无需手动设置表头与表体。
注解方式
注解方式生成 Excel 代码如下:
String fileName = "temp/annotateWrite" + System.currentTimeMillis() + ".xlsx";
// 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板 然后文件流会自动关闭
// 如果这里想使用03 则 传入excelType参数即可
EasyExcel.write(fileName, DemoData.class).sheet("注解方式").registerWriteHandler(createTableStyle())// Excel 表格样式.doWrite(data());
这里代码与上面大体一致,只不过这里需要在 write
方法传入 DemoData
数据类型。EasyExcel 会根据 DemoData
类型自动生成表头。
下面我们来看下 DemoData
这个类到底内部到底是啥样?
@ContentRowHeight(30)// 表体行高
@HeadRowHeight(20)// 表头行高
@ColumnWidth(35)// 列宽
@Data
public class DemoData {/*** 单独设置该列宽度*/@ColumnWidth(50)@ExcelProperty("字符串标题")private String string;/*** 年月日时分秒格式*/@DateTimeFormat("yyyy年MM月dd日HH时mm分ss秒")@ExcelProperty(value = "日期标题")private Date date;/*** 格式化百分比*/@NumberFormat("#.##%")@ExcelProperty("数字标题")private Double doubleData;@ExcelProperty(value = "枚举类",converter = DemoEnumConvert.class)private DemoEnum demoEnum;/*** 忽略这个字段*/@ExcelIgnoreprivate String ignore;
}
DemoData
就是一个普通的 POJO
类,上面使用 ExayExcel 相关注解,ExayExcel 将会通过反射读取字段类型以及相关注解,然后直接生成 Excel 。
ExayExcel 提供相关注解类,直接定义 Excel 的数据模型:
@ExcelProperty
指定当前字段对应excel中的那一列,内部 value 属性指定表头列的名称@ExcelIgnore
默认所有字段都会和excel去匹配,加了这个注解会忽略该字段@ContentRowHeight
指定表体行高@HeadRowHeight
指定表头行高@ColumnWidth
指定列的宽度
另外 ExayExcel 还提供几个注解,自定义日期以及数字的格式化转化。
@DateTimeFormat
@NumberFormat
另外我们可以自定义格式化转换方案,需要实现 Converter
类相关方法即可。
public class DemoEnumConvert implements Converter<DemoEnum> {@Overridepublic Class supportJavaTypeKey() {return DemoEnum.class;}@Overridepublic CellDataTypeEnum supportExcelTypeKey() {return CellDataTypeEnum.STRING;}/*** excel 转化为 java 类型,excel 读时将会被调用* @param cellData* @param contentProperty* @param globalConfiguration* @return* @throws Exception*/@Overridepublic DemoEnum convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {return null;}/*** java 类型转 excel 类型,excel 写时将会被调用* @param value* @param contentProperty* @param globalConfiguration* @return* @throws Exception*/@Overridepublic CellData convertToExcelData(DemoEnum value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {return new CellData(value.getDesc());}
}
最后我们还需要在 @ExcelProperty
注解上使用 converter
指定自定义格式转换方案。
使用方式如下:
@ExcelProperty(value = "枚举类",converter = DemoEnumConvert.class)
private DemoEnum demoEnum;
最后我们运行一下,看下 Excel 实际效果如何:
怎么样,效果还是可以吧。
对了,默认的样式表格样式可不是这样,这个效果是因为我们在 registerWriteHandler
方法中设置自定义的样式,具体代码如下:
/**** 设置 excel 的样式* @return*/
private static WriteHandler createTableStyle() {// 头的策略WriteCellStyle headWriteCellStyle = new WriteCellStyle();// 背景设置为红色headWriteCellStyle.setFillForegroundColor(IndexedColors.PINK.getIndex());// 设置字体WriteFont headWriteFont = new WriteFont();headWriteFont.setFontHeightInPoints((short) 20);headWriteCellStyle.setWriteFont(headWriteFont);// 内容的策略WriteCellStyle contentWriteCellStyle = new WriteCellStyle();// 这里需要指定 FillPatternType 为FillPatternType.SOLID_FOREGROUND 不然无法显示背景颜色.头默认了 FillPatternType所以可以不指定contentWriteCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);// 背景绿色contentWriteCellStyle.setFillForegroundColor(IndexedColors.LEMON_CHIFFON.getIndex());WriteFont contentWriteFont = new WriteFont();// 字体大小contentWriteFont.setFontHeightInPoints((short) 20);contentWriteCellStyle.setWriteFont(contentWriteFont);// 设置边框的样式contentWriteCellStyle.setBorderBottom(BorderStyle.DASHED);contentWriteCellStyle.setBorderLeft(BorderStyle.DASHED);contentWriteCellStyle.setBorderRight(BorderStyle.DASHED);contentWriteCellStyle.setBorderTop(BorderStyle.DASHED);// 这个策略是 头是头的样式 内容是内容的样式 其他的策略可以自己实现HorizontalCellStyleStrategy horizontalCellStyleStrategy =new HorizontalCellStyleStrategy(headWriteCellStyle, contentWriteCellStyle);return horizontalCellStyleStrategy;
}
使用注意点
poi 冲突问题
理论上当前 easyexcel
兼容支持 poi 的3.17
,4.0.1
,4.1.0
所有较新版本,但是如果项目之前使用较老版本的 poi,由于 poi 内部代码调整,某些类已被删除,这样直接运行时很大可能会抛出以下异常:
NoSuchMethodException
ClassNotFoundException
NoClassDefFoundError
所以使用过程中一定要注意统一项目中的 poi 的版本。
非注解方式自定义行高列宽
非注解方式自定义行高以及列宽比较麻烦,暂时没有找到直接设置的入口。查了一遍 github 相关 issue,开发人员回复需要实现 WriteHandler
接口,自定义表格样式。
总结
本文主要给各位小伙伴们安利 EasyExcel 强大的功能,介绍 EasyExcel 两种生成 excel 方式,以及演示相关的示例代码。EasyExcel 除了写之外,当然还支持快读读取 Excel 的功能,这里就不再详细介绍。Github 上相关文档例子非常丰富,大家可以自行参考。
Github 文档地址:https://alibaba-easyexcel.github.io/index.html
Reference
https://github.com/alibaba/easyexcel
https://alibaba-easyexcel.github.io/index.html
https://cloud.tencent.com/developer/article/1431888
我去,还在这样读写 excel 这也太低效了吧,好办法来了相关推荐
- .NET读写Excel工具Spire.Xls使用(1)入门介绍
原文:[原创].NET读写Excel工具Spire.Xls使用(1)入门介绍 在.NET平台,操作Excel文件是一个非常常用的需求,目前比较常规的方法有以下几种: 1.Office Com组件的方式 ...
- 数据分析从零开始实战,Pandas读写Excel/XML数据
点击查看第一篇文章: 数据分析从零开始实战,Pandas读取HTML页面+数据处理解析_ 数据分析 从零开始到实战,Pandas读写CSV数据_ 数据分析 从零开始到实战,Pandas读写CSV数据 ...
- python怎么读excelsheet_python3 excle(python怎么读写excel文件)
python读取已经打开的3个word和excle文件的路径 用 win32com 操控 word和Excel就可以实现 咋样把python写入excle中 # 需安装 xlrd-0.9.2 和 xl ...
- C++读写EXCEL文件方式比较 .
C++读取Excel的XLS文件的方法有很多,但是也许就是因为方法太多,大家在选择的时候会很疑惑. 由于前两天要做导表工具,比较了常用的方法,总结一下写个短文, 1.OLE的方式 这个大约是最常用的方 ...
- 【原创】.NET读写Excel工具Spire.Xls使用(4)对数据操作与控制
本博客所有文章分类的总目录:http://www.cnblogs.com/asxinyu/p/4288836.html .NET读写Excel工具Spire.Xls使用文章 ...
- Java程序利用POJ读写Excel的.xls或.xlsx文件所需的3个jar包
Java程序利用POJ读写Excel文件时,不能只用poi的jar包,因为它还依赖于xmlbeans的jar包,xmlbeans又以来与common-collections的jar包,因此,正常使用P ...
- Python使用openpyxl模块读写excel文件
Python使用openpyxl模块读写excel文件 openpyxl是一个用于写入和读取xlsx格式的excel文件的Python模块. excel2010后的后缀名为xlsx,不再是xls,使用 ...
- python怎么读写文件-python3 excle(python怎么读写excel文件)
python读取已经打开的3个word和excle文件的路径 用 win32com 操控 word和Excel就可以实现 咋样把python写入excle中 # 需安装 xlrd-0.9.2 和 xl ...
- Java读写Excel原来这么简单
前言 相信现在很多搞后端的同学大部分做的都是后台管理系统,那么管理系统就肯定免不了 Excel 的导出导入功能,今天我们就来介绍一下 Java 如何实现 Excel 的导入导出功能. Java领域解析 ...
最新文章
- usaco A game
- 活动报名 | 新国立尤洋:FastFold——将AlphaFold训练时间从11天减少到67小时
- 智源沙龙 | 人工智能“3个30年”之后,下个30年将走向何方?
- GDC-Client使用
- STM32 基础系列教程 43 – SRAM
- DateOnly和TimeOnly类型居然不能序列化!!! .Net 6下实现自定义JSON序列化
- Redis(案例五:Set数据)
- python怎么向列表中添加内容_Python中向List添加元素方法
- Java 学习多态笔记
- Django在根据models生成数据库表时报 __init__() missing 1 required positional argument: 'on_delete'...
- BlackBone工具集合:注入、hook、驱动程序
- vue 萤石云视频监控对接
- Android Facebook登录、分享;ins分享
- Chrome 谷歌浏览器将整个网页保存为图片
- 亚马逊测评日记: 亚马逊自养号是什么意思?测评的风险?review和feedback、rating星级评分的区别?
- HttpClient模拟登陆并获取指定页面的内容
- Quorum工作原理
- 浅谈Google三篇大数据论文
- 2021年第四季度全球消费者信心总体持平,印度仍为全球最高,中国大幅增长,日本仍远低于全球平均水平 | 美通社头条...
- 是面试官放水,还是实在公司太缺人?这都没挂,阿里巴巴原来这么容易进...
热门文章
- node.js入门 - 12.api:进程(process)
- 练习2: Python基本图形绘制 (第2周)
- qt 编译mysql wince_Qt4.8.6开发WinCE 5.0环境搭建
- 石墨烯区块链(2)核心功能
- (chap9 基于HTTP的功能追加协议) HTTP瓶颈
- (chap6 Http首部) 为Cookie服务的首部字段
- eclipse集成lombok了但是无法使用_编码神奇Lombok!搭配IDEA更爽哦!
- WIN10 关闭驱动签名
- c++ lambda基本语法
- C#获取一些常用目录