easyExcel 单元格合并

需求

现在有一张员工表，需要将员工信息导出为excel，同一个部门放在一起，同一个工资段放在一起。

case

在这里插入图片描述

员工表

package com.tx.test.testeasyexcel.excel;

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.annotation.write.style.ContentRowHeight;
import com.alibaba.excel.annotation.write.style.HeadRowHeight;
import com.tx.test.testeasyexcel.excel.converter.LocalDateTimeConverter;
import lombok.Builder;
import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * @description: 用户excel
 * @author: tx
 * @date: 2024/8/27 14:38
 * @version: 1.0
 */
@Data
@Builder
@ColumnWidth(25)
@HeadRowHeight(20)
@ContentRowHeight(18)
public class UserExcel implements Serializable {

    private static final long serialVersionUID = -5905730761779621234L;
    @ExcelProperty(value = {"用户信息", "部门"})
    private String dept;

    @ExcelProperty(value = {"用户信息", "部门描述"})
    private String deptDescription;

    @ExcelProperty(value = {"用户信息", "工资范围"})
    private String salaryRange;

    @ExcelProperty(value = {"用户信息", "工资"})
    private Double salary;

    @ExcelProperty(value = {"用户信息", "id"})
    private Long id;

    @ExcelProperty(value = {"用户信息", "姓名"})
    private String name;

    @ExcelProperty(value = {"用户信息", "生日"},converter = LocalDateTimeConverter.class)
    private LocalDateTime birthday;
}

处理

需要实现 easyExcel 的 CellWriteHandler 接口的 afterCellDispose 方法。
根据自定义的合并条件添加或修改 Sheet 单元格范围地址信息(MergedRegions)

我们先定义一个接口，用于自定义合并条件。接口有2个参数，一个是当前行，一个是上一行；返回结果是一个boolean值，true表示这两行的指定列需要合并需要，false表示不需要合并。

package com.tx.test.testeasyexcel.excel.handler;

import org.apache.poi.ss.usermodel.Row;

/**
 * @description: 合并条件接口
 * @author: tx
 * @date: 2024/8/27 16:49
 * @version: 1.0
 */
public interface MergeCondition {
    /**
     * 判断是否需要合并
     * @param cur 当前行
     * @param pre 前一行
     * @return 是否需要合并
     */
    boolean merged(Row cur, Row pre);
}

实现easyexcel的CellWriteHandler 接口，实现其中的afterCellDispose 方法。

为了方便使用以及自定义条件合并，该类定义了4个成员变量，在使用该类进行处理时需要通过构造函数传入这4个变量。4个变量分别是:
private int optLastColumnIdx;// 合并列的条件判断中需要使用到的最后一列，避免在进行判断时无法获取到该列的数据
private int[] mergeColumns; // 需要合并的列的下标数组
private MergeCondition mc; // 合并条件
private int startIdx; // 数据的起始行
大致流程如下

值得注意的是单元格合并如果合并的上一行已经被合并了，需要先移除上一行单元格所在的合并范围地址信息，然后最后一行加1再添加进去。

package com.tx.test.testeasyexcel.excel.handler;

import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.write.handler.CellWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
import lombok.extern.slf4j.Slf4j;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellRangeAddress;

import java.util.List;

/**
 * @description: 自定义单元格合并处理
 * @author: tx
 * @date: 2024/8/27 15:04
 * @version: 1.0
 */
@Slf4j
public class customCellWriteHandler implements CellWriteHandler {
    private int optLastColumnIdx;
    // 需要合并的列
    private int[] mergeColumns;
    // 合并条件
    private MergeCondition mc;
    // 数据起始行
    private int startIdx;

    /**
     * @param optLastColumnIdx 操作需要使用的最后一列，
     *                         主要用于将合并操作定位到这一列，避免一些使用的到数据还未被填充到excel中,导致无法正常判断。
     * @param startIdx         数据的起始行，从0开始计数
     * @param mergeColumns     需要合并的列
     * @param mc               合并条件
     */
    public customCellWriteHandler(int optLastColumnIdx, int startIdx, int[] mergeColumns, MergeCondition mc) {
        this.optLastColumnIdx = optLastColumnIdx;
        this.startIdx = startIdx;
        this.mergeColumns = mergeColumns;
        this.mc = mc;
    }

