[EasyExcel] 導出合併單元格

前言

使用spring boot 對excel 進行操作在平時項目中要經常使用。常見通過jxl和poi 的方式進行操作。但他們都存在一個嚴重的問題就是非常的耗內存。這裏介紹一種 Easy Excel 工具來對excel進行操作。

一、Easy Excel是什麼？

EasyExcel是阿里巴巴開源的一個excel處理框架，以使用簡單、節省內存著稱。easyExcel能大大減少佔用內存的主要原因是在解析Excel時沒有將文件數據一次性全部加載到內存中，而是從磁盤上一行行讀取數據，逐個解析。

二、使用EasyExcel 實現讀操作

從excel 中讀取數據，常用的場景就是讀取excel的數據，將相應的數據保存到數據庫中。需要實現一定的邏輯處理。

1、導入依賴

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

2、創建讀取數據封裝類

@Data
public class User {

    @ExcelProperty(index = 0)
    private Integer id;

    @ExcelProperty(index = 1)
    private String name;

    @ExcelProperty(index = 2)
    private Integer age;
}

比如我們要讀取兩列的數據，就寫兩個屬性。@ExcelProperty(index = 0)來設置要讀取的列,index=0表示讀取第一列。

3、創建讀取excel的監聽類

監聽器繼承 AnalysisEventListener 類

@Slf4j
public class UserExcelListener extends AnalysisEventListener<User> {

    /**
     * 解析excel文檔的每一行
     * @param user 參數user即是每行讀取數據轉換的User對象
     * @param analysisContext
     */
    @Override
    public void invoke(User user, AnalysisContext analysisContext){
        log.info("excel數據行：{}",user.toString());
    }

    /**
     * 整個文檔解析完執行
     * @param analysisContext
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        log.info("文檔解析完畢");
    }
}

當解析每一條數據時都會調用invoke方法，當所有數據都解析完畢時最後會調用doAfterAllAnalysed方法。可以在監聽類內的方法中將每次讀取到的數據進行保存或者其他操作處理。

4、接口使用easyExcel讀取excel文件調用監聽器

/**
     * 上傳excel文件並讀取其中內容
     *
     * @param file
     * @return
     */
    @PostMapping("/upload")
    public String uploadExcel(MultipartFile file) {
        log.info("easyExcel上傳文件：{}", file);
        try {
            InputStream inputStream = file.getInputStream();
            EasyExcel.read(inputStream, User.class, new UserExcelListener())
                    .sheet()
                    .doRead();
        } catch (Exception e) {

        }
        return "表格文件上傳成功";
    }

三、使用EasyExcel 實現寫操作

寫操作有兩種寫法，一種是不創建對象的寫入，另一種是根據對象寫入。這裏主要介紹創建對象寫入

創建對象寫入

1、創建excel對象類

@Data
public class User {

    @ExcelProperty(index = 0)
    private Integer id;

    @ExcelProperty(index = 1)
    private String name;

    @ExcelProperty(index = 2)
    private Integer age;
}

注意@ExcelProperty(“用戶編號”) 會生成相應的列名爲 用戶編號，如果不設置，則會直接將字段名設置爲excel的列名。

2、接口使用測試數據導出（常規導出不合並單元格）

/**
     * 輸出導出excel
     */
    @PostMapping("/export")
    public void export() {
        ArrayList<User> users = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            User user = new User();
            user.setId(i);
            user.setName("測試用戶-" + i);
            user.setAge(20 + i);
            users.add(user);
        }
        log.info("導出數據結果集：{}", users);
        String fileName = "C:\\Users\\pytho\\Desktop\\fsdownload\\用戶信息表.xlsx";
        EasyExcel.write(fileName, User.class)
                .autoCloseStream(true)
                .sheet("sheet名稱")
                .doWrite(users);
    }

3、接口測試導出（單列合併單元格）

