【Java】使用easyExcel导入复杂表格

PHP转Java的第三周，边工作边学习；
今天记录的是Java使用easyExcel导入复杂表格。

1. 导入依赖

首先，导入maven依赖，对于已导入的maven依赖的小伙伴请忽略这一步，切勿重复导入不同版本的统一依赖，会造成依赖冲突。

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

2. 创建实体类

这里推荐使用lombok，可以不用写大量丑陋的getter、setter、toString方法；
easyExcel提供的 @ExcelProperty 注解，可以自动绑定列名到变量，当然可玩性远不止此

名称	默认值	描述
value	空	用于匹配excel中的头，必须全匹配,如果有多行头，会匹配最后一行头
order	Integer.MAX_VALUE	优先级高于value，会根据order的顺序来匹配实体和excel中数据的顺序
index	-1	优先级高于value和order，会根据index直接指定到excel中具体的哪一列
converter	自动选择	指定当前字段用什么转换器，默认会自动选择。读的情况下只要实现com.alibaba.excel.converters.Converter#convertToJavaData(com.alibaba.excel.converters.ReadConverterContext<?>) 方法即可

更多注解信息可见 官方文档

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

import java.math.BigDecimal;

@Data
public class ExcelData {

    @ExcelProperty("终端号")
    private String zdh;
    @ExcelProperty("发卡行")
    private String fkh;
    @ExcelProperty("卡种")
    private String kz;
    @ExcelProperty("卡号-序列号")
    private String khxlh;
    @ExcelProperty("交易日期")
    private String jyrq;
    @ExcelProperty("交易时间")
    private String jysj;
    @ExcelProperty("交易类型")
    private String jylx;
    @ExcelProperty("授权号")
    private String sqh;
    @ExcelProperty("交易金额")
    private BigDecimal jyje;
    @ExcelProperty("小费")
    private BigDecimal xf;
    @ExcelProperty("分期期数")
    private String fqqs;
    @ExcelProperty("银行手续费")
    private BigDecimal yhsxf;
    @ExcelProperty("dcc返还手续费")
    private BigDecimal dccfhsxf;
    @ExcelProperty("划账金额")
    private BigDecimal hzje;
    @ExcelProperty("凭证号")
    private String pzh;
    @ExcelProperty("批次号")
    private String pch;
    @ExcelProperty("pos交易序列号")
    private String posjyxlh;
    @ExcelProperty("结算账号")
    private String jszh;
    @ExcelProperty("订单号")
    private String ddh;
    @ExcelProperty("柜台编号")
    private String gtbh;
    @ExcelProperty("系统参考号")
    private String xtckh;
    @ExcelProperty("持卡人姓名")
    private String ckrxm;
    @ExcelProperty("付款凭证号")
    private String fkpzh;
    @ExcelProperty("备注1")
    private String bz1;
    @ExcelProperty("备注2")
    private String bz2;
}

3. 创建监听器

// 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
@Slf4j
public class DemoDataListener implements ReadListener<DemoData> {

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

    public DemoDataListener() {
        // 这里是demo，所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
        demoDAO = new DemoDAO();
    }

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

    /**
     * 这个每一条数据解析都会来调用
     *
     * @param data    one row value. Is is same as {@link AnalysisContext#readRowHolder()}
     * @param context
     */
    @Override
    public void invoke(DemoData data, AnalysisContext context) {
        log.info("解析到一条数据:{}", JSON.toJSONString(data));
        cachedDataList.add(data);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if (cachedDataList.size() >= BATCH_COUNT) {
            saveData();
            // 存储完成清理 list
            cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        }
    }

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

    /**
     * 加上存储数据库
     */
    private void saveData() {
        log.info("{}条数据，开始存储数据库！", cachedDataList.size());
        demoDAO.save(cachedDataList);
        log.info("存储数据库成功！");
    }
}

4. 根据需要创建持久层

/**
 2. 假设这个是你的DAO存储。当然还要这个类让spring管理，当然你不用需要存储，也不需要这个类。
 **/
public class DemoDAO {
    public void save(List<DemoData> list) {
        // 如果是mybatis,尽量别直接调用多次insert,自己写一个mapper里面新增一个方法batchInsert,所有数据一次性插入
    }
}

5. 业务代码

private List<ZbillSourceRun> doLoadSourceBillExcel(String periodNo, String source, String sourceAppId) {
        String uploadPath = "D:\\银行账单\\";
        // String excelNameComplete = "SHOP.105130680620056.20240102.02.success - 副本.xlsx";
        String excelNameComplete = "SHOP.20240102.02.success.xlsx";
        String fileName = uploadPath + excelNameComplete;
        List<ExcelData> cachedDataList = new ArrayList<>();
		// fileName
		// 实体类
		// 监听器
        EasyExcel.read(fileName, ExcelData.class, new PageReadListener<ExcelData>(dataList -> {
                    for (ExcelData excelData : dataList) {
                        Pattern pattern = Pattern.compile("\\d{8}");
                        Matcher matcher = pattern.matcher(excelData.getZdh());
                        if (matcher.matches()) {
                            cachedDataList.add(excelData);
                        }
                    }
                }))
                .sheet("special_mcht_bill_plate") // 选择要导入的sheet页
                .headRowNumber(27) // 选择表头列，此处非从0开始索引，直接写表头列行号就可以
                .doRead(); // 执行读取
		/**
		 *  下方为业务处理，无需更多关注
		 **/
        List<ZbillSourceRun> sourceRunReally = Lists.newArrayList();
        ZbillSourceRun sourceRun;
        JSONObject extraData;
        for (ExcelData excelData : cachedDataList) {
            sourceRun = new ZbillSourceRun();

            BigDecimal amount = excelData.getJyje();
            sourceRun.setAmount(new BigDecimal(String.valueOf(amount)).abs());
            sourceRun.setSource("BDEYSesyy");

            this.verifyParam(sourceRun);
            sourceRunReally.add(sourceRun);
        }

        return sourceRunReally;
    }