造轮子--Excel报表工具

由于公司内部之前对于excel封装操作并不是很方便,而且对于特殊的需求不是很容易满足,这个月的任务是迁移部分业务小报表顺便重构下,因此这里造个轮子,便于导入和导出对应的excel报表。

代码

https://github.com/mrdear/easy-excel

编写原则

  1. 统一操作入口,作为工具架包,其对外的使用策略应当保证简单性。
  2. 链式操作,报表获取数据之后,导出应当一气呵成,也就是一个链式操作完成。
  3. 导入导出的可定制性,报表业务往往各种奇葩需求,因此需要暴露出钩子定制相应逻辑。
  4. Excel Header多种策略支持,注解,Map,实体类等等。

核心类

  • EasyExcel : 入口类,所有对外的操作都是由该类发起,主要有export与read两个操作。
  • ExcelWriter:导出类,其方法分为非终端操作与终端操作,终端操作会输出并关闭该流,非终端操作则可以继续接着读取,应对一张excel中含有多个sheet的情况。
  • ExcelReader:读取类,与上述ExcelWriter一样的操作。
  • ExcelField:修饰实体类注解,Excel中最麻烦的是header,因此提倡每一张报表单独对应一个POJO类,使用注解标识相应字段。
  • ExcelWriteContext:针对导出过程中一张sheet的配置,使用Builder模式构建。
  • ExcelReadContext:针对读取过程中一张sheet的配置,使用Builder模式构建。

Example

实体类
实体类使用注解标识字段,不使用的话则属性名会作为对应的columnName

1
2
3
4
5
6
7
8
9
10
11
12
13
public class UserWithAnnotation {

@ExcelField(columnName = "用户名")
private String username;

@ExcelField(columnName = "用户密码")
private String passwd;

@ExcelField(columnName = "登录日期",
writerConvert = DateToStringConvert.class,
readerConvert = StringToDateConvert.class)
private Date date;
}

单张表

export

1
2
3
4
5
6
7
8
9
10
@Test
public void testSimpleWithAnnotationExport() {
List<UserWithAnnotation> users = mockUserWithAnnotation(5);
EasyExcel.export("/tmp/test.xlsx")
.export(ExcelWriteContext.builder()
.datasource(users)
.sheetName("user")
.build())
.write();
}

import

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@Test
public void testRead2() {
InputStream inputStream = SimpleExcelReaderTest.class
.getClassLoader().getResourceAsStream("user2.xlsx");
ExcelReader reader = EasyExcel.read(inputStream);

List<UserWithAnnotation> result = reader.resolve(ExcelReadContext.<UserWithAnnotation>builder()
.clazz(UserWithAnnotation.class)
.build());

Assert.assertEquals(result.size(), 5);
Assert.assertEquals(result.get(0).getPasswd(), "0b6df627-5975-417b-abc9-1f2bad5ca1e2");
Assert.assertEquals(result.get(1).getUsername(), "张三1");

reader.close();
}

多张表+自定义header

sheet1最顶部有自定义的title

sheet2为普通表格

export
由于自定义的title往往非常复杂且多变,很难做到通用,因此这里是直接抛出一个钩子,可以自己实现自己想要的任何操作。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Test
public void testCustom() {
List<UserWithAnnotation> users = mockUserWithAnnotation(5);
EasyExcel.export("/tmp/test.xlsx")
.export(ExcelWriteContext.builder()
.datasource(users)
.sheetName("user1")
.createSheetHook((sheet, context) -> {
Row row = sheet.createRow(0);
sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, 2));
Cell cell = row.createCell(0);
cell.setCellValue("custom header");
})
.startRow(1)
.build())
.export(ExcelWriteContext.builder()
.datasource(users)
.sheetName("user2")
.build())
.write();
}

import

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
@Test
public void testCustom() {
InputStream inputStream = SimpleExcelReaderTest.class
.getClassLoader().getResourceAsStream("user3.xlsx");
ExcelReader reader = EasyExcel.read(inputStream);

List<UserWithAnnotation> sheet1Result = reader.resolve(ExcelReadContext.<UserWithAnnotation>builder()
.clazz(UserWithAnnotation.class)
.headerStart(1)
.sheetIndex(0)
.readSheetHook((sheet, context) -> {
Row row = sheet.getRow(0);
Assert.assertEquals(row.getCell(0).getStringCellValue(), "custom header");
})
.build());

Assert.assertEquals(sheet1Result.size(), 5);
Assert.assertEquals(sheet1Result.get(1).getUsername(), "张三1");


List<UserWithAnnotation> sheet2Result = reader.resolve(ExcelReadContext.<UserWithAnnotation>builder()
.clazz(UserWithAnnotation.class)
.sheetIndex(1)
.build());

Assert.assertEquals(sheet2Result.size(), 5);
Assert.assertEquals(sheet2Result.get(1).getUsername(), "张三1");

}

写入HttpServletResponse

提供ResponseHelperHttpServletResponse获取对应的输出流,然后放入

1
2
OutputStream outputStream = ResponseHelper.wrapper(response, "order.xlsx");
EasyExcel.export(outputStream)....

工作--如何封装第三方服务?
造轮子--文件分享工具