    @Override
    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row, Head head, Integer integer, Integer integer1, Boolean aBoolean) {

    }

    @Override
    public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer integer, Boolean aBoolean) {

    }

    @Override
    public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, CellData cellData, Cell cell, Head head, Integer integer, Boolean aBoolean) {

    }

    @Override
    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<CellData> list, Cell cell, Head head, Integer integer, Boolean aBoolean) {
        // 获取行号
        int rowIndex = cell.getRowIndex();
        // 获取列号
        int columnIndex = cell.getColumnIndex();
        // 行号 <= 数据所在的行,不做处理，直接返回，行号为数据行的第二行时才继续。 列号不等于需要使用的最后一列，直接返回
        if (rowIndex <= startIdx || optLastColumnIdx != columnIndex) return;
        // 获取处理结果
        boolean merged = mc.merged(cell.getSheet().getRow(rowIndex), cell.getSheet().getRow(rowIndex - 1));
        // 需要合并
        if (merged) {
            // 遍历需要合并的列
            for (int mergeColumn : mergeColumns) {
                // 标志位
                boolean isMerged = false;
                // 获取所有合并配置
                Sheet sheet = writeSheetHolder.getSheet();
                List<CellRangeAddress> mergeRegions = sheet.getMergedRegions();
                // 遍历合并配置
                for (int i = 0; i < mergeRegions.size(); i++) {
                    CellRangeAddress cellRangeAddr = mergeRegions.get(i);
                    // 上一行的单元格在配置中，移除这个配置，修改末尾行下标后重新加入一下。
                    if (cellRangeAddr.isInRange(rowIndex - 1, mergeColumn)) {
                        sheet.removeMergedRegion(i);
                        cellRangeAddr.setLastRow(rowIndex);
                        sheet.addMergedRegion(cellRangeAddr);
                        // 修改标志位，表示在已经存在的合并配置中存在当前需要合并的信息。
                        isMerged = true;
                        break;
                    }
                }
                // 新增合并单元
                if (!isMerged) {
                    CellRangeAddress cellRangeAddress = new CellRangeAddress(rowIndex - 1, rowIndex, mergeColumn,
                            mergeColumn);
                    sheet.addMergedRegion(cellRangeAddress);
                }
            }
        }
    }
}

简单测试

构造数据

这里设置了四个部门，每条数据随机选择。
2个工资范围段，分别是5000-10000，10000-15000。
名字是tx + 循环增加 i 。
数据创建完成后需要根据部门和工资范围排序。

        // 构造部门
        String dept[] = {"部门1", "部门2", "部门3", "bumen4"};
        // 工资范围
        int salaryRange[] = {5000, 10000, 15000};
        // 构造list
        List<UserExcel> excel = new ArrayList<>();
        for (int i = 0; i < 100; i++) {
            Instant instant = LocalDateTime.now().minusYears(Math.round(Math.random() * 20)).toInstant(ZoneOffset.ofHours(8));
            String randomDept = dept[(int) (Math.random() * 4)];
            String randomDeptDescription = randomDept + "的描述信息";
            Double salary = 5000 + BigDecimal.valueOf(Math.random() * 10000).setScale(2, BigDecimal.ROUND_UP).doubleValue();
            String salaryRangeString = "未知";
            for (int i1 = 0; i1 < salaryRange.length; i1++) {
                int end = salaryRange[i1];
                if (salary < end) {
                    salaryRangeString = salaryRange[i1 - 1] + "-" + end;
                    break;
                }
            }
            UserExcel user = UserExcel.builder().dept(randomDept).deptDescription(randomDeptDescription).id((long) i).name("tx-" + i).birthday(LocalDateTime.ofInstant(instant, ZoneId.systemDefault())).salary(salary).salaryRange(salaryRangeString).build();
            excel.add(user);
        }
        // 按照部门、工资范围排序
        excel.sort((one, two) -> {
            int i = one.getDept().compareTo(two.getDept());
            if (i == 0) {
                return one.getSalaryRange().compareTo(two.getSalaryRange());
            }
            return i;
        });

设置文件保存路径

        // 文件保存路径
        String baseDir = System.getProperty("user.dir");
        String fileName = Paths.get(baseDir, "testExcel.xlsx").toString();

合并单元格的excel导出

        EasyExcel.write(fileName, UserExcel.class).registerWriteHandler(new customCellWriteHandler(2, 2, new int[]{
                // 需要合并部门列、部门描述列、工资范围列
                0, 1, 2}, ((cur, pre) -> {
            // 部门名称相同 && 工资范围相同才需要合并
            String curDept = cur.getCell(0).getStringCellValue();
            String preDept = pre.getCell(0).getStringCellValue();
            String curSalaryRange = cur.getCell(2).getStringCellValue();
            String preSalaryRange = pre.getCell(2).getStringCellValue();
            return curDept.equals(preDept) && curSalaryRange.equals(preSalaryRange) ? true : false;
        }))).sheet("用户信息").doWrite(excel);

代码地址

https://gitee.com/tian_xiong/test-easy-excel

参考

https://easyexcel.opensource.alibaba.com/docs/current/quickstart/write#%E5%90%88%E5%B9%B6%E5%8D%95%E5%85%83%E6%A0%BC
https://sensationg.github.io/blog/%E4%BD%BF%E7%94%A8EasyExcel%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AF%BC%E5%87%BA/