快捷導(dǎo)航

Java使用EasyExcel動態(tài)修改模板Sheet名稱的具體方案

更新時(shí)間：2025年12月11日 10:01:13 作者：weixin_46244623

在使用 EasyExcel 通過模板導(dǎo)出時(shí),模板中的 sheet 名稱通常是固定的,如果我們希望在導(dǎo)出時(shí)根據(jù)業(yè)務(wù)需要動態(tài)修改 sheet 名稱,可以通過自定義 SheetWriteHandler 完成,所以本文介紹了Java使用EasyExcel動態(tài)修改模板Sheet名稱的具體方案,需要的朋友可以參考下

引言

在使用 EasyExcel 通過模板導(dǎo)出時(shí)，模板中的 sheet 名稱通常是固定的，如果我們希望在導(dǎo)出時(shí)根據(jù)業(yè)務(wù)需要 動態(tài)修改 sheet 名稱，可以通過自定義 SheetWriteHandler 完成。

很多同學(xué)在釘釘群里提到可以寫攔截器，我百度了一下，最終成功用下面的方式解決了 —— 記錄一下方案。

使用方式

只需要在構(gòu)建 WriteSheet 時(shí)注冊我們自定義的 handler：

WriteSheet writeSheet = EasyExcel.writerSheet(0)
        .registerWriteHandler(new CustomTemplateSheetStrategy("動態(tài)命名sheet"))
        .build();

自定義 SheetWriteHandler 攔截器

下面是完整代碼：用于在 sheet 創(chuàng)建完成后，動態(tài)修改 sheet 名稱。

import com.alibaba.excel.write.handler.SheetWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteWorkbookHolder;

/**
 * 自定義模板導(dǎo)出sheet攔截器
 */
public class CustomTemplateSheetStrategy implements SheetWriteHandler {

    private Integer sheetNo;

    private String sheetName;

    public CustomTemplateSheetStrategy(String sheetName) {
        this.sheetName = sheetName;
    }

    public CustomTemplateSheetStrategy(Integer sheetNo, String sheetName) {
        this.sheetNo = sheetNo;
        this.sheetName = sheetName;
    }

    @Override
    public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
    }

    /**
     * 功能：動態(tài)修改模板中sheet的名稱
     * sheet創(chuàng)建完成后調(diào)用
     * @param writeWorkbookHolder
     * @param writeSheetHolder
     */
    @Override
    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
        if (sheetName == null) {
            return;
        }
        if (sheetNo == null) {
            sheetNo = 0;
        }
        writeWorkbookHolder.getCachedWorkbook().setSheetName(sheetNo, sheetName);
    }
}