easypoi使用说明.pdf

《easypoi使用说明.pdf》由会员分享，可在线阅读，更多相关《easypoi使用说明.pdf（9页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

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

2、,只有理解了注解各个字段的含义才能最大的发挥EasyPoi的作用,当前一共6 个注解,核心注解3个,大家可以先理解下各个字段的作用,然后再使用util进行Excel 或者 Word的操作1.1.ExcelExcel 字段属性字段属性标示在 field 上面,表达需要导出的字段所代表的意思,样式,二次处理等含义.是主要的注解,基本上使用这个注解就可以完成导出,导入等下面介绍几个主要的字段:字段namewidthheightreplacetype作用,示例导入导出字段名称比如:name=学生姓名导出字段宽度(可以每个设置),width=30导出高度(一个设置全局生效),height=20替换值,比

3、如:replace=男_1,女_2导出字段类型导出类型 1 是文本 2 是图片,3 是函数默认是文本默认值无101011upload0空imageType图片类型,导出类型 1 从 file 读取 2 是从数据库中读取savePath图片保存路径orderNum排序format时间格式化2.2.ExcelCollectionExcelCollection 集合类集合类集合类处理注解,代表着一对多字段name作用,示例导入导出字段名称比如:name=学生姓名默认值无0ArrayListorderNum排序type导入时创建 List 的实现类3.3.ExcelEntityExcelEntity

4、实体类实体类实体类处理注解,代表着一对一或者多对一(主要是穿透作用)字段作用,示例默认值name导入导出字段名称比如:name=学生姓名无4.4.ExcelIgnoreExcelIgnore 忽略属性忽略属性忽略类注解,作用就是忽略这个对象主要作用就是防止无限循环.(相信大家 Json 序列号中已经体验过了)5.5.ExcelTargetExcelTarget导出目标导出目标导出对象,表示当前导出的对象,表示导出的 ID,为字段选择做依据6.6.ExcelVerifyExcelVerify导入校验导入校验Excel 导入的是数据验证注解,这个是一个新增注解,主要就是完成导入数据的基础校验,校验

5、失败会把错误信息,填入到 cell 中去字段作用,示例默认值falsefalsefalsefalsefalse-1-1空数据不符合规范interHandler是不是使用接口处理notNull非空isMobileisTelisEmailminLengthmaxLengthregexregexTip手机号座机号email最小长度最大长度正则表达式正则错误提示信息二二.Excel.Excel 的导出的导出ExcelExportUtil导出是利用反射依据实体对象的注解,来完成大家希望导出的数据.整个Excel导出具有4个函数分别针对了 4 中业务缩减为 2 个,就是模板导出和基础导出,大家可以根据自己

6、的业务自己选择1.1.单单sheetsheet导导 出出exportExcel(ExportParamsexportExcel(ExportParamsentity,entity,ClasspojoClass,CollectiondataSet)ClasspojoClass,CollectiondataSet)单 sheet 导出,完成基础的数据导出,可以完成大部分简单的数据导出,entity:导出数据的表头样式等pojoClass:导出对象dataset:导出集合对之前的导出进行了部分改良,导出数据限制为 60000,操作数据,自动创建新的 sheet,继续完成导出,同时添加了部分校验,防止

7、导出错误,同时把错误信息抛出,供大家自行处理.2.2.多多 sheetsheet 导出导出 exportExcel(ListMapString,exportExcel(ListMapObjectlist)list)多 sheet 导出,大家可以在一个 Excel 导出多个 sheet 数据,完成不同业务的集成.3.3.纯纯 模模 板板exportExcel(TemplateExportParamsparams,exportExcel(TemplateExportParamsparams,Mapmap)Mapmap)单纯的 Excel 模板导出,固定的数据报表.程序很难完成的Excel样式,大家

