造轮子--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

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

@Test
 public void testSimpleWithAnnotationExport() {
   List<UserWithAnnotation> users = mockUserWithAnnotation(5);
   EasyExcel.export("/tmp/test.xlsx")
       .export(ExcelWriteContext.builder()
           .datasource(users)
           .sheetName("user")
           .build())
       .write();
 }

import

@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往往非常复杂且多变,很难做到通用,因此这里是直接抛出一个钩子,可以自己实现自己想要的任何操作。

@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

@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获取对应的输出流,然后放入

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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏程序猿DD

Spring框架中的设计模式(四)​

本文是Spring框架中使用的设计模式第四篇。本文将在此呈现出新的3种模式。一开始,我们会讨论2种结构模式:适配器和装饰器。在第三部分和最后一部分,我们将讨论单...

3806
来自专栏函数式编程语言及工具

ScalaPB(2): 在scala中用gRPC实现微服务

2413
来自专栏cmazxiaoma的架构师之路

通用Mapper和PageHelper插件 学习笔记

8553
来自专栏zhisheng

渣渣菜鸡的 ElasticSearch 源码解析 —— 启动流程(上)

上篇文章写了 ElasticSearch 源码解析 —— 环境搭建 ,其中里面说了启动 打开 server 模块下的 Elasticsearch 类:org.e...

1281
来自专栏Flutter入门

Weex是如何在Android客户端上跑起来的

Weex可以通过自己设计的DSL,书写.we文件或者.vue文件来开发界面,整个页面书写分成了3段,template、style、script,借鉴了成熟的MV...

3675
来自专栏微服务那些事儿

关键数据变更监控

在经过了对mybatis的一番检索之后,没有发现对该需求的解决方式.在认知范围内,想到了使用mabatis拦截器解决该问题。

76619
来自专栏岑玉海

Carbondata源码系列(一)文件生成过程

在滴滴的两年一直在加班,人也变懒了,就很少再写博客了,最近在进行Carbondata和hive集成方面的工作,于是乎需要对Carbondata进行深入的研究。 ...

5766
来自专栏函数式编程语言及工具

Akka(13): 分布式运算:Cluster-Sharding-运算的集群分片

    通过上篇关于Cluster-Singleton的介绍,我们了解了Akka为分布式程序提供的编程支持:基于消息驱动的运算模式特别适合分布式程序编程,我们不...

4038
来自专栏Ryan Miao

使用dropwizard(6)-国际化-easy-i18n

前言 Dropwizard官方文档并没有提供国际化的模块,所以只能自己加。Spring的MessageResource用的很顺手,所以copy过来。 Easy...

37412
来自专栏开发 & 算法杂谈

Intel Pin-JIT模式和Probe模式下库函数的替换

这篇文章主要介绍一下Intel Pin在JIT模式和Probe模式下对库换数的替换,以及实现中有哪写需要注意的地方。

2486

扫码关注云+社区