You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 11 KiB

10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
9 years ago
10 years ago
9 years ago
10 years ago
9 years ago
10 years ago
10 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
9 years ago
9 years ago
9 years ago
10 years ago
10 years ago
10 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  1. ===========================
  2. EasyPoi Excel和 Word简易工具类
  3. ===========================
  4. easypoi功能如同名字easy,主打的功能就是容易,让一个没见接触过poi的人员
  5. 就可以方便的写出Excel导出,Excel模板导出,Excel导入,Word模板导出,通过简单的注解和模板
  6. 语言(熟悉的表达式语法),完成以前复杂的写法
  7. 作者博客:http://blog.csdn.net/qjueyue
  8. 作者邮箱: qrb.jueyue@gmail.com
  9. QQ群: 364192721
  10. ---------------------------
  11. EasyPoi的主要特点
  12. --------------------------
  13. 1.设计精巧,使用简单
  14. 2.接口丰富,扩展简单
  15. 3.默认值多,write less do more
  16. 4.AbstractView 支持,web导出可以简单明了
  17. ---------------------------
  18. EasyPoi的几个入口工具类
  19. ---------------------------
  20. 1.ExcelExportUtil Excel导出(
  21. 普通导出,模板导出)
  22. 2.ExcelImportUtil Excel导入
  23. 3.WordExportUtil Word导出(只支持docx ,doc版本poi存在图片的bug,暂不支持)
  24. ---------------------------
  25. 关于Excel导出XLS和XLSX区别
  26. ---------------------------
  27. 1.导出时间XLS比XLSX快2-3倍
  28. 2.导出大小XLS是XLSX的2-3倍或者更多
  29. 3.导出需要综合网速和本地速度做考虑^~^
  30. ---------------------------
  31. 几个工程的说明
  32. ---------------------------
  33. 1.easypoi 父包--作用大家都懂得
  34. 2.easypoi-annotation 基础注解包,作用与实体对象上,拆分后方便maven多工程的依赖管理
  35. 3.easypoi-base 导入导出的工具包,可以完成Excel导出,导入,Word的导出,Excel的导出功能
  36. 4.easypoi-web 耦合了spring-mvc 基于AbstractView,极大的简化spring-mvc下的导出功能
  37. 5.sax 导入使用xercesImpl这个包(这个包可能造成奇怪的问题哈),word导出使用poi-scratchpad,都作为可选包了
  38. --------------------------
  39. maven
  40. --------------------------
  41. 用的oschina的第三方库http://maven.oschina.net/content/repositories/thirdparty/
  42. ```xml
  43. <dependency>
  44. <groupId>org.jeecgframework</groupId>
  45. <artifactId>easypoi-base</artifactId>
  46. <version>2.1.1</version>
  47. </dependency>
  48. <dependency>
  49. <groupId>org.jeecgframework</groupId>
  50. <artifactId>easypoi-web</artifactId>
  51. <version>2.1.1</version>
  52. </dependency>
  53. <dependency>
  54. <groupId>org.jeecgframework</groupId>
  55. <artifactId>easypoi-annotation</artifactId>
  56. <version>2.1.1</version>
  57. </dependency>
  58. ```
  59. --------------------------
  60. 版本修改
  61. --------------------------
  62. - 2.1.1-release -小更新/防止下一个预览功能太久不能发布更新
  63. - $fe标签
  64. - 几个可能影响使用的bug
  65. - 导入Map的支持
  66. - 2.0.9-release--模板功能更新
  67. - 修复了中文路径,float类型导入等bug
  68. - 增加了根据CellStyler判断cell类型的功能
  69. - 优化了一下代码,sort 的compare 改为类实现接口,getValue统一由public处理
  70. - height和width 都改成double 可能更加准确的调整
  71. - 升级到common-lang3
  72. - 可以循环解析多个模板
  73. - !!模板增加了多个标签功能
  74. - 2.0.8-release--小版本更新
  75. - 分开了基础注解和base包,编译maven多模块集成
  76. - 加强了Excel导入的校验功能,可以追加错误信息,过滤不合格数据
  77. - 修复了spring mvc下的07版本不支持的问题
  78. - 添加了@ Controller 注解,扫描org.jeecgframework.poi.excel.view路径就可以了,不用写bean了
  79. - 加强了styler的自定义功能,参数改为entity,自由控制
  80. - test包下面增加了几个demo
  81. - 导出添加了一个冰冻列属性,可以简单执行
  82. - PS: 经过这段时间项目中的测试,模板导出Excel复杂报表可以省5倍以上的时间,特别是样式复杂的完全可以在Excel中完成,不是在代码中完成了
  83. - 2.0.7-release--推荐更新
  84. - 增加了合计的参数,便于统计合计信息
  85. - 修改了样式设置,使用默认设置,提供其他设置,和样式接口
  86. - 模板导出增加了插入导出的功能
  87. - 模板导出重用了Excel导出的代码功能更加强劲
  88. - 新增了Sax导入方式,大数据导入提供接口操作
  89. - Word修改了页眉页脚不替换的bug
  90. - 修改了捕获异常日志的bug
  91. - 修复了模板导出,Spring View没识别版本的bug
  92. - 修复了其他一些小bug
  93. - 2.0.6-release
  94. - 修复导入的自定义格式异常
  95. - 修复导入的BigDecimal不识别
  96. - 导出大数据替换为SXSSFWorkbook,提高07版本Excel导出效率
  97. - 根据sonar的提示,修复编码格式问题
  98. - 做了更加丰富的测试
  99. - word 导出的优化
  100. - 2.0.6-SNAPSHOT
  101. - 增加map的导出
  102. - 增加index 列
  103. ---------------------------
  104. EasyPoi 文档
  105. ---------------------------
  106. 这几篇是旧的教程,不过和现在大同小异
  107. [Excel 介绍篇](http://note.youdao.com/share/?id=ea5166076313d437abbfb28a18d85486&type=note)
  108. [Excel 工具类](http://note.youdao.com/share/?id=dcfef5355d1d75b718be8fd563ad5216&type=note)
  109. [Excel 注解介绍.第一篇](http://note.youdao.com/share/?id=9898d1777ca97b81d82a6e151b880dbb&type=note)
  110. [Excel 注解介绍.第二篇](http://note.youdao.com/share/?id=9898d1777ca97b81d82a6e151b880dbb&type=note)
  111. [Excel 实体类](http://note.youdao.com/share/?id=dab97eababf8e91356f87be204b581e8&type=note)
  112. [Word模板导出教程](http://note.youdao.com/share/?id=26794c8eb4a285828663178c0ae854a2&type=note)
  113. 后面都是新的了
  114. [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)
  115. [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)
  116. [EasyPoi 在spring mvc中简易开发方式](http://note.youdao.com/share/?id=8b04c4d88a0574a59aeaffd142c8e34b&type=note)
  117. [EasyPoi-新版自定义导出样式类型](http://note.youdao.com/share/?id=7937a9fe15f1016b8f39bf813be894f8&type=note)
  118. [EasyPoi-标签-模板导出的语法介绍](http://blog.csdn.net/qjueyue/article/details/45231801)
  119. [EasyPoi-Excel预览](http://blog.csdn.net/qjueyue/article/details/45620931)
  120. --------------------------
  121. EasyPoi 模板 表达式支持
  122. --------------------------
  123. - 空格分割
  124. - 三目运算 {{test ? obj:obj2}}
  125. - n: 表示 这个cell是数值类型 {{n:}}
  126. - le: 代表长度{{le:()}} 在if/else 运用{{le:() > 8 ? obj1 : obj2}}
  127. - fd: 格式化时间 {{fd:(obj;yyyy-MM-dd)}}
  128. - fn: 格式化数字 {{fn:(obj;###.00)}}
  129. - fe: 遍历数据,创建row
  130. - !fe: 遍历数据不创建row
  131. - $fe: 下移插入,把当前行,下面的行全部下移.size()行,然后插入
  132. - !if: 删除当前列 {{!if:(test)}}
  133. - 单引号表示常量值 '' 比如'1' 那么输出的就是 1
  134. ---------------------------
  135. EasyPoi导出实例
  136. ---------------------------
  137. 1.注解,导入导出都是基于注解的,实体上做上注解,标示导出对象,同时可以做一些操作
  138. ```Java
  139. @ExcelTarget("courseEntity")
  140. public class CourseEntity implements java.io.Serializable {
  141. /** 主键 */
  142. private String id;
  143. /** 课程名称 */
  144. @Excel(name = "课程名称", orderNum = "1", needMerge = true)
  145. private String name;
  146. /** 老师主键 */
  147. @ExcelEntity(id = "yuwen")
  148. @ExcelVerify()
  149. private TeacherEntity teacher;
  150. /** 老师主键 */
  151. @ExcelEntity(id = "shuxue")
  152. private TeacherEntity shuxueteacher;
  153. @ExcelCollection(name = "选课学生", orderNum = "4")
  154. private List<StudentEntity> students;
  155. ```
  156. 2.基础导出
  157. 传入导出参数,导出对象,以及对象列表即可完成导出
  158. ```Java
  159. HSSFWorkbook workbook = ExcelExportUtil.exportExcel(new ExportParams(
  160. "2412312", "测试", "测试"), CourseEntity.class, list);
  161. ```
  162. 3.基础导出,带有索引
  163. 在到处参数设置一个值,就可以在导出列增加索引
  164. ```Java
  165. ExportParams params = new ExportParams("2412312", "测试", "测试");
  166. params.setAddIndex(true);
  167. HSSFWorkbook workbook = ExcelExportUtil.exportExcel(params,
  168. TeacherEntity.class, telist);
  169. ```
  170. 4.导出Map
  171. 创建类似注解的集合,即可完成Map的导出,略有麻烦
  172. ```Java
  173. List<ExcelExportEntity> entity = new ArrayList<ExcelExportEntity>();
  174. entity.add(new ExcelExportEntity("姓名", "name"));
  175. entity.add(new ExcelExportEntity("性别", "sex"));
  176. List<Map<String, String>> list = new ArrayList<Map<String, String>>();
  177. Map<String, String> map;
  178. for (int i = 0; i < 10; i++) {
  179. map = new HashMap<String, String>();
  180. map.put("name", "1" + i);
  181. map.put("sex", "2" + i);
  182. list.add(map);
  183. }
  184. HSSFWorkbook workbook = ExcelExportUtil.exportExcel(new ExportParams(
  185. "测试", "测试"), entity, list);
  186. ```
  187. 5.模板导出
  188. 根据模板配置,完成对应导出
  189. ```Java
  190. TemplateExportParams params = new TemplateExportParams();
  191. params.setHeadingRows(2);
  192. params.setHeadingStartRow(2);
  193. Map<String,Object> map = new HashMap<String, Object>();
  194. map.put("year", "2013");
  195. map.put("sunCourses", list.size());
  196. Map<String,Object> obj = new HashMap<String, Object>();
  197. map.put("obj", obj);
  198. obj.put("name", list.size());
  199. params.setTemplateUrl("org/jeecgframework/poi/excel/doc/exportTemp.xls");
  200. Workbook book = ExcelExportUtil.exportExcel(params, CourseEntity.class, list,
  201. map);
  202. ```
  203. 6.导入
  204. 设置导入参数,传入文件或者流,即可获得相应的list
  205. ```Java
  206. ImportParams params = new ImportParams();
  207. params.setTitleRows(2);
  208. params.setHeadRows(2);
  209. //params.setSheetNum(9);
  210. params.setNeedSave(true);
  211. long start = new Date().getTime();
  212. List<CourseEntity> list = ExcelImportUtil.importExcel(new File(
  213. "d:/tt.xls"), CourseEntity.class, params);
  214. ```
  215. 7.和spring mvc的无缝融合
  216. 简单几句话,Excel导出搞定
  217. ```Java
  218. @RequestMapping(params = "exportXls")
  219. public String exportXls(CourseEntity course,HttpServletRequest request,HttpServletResponse response
  220. , DataGrid dataGrid,ModelMap map) {
  221. CriteriaQuery cq = new CriteriaQuery(CourseEntity.class, dataGrid);
  222. org.jeecgframework.core.extend.hqlsearch.HqlGenerateUtil.installHql(cq, course, request.getParameterMap());
  223. List<CourseEntity> courses = this.courseService.getListByCriteriaQuery(cq,false);
  224. map.put(NormalExcelConstants.FILE_NAME,"用户信息");
  225. map.put(NormalExcelConstants.CLASS,CourseEntity.class);
  226. map.put(NormalExcelConstants.PARAMS,new ExportParams("课程列表", "导出人:Jeecg",
  227. "导出信息"));
  228. map.put(NormalExcelConstants.DATA_LIST,courses);
  229. return NormalExcelConstants.JEECG_EXCEL_VIEW;
  230. }
  231. ```
  232. 8.Excel导入校验,过滤不符合规则的数据,追加错误信息到Excel,提供常用的校验规则,已经通用的校验接口
  233. ```Java
  234. /**
  235. * Email校验
  236. */
  237. @Excel(name = "Email", width = 25)
  238. @ExcelVerify(isEmail = true, notNull = true)
  239. private String email;
  240. /**
  241. * 手机号校验
  242. */
  243. @Excel(name = "Mobile", width = 20)
  244. @ExcelVerify(isMobile = true, notNull = true)
  245. private String mobile;
  246. ExcelImportResult<ExcelVerifyEntity> result = ExcelImportUtil.importExcelVerify(new File(
  247. "d:/tt.xls"), ExcelVerifyEntity.class, params);
  248. for (int i = 0; i < result.getList().size(); i++) {
  249. System.out.println(ReflectionToStringBuilder.toString(result.getList().get(i)));
  250. }
  251. ```