8、可以在 Excel 处理完成,然后只是在程序中填充数据,不会改变样式.4.4.导导出出+模模板板exportExcel(TemplateExportParamsparams,ClasspojexportExcel(TemplateExportParamsparams,ClasspojoClass,CollectiondataSet,Mapmap)oClass,CollectiondataSet,Mapmap)不仅具有替换功能,同时兼具了注解导出的功能,以来表头数据,大家可以依据导出的模板,来处理三三.Excel.Excel 导入导入ExcelImportUtil,导入比较简单了,没有业务处理导

9、入同样就 4 个方法,两个维度,本地导入,流导入,返回校验信息,不返回校验信息导入最主要的就是 ImportParams的设置ImportParamsImportParams字段titleRowsheadRowsstartRowskeyIndexsheetNumneedSavesaveUrl意义标题的行数表头的行数,最大支持 2字段真正值和列标题之间的距离,就是表头下面是不是有几行空格主键列,一对多的主要的读取的是第几个 sheet读取完是不是需要保存,默认值01001false保存地址upload/excelUploadupload/excelUpload/Test/yyyyMMddHHms

10、s_*保存名称上传时间_五位随机数数据校验接口nullverifyHanlder主要需要注意的就是 titleRows和 headRows,因为 titleRows等于需要过滤的行数1.1.文件导入带校验结果文件导入带校验结果importExcelVerify(File file,ClasspojoClass,ImportParamsparams)2.2.文件导入文件导入importExcel(File file,ClasspojoClass,ImportParamsparams)2.2.流导入流导入importExcelByIs(InputStreaminputstream,Classpoj

11、oClass,ImportParamsparams)4.4.流导入带校验结果流导入带校验结果importExcelByIsAndVerify(InputStreaminputstream,ClasspojoClass,ImportParamsparams)四四.Word.Word的导出的导出word 的导出主要是面对公文什么的,模板变化不大,但是样式比较麻烦,这样我们可以先在 word 中制定好模板,然后在替换值导出.导出只是支持 07 版本,同时可以支持在 word 中插入 Excel,支持 Map 和注解 Entity.1.1.语法语法a.a.替换替换替换值语法使用的是keykey这样的语

12、法,仅仅替换文本,不会修改样.b.b.图片图片图片算作一个比较特殊的值,jeecg 解决了 poi的图片的bug,可以让大家指定地方,指定大小.key 使用 WordImageEntity这个类c.c.表格表格 in pList in 表示这个表格是个集合数据,plist 有两个类型,一个是 ExcelListEntity一个是List,ExcelListEntity是使用注解来导出数据,以来表头来处理数据如参数listclazzheadRows意义数据源类的 Class 对象表格行数,1 或者 2List 以来下一行的数据来导出如,支持实体类和 Map导出主要就是利用上面三个语法进行组合数据

13、2.2.本地导出本地导出exportWord07(String url,Map map)url 是本地地址,map 是各个参数的封装3.3.文件导出文件导出exportWord07(XWPFDocument document,Map map)五五.Spring View.Spring Viewspring view 可以简化导出的操作,输入相应参数就可以完成Excel,Word导出例如:1.JeecgSingleExcelView1.JeecgSingleExcelView单 sheet 或者多 sheet 导出使用参数NormalExcelConstants.FILE_NAMENormalE

14、xcelConstants.PARAMSNormalExcelConstants.CLASSNormalExcelConstants.DATA_LISTNormalExcelConstants.MAP_LIST值导出文件名称导出参数实体对象数据源多数据源集合2.JeecgTemplateExcelView2.JeecgTemplateExcelViewExcel 模板导出使用参数值NormalExcelConstants.FILE_NAMENormalExcelConstants.PARAMSNormalExcelConstants.CLASSTemplateExcelConstants.LIST_DATATemplateExcelConstants.MAP_DATA导出文件名称导出参数实体对象注解使用导出数据源值替换导出数据源3.JeecgTemplateWordView3.JeecgTemplateWordViewWord模板导出参数NormalExcelConstants.FILE_NAMETemplateWordConstants.URLTemplateExcelConstants.MAP_DATA值导出文件名称Word地址值替换导出数据源六六.说明说明主要是缓存,使用的是 guava的缓存管理,缓存大小是 50 个文件以及一天的缓存时间