Springboot 基于EasyPoi的excel导入导出_springboot easypoi

1. EasyPoi简介

EasyPoi功能如同名字easy一样，主打的就是容易，让一个没见过也没接触过poi的人员就可以方便的写出Excel导出，Excel模板导出，Excel导入，Word模板导出，通过简单的注解和模板于洋，完成以前复杂的写法。

2. EasyPoi主要功能

• 基于注解的导入导出，修改注解就可以修改Excel。
• 支持常用的样式自定义。
• 基于Map可以灵活定义的表头字段。
• 支持一对多的导出导入。
• 支持模板的导出，一些常见的标签，自定义标签。
• 支持HTML/Excel转换，模板不能满足用户的需求时，可以使用这个功能。
• 支持Word的导出，支持图片。

3， EasyPoi注解介绍 

EasyPoi起因就是Excel的导入导出，最初的模板时实体和Excel的对应。model-row,filed-col这样利用注解我们可以容易做到excel的导入导出。经过一段时间发展，现在注解有5个，分别是：

• @Excel 作用到filed上面，是对Excel一列描述。
• @ExcelCollection 表示一个集合，主要针对一对多的导出，比如一个老师对应多个半截，班级可以用集合表示。
• @ExcelEntity 表示一个继续深入导出的实体，但它没有太多实际意义，只是告诉系统这个对象里面同样有导出的字段
• @Excelgnore 和名字一样表示这个字段被忽略跳过这个导出。
• @ExcelTarget 这个是用于最外层的对象，描述这个对象的id，一边支持一个对象可以针对不同导出做出不同处理。

3.1 @Excel 

这个是必须使用的注解，如果需求简单只使用这一个注解也是可以的，涵盖了常用的Excel需求,需要大家熟悉这个功能。

3.2 @ExcelCollection 

一对多的集合注解,用以标记集合是否被数据以及集合的整体排序

4. 如何使用EasyPoi 

4.1 添加maven依赖

<dependency>
   <groupId>cn.afterturn</groupId>
   <artifactId>easypoi-spring-boot-starter</artifactId>
   <version>4.2.0</version>
</dependency>

 4.2 导入功能的实现

首先定义需要导入的数据类型UserImportVO，并使用@Excel注解与excel列映射，导入的时候通常需要对导入的数据进行一些校验。

4.2.1 UserImportVO自定义类

EasyPoi的校验使用也很简单，对象上加上通用的校验规则，配置下需要校验就可以了，校验主要是JSR303规范，可以结合Hibernate Validator使用

自定义类对象实现IexcelModer，IexcelDataModel接口，可获取到错误校验信息。

@Data
public class UserImportVO implements Serializable,IExcelModel, IExcelDataModel {
 
    @NotBlank
    @Excel(name = "姓名")
    private String realName;
 
    @Excel(name = "性别", replace = { "男_1", "女_2" })
    private Integer sex;
 
    @Excel(name = "出生日期", format = "yyyy-MM-dd")
    private Date birthday;
 
    @Length(min=1, max=11, message = "请填写正确的手机号")
    @Excel(name = "手机号码")
    private String phone;
 
    @Excel(name = "固定电话")
    private String tel;
 
    @Email(message = "请填写正确的邮箱地址")
    @Excel(name = "邮箱")
    private String email;
 
    @Excel(name = "头像地址")
    private String avatar;
 
    @Excel(name = "信息")
    private String errorMsg;
 
    private Integer rowNum;
 
    @Override
    public Integer getRowNum() {
        return this.rowNum;
    }
 
    @Override
    public void setRowNum(Integer i) {
        this.rowNum = i;
    }
 
    @Override
    public String getErrorMsg() {
        return this.errorMsg;
    }
 
    @Override
    public void setErrorMsg(String s) {
        this.errorMsg = s;
    }
}

