EasyExcel实战：如何校验Excel文件Sheet数量与名称

EasyExcel实战：如何校验Excel文件Sheet数量与名称

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

在实际业务开发中，我们经常需要处理Excel文件的上传和解析。使用阿里巴巴开源的EasyExcel库时，可能会遇到需要校验上传文件Sheet数量或名称的场景。本文将详细介绍如何实现这一功能。

问题背景

当业务要求上传的Excel必须包含特定数量的Sheet（例如2个），或者Sheet名称必须符合规范时，如果用户上传了不符合要求的文件，系统应该能够及时检测并给出提示，而不是等到解析时才发现问题。

解决方案

EasyExcel提供了多种方式来实现Sheet数量和名称的校验：

方法一：使用ExcelReaderBuilder获取Sheet信息

// 获取文件输入流
InputStream inputStream = new FileInputStream("yourfile.xlsx");

// 构建ExcelReader
ExcelReader excelReader = EasyExcel.read(inputStream).build();

// 获取所有Sheet信息
List<ReadSheet> sheets = excelReader.excelExecutor().sheetList();

// 校验Sheet数量
if(sheets.size() != 2) {
    throw new RuntimeException("Excel必须包含2个Sheet");
}

// 校验Sheet名称
for(ReadSheet sheet : sheets) {
    String sheetName = sheet.getSheetName();
    if(!"Sheet1".equals(sheetName) && !"Sheet2".equals(sheetName)) {
        throw new RuntimeException("Sheet名称不符合要求");
    }
}

// 关闭资源
excelReader.close();
inputStream.close();

方法二：使用AnalysisContext获取Sheet信息

如果是在监听器中处理，可以通过AnalysisContext获取当前Sheet信息：

public class YourDataListener extends AnalysisEventListener<YourData> {
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        // 获取当前Sheet名称
        String currentSheetName = context.readSheetHolder().getSheetName();
        
        // 获取当前Sheet索引
        Integer sheetNo = context.readSheetHolder().getSheetNo();
        
        // 进行校验逻辑
    }
}

最佳实践建议

1. 前置校验：建议在正式解析数据前先校验Sheet信息，避免解析到一半才发现问题
2. 友好提示：校验不通过时应给出明确的错误信息，指导用户上传正确的文件
3. 资源释放：记得及时关闭ExcelReader和输入流，避免资源泄漏
4. 性能考虑：对于大文件，可以考虑只读取元信息而不加载全部数据

扩展思考

除了校验Sheet数量和名称外，在实际业务中还可能需要：

• 校验每个Sheet的表头是否符合要求
• 校验数据行数是否在合理范围内
• 校验单元格数据格式是否正确

这些都可以通过EasyExcel提供的API结合业务逻辑来实现，构建完善的Excel文件校验机制。

通过本文介绍的方法，开发者可以轻松实现对Excel文件Sheet数量和名称的校验，确保上传文件符合业务要求，提升系统的健壮性和用户体验。

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