EasyExcel 列宽自动适配与注解冲突问题解决方案

EasyExcel 列宽自动适配与注解冲突问题解决方案

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

问题背景

在使用阿里巴巴开源的 EasyExcel 库进行 Excel 导出时，开发者经常会遇到列宽设置的两种需求：一是通过 @ColumnWidth 注解精确指定列宽，二是希望某些列能根据内容自动调整宽度。然而在实际使用中，当启用了自动列宽适配功能后，@ColumnWidth 注解可能会失效。

技术分析

EasyExcel 提供了 LongestMatchColumnWidthStyleStrategy 策略类来实现列宽的自动适配，该策略会根据单元格内容的长度自动计算合适的列宽。然而，这个自动计算逻辑会覆盖 @ColumnWidth 注解的设置，导致开发者无法同时使用两种列宽设置方式。

解决方案

我们可以通过继承 LongestMatchColumnWidthStyleStrategy 类并重写其核心方法，实现以下逻辑：

1. 优先检查字段是否有 @ColumnWidth 注解
2. 如果有注解，则直接使用注解指定的宽度
3. 如果没有注解，则执行原有的自动计算逻辑

以下是实现代码示例：

public class CustomColumnWidthStrategy extends LongestMatchColumnWidthStyleStrategy {
    
    private static final int MAX_COLUMN_WIDTH = 255;
    private static final int MIN_COLUMN_WIDTH = 20;

    @Override
    protected void setColumnWidth(WriteSheetHolder writeSheetHolder, List<WriteCellData<?>> cellDataList,
                                Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
        // 检查是否有 @ColumnWidth 注解
        ColumnWidth columnWidthAnnotation = head.getField().getAnnotation(ColumnWidth.class);
        if (columnWidthAnnotation != null) {
            // 有注解时直接按注解宽度设置列宽
            int specifiedWidth = columnWidthAnnotation.value();
            writeSheetHolder.getSheet().setColumnWidth(cell.getColumnIndex(), specifiedWidth * 256);
            return;
        }

        // 如果没有注解，则执行自动宽度计算逻辑
        Integer columnWidth = dataLength(cellDataList, cell, isHead);
        if (columnWidth != null && columnWidth >= 0) {
            if (columnWidth > MAX_COLUMN_WIDTH) {
                columnWidth = MAX_COLUMN_WIDTH;
            } else if (columnWidth < MIN_COLUMN_WIDTH) {
                columnWidth *= 2; // 小于最小宽度时适当放大
            }
            writeSheetHolder.getSheet().setColumnWidth(cell.getColumnIndex(), columnWidth * 256);
        }
    }

    private Integer dataLength(List<WriteCellData<?>> cellDataList, Cell cell, Boolean isHead) {
        if (isHead) {
            return cell.getStringCellValue().getBytes().length;
        } else {
            WriteCellData<?> cellData = cellDataList.get(0);
            CellDataTypeEnum type = cellData.getType();
            if (type == null) {
                return -1;
            }
            switch (type) {
                case STRING: return cellData.getStringValue().getBytes().length;
                case BOOLEAN: return cellData.getBooleanValue().toString().getBytes().length;
                case NUMBER: return cellData.getNumberValue().toString().getBytes().length;
                default: return -1;
            }
        }
    }
}

使用说明

1. 将上述自定义策略类添加到项目中
2. 在创建 ExcelWriter 时指定该策略：

ExcelWriter excelWriter = EasyExcel.write(outputStream)
        .registerWriteHandler(new CustomColumnWidthStrategy())
        .build();

3. 在实体类中，可以自由选择使用 @ColumnWidth 注解或依赖自动计算：

public class DemoData {
    @ColumnWidth(30) // 固定宽度30
    private String fixedColumn;
    
    // 自动计算宽度
    private String autoColumn;
}

注意事项

1. Excel 的列宽单位与像素的换算比例为 256
2. 最大列宽限制为 255 个字符
3. 对于过短的内容，建议设置最小宽度保证可读性
4. 自动计算功能目前仍处于实验阶段，可能不适用于所有场景

总结

通过自定义列宽策略，我们成功解决了 EasyExcel 中自动列宽适配与 @ColumnWidth 注解的冲突问题。这种方案既保留了注解的精确控制能力，又提供了自动计算的灵活性，能够满足大多数业务场景的需求。开发者可以根据实际业务需要，调整代码中的最大最小宽度等参数，获得最佳的导出效果。

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