4.2.2 编写controller导入方法

  @Autowired
  private IUserService userService;
 
  @PostMapping("/importExcel")
  public String importExcel(@RequestParam("file") MultipartFile file) {
        try {
            String result = userService.importExcel(file);
            return result;
        } catch (Exception e) {
            return "导入失败";
        }
   }

4.2.3 编写Service方法 

    @Autowired
    private UserVerifyHandler userVerifyHandler;
 
    @Override
    public String importExcel(MultipartFile file) throws Exception{
        ImportParams importParams = new ImportParams();
        //表格标题行数,默认0
        importParams.setTitleRows(1);
        //是否需要校验上传的Excel
        importParams.setNeedVerify(true);
        //告诉easypoi我们自定义的验证器
        importParams.setVerifyHandler(userVerifyHandler);
        ExcelImportResult<UserImportVO> result = ExcelImportUtil.importExcelMore(file.getInputStream(),UserImportVO.class,importParams);
        if (!result.isVerifyFail() && !CollectionUtils.isEmpty(result.getList())) {
            for (UserImportVO vo : result.getList()) {
                log.info("从Excel导入数据到数据库的详细为 ：{}", vo);
                User user = new User();
                BeanUtil.copyProperties(vo,user);
                this.save(user);
            }
        } else {
            for (UserImportVO vo : result.getFailList()) {
                log.info("校验失败的详细为 ：{}", vo);
            }
            return "文档校验失败";
        }
        return "导入成功";
    }

 4.2.4 自定义校验规则

通用的校验满足不了所有的校验，例如还需要通过查询数据库，校验数据的唯一性，此时需要自定义一个校验规则，实现IexcelVerifyHandler接口。

    @Component
    public class UserVerifyHandler implements IExcelVerifyHandler<UserImportVO> {
 
    @Autowired
    private IUserService userService;
 
    @Override
    public ExcelVerifyHandlerResult verifyHandler(UserImportVO vo) {
        ExcelVerifyHandlerResult result = new ExcelVerifyHandlerResult();
        //假设我们要添加用户，现在去数据库查询realName，如果存在则表示校验不通过。
        User user = userService.getOne(new LambdaQueryWrapper<User>().eq(User::getRealName,vo.getRealName()));
        if (user!=null) {
            result.setMsg("唯一校验失败");
            result.setSuccess(false);
            return result;
        }
        result.setSuccess(true);
        return result;
    }
}

 4.3 导出功能实现

4.3.1 UserExportVO导出类

导出类不需要配置校验规则，只需要定义要导出的信息。

@Data
public class UserExportVO implements Serializable {
 
    @Excel(name = "姓名")
    private String realName;
 
    @Excel(name = "性别", replace = { "男_1", "女_2" }, suffix = "生")
    private Integer sex;
 
    @Excel(name = "出生日期", format = "yyyy-MM-dd")
    private Date birthday;
 
    @Excel(name = "手机号码")
    private String phone;
 
    @Excel(name = "固定电话")
    private String tel;
 
    @Excel(name = "邮箱")
    private String email;
 
    @Excel(name = "头像地址")
    private String avatar;
 
}

4.3.2 导出Controller类

编写导出的controller类

 @GetMapping("/exportExcel")
 public void export(HttpServletResponse response) {
        //查询要导出的数据
        List<UserExportVO> users = userService.getUserExportList();
        ExcelUtil.exportExcelX(users, "测试导出表", "sheet1", UserExportVO.class, "测试导出表.xlsx", response);
 }

4.3.3 Service层

编写service层查询需要导出的数据，把查询出来的集合转化成导出VO集合。

@Override
public List<UserExportVO> getUserExportList() {
        List<User> users = this.list();
        //users集合转成export集合
        List<UserExportVO> exportVOList = users.stream().map(user -> {
            UserExportVO vo = new UserExportVO();
            BeanUtils.copyProperties(user, vo);
            return vo;
        }).collect(Collectors.toList());
        return exportVOList;
}