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

前言

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

本篇文章就给大家介绍下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需求。

属性	类型	默认值	功能
name	String	null	列名
orderNum	String	“0”	列的排序
replace	String[]	{}	值的替换 {a_id,b_id}
type	int	1	导出类型 1 是文本 2 是图片,3 是函数,10 是数字 默认是文本
exportFormat	String	“”	导出的时间格式,以这个是否为空来判断是否需要格式化日期
importFormat	String	“”	导入的时间格式,以这个是否为空来判断是否需要格式化日期
format	String	“”	时间格式,相当于同时设置了exportFormat 和 importFormat
suffix	String	“”	文字后缀,如% 90 变成90%
isHyperlink	boolean	false	超链接,如果是需要实现接口返回对象
isImportField	boolean	true	校验字段,看看这个字段是不是导入的Excel中有,如果没有说明是错误的Excel,读取失败,支持name_id
## 2.@ExcelCollection
一对多的集合注解，用以标记集合是否被数据以及集合的整体排序
属性	类型	默认值	功能
--------	-----	-------	-----
id	String	null	定义ID
name	String	null	定义集合列名,支持nanm_id
orderNum	int	0	排序,支持name_id
type	Class	ArrayList.class	导入时创建对象使用

四、开始使用

1.添加依赖

   cn.afterturn
   easypoi-spring-boot-starter
   4.2.0

2.导入功能实现

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

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

2.1 UserImportVO导入类

导入类对象实现IExcelModel、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;
    }
}

2.2 controller层

在编写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 "导入失败";
        }
    }

2.3 service层

具体的实现是在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 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 "导入成功";
    }

2.4 ImportParams 参数

ImportParams 参数各属性介绍

属性	类型	默认值	功能
titleRows	int	0	表格标题行数,默认0
headRows	int	1	表头行数,默认1
startRows	int	0	字段真正值和列标题之间的距离 默认0
startSheetIndex	int	0	开始读取的sheet位置,默认为0
needVerfiy	boolean	false	是否需要校验上传的Excel
needSave	boolean	false	是否需要保存上传的Excel
saveUrl	String	"upload/excelUpload"	保存上传的Excel目录,默认是 如 TestEntity这个类保存路径就是upload/excelUpload/Test/yyyyMMddHHmss* 保存名称上传时间五位随机数
importFields	String[]	null	导入时校验数据模板,是不是正确的Excel
verifyHanlder	IExcelVerifyHandler	null	校验处理接口,自定义校验
dataHanlder	IExcelDataHandler	null	数据处理接口,以此为主,replace,format都在这后面

2.5 自定义校验规则

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

@Component
public class UserVerifyHandler implements IExcelVerifyHandler {

    @Autowired
    private IUserService userService;

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

2.6 测试

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

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

3.导出功能实现

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;

}

3.2 controller层

编写controller层导出方法

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

3.3 service层

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

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

3.4 测试

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

---

总结

好了，以上就是今天要讲的内容，感谢大家的阅读。本文仅仅简单介绍了使用EasyPoi导入导出功能的使用，而EasyPoi还提供了模板的导出、图片的导出、word的导出等等功能，