EasyExcel模板填充时动态修改Sheet名称的实现方法

EasyExcel模板填充时动态修改Sheet名称的实现方法

【免费下载链接】easyexcel 快速、简洁、解决大文件内存溢出的java处理Excel工具 项目地址: https://gitcode.com/gh_mirrors/ea/easyexcel

在使用阿里巴巴开源的EasyExcel库进行Excel操作时，模板填充是一个常用功能。然而，当我们需要在填充数据的同时修改Sheet名称时，可能会遇到一些挑战。本文将详细介绍如何通过自定义拦截器实现这一需求。

问题背景

EasyExcel提供了强大的模板填充功能，允许开发者基于预定义的Excel模板快速生成报表。但在实际应用中，我们经常需要根据业务需求动态修改Sheet名称。例如，在生成不同类别的报表时，可能需要将Sheet命名为"非合同制"、"合同制"等。

常规方法的局限性

EasyExcel的标准API提供了writerSheet()方法来指定Sheet名称：

WriteSheet writeSheet = EasyExcel.writerSheet(0,"非合同制").build();

然而，当与模板填充功能结合使用时，这种方法可能无法生效，因为模板文件中的Sheet名称会被优先保留。

解决方案：自定义SheetWriteHandler

为了解决这个问题，我们可以实现EasyExcel的SheetWriteHandler接口，创建一个自定义拦截器来动态修改Sheet名称。

自定义拦截器实现

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

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) {
        // 可以在此处添加Sheet创建前的逻辑
    }

    @Override
    public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, 
                               WriteSheetHolder writeSheetHolder) {
        if (sheetName == null) {
            return;
        }
        if (sheetNo == null) {
            sheetNo = 0; // 默认修改第一个Sheet
        }
        writeWorkbookHolder.getCachedWorkbook().setSheetName(sheetNo, sheetName);
    }
}

使用示例

// 创建ExcelWriter
ExcelWriter excelWriter = EasyExcel.write(fileName)
        .withTemplate(templateFileName)
        .build();

// 创建WriteSheet并注册自定义拦截器
WriteSheet writeSheet = EasyExcel.writerSheet(0)
        .registerWriteHandler(new CustomTemplateSheetStrategy("非合同制"))
        .build();

// 填充数据
FillConfig fillConfig = FillConfig.builder()
        .direction(WriteDirectionEnum.HORIZONTAL)
        .build();
excelWriter.fill(new FillWrapper("user", schedule), fillConfig, writeSheet);

// 其他数据填充操作...

// 关闭资源
excelWriter.finish();

实现原理

1. 拦截器机制：EasyExcel提供了丰富的拦截器机制，允许开发者在Excel操作的不同阶段插入自定义逻辑。

2. 执行时机：afterSheetCreate方法在Sheet创建完成后被调用，此时我们可以安全地修改Sheet名称而不会影响模板的结构。

3. 底层操作：通过WriteWorkbookHolder获取底层的POI Workbook对象，直接调用其setSheetName方法修改Sheet名称。

高级用法

1. 多Sheet处理：可以通过指定sheetNo参数来修改非第一个Sheet的名称。

2. 动态名称：可以在拦截器中根据业务逻辑动态生成Sheet名称，而不仅限于构造函数传入的固定值。

3. 条件判断：在afterSheetCreate方法中可以添加更复杂的逻辑，例如根据特定条件决定是否修改Sheet名称。

注意事项

1. 性能影响：虽然拦截器提供了灵活性，但过多的拦截器可能会轻微影响性能，应合理使用。

2. 索引安全：修改Sheet名称时需确保sheetNo参数有效，避免数组越界异常。

3. 名称冲突：修改后的Sheet名称应保证在Excel文件中唯一，避免名称冲突。

通过这种自定义拦截器的方式，我们可以在保持EasyExcel模板填充功能强大性的同时，灵活地控制Sheet名称，满足各种业务场景的需求。

【免费下载链接】easyexcel 快速、简洁、解决大文件内存溢出的java处理Excel工具 项目地址: https://gitcode.com/gh_mirrors/ea/easyexcel