快人一步！使用Easypoi，Excel导入导出不再是难事！

站长

2023年09月07日 20:01 · 阅读数 54

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中…欢迎大家订阅持续学习。

小伙伴们在批阅文章的过程中如果觉得文章对您有一丝丝帮助，还请别吝啬您手里的赞呀，大胆的把文章点亮👍吧，您的点赞三连(收藏⭐+关注👨‍🎓+留言📃)就是对bug菌我创作道路上最好的鼓励与支持😘。时光不弃🏃🏻‍♀️，创作不停💕，加油☘️

一、前言🔥

环境说明：Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

上期，我主要是带着大家学习了easypoi的一些概念及依赖配置，包括一些常用注解的使用，这期我将带着大家进行实战练习，希望大家在学习的路上虚心学习，我也不是大佬，但是我希望的写的文章能带动大家，哪怕这个大家是一个人，我也愿意帮我会的全部都倾囊相授，我就是这么一个人，让自己发光发热，带动更多人，你为大家，大家才会为你。

二、引入依赖配置

<!--easypoi依赖，excel导入导出-->
<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-spring-boot-starter</artifactId>
    <version>4.2.0</version>
</dependency>

三、实现excel导入

1、先定义一个接收实体

/**
 * excel导入user参数
 *
 * @author luoYong
 * @version 1.0
 * @date 2022/2/15 14:34
 */
@Data
public class ImportUser implements Serializable {

    private static final long serialVersionUID = 1L;


  /**
    * @Excel 作用在一个filed上面，对列的描述
    * @param name 列名
    * @param orderNum 下标，从0开始。
    */
    @Excel(name = "姓名", orderNum = "0")
    private String name;

    @Excel(name = "年龄", orderNum = "1")
    private Integer age;

    @Excel(name = "性别", orderNum = "2")
    private String sex;

    @Excel(name = "地址", orderNum = "3")
    private String address;

    @Excel(name = "用户描述", orderNum = "4")
    private String describes;
   
}

注意： 如果easypoi没有设置orderNum，默认是从上往下排序！！！

列的标题一定要和我们对象中的@Excle name名称对应，一定要对应！具体请看如下：

快人一步！使用Easypoi，Excel导入导出不再是难事！

拓展一下：

1.@Data  注解为lombok插件提供，为类提供读写功能，从而不用写get、set方法。
2.@Excel 作用到filed上面,是对Excel一列的一个描述。

2、Controller添加导入方法

/**
 * excel批量导入用户
 */
@GetMapping("/import")
@ApiOperation(value = "excel批量导入用户", notes = "excel批量导入用户")
public ResultResponse<Boolean> importUsers(@RequestParam("file") MultipartFile file) {
    return new ResultResponse<>(userService.importUsers(file));
}

3、定义导入接口

/**
 * excel批量导入用户
 *
 * @param file excel文件
 */
Boolean importUsers(MultipartFile file);

4、实现导入接口

/**
 * excel批量导入用户
 *
 * @param file excel文件
 */
@Override
public Boolean importUsers(MultipartFile file) {
    
    ImportParams importParams = new ImportParams();
    //标题行设置为1行，默认是0，可以不设置；依实际情况设置。
    importParams.setTitleRows(1);
    // 表头设置为1行
    importParams.setHeadRows(1);
    try {
        //读取excel
        List<ImportUser> users = ExcelImportUtil.importExcel(file.getInputStream(), ImportUser.class, importParams);    
        //批量插入
        boolean isSuccess = this.saveUsers(users);
        //返回结果
        return isSuccess;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return false;
}

这里需要注意表头的行数设置一定要正确！否则集合数据将无法读取报错。一定要区分表头与标题的区别，表头是列名称，标题是表头上面的文字，具体事例可以看下方截图。

示例截图文件中有标题并占用一行，所以setTitleRows设置为1。表头也占用一行，所以setHeadRows设置为1；

快人一步！使用Easypoi，Excel导入导出不再是难事！

代码具体设置如下：

importParams.setTitleRows(1);
importParams.setHeadRows(1);

然后获取到要插入到数据库中的数据之后，再使用批量插入方法，将集合插入到数据库中。

/**
 * 批量插入用户数据
 */
private boolean saveUsers(List<ImportUser> users) {

    //存放user
    List<UserEntity> userList = new ArrayList<>();

    //转成user实体
    for (ImportUser user : users) {
        UserEntity userEntity = new UserEntity(user);
        userList.add(userEntity);
    }
    //批量插入
    return this.saveBatch(userList);
}