easypoi使用说明

JEECG EasyPoi操作手册

文件状态： [√] 草稿 [ ] 正式发布 []正在修改 文件标识： 当前版本： 作者： 1.0

前言：此手册主要为EasyPoi的使用说明，EasyPoi主要是为了简化Poi的API操作,降低Excel导入导出已经Word导出的入门门槛,通过一系列的注解,来代替原有的Poi,使其更加简便,美观和高效.EasyPoi是在Jeecg原有的Excel功能基础上发展而来的,去除了原有的一些弊端(如命名过长,convert这个不好注入Bean等)加入新的接口已经新的功能为大家提供更好的服务.

一.注解

注解是整个EasyPoi的基础,只有理解了注解各个字段的含义才能最大的发挥EasyPoi的作用,当前一共6个注解,核心注解3个,大家可以先理解下各个字段的作用,然后再使用util进行Excel或者Word的操作

1. Excel字段属性

标示在field上面,表达需要导出的字段所代表的意思,样式,二次处理等含义.是主要的注解,基本上使用这个注解就可以完成导出,导入等 下面介绍几个主要的字段: 字段 name width height replace type 作用,示例 导入导出字段名称比如: name = \学生姓名\导出字段宽度(可以每个设置), width = 30 导出高度(一个设置全局生效), height = 20 替换值,比如: replace = {\男_1\女_2\导出字段类型导出类型 1 是文本 2 是图片,3是函数默认是文本 默认值 无 10 10 [] 1 1 upload 0 空 imageType 图片类型, 导出类型 1 从file读取 2 是从数据库中读取 savePath 图片保存路径 orderNum 排序 format 时间格式化 2. ExcelCollection集合类

集合类处理注解,代表着一对多 字段 name 作用,示例 导入导出字段名称比如: name = \学生姓名\默认值 无 0 ArrayList orderNum 排序 type 导入时创建List的实现类 3. ExcelEntity实体类

实体类处理注解,代表着一对一或者多对一(主要是穿透作用) 字段 作用,示例 默认值 name 导入导出字段名称比如: name = \学生姓名\无 4. ExcelIgnore忽略属性

忽略类注解,作用就是忽略这个对象主要作用就是防止无限循环.(相信大家Json序列号中已经体验过了)

5. ExcelTarget导出目标

导出对象,表示当前导出的对象,表示导出的ID,为字段选择做依据

6. ExcelVerify导入校验

Excel导入的是数据验证注解,这个是一个新增注解,主要就是完成导入数据的基础校验,校验失败会把错误信息,填入到cell中去 字段 作用,示例 默认值 false false false false false -1 -1 空 数据不符合规范 interHandler 是不是使用接口处理 notNull 非空 isMobile isTel isEmail minLength maxLength regex regexTip 手机号 座机号 email 最小长度 最大长度 正则表达式 正则错误提示信息 二.Excel的导出

ExcelExportUtil

导出是利用反射依据实体对象的注解,来完成大家希望导出的数据.整个Excel导出具有4个函数分别针对了4中业务缩减为2个,就是模板导出和基础导出,大家可以根据自己的业务自己选择

1.单sheet导出exportExcel(ExportParams entity,

ClasspojoClass, CollectiondataSet)

单sheet导出,完成基础的数据导出,可以完成大部分简单的数据导出, entity:导出数据的表头样式等

pojoClass:导出对象 dataset:导出集合

对之前的导出进行了部分改良,导出数据限制为60000,操作数据,自动创建新的sheet,继续完成导出,同时添加了部分校验,防止导出错误,同时把错误信息抛出,供大家自行处理.

2.多sheet导出exportExcel(List> list)

多sheet导出,大家可以在一个Excel导出多个sheet数据,完成不同业务的集成.