EEC（Excel Export Core）是一个Excel读取和写入工具，目前支持xlsx格式的读取、写入以及xls格式的读取(xls支持版本BIFF8也就是excel 97~2003格式)。
EEC的设计初衷是为了解决Apache POI速度慢，高内存且API臃肿的诟病，EEC的底层并没有使用Apache POI包，所有的底层读写代码均自己实现，事实上EEC仅依懒dom4j和logback，前者用于小文件xml读取，后者统一日志接口。
EEC最大特点是高速和低内存，如果在项目中做数据导入导出功能，选用EEC将为你带来极大的便利，同时它的可扩展能力也不弱。
使用inlineStr模式的情况下EEC的读写内存可以控制在10MB以下，SharedString模式也可以控制在16MB以下。这里有关于EEC的压力测试，最低可以在6MB的情况下完成1,000,000行x29列数据的读写。
EEC采用单线程、高IO设计，所以多核心、高内存并不能显著提高速度，高主频和一块好SSD能显著提升速度。
EEC在JVM参数-Xmx6m -Xms1m下读写1,000,000行x29列内存使用截图
写文件
读文件
目前已实现worksheet类型有
- ListSheet // 对象数组
- ListMapSheet // Map数组
- StatementSheet // PreparedStatement
- ResultSetSheet // ResultSet支持(多用于存储过程)
- EmptySheet // 空worksheet
也可以继承已知Worksheet来实现自定义数据源，比如微服务，mybatis或者其它RPC
EEC并不是一个功能全面的Excel操作工具类，它功能有限并不能用它来完全替代Apache POI，它最擅长的操作是表格处理。比如将数据库表导出为Excel或者读取Excel表格内容到Stream或数据库。
阅读WIKI了解更多用法（编写中）
- 支持大数据量导出，行数无上限。如果数据量超过单个sheet上限会自动分页。（xlsx单sheet最大1,048,576行）
- 超低内存，无论是xlsx还是xls格式，大部分情况下可以在10MB以内完成十万级甚至百万级行数据读写。
- 支持 对象数组 和 Map数组 导出。
- 可以为某列设置阀值高亮显示。如导出学生成绩时低于60分的单元格背景标黄显示。
- 导出excel默认隔行变色(俗称斑马线)，利于阅读
- 设置列宽自动调节（功能未完善）
- 设置水印（文字，本地＆网络图片）
- 提供Watch窗口查看操作细节也可以做进度条。
- ExcelReader采用stream方式读取文件，只有当你操作某行数据的时候才会执行读文件，而不会将整个文件读入到内存。
- Reader支持iterator或者stream+lambda操作sheet或行数据，你可以像操作集合类一样读取并操作excel
pom.xml添加
<dependency>
<groupId>org.ttzero</groupId>
<artifactId>eec</artifactId>
<version>${eec.version}</version>
</dependency>
所有测试生成的excel文件均放在target/excel目录下，可以使用mvn clean清空。测试命令可以使用mvn clean test
清空先前文件避免找不到测试结果文件
对象数组导出时可以在对象上使用注解@ExcelColumn("column name")来设置excel头部信息，未添加ExcelColumn注解标记的属性将不会被导出，也可以通过调用forceExport方法来强制导出。
private int id; // not export
@ExcelColumn("渠道ID")
private int channelId;
@ExcelColumn
private String account;
@ExcelColumn("注册时间")
private Timestamp registered;
默认情况下导出的列顺序与字段在对象中的定义顺序一致，也可以在addSheet时重置列头顺序。
public void testWrite(List<Student> students) throws IOException {
// 创建一个名为"test object"的excel文件，指定作者，不指定时默认取系统登陆名
new Workbook("test object", "guanquan.wang")
// 添加一个worksheet，可以通过addSheet添加多个worksheet
.addSheet(new ListSheet<>("学生信息", students))
// 指定输出位置，如果做文件导出可以直接输出到`respone.getOutputStream()`
.writeTo(Paths.get("f:/excel"));
}
高亮和int转换是通过@FunctionalInterface实现，目前仅提供int值转换。
// 定义一个动态改变填充的lambda表达式，成绩低于60分标黄
private StyleProcessor sp = (o, style, sst) -> {
if ((int)o < 60) {
style = Styles.clearFill(style)
| sst.addFill(new Fill(PatternType.solid, Color.orange));
}
return style;
};
// 定义一个转换lambda表达式，成绩低于60分显示"不及格"，其余显示正常分数
private ConversionProcessor conversion = n -> (int) n < 60 ? "不及格" : n;
public void testStyleConversion(List<Student> students) throws IOException {
new Workbook("object style processor", "guanquan.wang")
.addSheet(new ListSheet<>("期末成绩", students
, new Column("学号", "id", int.class)
, new Column("姓名", "name", String.class)
, new Column("成绩", "score", int.class, conversion)
.setStyleProcessor(sp)
)
)
.writeTo(Paths.get("f:/excel"));
}
内容如下图
有时候数据并不来自于一个数据库或一个服务器，也不能一次将数据取到数组中，此时可以自定义一个worksheet继承已有的Sheet类并覆写more方法即可。如下
new Workbook("customize datasource")
.addSheet(new ListSheet<Student>("自定义源") {
private int pageNo, limit = 100;
@Override
public List<Student> more() {
// Call remote RPC service
return service.getPageData(pageNo++, limit);
}
})
.writeTo(Paths.get("f:/excel"));
更详细的信息请查测试类CustomizeDataSourceSheet
数据源为关系型数据库时可以使用StatementSheet和ResultSetSheet两种Worksheet，它们的工作方式是将SQL和参数交给EEC，EEC内部去查询并使用游标做到取一个值写一个值，省掉了将表数据转为Java实体的过程。
public void testFromDatabase() {
try (Connection con = dataSource.getConnection()) {
new Workbook("用户注册列表", author) // 指定workbook名，作者
.setConnection(con) // 数据库连接
.setAutoSize(true) // 列宽自动调节
.watch(System.out::println) // 添加watch窗口查看导出细节
.addSheet("用户注册"
, "select id,pro_id,channel_no,aid,account,regist_time,uid,platform_type from wh_regist limit 10"
, new Column("ID", int.class)
, new Column("产品ID", int.class)
, new Column("渠道ID", int.class)
, new Column("AID", int.class)
// 默认字符串多个worksheet不共享，如果已知字符串重复使用则可以设置为true
, new Column("注册账号", String.class, false)
, new Column("注册时间", Timestamp.class)
, new Column("CPS用户ID", int.class)
, new Column("渠道类型", int.class)
) // 添加一个sheet页
.writeTo(Paths.get("f:\\excel"));
} catch (SQLException | IOException e) {
e.printStackTrace();
}
}
执行以上代码会在f:\\excel文件夹下生成一个《用户注册列表.xlsx》文件
内容如下图
public void testFromDatabase2() {
try (Connection con = dataSource.getConnection()) {
String[] cs = {"正常", "注销"};
final Fill fill = new Fill(PatternType.solid, Color.red);
new Workbook("多Sheet页-值转换＆样式转换", creator)
.setConnection(con)
.setAutoSize(true)
.addSheet("用户信息"
, "select id,name,account,status,city from t_user where id between ? and ? and city = ?"
, p -> {
p.setInt(1, 1);
p.setInt(2, 500);
p.setString(3, "苏州市");
} // 设定SQL参数
, new Column("用户编号", int.class)
, new Column("登录名", String.class, false) // 登录名都是唯一的设置不共享
, new Column("通行证", String.class)
, new Column("状态", char.class, c -> cs[c]) // 将0/1用户无感的数字转为文字
.setStyleProcessor((n, style, sst) -> {
if ((int) n == 1) { // 将注销的用户标记
style = Styles.clearFill(style) | sst.addFill(fill); // 注销标红
}
return style;
})
, new Column("城市", String.class)
)
.writeTo(Paths.get("f:\\excel"));
} catch (SQLException | IOException e) {
e.printStackTrace();
}
}
Excel如下图
有时候你可能会使用模板来规范格式，不固定的部分使用${key}标记，Excel导出时使用Map或者Java bean传入。
如有以下格式模板文件template.xlsx
通知书 ${name } 同学，在本次期末考试的成绩是 ${score}。 ${date }
测试代码
@Test public void t4() {
try (FileInputStream fis = new FileInputStream(new File(defaultPath.toString(), "template.xlsx"))) {
// Map data
Map<String, Object> map = new HashMap<>();
map.put("name", "guanquan.wang");
map.put("score", 90);
map.put("date", "2018-02-12 12:22:29");
// java bean
// BindEntity entity = new BindEntity();
// entity.score = 67;
// entity.name = "张三";
// entity.date = new Timestamp(System.currentTimeMillis());
new Workbook("模板导出", creator)
.withTemplate(fis, map) // 绑定模板
.writeTo(Paths.get("f:\\excel")); // 写到某个文件夹
} catch (IOException e) {
e.printStackTrace();
}
}
Excel使用ExcelReader#read静态方法读文件，其内部采用流式操作，当使用某一行数据时才会真正读入内存，所以即使是GB级别的Excel文件也只占用少量内存。
默认的ExcelReader仅读取单元格的值而忽略单元格的公式，可以使用ExcelReader#parseFormula方法使Reader解析单元格的公式。
下面展示一些常规的读取方法
/**
* 使用iterator遍历所有行
*/
public void iteratorRead() {
try (ExcelReader reader = ExcelReader.read(defaultPath.resolve("单Sheet.xlsx"))) {
// Get first sheet
Sheet sheet = reader.sheet(0);
for (
Iterator<Row> ite = sheet.iterator();
ite.hasNext();
System.out.println(ite.next())
);
} catch (IOException e) {
e.printStackTrace();
}
}
public void streamRead() {
try (ExcelReader reader = ExcelReader.read(defaultPath.resolve("用户注册.xlsx"))) {
reader.sheets().flatMap(Sheet::rows).forEach(System.out::println);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* read excel to object array
*/
public void readToList() {
try (ExcelReader reader = ExcelReader.read(defaultPath.resolve("用户注册.xlsx"))) {
Regist[] array = reader.sheets() // 所有worksheet
.flatMap(Sheet::dataRows) // 去掉表头和空行
.map(row -> row.to(Regist.class)) // 将每行数据转换为Regist对象
.toArray(Regist[]::new);
// do...
} catch (IOException e) {
e.printStackTrace();
}
}
reader.sheets()
.flatMap(Sheet::dataRows)
.map(row -> row.to(Regist.class))
.filter(e -> "iOS".equals(e.platform()))
.collect(Collectors.toList());
以上代码相当于select * from 用户注册 where platform = 'iOS'
@Test public void testFilter() {
try (ExcelReader reader = ExcelReader.read(testResourceRoot().resolve("1.xlsx"))) {
String[] games = reader.sheet(0)
.dataRows()
.map(row -> row.getString("游戏"))
.distinct()
.toArray(String[]::new);
print(Arrays.toString(games));
} catch (IOException e) {
e.printStackTrace();
}
}
以上方法获取excel文件的"游戏"列的不重复值
@Test public void testFormula() {
try (ExcelReader reader = ExcelReader.read(testResourceRoot().resolve("formula.xlsx"))) {
if (reader.hasFormula()) {
// Call `parseFormula` to parse formula
reader.parseFormula().sheets().flatMap(sheet -> {
println("----------------" + sheet.getName() + "----------------");
return sheet.dataRows();
}).forEach(row -> {
for (int i = row.fc; i < row.lc; i++) {
if (row.hasFormula(i)) {
print(int2Col(i + 1));
print(row.getRowNumber());
print("=");
print(row.getFormula(i)); // Getting formula string
println();
}
}
});
}
} catch (IOException e) {
e.printStackTrace();
}
}
读取xls格式的方法与读取xlsx格式完全一样，读取文件时不需要判断是xls格式还是xlsx格式，因为EEC为其提供了完全一样的接口，内部会根据文件头去判断具体类型， 这种方式比判断文件后缀准确得多。
pom.xml添加
<dependency>
<groupId>org.ttzero</groupId>
<artifactId>eec-e3-support</artifactId>
<version>0.4.11</version>
</dependency>
你可以在 search.maven.org 查询eec-e3-support版本
xls读取对方法式与xlsx完全一致
public void testReadXLS() {
try (ExcelReader reader = ExcelReader.read(defaultPath.resolve("用户注册.xls"))) {
reader.sheets().flatMap(Sheet::rows).forEach(System.out::println);
} catch (IOException e) {
e.printStackTrace();
}
}
ExcelWriter支持csv格式，只需要在writeTo方法前添加saveAsCSV()即可。测试代码参考
- CSV => Excel 向Workbook中添加一个
CSVSheet即可 - Excel => CSV 读Excel后通过Worksheet调用
saveAsCSV
代码示例
// CSV转Excel
new Workbook("csv path test", author)
.addSheet(new CSVSheet(csvPath)) // 添加CSVSheet并指定csv路径
.writeTo(getOutputTestPath());
// Excel转CSV
try (ExcelReader reader = ExcelReader.read(testResourceRoot().resolve("1.xlsx"))) {
// 读取Excel并保存为CSV格式
reader.sheet(0).saveAsCSV(getOutputTestPath());
} catch (IOException e) {
e.printStackTrace();
}
- 提高对Numbers转xlsx的兼容性
- 值转换从原来的int类型扩大为Object
- 增加@RowNum注解，用于注入行号
- 修改ListSheet.EntryColumn的访问权限，方便实现更多高级特性
- 支持单列数字无表头导出，现在可以简单的导出
List<String>数据 - 修复已知BUG(#197,#202，#205,#219)
- 将com.google.common包重命名为org.ttzero.excel.common解决内嵌引起的包冲突(#200)
- 支持xls获取图片
@ExcelColumn注解增加colIndex属性，用于指定列顺序(#188)- 读取文件时
Worksheet#getIndex()方法返回Sheet在文件中的下标而非id，并取消按id排序(#193) - 修复部分BUG(#182,#190)
- Hotfix：HeaderStyle注解设置某列cell颜色会影响所有表头样式
- 增加获取图片功能(#168)
- 支持row()方法转对象(#175)
- 读取文件默认使用包装类而非基本类型，为了方便处理Null类型(#177)
- 增加
@HeaderStyle注解自定义头部样式，本次仅引入颜色的定制，后续将提供更丰富的样式支持