SpringBoot项目使用EasyPoi实现导入导出，就是这么的丝滑

前言

在项目的开发工程中，经常有导入导出数据的常见功能场景，Apache的POI是处理导入导出中最常用的，但是其原生的用法太复杂，很繁琐，总是在Copy… ，无意间发现一款简单粗暴的神器EasyPoi，EasyPoi也是基于POI的，在SpringBoot中也是做了很好的封装，让我们能够在SpringBoot 快速地使用 EasyPoi 进行开发，很方便，而且支持多种格式的导入导出。

---

一、EasyPoi简介

EasyPoi功能如同名字easy，主打的功能就是容易,让一个没见接触过poi的人员就可以方便的写出Excel导出，Excel模板导出，Excel导入，Word模板导出，通过简单的注解和模板语言(熟悉的表达式语法)，完成以前复杂的写法。

二、EasyPoi主要功能

• 基于注解的导入导出，修改注解就可以修改Excel
• 支持常用的样式自定义
• 基于map可以灵活定义的表头字段
• 支持一对多的导出，导入
• 支持模板的导出，一些常见的标签,自定义标签
• 支持HTML/Excel转换，如果模板还不能满足用户的变态需求，请用这个功能
• 支持word的导出，支持图片、Excel

三、EasyPoi注解

easypoi起因就是Excel的导入导出，最初的模板是实体和Excel的对应，model–row，filed–col 这样利用注解我们可以和容易做到excel到导入导出。

1.@Excel

这个是必须使用的注解，如果需求简单只使用这一个注解也是可以的，涵盖了常用的Excel需求。

四、开始使用

1.添加依赖

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

2.导入功能实现

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

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

2.1 UserImportVO导入类

导入类对象实现IExcelModel、IExcelDataModel 接口，可获取到错误校验信息。

1.  
   @Data
2.  
   public class UserImportVO implements Serializable,IExcelModel, IExcelDataModel {
3.  
    
4.  
   @NotBlank
5.  
   @Excel(name = "姓名")
6.  
   private String realName;
7.  
    
8.  
   @Excel(name = "性别", replace = { "男_1", "女_2" })
9.  
   private Integer sex;
10.  
     
11.  
    @Excel(name = "出生日期", format = "yyyy-MM-dd")
12.  
    private Date birthday;
13.  
     
14.  
    @Length(min=1, max=11, message = "请填写正确的手机号")
15.  
    @Excel(name = "手机号码")
16.  
    private String phone;
17.  
     
18.  
    @Excel(name = "固定电话")
19.  
    private String tel;
20.  
     
21.  
    @Email(message = "请填写正确的邮箱地址")
22.  
    @Excel(name = "邮箱")
23.  
    private String email;
24.  
     
25.  
    @Excel(name = "头像地址")
26.  
    private String avatar;
27.  
     
28.  
    @Excel(name = "信息")
29.  
    private String errorMsg;
30.  
     
31.  
    private Integer rowNum;
32.  
     
33.  
    @Override
34.  
    public Integer getRowNum() {
35.  
    return this.rowNum;
36.  
    }
37.  
     
38.  
    @Override
39.  
    public void setRowNum(Integer i) {
40.  
    this.rowNum = i;
41.  
    }
42.  
     
43.  
    @Override
44.  
    public String getErrorMsg() {
45.  
    return this.errorMsg;
46.  
    }
47.  
     
48.  
    @Override
49.  
    public void setErrorMsg(String s) {
50.  
    this.errorMsg = s;
51.  
    }
52.  
    }

2.2 controller层

在编写controller层导入方法

1.  
   @Autowired
2.  
   private IUserService userService;
3.  
    
4.  
   @PostMapping("/importExcel")
5.  
   public String importExcel(@RequestParam("file") MultipartFile file) {
6.  
   try {
7.  
   String result = userService.importExcel(file);
8.  
   return result;
9.  
   } catch (Exception e) {
10.  
    return "导入失败";
11.  
    }
12.  
    }

2.3 service层

具体的实现是在service层

1.  
   @Autowired
2.  
   private UserVerifyHandler userVerifyHandler;
3.  
    
4.  
   @Override
5.  
   public String importExcel(MultipartFile file) throws Exception{
6.  
   ImportParams importParams = new ImportParams();
7.  
   //表格标题行数,默认0
8.  
   importParams.setTitleRows(1);
9.  
   //是否需要校验上传的Excel
10.  
    importParams.setNeedVerify(true);
11.  
    //告诉easypoi我们自定义的验证器
12.  
    importParams.setVerifyHandler(userVerifyHandler);
13.  
    ExcelImportResult<UserImportVO> result = ExcelImportUtil.importExcelMore(file.getInputStream(),UserImportVO.class,importParams);
14.  
    if (!result.isVerifyFail() && !CollectionUtils.isEmpty(result.getList())) {
15.  
    for (UserImportVO vo : result.getList()) {
16.  
    log.info("从Excel导入数据到数据库的详细为 ：{}", vo);
17.  
    User user = new User();
18.  
    BeanUtil.copyProperties(vo,user);
19.  
    this.save(user);
20.  
    }
21.  
    } else {
22.  
    for (UserImportVO vo : result.getFailList()) {
23.  
    log.info("校验失败的详细为 ：{}", vo);
24.  
    }
25.  
    return "文档校验失败";
26.  
    }
27.  
    return "导入成功";
28.  
    }

2.4 ImportParams 参数

ImportParams 参数各属性介绍

2.5 自定义校验规则

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

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

2.6 测试

1.使用postman工具进行导入测试，先填充一些不符合规则的数据，可以看到控制台输出的校验错误的信息。

2.再填充一些符合规则的数据，可以看到导入成功，数据库成功插入数据。

3.导出功能实现

3.1 UserExportVO导出类

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

1.  
   @Data
2.  
   public class UserExportVO implements Serializable {
3.  
    
4.  
   @Excel(name = "姓名")
5.  
   private String realName;
6.  
    
7.  
   @Excel(name = "性别", replace = { "男_1", "女_2" }, suffix = "生")
8.  
   private Integer sex;
9.  
    
10.  
    @Excel(name = "出生日期", format = "yyyy-MM-dd")
11.  
    private Date birthday;
12.  
     
13.  
    @Excel(name = "手机号码")
14.  
    private String phone;
15.  
     
16.  
    @Excel(name = "固定电话")
17.  
    private String tel;
18.  
     
19.  
    @Excel(name = "邮箱")
20.  
    private String email;
21.  
     
22.  
    @Excel(name = "头像地址")
23.  
    private String avatar;
24.  
     
25.  
    }

3.2 controller层

编写controller层导出方法

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

3.3 service层

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

1.  
   @Override
2.  
   public List<UserExportVO> getUserExportList() {
3.  
   List<User> users = this.list();
4.  
   //users集合转成export集合
5.  
   List<UserExportVO> exportVOList = users.stream().map(user -> {
6.  
   UserExportVO vo = new UserExportVO();
7.  
   BeanUtils.copyProperties(user, vo);
8.  
   return vo;
9.  
   }).collect(Collectors.toList());
10.  
    return exportVOList;
11.  
    }

3.4 测试

直接浏览器请求导出接口，成功导出。

---

总结

这篇好文章是转载于：学新通技术网