/**
     * 輸出導出excel
     */
    @PostMapping("/export1")
    public void export1() {
        ArrayList<User> users = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            User user = new User();
            user.setId(i);
            if (i == 3 || i == 4 || i == 5) {
                user.setName("測試用戶-3");
            } else {
                user.setName("測試用戶-" + i);
            }
            user.setAge(20 + i);
            users.add(user);
        }
        log.info("導出數據結果集：{}", users);
        String fileName = "C:\\Users\\pytho\\Desktop\\fsdownload\\(單列相同內容合併單元格)用戶信息表.xlsx";
        EasyExcel.write(fileName, User.class)
                .registerWriteHandler(new SimpleExcelMergeUtil())
                .autoCloseStream(true)
                .sheet("sheet名稱")
                .doWrite(users);
    }

如果要對導出的excel進行處理，就需要自定義處理器類進行處理

自定義easyExcel處理器（單列合併：根據用戶id相同的列進行合併單元格）：

/**
 * @version 1.0
 * @Package: com.stech.bms.buss.utils
 * @ClassName: ExcelMergeUtil
 * @Author: sgq
 * @Date: 2023/7/28 13:29
 * @Description: 僅處理單列數據相同合併單元格
 */
public class SimpleExcelMergeUtil implements CellWriteHandler {

    public SimpleExcelMergeUtil() {
    }

    /**
     * 創建每個單元格之前執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param row
     * @param head
     * @param columnIndex
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row, Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) {

    }

    /**
     * 創建每個單元格之後執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param cell
     * @param head
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {

    }

    /**
     * 每個單元格數據內容渲染之後執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param cellData
     * @param cell
     * @param head
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, CellData cellData, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {

    }

    /**
     * 每個單元格完全創建完之後執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param cellDataList
     * @param cell
     * @param head
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<CellData> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
        // 當前行
        int curRowIndex = cell.getRowIndex();
        // 當前列
        int curColIndex = cell.getColumnIndex();

        if (!isHead) {
            if (curRowIndex > 1 && curColIndex == 1) {
                // 從第二行數據行開始,獲取當前行第二列數據
                Object curData = cell.getCellTypeEnum() == CellType.STRING ? cell.getStringCellValue() : cell.getNumericCellValue();
                // 獲取上一行第二列數據
                Cell preCell = cell.getSheet().getRow(curRowIndex - 1).getCell(curColIndex);
                Object preData = preCell.getCellTypeEnum() == CellType.STRING ? preCell.getStringCellValue() : preCell.getNumericCellValue();
                if (curData.equals(preData)) {
                    Sheet sheet = writeSheetHolder.getSheet();
                    List<CellRangeAddress> mergedRegions = sheet.getMergedRegions();
                    boolean isMerged = false;
                    for (int i = 0; i < mergedRegions.size() && !isMerged; i++) {
                        CellRangeAddress cellRangeAddr = mergedRegions.get(i);
                        // 若上一個單元格已經被合併，則先移出原有的合併單元，再重新添加合併單元
                        if (cellRangeAddr.isInRange(curRowIndex - 1, curColIndex)) {
                            sheet.removeMergedRegion(i);
                            cellRangeAddr.setLastRow(curRowIndex);
                            sheet.addMergedRegion(cellRangeAddr);
                            isMerged = true;
                        }
                    }
                    // 若上一個單元格未被合併，則新增合併單元
                    if (!isMerged) {
                        CellRangeAddress cellRangeAddress = new CellRangeAddress(curRowIndex - 1, curRowIndex, curColIndex, curColIndex);
                        sheet.addMergedRegion(cellRangeAddress);
                    }
                }
            }
        }
    }
}

4、接口測試導出（通用合併單元格）

/**
     * 輸出導出excel
     */
    @PostMapping("/export2")
    public void export2() {
        ArrayList<User> users = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            User user = new User();
            user.setId(i);
            if (i == 3 || i == 4 || i == 5) {
                user.setName("測試用戶-3");
            } else {
                user.setName("測試用戶-" + i);
            }
            user.setAge(20 + i);
            users.add(user);
        }
        log.info("導出數據結果集：{}", users);
        // 從第幾行開始合併
        int mergeStartRowIndex = 5;
        // 需要合併哪些列
        int[] mergeColumns = {1};
        String fileName = "C:\\Users\\pytho\\Desktop\\fsdownload\\(單列相同內容合併單元格-通用版)用戶信息表.xlsx";
        EasyExcel.write(fileName, User.class)
                .registerWriteHandler(new SimpleCommonExcelMergeUtil(mergeStartRowIndex,mergeColumns))
                .autoCloseStream(true)
                .sheet("sheet名稱")
                .doWrite(users);
    }

