在线问题反馈模块实战(十八):实现excel台账文件记录批量导入功能

👨‍🎓作者：bug菌
✏️博客：CSDN、掘金、infoQ、51CTO等
🎉简介：CSDN博客专家，C站历届博客之星Top50，掘金/InfoQ/51CTO等社区优质创作者，全网合计8w粉+，对一切技术感兴趣，重心偏Java方向；硬核公众号「猿圈奇妙屋」，欢迎小伙伴们的加入，一起秃头，一起变强。
..
✍️温馨提醒：本文字数：1999字, 阅读完需：约 5 分钟

嗨，家人们，我是bug菌呀，我又来啦。今天我们来聊点什么咧，OK，接着为大家更《springboot零基础入门教学》系列文章吧。希望能帮助更多的初学者们快速入门！

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

一、前言🔥

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

接下来的这几期，bug菌想跟大家分享一下自己昨天刚接到一个临时的需求，热乎着呢，想分享一下自己是如何面对临时需求并制定整个开发周期，其中包括从梳理业务到创建业务表再到实现业务逻辑形成闭环再到与前端对接，其中会穿插一些业务拓展及功能性拓展，这一条龙流程在线与大家一起见证，分享给刚入门的小伙伴，希望对你们有所帮助。

环境说明：idea2019.3 + springboot2.3.1.REALSE + mybati-plus3.2.0 + mysql5.6 + jdk1.8

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

二、概述🔥

时间犹如白驹过隙，一转眼已是六月中旬，高考也告一段落，曾忆起自己当年这个时候已是放飞自我，整天到处约同学戏耍，然而，时过境迁，我以一名社会人的身份坐在办公室，怀揣着当时的心情一起为你们祈祷，能在这场无硝烟的战场上一举成名，金榜题名，寒窗苦读十二载，不就为了这一次，希望高考结果都令你所愿，而我却只能站在你们的前面，以回忆作伴，来祭奠我那逝去的青春。作罢作罢！咱们说正事儿。

由于上一期我给大家演示了如何从服务器下载excel模板文件，你们就可能猜到了，会有此期业务场景的诞生，由于考虑前期问题及需求迭代比较多，借此就提出了需要满足用户能够通过excel文件导入问题数据，那么，既然要满足该需求，第一点就是需要按我们所给的台账模块来填写，唯有这样，我们才能通过代码方式来读取excel文件数据，从而将记录保存入库即可。

该场景在现实中也是很常见的一种，所以对于大家而言，也是司空见惯，借此，这期就跟大家一起聊聊如何实现的事儿吧。

三、如何代码实现excel导入功能🔥

0️⃣依赖引入

对于excel的导入导出功能，我们这里用到的是easypoi的开源组件，也推荐大家使用。简单介绍一下，easyPoi是一种专门用于做poi的工具集，使用起来简单且易上手，而且它提供了很多简单的注解和模板语言(熟悉的表达式语法)来完成以前poi复杂的写法。

so，只需要在你们的pom依赖配置文件中加上如下依赖配置，你们就能使用它啦。

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

1️⃣定义Controller请求

由于excel文件导入，即我们只需要开个口子将用户上传的excel接收即可。所以我们对于文件类的处理统一都是用MultipartFile类来接收即可。

    /**
     * excel批量导入问题反馈
     */
    @GetMapping("/import")
    @ApiOperation(value = "excel批量导入问题反馈", notes = "excel批量导入问题反馈")
    public ResultResponse<Boolean> importUsers(@ApiParam("excel文件") MultipartFile file) {
        return new ResultResponse<>(userQuestionsService.importQuestions(file));
    }

2️⃣定义接口方法importQuestions()

对于该接口，我们也是只需要返回一个boolean值即可。因为最后执行结果就是记录的批量写入，返回结果就是一个布尔值。

    /**
     * excel批量导入问题反馈
     */
    Boolean importQuestions(MultipartFile file);

3️⃣实现方法importQuestions()

想要实现该方法，我们还要定义一个导入pojo，它是对应于你excel文件中的列名，底层如何实现的你们可以去看看，一一对应是有先后顺序的，这里我给大家做个示例，具体如何定义请看如下样例，这也是我整期内容所用到的导入类。

ImportQuestions.java

@Data
public class ImportQuestions implements Serializable {
    private static final long serialVersionUID = 1L;

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

    @Excel(name = "域账号", orderNum = "1",width = 10.0)
    private String creatorAccountId;

    @Excel(name = "部门名称", orderNum = "2",width = 5.0)
    private String creatorDeptName;

    @Excel(name = "反馈问题类型", orderNum = "3",width = 30.0)
    private String questionType;

    @Excel(name = "反馈问题详情", orderNum = "4",width = 20.0)
    private String questionContent;

    @Excel(name = "问题所在页面", orderNum = "4",width = 20.0)
    private String inPage;

}

不会定义的你们跟着我给出的excel模板文件来写，就能知道它是如何进行确定字段类型，及@Excel注解中的属性了。

定义好了导入pojo，接下来就是要实现如何从excel文件中读取数据且insert入库了。这里分为两步，第一步获取excel文件数据，第二步就是将获取到的数据进行保存入库。

接下来我先给大家演示第一步的实现代码。

    /**
     * excel批量导入问题反馈
     */
    @Override
    public Boolean importQuestions(MultipartFile file) {

        ImportParams importParams = new ImportParams();
        //标题行设置为1行，默认是0，可以不设置；依实际情况设置。
        importParams.setTitleRows(1);
        // 表头设置为1行
        importParams.setHeadRows(1);
        // 第几个sheet页
        importParams.setStartSheetIndex(0);
        try {
            List<ImportQuestions> questions = ExcelImportUtil.importExcel(file.getInputStream(), ImportQuestions.class, importParams);
            //批量插入
            boolean isSuccess = this.saveQuestions(questions);
            return isSuccess;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
    }

如上写法，你们就按照我写的逻辑直接用就可以了。对于其中的savaQuestions()方法，也就是我所提到的第二步，实现逻辑有二，第一将pojo导入类转成Entity实体，第二将执行saveBatch()批量插入方法，最终目的是将excel中的所有记录成功保存入库。

    /**
     * 批量保存问题反馈记录
     *
     * @param questions
     */
    boolean saveQuestions(List<ImportQuestions> questions) {
        //存放UserQuestionsEntity
        List<UserQuestionsEntity> questionsEntityList = new ArrayList<>();

        //转成UserQuestionsEntity实体
        for (ImportQuestions question : questions) {
            //验空
            if (question != null) {
                UserQuestionsEntity questionsEntity = new UserQuestionsEntity(question);

                questionsEntityList.add(questionsEntity);
            }
        }
        //批量插入
        return this.saveBatch(questionsEntityList);
    }

如上代码就已经实现了从上传excel到读取excel记录再到批量插入记录入库几步，接下来就是要测试这个接口是否能完美运行通过了。