Java?EasyExcel導(dǎo)出合并單元格的示例詳解

更新時(shí)間：2023年09月08日 08:38:48 作者：佛祖讓我來(lái)巡山

EasyExcel是阿里巴巴開源的一個(gè)excel處理框架,以使用簡(jiǎn)單、節(jié)省內(nèi)存著稱,這篇文章主要為大家介紹了如何利用EasyExcel導(dǎo)出合并單元格,需要的可以參考下

前言

使用spring boot 對(duì)excel 進(jìn)行操作在平時(shí)項(xiàng)目中要經(jīng)常使用。常見(jiàn)通過(guò)jxl和poi 的方式進(jìn)行操作。但他們都存在一個(gè)嚴(yán)重的問(wèn)題就是非常的耗內(nèi)存。這里介紹一種 Easy Excel 工具來(lái)對(duì)excel進(jìn)行操作。

一、Easy Excel是什么

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

二、使用EasyExcel 實(shí)現(xiàn)讀操作

從excel 中讀取數(shù)據(jù)，常用的場(chǎng)景就是讀取excel的數(shù)據(jù)，將相應(yīng)的數(shù)據(jù)保存到數(shù)據(jù)庫(kù)中。需要實(shí)現(xiàn)一定的邏輯處理。

1、導(dǎo)入依賴

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

2、創(chuàng)建讀取數(shù)據(jù)封裝類

@Data
public class User {
    @ExcelProperty(index = 0)
    private Integer id;
    @ExcelProperty(index = 1)
    private String name;
    @ExcelProperty(index = 2)
    private Integer age;
}

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

3、創(chuàng)建讀取excel的監(jiān)聽(tīng)類

監(jiān)聽(tīng)器繼承 AnalysisEventListener 類

