EasyPOI的基本使用

转x33g5p2x  于2021-09-29 转载在 其他  
字(7.0k)|赞(0)|评价(0)|浏览(849)

引入依赖

SSM 项目，引入依赖

如果spring的版本是4.x的话引入的easypoi的版本是3.0.1，如果spring是5.x的话引入easypoi的版本是4.0.0

  1. <dependency>
  2.             <groupId>cn.afterturn</groupId>
  3.             <artifactId>easypoi-base</artifactId>
  4.             <version>4.0.0</version>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>cn.afterturn</groupId>
  8.             <artifactId>easypoi-web</artifactId>
  9.             <version>4.0.0</version>
  10.         </dependency>
  11.         <dependency>
  12.             <groupId>cn.afterturn</groupId>
  13.             <artifactId>easypoi-annotation</artifactId>
  14.             <version>4.0.0</version>
  15.         </dependency>

Spring Boot 项目（2.x以上的版本，我demo的版本是2.1.3.RELEASE），引入依赖

  1. <dependency>
  2. 			<groupId>cn.afterturn</groupId>
  3. 			<artifactId>easypoi-spring-boot-starter</artifactId>
  4.             <version>4.0.0</version>
  5. 		</dependency>

需要注意的是由于easypoi的依赖内部依赖原生的poi，所以，引入了easypoi的依赖之后，需要把原生的poi的依赖删掉

注解方式导出Excel

导出测试的demo
  1. @Test
  2.     public void testExportExcel() throws Exception {
  4.         List<CourseEntity> courseEntityList = new ArrayList<>();
  5.         CourseEntity courseEntity = new CourseEntity();
  6.         courseEntity.setId("1");
  7.         courseEntity.setName("测试课程");
  9.         TeacherEntity teacherEntity = new TeacherEntity();
  10.         teacherEntity.setName("张老师");
  11.         teacherEntity.setSex(1);
  13.         courseEntity.setMathTeacher(teacherEntity);
  15.         List<StudentEntity> studentEntities = new ArrayList<>();
  16.         for (int i = 1; i <= 2; i++) {
  17.             StudentEntity studentEntity = new StudentEntity();
  18.             studentEntity.setName("学生" + i);
  19.             studentEntity.setSex(i);
  20.             studentEntity.setBirthday(new Date());
  21.             studentEntities.add(studentEntity);
  22.         }
  23.         courseEntity.setStudents(studentEntities);
  24.         courseEntityList.add(courseEntity);
  25.         System.out.println(courseEntityList+"11111111111111");
  26.         Date start = new Date();
  27.         Workbook workbook = ExcelExportUtil.exportExcel( new ExportParams("导出测试",
  28.                         null, "测试"),
  29.                 CourseEntity.class, courseEntityList);
  30.         System.out.println(new Date().getTime() - start.getTime());
  31.         File savefile = new File("E:/desktop/excel/");
  32.         if (!savefile.exists()) {
  33.             savefile.mkdirs();
  34.         }
  35.         FileOutputStream fos = new FileOutputStream("E:/desktop/excel/教师课程学生导出测试.xls");
  36.         workbook.write(fos);
  37.         fos.close();
  38.     }
导出对应的Bean

CourseEntity 类。

  1. package com.mye.hl11easypoi.api.pojo;
  3. import cn.afterturn.easypoi.excel.annotation.Excel;
  4. import cn.afterturn.easypoi.excel.annotation.ExcelCollection;
  5. import cn.afterturn.easypoi.excel.annotation.ExcelEntity;
  6. import cn.afterturn.easypoi.excel.annotation.ExcelTarget;
  7. import lombok.Data;
  9. import java.util.List;
  11. @Data
  12. @ExcelTarget("courseEntity")
  13. public class CourseEntity implements java.io.Serializable {
  14.     /** * 主键 */
  15.     private String id;
  16.     /** * 课程名称 * needMerge 是否需要纵向合并单元格(用于list创建的多个row) */
  17.     @Excel(name = "课程名称", orderNum = "0", width = 25, needMerge = true)
  18.     private String name;
  19.     /** * 老师主键 */
  20. // @ExcelEntity(id = "major")
  21.     private TeacherEntity chineseTeacher;
  22.     /** * 老师主键 */
  23.     @ExcelEntity(id = "absent")
  24.     private TeacherEntity mathTeacher;
  26.     @ExcelCollection(name = "学生", orderNum = "3")
  27.     private List<StudentEntity> students;
  28. }

TeacherEntity 类

  1. package com.mye.hl11easypoi.api.pojo;
  3. import cn.afterturn.easypoi.excel.annotation.Excel;
  4. import lombok.Data;
  6. @Data
  7. public class TeacherEntity {
  8.     /** * 教师名称 * isImportField 导入Excel时，对Excel中的字段进行校验，如果没有该字段，导入失败 */
  9.     @Excel(name = "教师姓名", width = 30, orderNum = "1" ,isImportField = "true")
  10.     private String name;
  11.     /** * 教师性别 * replace 值的替换，`replace = {"男_1", "女_2"} `将值为1的替换为男 * suffix 文字后缀 */
  12.     @Excel(name = "教师性别", replace = {"男_1", "女_2"}, suffix = "生", isImportField = "true_st",orderNum = "2")
  13.     private int sex;
  14. }

