eec（Excel Export Core）是一个Excel读取和写入工具，目前支持xlsx格式的 读取、写入以及xls格式的读取(xls支持版本BIFF8也就是excel 97~2003格式)。
与传统Excel操作不同之处在于eec并不缓存数据到内存，相反会边读数据边写文件, 省去了将数据拉取到内存的操作也降低了OOM的可能。目前已实现worksheet类型有
- ListSheet // 对象数组
- ListMapSheet // Map数组
- StatementSheet // PreparedStatement
- ResultSetSheet // ResultSet支持(多用于存储过程)
- EmptySheet // 空worksheet
也可以继承已知Worksheet来实现自定义数据源，比如微服务，mybatis或者其它RPC
eec并不是一个功能全面的excel操作工具类，它功能有限并不能用它来完全替代Apache POI ，它最擅长的操作是表格处理。比如将数据库表导出为excel文档或者读取excel表格内容到 stream或数据库。
它的最大特点是高速和低内存，如果在项目中做数据导入导出，选用EEC将为你带来极大的便利。
同时它的可扩展能力也不弱
- 支持大数据量导出，行数无上限。如果数据量超过单个sheet上限会自动分页。（xlsx单sheet最大1,048,576行）
- 支持 对象数组 和 Map数组 导出。
- 可以为某列设置阀值高亮显示。如导出学生成绩时低于60分的单元格背景标黄显示。
- int类型(byte,char,short,int)方便转可被识别文字
- excel隔行变色，利于阅读
- 设置列宽自动调节（功能未完善）
- 设置水印（文字，本地＆网络图片）
- 提供Watch窗口查看操作细节也可以做进度条。
- ExcelReader采用stream方式读取文件，只有当你操作某行数据的时候才会执行读文件，而不会将整个文件读入到内存。
- Reader支持iterator或者stream+lambda操作sheet或行数据，你可以像操作集合类一样读取并操作excel
- Reader内置的to和too方法可以方便将行数据转换为对象（前者每次转换都会实例化一个对象，后者内存共享仅产生一个实例）
导入eec.jar即可使用
git clone https://www.github.com/wangguanquan/eec.git
mvn source:jar install
pom.xml添加
<dependency>
<groupId>org.ttzero</groupId>
<artifactId>eec</artifactId>
<version>${eec.version}</version>
</dependency>
eec内部仅依赖dom4j.1.6.1和log4j.2.11.1, 如果目标工程已包含此依赖，使用如下引用
<dependency>
<groupId>org.ttzero</groupId>
<artifactId>eec</artifactId>
<version>{eec.version}</version>
<exclusions>
<exclusion>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
</exclusion>
</exclusions>
</dependency>
xls格式的读写目前处于开发中，项目地址eec-e3-support暂时未开源 尝鲜的朋友可以在本项目的beta目录下找到相关jar包，加入到项目classpath即可实现xls格式读取。 xls格式的读取与xlsx对外暴露完全一样，ExcelReader内部判断文件类型，执行不同的Reader方法。
示例请查找testReadXLS()方法。
所有测试生成的excel文件均放在target/excel目录下，可以使用mvn clean清空。测试命令可以使用mvn clean test
清空先前文件避免找不到测试结果文件
对象数组导出时可以在对象上使用注解@ExcelColumn("column name")来设置excel头部信息，
使用注解@IgnoreExport标记不需要导出的字段。
@NotExport("敏感信息不导出")
private int id; // not export
@ExcelColumn("渠道ID")
private int channelId;
@ExcelColumn(share = false)
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")
// 添加watch窗口查看导出细节
.watch(System.out::println)
// 列宽自动调整，如果不设置此属性则默认宽度为20,也可以使用`setWidth(double)`来重置列宽
.setAutoSize(true)
// 添加一个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;
};
// 定义一个int值转换lambda表达式，成绩低于60分显示"不及格"，其余显示正常分数
private IntConversionProcessor conversion = n -> n < 60 ? "不及格" : n;
public void testStyleConversion(List<Student> students) throws IOException {
new Workbook("object style processor", "guanquan.wang")
.addSheet(new ListSheet<>("期末成绩", students
, new Sheet.Column("学号", "id", int.class)
, new Sheet.Column("姓名", "name", String.class)
, new Sheet.Column("成绩", "score", int.class, conversion)
.setStyleProcessor(sp)
)
)
.writeTo(Paths.get("f:/excel"));
}
内容如下图
有时候数据并不来自于一个数据库或一个服务器，也不能一次将数据取到数组中，此时可以自定义一个worksheet继承已有的Sheet类 并复写相应方法即可。如下
public class CustomizeDataSourceSheet extends ListSheet<Student> {
// RPC, mybatis, jpa or others service
private StudentService service;
// The paging info
private int pageNo, limit = 100;
// The query parameter
private Parameter params;
/**
* 指定worksheet名称
*/
public CustomizeDataSourceSheet(String name, Parameter params) {
super(name);
this.service = new StudentService();
this.params = params;
}
/**
* 获取worksheet行数据，返回null或空数组表示当前worksheet写结束
*/
@Override
public List<Student> more() {
return service.getPageData(params, pageNo++, limit);
}
}
/**
* 测试类
*/
public void testCustomizeDataSource(Parameter params) throws IOException {
new Workbook("customize datasource")
// 设置自定义数据源worksheet
.addSheet(new CustomizeDataSourceSheet("自定义源", params))
.writeTo(Paths.get("f:/excel"));
}
更详细的信息请查测试类CustomizeDataSourceSheet
数据源为数据库时可以直接传入java.sql.Connection和SQL语句，取数据的过程在EEC内部实现，
EEC内部通过游标获取数据直接写入文件，并不会在内存保存副本，所以能极大的降低内存消耗。
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 Sheet.Column("ID", int.class)
, new Sheet.Column("产品ID", int.class)
, new Sheet.Column("渠道ID", int.class)
, new Sheet.Column("AID", int.class)
// 默认字符串多个worksheet共享，如果已知字符串唯一可设置为不共享
, new Sheet.Column("注册账号", String.class, false)
, new Sheet.Column("注册时间", Timestamp.class)
, new Sheet.Column("CPS用户ID", int.class)
, new Sheet.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 Sheet.Column("用户编号", int.class)
, new Sheet.Column("登录名", String.class, false) // 登录名都是唯一的设置不共享
, new Sheet.Column("通行证", String.class)
, new Sheet.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 Sheet.Column("城市", String.class)
)
.writeTo(Paths.get("f:\\excel"));
} catch (SQLException | IOException e) {
e.printStackTrace();
}
}
Excel如下图
如有以下格式模板文件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文件也只占用少量内存。
下面展示一些常规的读取方法
/**
* 使用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();
}
}
reade.sheets()
.flatMap(Sheet::dataRows)
.map(row -> row.to(Regist.class))
.filter(e -> "iOS".equals(e.platform()))
.collect(Collectors.toList());
以上代码相当于select * from 用户注册 where platform = 'iOS'
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();
}
}
- 读取Excel时可以获取单元格数据类型
- 支持Worksheet重复读取
- 修复已知BUG
- 修改注释准备发版到Maven中心仓库
- Rename package (cn.ttzero -> org.ttzero)
- SharedStringTable升级
- 模板导出更新以兼容Excel97~03
- 修改SQL别名导出表头文字错误的BUG
- AutoSize方法升级，现在AutoSize并不需要借助临时文件
- 当BloomFilter满时不扩容而进行清空
- 写入Excel进行重构以提升扩展能力，现在支持自定义数据源worksheet
- 对Excel 97~03写入兼容支持，eec-e3-support还在开发当中
- 支持自定义WorkbookWriter或WorksheetWriter以满足个性化需求， 比如修改每个worksheet最大行数
- 修复一些已知BUG
- SharedStringTable引入Google BloomFilter