excel處理器類：

/**
 * @version 1.0
 * @Package: com.stech.bms.buss.utils
 * @ClassName: ExcelMergeUtil
 * @Author: sgq
 * @Date: 2023/7/28 13:29
 * @Description: 僅處理單列數據相同合併單元格
 */
public class SimpleCommonExcelMergeUtil implements CellWriteHandler {

    private int mergeStartRowIndex;
    private int[] mergeColumns;
    private List<Integer> mergeColumnList;

    public SimpleCommonExcelMergeUtil() {
    }

    public SimpleCommonExcelMergeUtil(int mergeStartRowIndex, int[] mergeColumns) {
        this.mergeStartRowIndex = mergeStartRowIndex;
        this.mergeColumns = mergeColumns;
        mergeColumnList = new ArrayList<>();
        for (int i : mergeColumns) {
            mergeColumnList.add(i);
        }
    }

    /**
     * 創建每個單元格之前執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param row
     * @param head
     * @param columnIndex
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row, Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) {

    }

    /**
     * 創建每個單元格之後執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param cell
     * @param head
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {

    }

    /**
     * 每個單元格數據內容渲染之後執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param cellData
     * @param cell
     * @param head
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, CellData cellData, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {

    }

    /**
     * 每個單元格完全創建完之後執行
     *
     * @param writeSheetHolder
     * @param writeTableHolder
     * @param cellDataList
     * @param cell
     * @param head
     * @param relativeRowIndex
     * @param isHead
     */
    @Override
    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<CellData> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
        // 當前行
        int curRowIndex = cell.getRowIndex();
        // 當前列
        int curColIndex = cell.getColumnIndex();

        if (!isHead) {
            if (curRowIndex > mergeStartRowIndex && mergeColumnList.contains(curColIndex)) {
                // 從第二行數據行開始,獲取當前行第二列數據
                Object curData = cell.getCellTypeEnum() == CellType.STRING ? cell.getStringCellValue() : cell.getNumericCellValue();
                // 獲取上一行第二列數據
                Cell preCell = cell.getSheet().getRow(curRowIndex - 1).getCell(curColIndex);
                Object preData = preCell.getCellTypeEnum() == CellType.STRING ? preCell.getStringCellValue() : preCell.getNumericCellValue();
                if (curData.equals(preData)) {
                    Sheet sheet = writeSheetHolder.getSheet();
                    List<CellRangeAddress> mergedRegions = sheet.getMergedRegions();
                    boolean isMerged = false;
                    for (int i = 0; i < mergedRegions.size() && !isMerged; i++) {
                        CellRangeAddress cellRangeAddr = mergedRegions.get(i);
                        // 若上一個單元格已經被合併，則先移出原有的合併單元，再重新添加合併單元
                        if (cellRangeAddr.isInRange(curRowIndex - 1, curColIndex)) {
                            sheet.removeMergedRegion(i);
                            cellRangeAddr.setLastRow(curRowIndex);
                            sheet.addMergedRegion(cellRangeAddr);
                            isMerged = true;
                        }
                    }
                    // 若上一個單元格未被合併，則新增合併單元
                    if (!isMerged) {
                        CellRangeAddress cellRangeAddress = new CellRangeAddress(curRowIndex - 1, curRowIndex, curColIndex, curColIndex);
                        sheet.addMergedRegion(cellRangeAddress);
                    }
                }
            }
        }
    }
}

這只是簡單的合併單元格例子，拋磚引玉的作用。工作中可能會遇到很多情況：合併單元格後第一列序列號也需要根據其他列進行合併單元格且序列號還必須保持連續，根據部分列合併單元格，隔行合併單元格等等情況，這就需要開發者對easyExcel的處理器類裏面的api比較瞭解才能完成。遇到的問題也可以留言，看到也會嘗試一起處理解決。