選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

README.md 16 KiB

10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
10年前
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
  1. ===========================
  2. EasyPoi Excel和 Word简易工具类
  3. ===========================
  4. easypoi功能如同名字easy,主打的功能就是容易,让一个没见接触过poi的人员
  5. 就可以方便的写出Excel导出,Excel模板导出,Excel导入,Word模板导出,通过简单的注解和模板
  6. 语言(熟悉的表达式语法),完成以前复杂的写法
  7. 作者博客:http://blog.afterturn.cn/
  8. 作者邮箱: qrb.jueyue@gmail.com
  9. QQ群: 364192721
  10. 开发者:魔幻之翼 xf.key@163.com
  11. [测试项目](http://git.oschina.net/jueyue/easypoi-test): http://git.oschina.net/jueyue/easypoi-test
  12. [开发文档请查看DOC下面的EasyPoi教程](http://git.oschina.net/jueyue/easypoi/blob/master/doc/EasyPoi%E6%95%99%E7%A8%8B.docx?dir=0&filepath=doc%2FEasyPoi%E6%95%99%E7%A8%8B.docx&oid=133ebde5641f128420023dbdc2533ab4b53c7792&sha=4c8d94c80544811e2e358518bad6c689a63c13e9)
  13. !!!2.1.6 版本开始和之前的版本校验不兼用,使用JSR303的校验,删除了之前的注解,请注意
  14. !!! 2.3.0 模板导出有问题,请使用2.3.0.1修复版本
  15. ---------------------------
  16. EasyPoi的主要特点
  17. --------------------------
  18. 1.设计精巧,使用简单
  19. 2.接口丰富,扩展简单
  20. 3.默认值多,write less do more
  21. 4.AbstractView 支持,web导出可以简单明了
  22. ---------------------------
  23. EasyPoi的几个入口工具类
  24. ---------------------------
  25. 1.ExcelExportUtil Excel导出(
  26. 普通导出,模板导出)
  27. 2.ExcelImportUtil Excel导入
  28. 3.WordExportUtil Word导出(只支持docx ,doc版本poi存在图片的bug,暂不支持)
  29. ---------------------------
  30. 关于Excel导出XLS和XLSX区别
  31. ---------------------------
  32. 1.导出时间XLS比XLSX快2-3倍
  33. 2.导出大小XLS是XLSX的2-3倍或者更多
  34. 3.导出需要综合网速和本地速度做考虑^~^
  35. ---------------------------
  36. 几个工程的说明
  37. ---------------------------
  38. 1.easypoi 父包--作用大家都懂得
  39. 2.easypoi-annotation 基础注解包,作用与实体对象上,拆分后方便maven多工程的依赖管理
  40. 3.easypoi-base 导入导出的工具包,可以完成Excel导出,导入,Word的导出,Excel的导出功能
  41. 4.easypoi-web 耦合了spring-mvc 基于AbstractView,极大的简化spring-mvc下的导出功能
  42. 5.sax 导入使用xercesImpl这个包(这个包可能造成奇怪的问题哈),word导出使用poi-scratchpad,都作为可选包了
  43. --------------------------
  44. maven
  45. --------------------------
  46. maven库应该都可以了
  47. SNAPSHOT 版本
  48. https://oss.sonatype.org/content/repositories/snapshots/
  49. ```xml
  50. <dependency>
  51. <groupId>org.jeecg</groupId>
  52. <artifactId>easypoi-base</artifactId>
  53. <version>2.3.1</version>
  54. </dependency>
  55. <dependency>
  56. <groupId>org.jeecg</groupId>
  57. <artifactId>easypoi-web</artifactId>
  58. <version>2.3.1</version>
  59. </dependency>
  60. <dependency>
  61. <groupId>org.jeecg</groupId>
  62. <artifactId>easypoi-annotation</artifactId>
  63. <version>2.3.1</version>
  64. </dependency>
  65. ```
  66. ---------------------------
  67. EasyPoi 文档
  68. ---------------------------
  69. 这几篇是旧的教程,不过和现在大同小异
  70. [Excel 介绍篇](http://note.youdao.com/share/?id=ea5166076313d437abbfb28a18d85486&type=note)
  71. [Excel 工具类](http://note.youdao.com/share/?id=dcfef5355d1d75b718be8fd563ad5216&type=note)
  72. [Excel 注解介绍.第一篇](http://note.youdao.com/share/?id=9898d1777ca97b81d82a6e151b880dbb&type=note)
  73. [Excel 注解介绍.第二篇](http://note.youdao.com/share/?id=9898d1777ca97b81d82a6e151b880dbb&type=note)
  74. [Excel 实体类](http://note.youdao.com/share/?id=dab97eababf8e91356f87be204b581e8&type=note)
  75. [Word模板导出教程](http://note.youdao.com/share/?id=26794c8eb4a285828663178c0ae854a2&type=note)
  76. 后面都是新的了
  77. [EasyPoi-在财务报表中的应用](http://git.oschina.net/jueyue/easypoi/wikis/EasyPoi-%E5%9C%A8%E8%B4%A2%E5%8A%A1%E6%8A%A5%E8%A1%A8%E4%B8%AD%E7%9A%84%E5%BA%94%E7%94%A8)
  78. [EasyPoi-如何筛选导出属性](http://git.oschina.net/jueyue/easypoi/wikis/EasyPoi-%E5%A6%82%E4%BD%95%E7%AD%9B%E9%80%89%E5%AF%BC%E5%87%BA%E5%B1%9E%E6%80%A7)
  79. [EasyPoi 在spring mvc中简易开发方式](http://note.youdao.com/share/?id=8b04c4d88a0574a59aeaffd142c8e34b&type=note)
  80. [EasyPoi-新版自定义导出样式类型](http://note.youdao.com/share/?id=7937a9fe15f1016b8f39bf813be894f8&type=note)
  81. [EasyPoi-标签-模板导出的语法介绍](http://blog.csdn.net/qjueyue/article/details/45231801)
  82. [EasyPoi-Excel预览(New)](http://blog.afterturn.cn/?p=34)
  83. [EasyPoi-多行模板输出(New)](http://blog.afterturn.cn/?p=40)
  84. [EasyPoi-校验集成](http://blog.afterturn.cn/?p=65)
  85. --------------------------
  86. EasyPoi 模板 表达式支持
  87. --------------------------
  88. - 空格分割
  89. - 三目运算 {{test ? obj:obj2}}
  90. - n: 表示 这个cell是数值类型 {{n:}}
  91. - le: 代表长度{{le:()}} 在if/else 运用{{le:() > 8 ? obj1 : obj2}}
  92. - fd: 格式化时间 {{fd:(obj;yyyy-MM-dd)}}
  93. - fn: 格式化数字 {{fn:(obj;###.00)}}
  94. - fe: 遍历数据,创建row
  95. - !fe: 遍历数据不创建row
  96. - $fe: 下移插入,把当前行,下面的行全部下移.size()行,然后插入
  97. - !if: 删除当前列 {{!if:(test)}}
  98. - 单引号表示常量值 '' 比如'1' 那么输出的就是 1
  99. - &NULL& 控制
  100. - ]] 换行符
  101. --------------------------
  102. pom说明
  103. --------------------------
  104. word和sax读取的时候才使用,就不是必须的了,请手动引用,JSR303的校验也是可选的,PDF的jar也是可选的
  105. ```xml
  106. <!-- sax 读取时候用到的 -->
  107. <dependency>
  108. <groupId>xerces</groupId>
  109. <artifactId>xercesImpl</artifactId>
  110. <version>${xerces.version}</version>
  111. <optional>true</optional>
  112. </dependency>
  113. <dependency>
  114. <groupId>org.apache.poi</groupId>
  115. <artifactId>poi-scratchpad</artifactId>
  116. <version>${poi.version}</version>
  117. <optional>true</optional>
  118. </dependency>
  119. <!-- 校验,下面两个实现 -->
  120. <dependency>
  121. <groupId>org.hibernate</groupId>
  122. <artifactId>hibernate-validator</artifactId>
  123. <version>5.1.3.Final</version>
  124. <optional>true</optional>
  125. </dependency>
  126. <dependency>
  127. <groupId>org.apache.bval</groupId>
  128. <artifactId>org.apache.bval.bundle</artifactId>
  129. <version>1.1.0</version>
  130. </dependency>
  131. <!-- PDF -->
  132. <dependency>
  133. <groupId>com.itextpdf</groupId>
  134. <artifactId>itextpdf</artifactId>
  135. <version>5.5.6</version>
  136. <optional>true</optional>
  137. </dependency>
  138. <dependency>
  139. <groupId>com.itextpdf</groupId>
  140. <artifactId>itext-asian</artifactId>
  141. <version>5.2.0</version>
  142. <optional>true</optional>
  143. </dependency>
  144. ```
  145. --------------------------
  146. 版本修改
  147. --------------------------
  148. - 2.3.1 修复bug,推荐更新
  149. - 支持三目运算嵌套
  150. - 提供大量导出功能,分批插入数据
  151. - 勉强支持模板统计了
  152. - 把最大值设置成参数
  153. - 2.3.0.1 修复bug,推荐更新
  154. - 提供的PDF基础的Excel导出支持
  155. - 提供了Excel Charts的导出支持
  156. - 升级了POI
  157. - 提供了Word换行支持
  158. - 图片提供统一缓存
  159. - 增加Cell取值工具,自动分辨合并单元格和独立单元格
  160. - 修复合并单元格,获取cell改为递归,之前判断有问题
  161. - 修改了下,el表达式的==判断,给fe加上了样式自定义方法
  162. - 修复if(),单字段的判断
  163. - 修复其他一些bug
  164. - 2.1.6 校验规则不向下兼容,升级请自行考虑
  165. - 其实不想升的,不过有必要的bug要修复,所以就先生上来吧
  166. - 升级交易为hibernate校验,hibernate的maven自己配置可选
  167. - WORD的Excel遍历 的Row,改为Insert Row
  168. - 修复了font的数组越界
  169. - 修复targetId的数组越界
  170. - 修复多行模板导出的bug
  171. - 增加了验证Excel的功能
  172. - 2.1.5 bug修复,建议升级
  173. - fix指定sheetNum导入的bug
  174. - add导入时候setIndex(null) 可以防止识别为集合的问题
  175. - fix导入excel列数量判断有bug,导致有些列数漏掉校验
  176. - update修改了getValue的方式,减少导入cell value识别错误
  177. - 2.1.4
  178. - 模板输出自动合并单元格功能
  179. - 多行模板数据导出
  180. - 导出链接功能
  181. - 把反射加入了缓存
  182. - word和Excel语法保持了统一
  183. - Excel to Html 增加了图片显示和缓存功能
  184. - 导入增加一个参数startSheetIndex 用以指定sheet位置
  185. - 2.1.3
  186. - 屏蔽了科学计数法的问题
  187. - 修复了多模版记得清空记录信息
  188. - 加入了map setValue的接口,用以自定义setValue,主要是可以自定义key
  189. - 把合并单元格的数据提起出来,让大家都可以复用
  190. - 多个sheet导出问题
  191. - 2.1.2
  192. - groupId 改成org.jeecg,为了以后可以直接提交到中央库了
  193. - 把test 那个模块删除了
  194. - 提供了Excel 预览的功能
  195. - type 新增一个 4类型,用于Excel是数字,但是java 是String,防止科学计数法
  196. - 修复一些bug
  197. - 2.1.1-release -小更新/防止下一个预览功能太久不能发布更新
  198. - $fe标签
  199. - 几个可能影响使用的bug
  200. - 导入Map的支持
  201. - 2.0.9-release--模板功能更新
  202. - 修复了中文路径,float类型导入等bug
  203. - 增加了根据CellStyler判断cell类型的功能
  204. - 优化了一下代码,sort 的compare 改为类实现接口,getValue统一由public处理
  205. - height和width 都改成double 可能更加准确的调整
  206. - 升级到common-lang3
  207. - 可以循环解析多个模板
  208. - !!模板增加了多个标签功能
  209. - 2.0.8-release--小版本更新
  210. - 分开了基础注解和base包,编译maven多模块集成
  211. - 加强了Excel导入的校验功能,可以追加错误信息,过滤不合格数据
  212. - 修复了spring mvc下的07版本不支持的问题
  213. - 添加了@ Controller 注解,扫描org.jeecgframework.poi.excel.view路径就可以了,不用写bean了
  214. - 加强了styler的自定义功能,参数改为entity,自由控制
  215. - test包下面增加了几个demo
  216. - 导出添加了一个冰冻列属性,可以简单执行
  217. - PS: 经过这段时间项目中的测试,模板导出Excel复杂报表可以省5倍以上的时间,特别是样式复杂的完全可以在Excel中完成,不是在代码中完成了
  218. - 2.0.7-release--推荐更新
  219. - 增加了合计的参数,便于统计合计信息
  220. - 修改了样式设置,使用默认设置,提供其他设置,和样式接口
  221. - 模板导出增加了插入导出的功能
  222. - 模板导出重用了Excel导出的代码功能更加强劲
  223. - 新增了Sax导入方式,大数据导入提供接口操作
  224. - Word修改了页眉页脚不替换的bug
  225. - 修改了捕获异常日志的bug
  226. - 修复了模板导出,Spring View没识别版本的bug
  227. - 修复了其他一些小bug
  228. - 2.0.6-release
  229. - 修复导入的自定义格式异常
  230. - 修复导入的BigDecimal不识别
  231. - 导出大数据替换为SXSSFWorkbook,提高07版本Excel导出效率
  232. - 根据sonar的提示,修复编码格式问题
  233. - 做了更加丰富的测试
  234. - word 导出的优化
  235. - 2.0.6-SNAPSHOT
  236. - 增加map的导出
  237. - 增加index 列
  238. ---------------------------
  239. EasyPoi导出实例
  240. ---------------------------
  241. 1.注解,导入导出都是基于注解的,实体上做上注解,标示导出对象,同时可以做一些操作
  242. ```Java
  243. @ExcelTarget("courseEntity")
  244. public class CourseEntity implements java.io.Serializable {
  245. /** 主键 */
  246. private String id;
  247. /** 课程名称 */
  248. @Excel(name = "课程名称", orderNum = "1", needMerge = true)
  249. private String name;
  250. /** 老师主键 */
  251. @ExcelEntity(id = "yuwen")
  252. @ExcelVerify()
  253. private TeacherEntity teacher;
  254. /** 老师主键 */
  255. @ExcelEntity(id = "shuxue")
  256. private TeacherEntity shuxueteacher;
  257. @ExcelCollection(name = "选课学生", orderNum = "4")
  258. private List<StudentEntity> students;
  259. ```
  260. 2.基础导出
  261. 传入导出参数,导出对象,以及对象列表即可完成导出
  262. ```Java
  263. HSSFWorkbook workbook = ExcelExportUtil.exportExcel(new ExportParams(
  264. "2412312", "测试", "测试"), CourseEntity.class, list);
  265. ```
  266. 3.基础导出,带有索引
  267. 在到处参数设置一个值,就可以在导出列增加索引
  268. ```Java
  269. ExportParams params = new ExportParams("2412312", "测试", "测试");
  270. params.setAddIndex(true);
  271. HSSFWorkbook workbook = ExcelExportUtil.exportExcel(params,
  272. TeacherEntity.class, telist);
  273. ```
  274. 4.导出Map
  275. 创建类似注解的集合,即可完成Map的导出,略有麻烦
  276. ```Java
  277. List<ExcelExportEntity> entity = new ArrayList<ExcelExportEntity>();
  278. entity.add(new ExcelExportEntity("姓名", "name"));
  279. entity.add(new ExcelExportEntity("性别", "sex"));
  280. List<Map<String, String>> list = new ArrayList<Map<String, String>>();
  281. Map<String, String> map;
  282. for (int i = 0; i < 10; i++) {
  283. map = new HashMap<String, String>();
  284. map.put("name", "1" + i);
  285. map.put("sex", "2" + i);
  286. list.add(map);
  287. }
  288. HSSFWorkbook workbook = ExcelExportUtil.exportExcel(new ExportParams(
  289. "测试", "测试"), entity, list);
  290. ```
  291. 5.模板导出
  292. 根据模板配置,完成对应导出
  293. ```Java
  294. TemplateExportParams params = new TemplateExportParams();
  295. params.setHeadingRows(2);
  296. params.setHeadingStartRow(2);
  297. Map<String,Object> map = new HashMap<String, Object>();
  298. map.put("year", "2013");
  299. map.put("sunCourses", list.size());
  300. Map<String,Object> obj = new HashMap<String, Object>();
  301. map.put("obj", obj);
  302. obj.put("name", list.size());
  303. params.setTemplateUrl("org/jeecgframework/poi/excel/doc/exportTemp.xls");
  304. Workbook book = ExcelExportUtil.exportExcel(params, CourseEntity.class, list,
  305. map);
  306. ```
  307. 6.导入
  308. 设置导入参数,传入文件或者流,即可获得相应的list
  309. ```Java
  310. ImportParams params = new ImportParams();
  311. params.setTitleRows(2);
  312. params.setHeadRows(2);
  313. //params.setSheetNum(9);
  314. params.setNeedSave(true);
  315. long start = new Date().getTime();
  316. List<CourseEntity> list = ExcelImportUtil.importExcel(new File(
  317. "d:/tt.xls"), CourseEntity.class, params);
  318. ```
  319. 7.和spring mvc的无缝融合
  320. 简单几句话,Excel导出搞定
  321. ```Java
  322. @RequestMapping(params = "exportXls")
  323. public String exportXls(CourseEntity course,HttpServletRequest request,HttpServletResponse response
  324. , DataGrid dataGrid,ModelMap map) {
  325. CriteriaQuery cq = new CriteriaQuery(CourseEntity.class, dataGrid);
  326. org.jeecgframework.core.extend.hqlsearch.HqlGenerateUtil.installHql(cq, course, request.getParameterMap());
  327. List<CourseEntity> courses = this.courseService.getListByCriteriaQuery(cq,false);
  328. map.put(NormalExcelConstants.FILE_NAME,"用户信息");
  329. map.put(NormalExcelConstants.CLASS,CourseEntity.class);
  330. map.put(NormalExcelConstants.PARAMS,new ExportParams("课程列表", "导出人:Jeecg",
  331. "导出信息"));
  332. map.put(NormalExcelConstants.DATA_LIST,courses);
  333. return NormalExcelConstants.JEECG_EXCEL_VIEW;
  334. }
  335. ```
  336. 8.Excel导入校验,过滤不符合规则的数据,追加错误信息到Excel,提供常用的校验规则,已经通用的校验接口
  337. ```Java
  338. @Excel(name = "Email", width = 25)
  339. @Max(value = 15,message = "max 最大值不能超过15")
  340. private int email;
  341. /**
  342. * 手机号
  343. */
  344. @Excel(name = "Mobile", width = 20)
  345. @NotNull
  346. private String mobile;
  347. ExcelImportResult<ExcelVerifyEntity> result = ExcelImportUtil.importExcelVerify(new File(
  348. "d:/tt.xls"), ExcelVerifyEntity.class, params);
  349. for (int i = 0; i < result.getList().size(); i++) {
  350. System.out.println(ReflectionToStringBuilder.toString(result.getList().get(i)));
  351. }
  352. ```
  353. 9.导入Map
  354. 设置导入参数,传入文件或者流,即可获得相应的list,自定义Key,需要实现IExcelDataHandler接口
  355. ```Java
  356. ImportParams params = new ImportParams();
  357. List<Map<String,Object>> list = ExcelImportUtil.importExcel(new File(
  358. "d:/tt.xls"), Map.class, params);
  359. ```
  360. 10.大数据量Excel导出
  361. exportBigExcel 的方法 ,最后可以关闭closeExportBigExcel 也可以不关闭