为什么会写Easypoi

以前的以前(岁月真TMD的快)我虽然写了不少代码但还是很少写poi,然后跳到一家公司之后就和业务人员聊上了,来这个需要个报表,这个报表样式是这样的,这个表头是这样的,就这样我写了大量的poi代码,每次都是大量的篇幅,copy to copy,无聊的一逼,然后加入了jeecg,jeecg中有一个小的工具类,虽然我也不知道是谁写的,然是可以用注解搞定最简单的导出,突然豁然开朗,我可以完善,让我从报表的苦海当中脱离出来,这样我花了一周的时间做了第一个版本支持导入导出放到了jeecg,发现还是不错的,慢慢的用的人越来越多,我就把这块独立出来了,再然后有人提出了模板,然后就加入了模板功能,提出了word的需求,加入了word的功能,后来工作忙了虽然没再参与jeecg,但还是一直维持这easypoi的更新,根据见识的增长也不断的重构这代码,直到现在

独特的功能

• 基于注解的导入导出,修改注解就可以修改Excel
• 支持常用的样式自定义
• 基于map可以灵活定义的表头字段
• 支持一堆多的导出,导入
• 支持模板的导出,一些常见的标签,自定义标签
• 支持HTML/Excel转换,如果模板还不能满足用户的变态需求,请用这个功能
• 支持word的导出,支持图片,Excel

小白如何开始

• 下载demo运行看看,基本上常见的用用法都在里面easypoi-test
• 查看几个*Util的用法,Easypoi的主要输出就是这个
• 看看注解的意思
• 看看模板的标签用法
• 可以出师了

Easypoi 为谁而开发

• 不太熟悉poi的
• 不想写太多重复太多的
• 只是简单的导入导出的
• 喜欢使用模板的

都可以使用easypoi

Easypoi的目标是什么

Easypoi的目标不是替代poi,而是让一个不懂导入导出的快速使用poi完成Excel和word的各种操作,而不是看很多api才可以完成这样工作

1.3 使用

• 1.easypoi 父包--作用大家都懂得
• 2.easypoi-annotation 基础注解包,作用与实体对象上,拆分后方便maven多工程的依赖管理
• 3.easypoi-base 导入导出的工具包,可以完成Excel导出,导入,Word的导出,Excel的导出功能
• 4.easypoi-web 耦合了spring-mvc 基于AbstractView,极大的简化spring-mvc下的导出功能
• 5.sax 导入使用xercesImpl这个包(这个包可能造成奇怪的问题哈),word导出使用poi-scratchpad,都作为可选包了

如果不使用spring mvc的便捷福利,直接引入easypoi-base 就可以了,easypoi-annotation

1.4 测试项目

测试这个事情真不是个容易的事情

测试项目包括两块 Junit 的常见测试和spring 的view测试

1.spring view测试

运行application就可以了,访问界面,然后看到界面

对应的代码在view下面

2.Junit的测试目录结构如下

• tohtml html预览测试
• view 导出的view测试
• cache 自定义缓存测试
• html html互转测试
• test
• excel
• read 读取Excel测试
• check 导入检查测试
• hanlder 导入数据处理
• img 含图片导入测试
• styler 导出样式自定义测试
• template 模板导出测试
• sum 导出含统计测试
• test 导出测试
• groupname groupname 属性测试
• img 导出图片测试
• pdf pdf测试
• word word导出测试
• util util 内部测试

目前的测试覆盖率

2. Excel 注解版

2.1 Excel导入导出

Excel的导入导出是Easypoi的核心功能,前期基本也是围绕这个打造的,主要分为三种方式的处理,其中模板和Html目前只支持导出,因为支持Map.class其实导入应该是怎样都支持的

• 注解方式,注解变种方式
• 模板方式
• Html方式

下面分别就这三种方式进行讲解

2.2 注解

注解介绍

easypoi起因就是Excel的导入导出,最初的模板是实体和Excel的对应,model--row,filed--col 这样利用注解我们可以和容易做到excel到导入导出

经过一段时间发展,现在注解有5个类分别是

• @Excel 作用到filed上面,是对Excel一列的一个描述
• @ExcelCollection 表示一个集合,主要针对一对多的导出,比如一个老师对应多个科目,科目就可以用集合表示
• @ExcelEntity 表示一个继续深入导出的实体,但他没有太多的实际意义,只是告诉系统这个对象里面同样有导出的字段
• @ExcelIgnore 和名字一样表示这个字段被忽略跳过这个导导出
• @ExcelTarget 这个是作用于最外层的对象,描述这个对象的id,以便支持一个对象可以针对不同导出做出不同处理

注解中的ID的用法

这个ID算是一个比较独特的例子,比如

@ExcelTarget("teacherEntity")public class TeacherEntity implements java.io.Serializable { /** name */ @Excel(name = "主讲老师_teacherEntity,代课老师_absent