@Slf4j
public class UserExcelListener extends AnalysisEventListener<User> {
    /**
     * 解析excel文檔的每一行
     * @param user 參數(shù)user即是每行讀取數(shù)據(jù)轉(zhuǎn)換的User對(duì)象
     * @param analysisContext
     */
    @Override
    public void invoke(User user, AnalysisContext analysisContext){
        log.info("excel數(shù)據(jù)行：{}",user.toString());
    }
    /**
     * 整個(gè)文檔解析完執(zhí)行
     * @param analysisContext
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        log.info("文檔解析完畢");
    }
}

當(dāng)解析每一條數(shù)據(jù)時(shí)都會(huì)調(diào)用invoke方法，當(dāng)所有數(shù)據(jù)都解析完畢時(shí)最后會(huì)調(diào)用doAfterAllAnalysed方法?？梢栽诒O(jiān)聽(tīng)類內(nèi)的方法中將每次讀取到的數(shù)據(jù)進(jìn)行保存或者其他操作處理。

4、接口使用easyExcel讀取excel文件調(diào)用監(jiān)聽(tīng)器

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

三、使用EasyExcel 實(shí)現(xiàn)寫操作

寫操作有兩種寫法，一種是不創(chuàng)建對(duì)象的寫入，另一種是根據(jù)對(duì)象寫入。這里主要介紹創(chuàng)建對(duì)象寫入

創(chuàng)建對(duì)象寫入

1、創(chuàng)建excel對(duì)象類

@Data
public class User {
    @ExcelProperty(index = 0)
    private Integer id;
    @ExcelProperty(index = 1)
    private String name;
    @ExcelProperty(index = 2)
    private Integer age;
}

注意@ExcelProperty(“用戶編號(hào)”) 會(huì)生成相應(yīng)的列名為用戶編號(hào)，如果不設(shè)置，則會(huì)直接將字段名設(shè)置為excel的列名。

2、接口使用測(cè)試數(shù)據(jù)導(dǎo)出（常規(guī)導(dǎo)出不合并單元格）

/**
     * 輸出導(dǎo)出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("測(cè)試用戶-" + i);
            user.setAge(20 + i);
            users.add(user);
        }
        log.info("導(dǎo)出數(shù)據(jù)結(jié)果集：{}", users);
        String fileName = "C:\\Users\\pytho\\Desktop\\fsdownload\\用戶信息表.xlsx";
        EasyExcel.write(fileName, User.class)
                .autoCloseStream(true)
                .sheet("sheet名稱")
                .doWrite(users);
    }

3、接口測(cè)試導(dǎo)出（單列合并單元格）

/**
     * 輸出導(dǎo)出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("測(cè)試用戶-3");
            } else {
                user.setName("測(cè)試用戶-" + i);
            }
            user.setAge(20 + i);
            users.add(user);
        }
        log.info("導(dǎo)出數(shù)據(jù)結(jié)果集：{}", users);
        String fileName = "C:\\Users\\pytho\\Desktop\\fsdownload\\(單列相同內(nèi)容合并單元格)用戶信息表.xlsx";
        EasyExcel.write(fileName, User.class)
               <strong> .registerWriteHandler(</strong><strong>new</strong><strong> SimpleExcelMergeUtil())</strong>
                .autoCloseStream(true)
                .sheet("sheet名稱")
                .doWrite(users);
    }

如果要對(duì)導(dǎo)出的excel進(jìn)行處理，就需要自定義處理器類進(jìn)行處理

自定義easyExcel處理器（單列合并：根據(jù)用戶id相同的列進(jìn)行合并單元格）：

/**
 * @version 1.0
 * @Package: com.stech.bms.buss.utils
 * @ClassName: ExcelMergeUtil
 * @Author: sgq
 * @Date: 2023/7/28 13:29
 * @Description: 僅處理單列數(shù)據(jù)相同合并單元格
 */
public class SimpleExcelMergeUtil implements CellWriteHandler {
    public SimpleExcelMergeUtil() {
    }
    /**
     * 創(chuàng)建每個(gè)單元格之前執(zhí)行
     *
     * @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) {
    }
    /**
     * 創(chuàng)建每個(gè)單元格之后執(zhí)行
     *
     * @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) {
    }
    /**
     * 每個(gè)單元格數(shù)據(jù)內(nèi)容渲染之后執(zhí)行
     *
     * @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) {
    }
    /**
     * 每個(gè)單元格完全創(chuàng)建完之后執(zhí)行
     *
     * @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) {
        // 當(dāng)前行
        int curRowIndex = cell.getRowIndex();
        // 當(dāng)前列
        int curColIndex = cell.getColumnIndex();
        if (!isHead) {
            if (curRowIndex > 1 && curColIndex == 1) {
                // 從第二行數(shù)據(jù)行開始,獲取當(dāng)前行第二列數(shù)據(jù)
                Object curData = cell.getCellTypeEnum() == CellType.STRING ? cell.getStringCellValue() : cell.getNumericCellValue();
                // 獲取上一行第二列數(shù)據(jù)
                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);
                        // 若上一個(gè)單元格已經(jīng)被合并，則先移出原有的合并單元，再重新添加合并單元
                        if (cellRangeAddr.isInRange(curRowIndex - 1, curColIndex)) {
                            sheet.removeMergedRegion(i);
                            cellRangeAddr.setLastRow(curRowIndex);
                            sheet.addMergedRegion(cellRangeAddr);
                            isMerged = true;
                        }
                    }
                    // 若上一個(gè)單元格未被合并，則新增合并單元
                    if (!isMerged) {
                        CellRangeAddress cellRangeAddress = new CellRangeAddress(curRowIndex - 1, curRowIndex, curColIndex, curColIndex);
                        sheet.addMergedRegion(cellRangeAddress);
                    }
                }
            }
        }
    }
}

4、接口測(cè)試導(dǎo)出（通用合并單元格）

/**
     * 輸出導(dǎo)出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("測(cè)試用戶-3");
            } else {
                user.setName("測(cè)試用戶-" + i);
            }
            user.setAge(20 + i);
            users.add(user);
        }
        log.info("導(dǎo)出數(shù)據(jù)結(jié)果集：{}", users);
        // 從第幾行開始合并
        int mergeStartRowIndex = 5;
        // 需要合并哪些列
        int[] mergeColumns = {1};
        String fileName = "C:\\Users\\pytho\\Desktop\\fsdownload\\(單列相同內(nèi)容合并單元格-通用版)用戶信息表.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: 僅處理單列數(shù)據(jù)相同合并單元格
 */
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);
        }
    }
    /**
     * 創(chuàng)建每個(gè)單元格之前執(zhí)行
     *
     * @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) {
    }
    /**
     * 創(chuàng)建每個(gè)單元格之后執(zhí)行
     *
     * @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) {
    }
    /**
     * 每個(gè)單元格數(shù)據(jù)內(nèi)容渲染之后執(zhí)行
     *
     * @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) {
    }
    /**
     * 每個(gè)單元格完全創(chuàng)建完之后執(zhí)行
     *
     * @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) {
        // 當(dāng)前行
        int curRowIndex = cell.getRowIndex();
        // 當(dāng)前列
        int curColIndex = cell.getColumnIndex();
        if (!isHead) {
            if (curRowIndex > mergeStartRowIndex && mergeColumnList.contains(curColIndex)) {
                // 從第二行數(shù)據(jù)行開始,獲取當(dāng)前行第二列數(shù)據(jù)
                Object curData = cell.getCellTypeEnum() == CellType.STRING ? cell.getStringCellValue() : cell.getNumericCellValue();
                // 獲取上一行第二列數(shù)據(jù)
                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);
                        // 若上一個(gè)單元格已經(jīng)被合并，則先移出原有的合并單元，再重新添加合并單元
                        if (cellRangeAddr.isInRange(curRowIndex - 1, curColIndex)) {
                            sheet.removeMergedRegion(i);
                            cellRangeAddr.setLastRow(curRowIndex);
                            sheet.addMergedRegion(cellRangeAddr);
                            isMerged = true;
                        }
                    }
                    // 若上一個(gè)單元格未被合并，則新增合并單元
                    if (!isMerged) {
                        CellRangeAddress cellRangeAddress = new CellRangeAddress(curRowIndex - 1, curRowIndex, curColIndex, curColIndex);
                        sheet.addMergedRegion(cellRangeAddress);
                    }
                }
            }
        }
    }
}

這只是簡(jiǎn)單的合并單元格例子，拋磚引玉的作用。工作中可能會(huì)遇到很多情況：合并單元格后第一列序列號(hào)也需要根據(jù)其他列進(jìn)行合并單元格且序列號(hào)還必須保持連續(xù)，根據(jù)部分列合并單元格，隔行合并單元格等等情況，這就需要開發(fā)者對(duì)easyExcel的處理器類里面的api比較了解才能完成。遇到的問(wèn)題也可以留言，看到也會(huì)嘗試一起處理解決。

到此這篇關(guān)于Java EasyExcel導(dǎo)出合并單元格的示例詳解的文章就介紹到這了,更多相關(guān)Java EasyExcel內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: