一、 介绍
Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，一个3M的excel用POI sax解析依然需要100M左右内存，改用easyexcel可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便
版本支持
2+版本支持Java7&Java6
3+版本支持Java8
详细了解可以点击官网文档查阅
个人依赖：
com.alibaba
easyexcel
2.1.6
org.slf4j
slf4j-log4j12
1.7.30
二、 读Excel
Excel：
对象：
@Data
public class Question1 {
private String id; //题目ID
private String companyId; //所属企业
private String catalogId; //题目所属目录ID
}
监视器：
| 名称 | 说明 |
|---|---|
| AnalysisEventListener |
分析事件侦听器：接收解析的每条数据的返回 |
| SyncReadListener | 同步读取侦听器 |
| AbstractIgnoreExceptionReadListener | 抽象忽略异常读取侦听器 |
| ModelBuildEventListener | 模型构建事件侦听器 |
AnalysisEventListener
所有已实现的接口:Listener、ReadListener
直接已知子类:SyncReadListener
| 方法 | 返回值类型 | 说明 |
|---|---|---|
| boolean | hasNext | 验证是否有另一条数据。您可以通过返回 false 来停止读取 |
| void | invokeHead | 分析第一行时触发调用函数 |
| void | invokeHeadMap | 以map的形式放回表头，覆盖当前方法以接收表头数据 |
| void | onException | 当任何一个监听器进行错误报告时，所有监听器都会收到此方法 |
代码：
private static void read2() {
final List list = new ArrayList();
//使用EasyExcel读取test1.xlsx文件
EasyExcel.read("../test/test1.xlsx", Question1.class, new AnalysisEventListener() {
//重写子类方法
@Override
public void invoke(Question1 question1, AnalysisContext analysisContext) {
list.add(question1);
}
//重写子类方法
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
}
@Override
public void invokeHeadMap(Map headMap, AnalysisContext context) {
System.out.println(headMap);
}
}
).doReadAll();
//获取读取到的数据
for (Object o : list) {
Question1 question1 = (Question1) o;
System.out.println(question1);
}
}
结果视图：
SyncReadListener
所有已实现的接口:Listener、ReadListener
直接已知父类：AnalysisEventListener
| 方法 | 返回值类型 | 说明 |
|---|---|---|
| void | doAfterAllAnalysed | 如果有什么操作在全部分析结束后执行 |
| List | getList | |
| void | invoke | 当分析一行触发器调用函数 |
| void | setList(List |
代码：
private static void read1() {
final List list = new ArrayList();
//使用EasyExcel读取test1.xlsx文件
EasyExcel.read("../test/test1.xlsx", Question1.class, new SyncReadListener() {
//EasyExcel在读取excel表格时，每读取到一行，就会调用一次这个方法，
//并且将读取到的行数据，封装到指定类型（Question1）的对象中，传递给我们（Object object）
/*
此问题可能出现在低版本的easyExcel中，出现时可以按照下列方式解决
如果表格数据不是顶行写的，需要通过headRowNumber指定表头行的数量
如果表格数据不是顶列写的，需要在封装的实体属性上通过@ExcelProperty将实体属性和表格列名进行对应
*/
@Override
public void invoke(Object object, AnalysisContext context) {
// System.out.println(object);
list.add(object);
}
}).doReadAll();
//获取读取到的数据
for (Object o : list) {
Question1 question1 = (Question1) o;
System.out.println(question1);
}
}
解决方式
//index属性指定当前这个对应的是表格中哪个索引的列，表格中的索引是从0开始的
/**
* 强制读取第三个 这里不建议 index 和 name 同时用，要么一个对象只用index，要么一个对象只用name去匹配
*/
@ExcelProperty(index = 2)
private String catalogId; //题目所属目录ID
/**
* 用名字去匹配，这里需要注意，如果名字重复，会导致只有一个字段读取到数据
*/
@ExcelProperty("题目id")
private String id; //题目ID
@ExcelProperty("企业id")
private String companyId; //所属企业
三、 写Excel （比较常用）
3.1、简单入门
private static void write() {
List list = new ArrayList();
list.add(new Question1("1", "1", "1"));
list.add(new Question1("2", "1", "1"));
list.add(new Question1("3", "1", "1"));
1.
EasyExcel
.write("test/test_w.xlsx", Question1.class)
.sheet()
.doWrite(list);
2.
ExcelWriter excelWriter = null;
try {
excelWriter = EasyExcel.write("test/test_w.xlsx", Question1.class).build();
WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
excelWriter.write(list, writeSheet);
} finally {
// 千万别忘记finish 会帮忙关闭流
if (excelWriter != null) {
excelWriter.finish();
}
}
}
3.2、 指定写入的列
添加该实体列的注释就可以实现如下：
@ExcelProperty(value = "题目id", index = 0)
private String id; //题目ID
@ExcelProperty(value = "企业id", index = 1)
private String companyId; //所属企业
@ExcelProperty(value = "类目id", index = 3)
private String catalogId; //题目所属目录ID
3.2、 复杂表头
添加该实体列的注释就可以实现如下：
@ExcelProperty({"主标题", "题目id"})
private String id; //题目ID
@ExcelProperty({"主标题", "企业id"})
private String companyId; //所属企业
@ExcelProperty({"主标题", "类目id"})
private String catalogId; //题目所属目录ID
3.3、 列宽 行高
添加该实体列的注释就可以实现如下：
@Data
@HeadRowHeight(30) //表头行高
@ContentRowHeight(20) //数据行高
@ColumnWidth(25) //列宽
public class Question1 {
@ExcelProperty({"题目id"})
private String id; //题目ID
@ExcelProperty({"企业id"})
private String companyId; //所属企业
//局部定义
@ColumnWidth(50)
@ExcelProperty({"类目id"})
private String catalogId; //题目所属目录ID
}
-
自定义列宽 行高
三、填充Excel
3.1、基于模板填充表格数据
- 写出多条记录
private static void write_template_multi() {
List list = new ArrayList();
list.add(new Question1("1", "1", "1"));
list.add(new Question1("2", "1", "1"));
list.add(new Question1("3", "1", "1"));
EasyExcel
.write("../test/test_w.xlsx", Question1.class)
.withTemplate("../test/test_template.xlsx")
.sheet()
.doFill(list);
}
-
多条数据
2.写出一条记录
private static void write_template_one() {
EasyExcel
.write("test/test_w.xlsx", Question1.class)
.withTemplate("test/test_template_one.xlsx")
.sheet()
.doFill(new Question1("1", "1", "1"));
}
-
一条数据
添加一条数据与添加多条数据的差别如下：
模板中参数中的前是否有.，若有则能多或单条条数据写入；否则只允许单条数据写入
-
一条模板
-
多条模板
3.1、复杂的填充
private static void write_template_multi_one() {
List list = new ArrayList();
list.add(new Question1("1", "1", "1"));
list.add(new Question1("2", "1", "1"));
list.add(new Question1("3", "1", "1"));
ExcelWriterBuilder writerBuilder = EasyExcel
.write("../test/test_w.xlsx", Question1.class)
.withTemplate("../test/test_template_mul_one.xlsx");
WriteSheet writeSheet = writerBuilder.sheet().build();
ExcelWriter excelWriter = writerBuilder.build();
//在填充玩多结果数据后，要强制换行，不然后续的单结果数据会发生覆盖现象
FillConfig fillConfig = FillConfig.builder().forceNewRow(true).build();
excelWriter.fill(list, fillConfig, writeSheet);
Map map = new HashMap();
map.put("total", 600);
excelWriter.fill(map, writeSheet);
//调用finish方法
excelWriter.finish();
}
四、常见API
4.1、关于常见类解析
| 类名 | 说明 |
|---|---|
| EasyExcel | 入口类，用于构建开始各种操作 |
| ExcelReaderBuilder ExcelWriterBuilder | 构建出一个 ReadWorkbook WriteWorkbook，可以理解成一个excel对象，一个excel只要构建一个 |
| ExcelReaderSheetBuilder ExcelWriterSheetBuilder | 构建出一个 ReadSheet WriteSheet对象，可以理解成excel里面的一页,每一页都要构建一个 |
| ReadListener | 在每一行读取完毕后都会调用ReadListener来处理数据 |
| WriteHandler | 在每一个操作包括创建单元格、创建表格等都会调用WriteHandler来处理数据 |
所有配置都是继承的，Workbook的配置会被Sheet继承，所以在用EasyExcel设置参数的时候，在EasyExcel...sheet()方法之前作用域是整个sheet,之后针对单个sheet
4.2、读
注解
● ExcelProperty 指定当前字段对应excel中的那一列。可以根据名字或者Index去匹配。当然也可以不写，默认第一个字段就是index=0，以此类推。千万注意，要么全部不写，要么全部用index，要么全部用名字去匹配。千万别三个混着用，除非你非常了解源代码中三个混着用怎么去排序的。
● ExcelIgnore 默认所有字段都会和excel去匹配，加了这个注解会忽略该字段
● DateTimeFormat 日期转换，用String去接收excel日期格式的数据会调用这个注解。里面的value参照java.text.SimpleDateFormat
● NumberFormat 数字转换，用String去接收excel数字格式的数据会调用这个注解。里面的value参照java.text.DecimalFormat
● ExcelIgnoreUnannotated 默认不加ExcelProperty 的注解的都会参与读写，加了不会参与
4.2、写
注解
● ExcelProperty index 指定写到第几列，默认根据成员变量排序。value指定写入的名称，默认成员变量的名字，多个value可以参照快速开始中的复杂头
● ExcelIgnore 默认所有字段都会写入excel，这个注解会忽略这个字段
● DateTimeFormat 日期转换，将Date写到excel会调用这个注解。里面的value参照java.text.SimpleDateFormat
● NumberFormat 数字转换，用Number写excel会调用这个注解。里面的value参照java.text.DecimalFormat
● ExcelIgnoreUnannotated 默认不加ExcelProperty 的注解的都会参与读写，加了不会参与