StudentEntity 类

  1. package com.mye.hl11easypoi.api.pojo;
  3. import cn.afterturn.easypoi.excel.annotation.Excel;
  4. import lombok.Data;
  6. import java.util.Date;
  8. @Data
  9. public class StudentEntity implements java.io.Serializable {
  10.     /** * id */
  11.     private String id;
  12.     /** * 学生姓名 */
  13.     @Excel(name = "学生姓名", height = 20, width = 30, isImportField = "true_st")
  14.     private String name;
  15.     /** * 学生性别 */
  16.     @Excel(name = "学生性别", replace = {"男_1", "女_2"}, suffix = "生", isImportField = "true_st")
  17.     private int sex;
  19.     @Excel(name = "出生日期", exportFormat = "yyyyMMddHHmmss", format = "yyyy-MM-dd", isImportField = "true_st", width = 20)
  20.     private Date birthday;
  22.     @Excel(name = "进校日期", exportFormat = "yyyyMMddHHmmss", format = "yyyy-MM-dd")
  23.     private Date registrationDate;
  24. }
导出结果

注解方式导入Excel

ImportParams参数
属性类型默认值功能
titleRowsint0表格标题行数
headRowsint1表头行数
startRowsint0字段值与列标题之间的距离
keyIndexint0主键
startSheetIndexint0开始读取的sheet位置
sheetNumint1上传表格需要读取的sheet数量
needSavebooleanfalse是否需要保存上传的Excel
needVerfiybooleanfalse是否需要校验上传的Excel
verifyHanlderIExcelVerifyHandlernull校验处理接口自定义校验
importFieldsString[]null导入时校验数据模板，是不是正确的Excel
saveUrlString“upload/excelUpload”保存上传的Excel目录，默认是如TestEntity这个类保存路径是upload/excelUpload/Test/yyyyMMddHHmmss

需要说明的是
1、titleRows表示的是表格标题行数，如果没有就是0，如果有一个标题就是1，如果是两个标题就2
2. headRows表示的是表头行数，默认是1，如果有两个表头则需要设置2

导入代码

  1. @Test
  2.     public void testImport2() throws Exception {
  3.         // 参数1：导入excel文件流 参数2：导入类型 参数3：导入的配置对象
  4.         ImportParams importParams = new ImportParams();
  5.         importParams.setTitleRows(1); // 设置标题列占几行
  6.         importParams.setHeadRows(2);  // 设置字段名称占几行 即header
  7.         importParams.setNeedVerify(true);//开启校验
  8.         importParams.setStartSheetIndex(0);  // 设置从第几张表格开始读取，这里0代表第一张表，默认从第一张表读取
  9.         List<CourseEntity> courseEntityList = ExcelImportUtil.importExcel(new FileInputStream("E:/desktop/excel/教师课程学生导出测试.xls"), CourseEntity.class, importParams);
  10.         for (CourseEntity courseEntity : courseEntityList) {
  11.             System.out.println(courseEntity);
  12.         }
  13.     }

导入结果

  1. CourseEntity(
  2. id=null, 
  3. name=测试课程, 
  4. chineseTeacher=null, 
  5. mathTeacher=TeacherEntity(name=张老师, sex=1), 
  6. students=[StudentEntity(
  7. 		id=null, 
  8. 		name=学生1, 
  9. 		sex=1, 
  10. 		birthday=Wed Aug 03 20:31:23 CST 5881510, 	  	registrationDate=null), 
  11. 		StudentEntity(
  12. 		id=null, 
  13. 		name=学生2, 
  14. 		sex=2, 
  15. 		birthday=Wed Aug 03 20:31:23 CST 5881510, registrationDate=null)]
  16. )

Excel导入校验

EasyPoi的校验使用也很简单,在导入对象上加上通用的校验规则或者这定义的这个看你用的哪个实现然后params.setNeedVerfiy(true);配置下需要校验就可以了

  1. /** * Email校验 */
  2.     @Excel(name = "Email", width = 25)
  3.     private String email;
  4.     /** * 最大 */
  5.     @Excel(name = "Max")
  6.     @Max(value = 15,message = "max 最大值不能超过15" ,groups = {ViliGroupOne.class})
  7.     private int    max;
  8.     /** * 最小 */
  9.     @Excel(name = "Min")
  10.     @Min(value = 3, groups = {ViliGroupTwo.class})
  11.     private int    min;
  12.     /** * 非空校验 */
  13.     @Excel(name = "NotNull")
  14.     @NotNull
  15.     private String notNull;
  16.     /** * 正则校验 */
  17.     @Excel(name = "Regex")
  18.     @Pattern(regexp = "[\u4E00-\u9FA5]*", message = "不是中文")
  19.     private String regex;

使用方式就是在导入时设置needVerfiy属性为true。

  1. @Test
  2.     public void basetest() {
  3.         try {
  4.             ImportParams params = new ImportParams();
  5.             params.setNeedVerfiy(true);
  6.             params.setVerfiyGroup(new Class[]{ViliGroupOne.class});
  7.             ExcelImportResult<ExcelVerifyEntity> result = ExcelImportUtil.importExcelMore(
  8.                 new File(PoiPublicUtil.getWebRootPath("import/verfiy.xlsx")),
  9.                 ExcelVerifyEntity.class, params);
  10.             FileOutputStream fos = new FileOutputStream("D:/excel/ExcelVerifyTest.basetest.xlsx");
  11.             result.getWorkbook().write(fos);
  12.             fos.close();
  13.             for (int i = 0; i < result.getList().size(); i++) {
  14.                 System.out.println(ReflectionToStringBuilder.toString(result.getList().get(i)));
  15.             }
  16.             Assert.assertTrue(result.getList().size() == 1);
  17.             Assert.assertTrue(result.isVerfiyFail());
  18.         } catch (Exception e) {
  19.             LOGGER.error(e.getMessage(),e);

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://blog.csdn.net/weixin_43296313/article/details/120547303

内容来源于网络，如有侵权，请联系作者删除！

Javaspring bootpoi

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com