Springboot 集成 easyexcel excel导入并验证模板

已于 2023-06-30 16:20:14 修改
阅读量2.2k 收藏 8
点赞数 1
分类专栏： java插件 文章标签： java
于 2022-03-23 15:59:46 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Sunny0209/article/details/123686412
版权

提示：文章如有错误的地方请指出，以免误人子弟！

easyexcel 导入

文章目录

提示：以下是本篇文章正文内容，下面案例可供参考

一、导入maven jar包

maven 地址

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>3.1.1</version>
</dependency>

二、直接上代码

easyexcel 官网
本文章只展示单个sheet读取。
多个sheet 读取，其实就是新加一个读sheet方法以及sheet数据类型不同，需要重写多个监听器。

  1. controller
    @Autowired
    private SysEmpInfoMapper sysEmpInfoMapper;

	@PostMapping("/importEmpExcel")
    public ResponseResult importEmpExcelInfo(MultipartFile multipartFile) {
        try {
            // 文件名称
            String fileName = multipartFile.getOriginalFilename();
            // 截取文件后缀
            String fileSuffix = null;
            if (StringUtils.isNotEmpty(fileName)) {
                fileSuffix = fileName.substring(fileName.indexOf("."));
            }
            // 判断文件是否是excel文件
            if (FinalCode.EXCEL_SUFFIX.equals(fileSuffix) || FinalCode.EXCEL_SUFFIX_PLUS.equals(fileSuffix)) {
                XSSFWorkbook xssfWorkbook = new XSSFWorkbook(multipartFile.getInputStream());
                XSSFSheet sheet = xssfWorkbook.getSheetAt(0);
                // 验证是否是指定的模板
                ResponseResult result = excelModel(sheet);
                if (!StringCommons.isEmpty(result)) {
                    return result;
                }
                else {
                    // 判断文件是否为空
                    if (sheet.getPhysicalNumberOfRows() == 1) {
                        return ResponseResult.create().success(false).msg(FinalCode.ABNORMAL_CODE, "模板数据为空");
                    }
                    EmpExcelListener empExcelListener = new EmpExcelListener(sysEmpInfoMapper);
                    EasyExcel.read(multipartFile.getInputStream(), EmpInfoExcelModel.class, empExcelListener).sheet("用户信息").doRead();
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return ResponseResult.create().success(true).data("success");
    }

验证模板的封装方法

private ResponseResult excelModel(XSSFSheet sheet) {
        XSSFRow row = null;
        ResponseResult result = null;
        boolean flagWait = true;
        for (int i = 0; i < sheet.getPhysicalNumberOfRows(); i++) {
            boolean flag = false;
            if (i == 0) {
                flag = true;
            }
            row = sheet.getRow(i);
            if (flag) {
                if (!StringCommons.isEmpty(row.getCell(0))) {
                    String stringCellValue = row.getCell(0).getStringCellValue();
                    if (!"工号".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(1))) {
                    String stringCellValue = row.getCell(1).getStringCellValue();
                    if (!"昵称".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(2))) {
                    String stringCellValue = row.getCell(2).getStringCellValue();
                    if (!"姓名".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(3))) {
                    String stringCellValue = row.getCell(3).getStringCellValue();
                    if (!"性别".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(4))) {
                    String stringCellValue = row.getCell(4).getStringCellValue();
                    if (!"年龄".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(5))) {
                    String stringCellValue = row.getCell(5).getStringCellValue();
                    if (!"出生日期".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(6))) {
                    String stringCellValue = row.getCell(6).getStringCellValue();
                    if (!"手机号".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(7))) {
                    String stringCellValue = row.getCell(7).getStringCellValue();
                    if (!"电子邮箱".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(8))) {
                    String stringCellValue = row.getCell(8).getStringCellValue();
                    if (!"身份证号".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(9))) {
                    String stringCellValue = row.getCell(9).getStringCellValue();
                    if (!"学历".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(10))) {
                    String stringCellValue = row.getCell(10).getStringCellValue();
                    if (!"毕业院校".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(11))) {
                    String stringCellValue = row.getCell(11).getStringCellValue();
                    if (!"省市区".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(12))) {
                    String stringCellValue = row.getCell(12).getStringCellValue();
                    if (!"详细地址".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(13))) {
                    String stringCellValue = row.getCell(13).getStringCellValue();
                    if (!"入职时间".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(14))) {
                    String stringCellValue = row.getCell(14).getStringCellValue();
                    if (!"部门名称".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(15))) {
                    String stringCellValue = row.getCell(15).getStringCellValue();
                    if (!"职位名称".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
                if (!StringCommons.isEmpty(row.getCell(16))) {
                    String stringCellValue = row.getCell(16).getStringCellValue();
                    if (!"创建时间".equals(stringCellValue)) {
                        flagWait = false;
                        break;
                    }
                }
            }
        }
        if (!flagWait) {
            result = ResponseResult.create().success(false).msg(FinalCode.ABNORMAL_CODE, "请使用正确模板填写");
        }
        return result;
    }

EmpInfoExcelModel.class 这个就是接收excel sheet数据类型所需的实体类

/**
 * @author 
 * @date 2021/01/27 11:00
 * HeadStyle：表头背景颜色为白色
 * ContentRowHeight：内容行高
 * HeadRowHeight：表头行高
 * ContentStyle：内容水平居中
 */
@HeadStyle(fillPatternType = FillPatternTypeEnum.SOLID_FOREGROUND, fillForegroundColor = 9)
@ContentRowHeight(18)
@HeadRowHeight(25)
@ContentStyle(horizontalAlignment = HorizontalAlignmentEnum.CENTER)
@Data
@JsonInclude(value = JsonInclude.Include.NON_NULL)
public class EmpInfoExcelModel implements Serializable {
    /**
     * description: @ExcelIgnore不导出该字段
     */
    @ExcelIgnore
    @ColumnWidth(8)
    @ExcelProperty(value = "ID", index = 0)
    private String id;
    @ColumnWidth(10)
    @ExcelProperty(value = "工号")
    private String jobNumber;
    @ColumnWidth(15)
    @ExcelProperty(value = "昵称")
    private String userName;
    @ColumnWidth(10)
    @ExcelProperty(value = "姓名")
    private String fullName;
    @ColumnWidth(8)
    @ExcelProperty(value = "性别")
    private String gender;
    @ColumnWidth(8)
    @ExcelProperty(value = "年龄")
    private Integer age;
    @ColumnWidth(17)
    @ExcelProperty(value = "出生日期")
    private String birthday;
    @ColumnWidth(15)
    @ExcelProperty(value = "手机号")
    private String userPhone;
    @ColumnWidth(20)
    @ExcelProperty(value = "电子邮箱")
    private String userMail;
    @ColumnWidth(25)
    @ExcelProperty(value = "身份证号")
    private String idNumber;
    @ColumnWidth(10)
    @ExcelProperty(value = "学历")
    private String education;
    @ColumnWidth(30)
    @ExcelProperty(value = "毕业院校")
    private String graduationSchool;
    @ColumnWidth(25)
    @ExcelProperty(value = "省市区")
    private String address;
    @ColumnWidth(35)
    @ExcelProperty(value = "详细地址")
    private String detailedAddress;
    @ColumnWidth(22)
    @ExcelProperty(value = "入职时间")
    private String entryTime;
    @ColumnWidth(18)
    @ExcelProperty(value = "部门名称")
    private String depName;
    @ColumnWidth(18)
    @ExcelProperty(value = "职位名称")
    private String roleName;
    //    @ColumnWidth(18)
//    @ExcelProperty(value = "权限名称")
//    private String perName;
    @ColumnWidth(22)
    @ExcelProperty(value = "创建时间")
    private String createTime;
}

监听器

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.fastjson.JSON;
import com.hqll.system.entity.doo.system.SysEmpInfoDO;
import com.hqll.system.entity.dto.system.EmpInfoExcelModel;
import com.hqll.system.mapper.system.SysEmpInfoMapper;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.BeanUtils;

import java.util.List;
import java.util.UUID;

/**
 * @author Tigger
 * @date 2023/2/3 19:55
 */
@Slf4j
public class EmpExcelListener implements ReadListener<EmpInfoExcelModel> {

    /**
     * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    /**
     * 缓存的数据
     */
    private List<SysEmpInfoDO> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    /**
     * 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
     */
    private SysEmpInfoMapper sysEmpInfoMapper;

    /**
     * description: 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
     *
     * @param sysEmpInfoMapper sysEmpInfoMapper
     * @return
     * @author Tigger
     */
    public EmpExcelListener(SysEmpInfoMapper sysEmpInfoMapper) {
        this.sysEmpInfoMapper = sysEmpInfoMapper;
    }

    /**
     * description: 这个每一条数据解析都会来调用
     *
     * @param empInfoExcelModel 表格数据
     * @param analysisContext analysisContext
     * @return void
     * @author Tigger
     */
    @Override
    public void invoke(EmpInfoExcelModel empInfoExcelModel, AnalysisContext analysisContext) {
        log.info("解析到一条数据:{}", JSON.toJSONString(empInfoExcelModel));
        empInfoExcelModel.setBirthday(empInfoExcelModel.getBirthday().replace("/", "-"));
        empInfoExcelModel.setEntryTime(empInfoExcelModel.getEntryTime().replace("/", "-"));
        empInfoExcelModel.setCreateTime(empInfoExcelModel.getCreateTime().replace("/", "-"));
        SysEmpInfoDO sysEmpInfoDO = new SysEmpInfoDO();
        BeanUtils.copyProperties(empInfoExcelModel, sysEmpInfoDO);
        sysEmpInfoDO.setId(UUID.randomUUID().toString());
        // 性别
        String gender = sysEmpInfoDO.getGender();
        if (StringUtils.isNotEmpty(gender)) {
            String genderName = "女";
            String name;
            if (genderName.equals(gender)) {
                name = "x";
            }
            else {
                name = "y";
            }
            sysEmpInfoDO.setGender(name);
        }
        // 查询部门id
        if (StringUtils.isNotEmpty(empInfoExcelModel.getDepName())) {
            String depName = empInfoExcelModel.getDepName();
            Integer depId = sysEmpInfoMapper.getDepartmentId(depName);
            sysEmpInfoDO.setDepId(depId);
        }
        // 查询角色id
        if (StringUtils.isNotEmpty(empInfoExcelModel.getRoleName())) {
            String roleName = empInfoExcelModel.getRoleName();
            Integer roleId = sysEmpInfoMapper.getRoleId(roleName);
            sysEmpInfoDO.setRoleId(roleId);
        }

        cachedDataList.add(sysEmpInfoDO);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if (cachedDataList.size() >= BATCH_COUNT) {
            saveData();
            // 存储完成清理 list
            cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        }
    }

    /**
     * description: 所有数据解析完成了 都会来调用
     *
     * @param analysisContext
     * @return void
     * @author Tigger
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        // 这里也要保存数据，确保最后遗留的数据也存储到数据库
        if (cachedDataList.size() > 0) {
            saveData();
        }
        log.info("所有数据解析完成！");
    }

    /**
     * description: 加上存储数据库
     *
     * @param
     * @return void
     * @author Tigger
     */
    private void saveData() {
        log.info("{}条数据，开始存储数据库！", cachedDataList.size());
        int i = sysEmpInfoMapper.addEmpInfoList(cachedDataList);
        if (i > 0) {
            log.info("存储数据库成功！");
        }
    }
}
  1. mapper
    /**
     * description: 批量添加用户信息
     *
     * @param list 用户集合
     * @return int
     * @author Tigger
     */
    int addEmpInfoList(List<SysEmpInfoDO> list);
  1. sql
	<insert id="addEmpInfoList" parameterType="java.util.List">
        insert into sys_emp_info (
            id,
            job_number,
            userName,
            full_name,
            gender,
            birthday,
            userPhone,
            userMail,
            id_number,
            education,
            graduation_school,
            address,
            detailed_address,
            entry_time,
            depId,
            roleId,
            create_time
        )
        values
        <foreach collection="list" item="item" index="index" separator=",">
            (#{item.id},
            #{item.jobNumber},
            #{item.userName},
            #{item.fullName},
            #{item.gender},
            #{item.birthday},
            #{item.userPhone},
            #{item.userMail},
            #{item.idNumber},
            #{item.education},
            #{item.graduationSchool},
            #{item.address},
            #{item.detailedAddress},
            #{item.entryTime},
            #{item.depId},
            #{item.roleId},
            #{item.createTime})
        </foreach>
    </insert>

希望对你有所帮助！

Springboot 集成 easyexcel 实现导出

WWWh0209
关注
  • 1
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot集成EasyExcel导入导出excel表格
cnuwsn的博客
12-25 931
1.demo 1.引入依赖 <!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel --> <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2
easyexcel 根据模板导出_SpringBoot整合easyexcel
weixin_42560530的博客
12-18 4246
什么是easyexcel 什么是easyexcel，easyexcel是阿里开发的一款简易的excel导出的工具，在一般的后台管理中都少不了excel的导出。以前一般用的都是poi做导出的功能，但是这种原生的excel导出excel的功能是在太麻烦了，如果有架构师帮你封装好给你用那还好点。但是这种一般都是自己去整合，而且poi导出excel的功能会有很多bug，就比如最常见的oom异常，...
阿里-EasyExcel导入校验
兴趣是最好的老师
06-23 1333
可以看出只需要在实体对象使用@ExcelProperty注解，读取时指定该class，即可读取，并且自动。过滤了空行，对于excel的读取及其简单。不过此时发现一个问题，这样我如果要校验字段该怎么。不必担心，我们可以想到的问题，作者肯定也考虑到了，下面来一个Demo。要将字段类型转换成另外一个类型呢？
java-通过easyexcel生成本地xlsx文件--工具类---使用方法
wglwgl55的博客
03-29 602
java通过响应集合实体，生成对应的excel表格
EasyExcel 校验后导入
qq56477643的博客
04-07 452
/</</</
验证EXCEL导入模板是否符合标准
12-04
C#系统写的验证EXCEL导入模板是否标准，可以验证EXCEL文件名、工作表名、字段名称，经过半天的研究和实践，已经完成，与大家共享
EasyExcel判断导入时是否符合给定模板
a2667486939的博客
02-19 7360
EasyExcel导入时判断是否符合给定模板
EasyExcel实现导入+各种数据校验
qq_43759721的博客
03-02 1万+
1.导入非xls和xlsx格式的文件 2.导入空数据的excel文件 3.数据缺失 4.导入的excel文件中有重复的数据 5.导入的excel文件数据错误 6.导入的模板不是正确模板
EasyExcel实现导入并校验
热门推荐
王华春_Jason
12-07 1万+
总结公司业务中需要用户导入Excel数据，并且每次几万条，要求速度快，用户操作方便灵活，有些非必填字段的数据可以为空。当然目前有很多成熟的框架都可以实现该功能，在这里就不详细的描述我们是如何选择这些框架的过程，我们选择的是阿里的easyExcel框架，号称操作简单、省内存、性能稳定等。导入功能本身并没什么复杂的，这里主要想分享下我在
EasyExcel实现批量导入，校验导入模板是否匹配
MiaoJ94的博客
06-21 545
null。
springboot整合easyexcel实现excel文件上传解析，下载导出简单实例.zip
11-10
best20182022-10-17 14:55:20原证springboot整合easyexcel实现excel文件上传解析，下载导出简单实例 项目描述 springboot整合easyexcel，上传解析Excel，下载导出Excel 运行环境 jdk8+tomcat9+IntelliJ IDEA+...
SpringBoot整合EasyExcel+MyBatis-Plus实现Excel批量导入和导出
最新发布
05-03
SpringBoot整合EasyExcel+MyBatis-Plus实现Excel批量导入和导出
SpringBoot集成EasyExcel快速入门Demo
04-07
编译器版本：IntelliJ IDEA 2020.3.2 x64 JDK版本：java 1.8.0_111 SpringBoot集成EasyExcel快速入门Demo，实现excel上传与下载功能
SpringBoot整合EasyExcel进行报表导入导出实例Demo
11-19
SpringBoot整合EasyExcel进行报表导入导出代码实例
spring-boot-excel springboot整合easyexcel 有注释 打开可以运行
04-08
spring-boot-excel springboot整合easyexcel 有注释 打开可以运行 妈妈再也不用担心我不会导出导入了
easyExcel验证表头与模板是否一致
weixin_44792849的博客
02-03 3233
在监听器中重写invokeHeadMap，校验表头与模板是否一致,比如读取数据时我们写从第二行开始读，会认为第零行和第一行是表头，这里会读取到两次表头，根据下标和表头内容可以验证表头与模板是否一致。为了保证数据的完整性，当模板被修改后，就不应该导入数据，
easyexcel导入进行通用校验
梵法利亚的博客
12-24 3700
Target({//是否为空，默认不为空。//是否进行格式检验，默认不进行。//格式检验类型，int 已经支持的类型有 0->ip、1->端口、2->时间日期格式、 int length() default - 1;//长度校验， int 字符串的长度，-1不进行校验 boolean checkDict() default false;//是否进行格式检验，默认不进行。//字典名称，用于查询关联字典数据 }
EasyExcel 批量导入并校验数据
Mr_Wanter
06-12 3983
EasyExcel 批量导入并校验数据。
springboot集成easyexcel的导入
09-07
要在Spring Boot中集成easyexcel进行导入，您需要进行以下步骤： 1. 首先，您需要在您的项目中添加easyexcel的相关依赖。在您的pom.xml文件中添加以下依赖： ``` <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.1.4</version> </dependency> ``` 2. 您需要创建一个控制器类来处理导入请求。在该类中，您可以使用`@PostMapping`注解来处理导入请求，并将上传的文件作为`MultipartFile`参数。在该方法中，您可以调用相应的服务类来处理导入逻辑。以下是一个示例控制器类的代码： ```java @RestController @RequestMapping("/excel") public class ExcelController { @Autowired private ExcelService excelService; @PostMapping("/user/excelImport") public String excelImport(@RequestParam("file") MultipartFile file) throws IOException { excelService.excelImport(file); return "success"; } } ``` 3. 您还需要创建一个服务类来处理导入逻辑。在该类中，您可以使用easyexcel提供的API来读取并处理Excel文件。以下是一个示例服务类的代码： ```java @Service public class ExcelService { public void excelImport(MultipartFile file) throws IOException { // 使用easyexcel API读取并处理Excel文件 InputStream inputStream = file.getInputStream(); EasyExcel.read(inputStream, YourDataClass.class, new YourDataListener()).sheet().doRead(); } } ``` 4. 最后，您还需要创建一个数据监听器类来处理导入的Excel数据。您可以在此类中实现`AnalysisEventListener`接口，并重写对应的方法来处理每一行的数据。以下是一个示例数据监听器类的代码： ```java public class YourDataListener extends AnalysisEventListener<YourDataClass> { @Override public void invoke(YourDataClass data, AnalysisContext context) { // 处理每一行的数据 } @Override public void doAfterAllAnalysed(AnalysisContext context) { // 所有数据解析完成后的操作 } } ``` 以上就是在Spring Boot中集成easyexcel进行导入的基本步骤。您可以根据您的具体需求进行相应的调整和扩展。<span class="em">1</span><span class="em">2</span><span class="em">3</span><span class="em">4</span>

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值