阿里-EasyExcel导入校验

「爱情、让人受尽委屈。」 2024-04-08 13:42 7阅读 0赞

导入对应的实体类：

@Data
    public class ReqCustomerDailyImport {
        /**
         * 客户名称
         */
        @ExcelProperty(index = 0)
        private String customerName;
    
        /**
         * MIS编码
         */
        @ExcelProperty(index = 1)
        private String misCode;
    
        /**
         * 月度滚动额
         */
        @ExcelProperty(index = 3)
        private BigDecimal monthlyQuota;
    
        /**
         * 最新应收账款余额
         */
        @ExcelProperty(index = 4)
        private BigDecimal accountReceivableQuota;
    
        /**
         * 本月利率(年化）
         */
        @ExcelProperty(index = 5)
        private BigDecimal dailyInterestRate;
    }

Controller：

@PostMapping("/import")
    public void importCustomerDaily(@RequestParam MultipartFile file) throws IOException {
        InputStream inputStream = file.getInputStream();
        List<ReqCustomerDailyImport> reqCustomerDailyImports = EasyExcel.read(inputStream)
                .head(ReqCustomerDailyImport.class)
                // 设置sheet,默认读取第一个
                .sheet()
                // 设置标题所在行数
                .headRowNumber(2)
                .doReadSync();
    }

--------------------

可以看出只需要在实体对象使用@ExcelProperty注解，读取时指定该class，即可读取，并且自动

过滤了空行，对于excel的读取及其简单。不过此时发现一个问题，这样我如果要校验字段该怎么

办？要将字段类型转换成另外一个类型呢？

不必担心，我们可以想到的问题，作者肯定也考虑到了，下面来一个Demo

List<ReqCustomerDailyImport> reqCustomerDailyImports = EasyExcel.read(inputStream)
                // 这个转换是成全局的， 所有java为string,excel为string的都会用这个转换器。
                // 如果就想单个字段使用请使用@ExcelProperty 指定converter
                .registerConverter(new StringConverter())
                // 注册监听器，可以在这里校验字段
                .registerReadListener(new CustomerDailyImportListener())
                .head(ReqCustomerDailyImport.class)
                .sheet()
                .headRowNumber(2)
                .doReadSync();
    }

监听器：

public class CustomerDailyImportListener extends AnalysisEventListener {
    
        List misCodes = Lists.newArrayList();
    
        /**
         * 每解析一行，回调该方法
         * @param data
         * @param context
         */
        @Override
        public void invoke(Object data, AnalysisContext context) {
            String misCode = ((ReqCustomerDailyImport) data).getMisCode();
            if (StringUtils.isEmpty(misCode)) {
                throw new RuntimeException(String.format("第%s行MIS编码为空，请核实", context.readRowHolder().getRowIndex() + 1));
            }
            if (misCodes.contains(misCodes)) {
                throw new RuntimeException(String.format("第%s行MIS编码已重复，请核实", context.readRowHolder().getRowIndex() + 1));
            } else {
                misCodes.add(misCode);
            }
        }
    
        /**
         * 出现异常回调
         * @param exception
         * @param context
         * @throws Exception
         */
        @Override
        public void onException(Exception exception, AnalysisContext context) throws Exception {
            // ExcelDataConvertException:当数据转换异常的时候，会抛出该异常，此处可以得知第几行，第几列的数据
            if (exception instanceof ExcelDataConvertException) {
                Integer columnIndex = ((ExcelDataConvertException) exception).getColumnIndex() + 1;
                Integer rowIndex = ((ExcelDataConvertException) exception).getRowIndex() + 1;
                String message = "第" + rowIndex + "行，第" + columnIndex + "列" + "数据格式有误，请核实";
                throw new RuntimeException(message);
            } else if (exception instanceof RuntimeException) {
                throw exception;
            } else {
                super.onException(exception, context);
            }
        }
    
        /**
         * 解析完全部回调
         * @param context
         */
        @Override
        public void doAfterAllAnalysed(AnalysisContext context) {
            misCodes.clear();
        }
    }

[EasyExcel，让excel导入导出更加简单 - 腾讯云开发者社区-腾讯云][EasyExcel_excel_ - _-]

[EasyExcel工具读取Excel空数据行问题的解决办法-云海天教程][EasyExcel_Excel_-]

[easyExcel导入的时候处理空格行\_未来可期MXH的博客-CSDN博客\_easyexcel空行导入问题][easyExcel_MXH_-CSDN_easyexcel]

[EasyExcel_excel_ - _-]: https://cloud.tencent.com/developer/article/1888727
[EasyExcel_Excel_-]: https://www.yht7.com/news/203042
[easyExcel_MXH_-CSDN_easyexcel]: https://blog.csdn.net/qflyIT/article/details/114281122