文章目录
前言
最近业务方对于部分表格的个性化要求太多了，虽然用模板导出就能解决大部分的问题，但我想着趁此机会扩展学习一下这个过程中的自定义策略，毕竟这方面确实没怎么认真学过，也就看看用用。
第一部分：EasyExcel自定义能力概览
在进行Excel操作时，除了基础的数据读写，业务场景往往要求更复杂的定制化功能，例如动态样式、单元格合并、数据校验、超链接嵌入等。EasyExcel通过一套灵活的API和拦截器机制，提供了强大的自定义能力。
1.1 主要自定义方向
EasyExcel的自定义主要体现在以下几个方面：
- 样式与格式控制： 包括设置表头和内容的字体、背景色、边框、对齐方式、行高和列宽等 。这通常通过
WriteCellStyle类或自定义样式策略实现 。 - 数据转换与格式化： 通过
@ExcelProperty注解中的converter属性，可以实现数据类型在Java对象与Excel单元格之间的自定义转换，例如将数据库中的状态码（如1、2）转换成用户可读的文本（如“男”、“女”） 。 - 动态结构处理：
- 动态表头： 支持在运行时根据数据动态生成Excel的列头。
- 单元格合并： 允许根据特定业务逻辑动态合并行或列中的单元格 。
- 内容增强： 支持在单元格中添加批注、嵌入图片以及创建超链接 。
- 导入数据校验： 虽然EasyExcel核心更侧重于读写，但可以通过监听器（Listener）在读取数据时结合
javax.validation等校验框架实现自定义的数据校验逻辑。
1.2 核心自定义机制：拦截器（Handler）
EasyExcel设计的精髓之一在于其拦截器（Handler）机制。在Excel文件写入的生命周期中，EasyExcel定义了不同层级的接口，允许开发者在特定节点介入，执行自定义逻辑。这些接口主要包括：
WorkbookWriteHandler: 工作簿级别拦截器，在创建工作簿前后执行。SheetWriteHandler: 工作表级别拦截器，在创建工作表前后执行。RowWriteHandler: 行级别拦截器，在创建行前后执行。CellWriteHandler: 单元格级别拦截器，在创建单元格前后及数据转换后执行。
其中，CellWriteHandler由于其最细粒度的控制能力，成为实现复杂样式和内容自定义的关键。EasyExcel为此提供了一个便捷的抽象类AbstractCellWriteHandler，开发者通过继承该类，可以更方便地实现单元格级别的定制 。
第二部分：核心拦截器AbstractCellWriteHandler深度解析
AbstractCellWriteHandler是CellWriteHandler接口的一个抽象实现，它将接口中的方法进行了默认实现，并提供了清晰的生命周期钩子方法，极大地简化了自定义开发 。
2.1 AbstractCellWriteHandler的核心生命周期方法
继承AbstractCellWriteHandler后，我们主要关注并重写以下几个核心方法，它们在单元格写入过程中的不同阶段被回调 ：
-
beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row, Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead)- 触发时机： 在创建
Cell对象之前被调用。 - 应用场景： 主要用于准备工作，例如根据上下文信息预先计算样式或判断是否需要进行某些操作。此时
Cell对象尚未存在。
- 触发时机： 在创建
-
afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead)- 触发时机： 在
Cell对象创建之后，但数据写入Cell之前被调用。 - 应用场景： 此阶段已经可以获取到
Cell对象，可以对其进行一些初始设置，但不建议在此处设置最终样式，因为它可能会被后续的数据写入操作覆盖。
- 触发时机： 在
-
afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, CellData cellData, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead)- 触发时机： 在Java对象的数据被转换成
CellData之后，写入Cell之前被调用。 - 应用场景： 可以在此阶段修改即将写入单元格的数据
cellData，实现动态数据转换。
- 触发时机： 在Java对象的数据被转换成
-
afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<CellData> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead)- 触发时机： 在单元格所有数据都处理完毕后调用。这是进行最终样式设置、单元格合并和添加超链接等操作的最理想位置。
- 应用场景：
- 设置单元格样式： 这是最常见的用途，可以根据单元格内容、行号或列号等条件动态设置样式 。
- 动态单元格合并： 在此方法中，可以通过判断当前单元格与前一单元格的数据是否相同来决定是否需要合并 。
- 添加超链接： 可以获取到
Workbook对象，从而创建并设置超链接 。
2.2 实战场景：构建多功能自定义WriteHandler
以下我们将通过一个综合性的代码示例，展示如何继承AbstractCellWriteHandler来实现一个集样式设置、条件合并单元格和添加超链接于一体的自定义处理器。
import com.alibaba.excel.metadata.Head;
import com.alibaba.excel.metadata.data.CellData;
import com.alibaba.excel.metadata.data.WriteCellData;
import com.alibaba.excel.write.handler.AbstractCellWriteHandler;
import com.alibaba.excel.write.metadata.holder.WriteSheetHolder;
import com.alibaba.excel.write.metadata.holder.WriteTableHolder;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellRangeAddress;
import java.util.List;
/**
* 综合自定义单元格处理器
* 1. 为特定列（例如"备注"列）的内容添加超链接。
* 2. 对特定列（例如"部门"列）进行内容相同的相邻单元格合并。
* 3. 对特定列（例如"状态"列）根据内容设置不同背景色。
*/
public class ComprehensiveCellWriteHandler extends AbstractCellWriteHandler {
// 用于跟踪需要合并的起始行
private int mergeStartRowIndex = -1;
// 需要合并的列索引
private int mergeColumnIndex;
// 上一行的单元格值，用于比较
private String previousCellValue = null;
public ComprehensiveCellWriteHandler(int mergeColumnIndex) {
this.mergeColumnIndex = mergeColumnIndex;
}
@Override
public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
List<CellData> cellDataList, Cell cell, Head head,
Integer relativeRowIndex, Boolean isHead) {
// 只处理数据行，跳过表头
if (isHead) {
return;
}
// 场景一：根据内容设置样式（例如：状态列）
if (cell.getColumnIndex() == 2) { // 假设第3列是状态列
Workbook workbook = writeSheetHolder.getSheet().getWorkbook();
CellStyle style = workbook.createCellStyle();
style.cloneStyleFrom(cell.getCellStyle()); // 继承原有样式
String cellValue = cell.getStringCellValue();
if ("正常".equals(cellValue)) {
style.setFillForegroundColor(IndexedColors.LIGHT_GREEN.getIndex());
} else if ("异常".equals(cellValue)) {
style.setFillForegroundColor(IndexedColors.RED.getIndex());
}
style.setFillPattern(FillPatternType.SOLID_FOREGROUND);
cell.setCellStyle(style);
}
// 场景二：添加超链接（例如：备注列）
if (cell.getColumnIndex() == 3 && cell.getStringCellValue().startsWith("http")) { // 假设第4列是备注列
Workbook workbook = writeSheetHolder.getSheet().getWorkbook();
CreationHelper createHelper = workbook.getCreationHelper();
Hyperlink link = createHelper.createHyperlink(Hyperlink.LINK_URL);
link.setAddress(cell.getStringCellValue());
cell.setHyperlink(link);
// 为超链接设置蓝色字体样式
CellStyle linkStyle = workbook.createCellStyle();
linkStyle.cloneStyleFrom(cell.getCellStyle());
Font linkFont = workbook.createFont();
linkFont.setUnderline(Font.U_SINGLE);
linkFont.setColor(IndexedColors.BLUE.getIndex());
linkStyle.setFont(linkFont);
cell.setCellStyle(linkStyle);
}
// 场景三：单元格合并（例如：部门列）
handleCellMerging(writeSheetHolder, cell, relativeRowIndex);
}
private void handleCellMerging(WriteSheetHolder writeSheetHolder, Cell cell, int relativeRowIndex) {
if (cell.getColumnIndex() != mergeColumnIndex) {
return;
}
String currentCellValue = cell.getStringCellValue();
// 首次进入或值发生变化
if (previousCellValue == null || !previousCellValue.equals(currentCellValue)) {
// 如果之前有需要合并的区域，先执行合并
if (mergeStartRowIndex != -1 && relativeRowIndex > mergeStartRowIndex + 1) {
mergeCells(writeSheetHolder.getSheet(), mergeColumnIndex, mergeStartRowIndex, relativeRowIndex - 1);
}
// 重置合并起始点
mergeStartRowIndex = relativeRowIndex + 1; // +1是因为cell的rowIndex是从0开始，而合并需要的是实际行号
previousCellValue = currentCellValue;
}
// 如果这是最后一行数据，需要检查是否需要执行最后一次合并
// 注意：这里的判断逻辑比较复杂，通常需要结合Listener的`invoke`和`doAfterAllAnalysed`来精确处理最后一行。
// 一个简化的处理方式是在数据导出完成后手动调用一个完成方法。
// 或者在写入时传入总数据量，通过relativeRowIndex判断是否是最后一行。
}
private void mergeCells(Sheet sheet, int colIndex, int startRow, int endRow) {
if (startRow < endRow) {
sheet.addMergedRegionUnsafe(new CellRangeAddress(startRow, endRow, colIndex, colIndex));
}
}
// 需要一个方法来处理最后一组数据的合并
public void completeMerging(Sheet sheet, int lastRowIndex) {
if (mergeStartRowIndex != -1 && lastRowIndex > mergeStartRowIndex) {
mergeCells(sheet, mergeColumnIndex, mergeStartRowIndex, lastRowIndex);
}
}
}
// 如何使用:
// List<Data> dataList = ...
// ComprehensiveCellWriteHandler handler = new ComprehensiveCellWriteHandler(1); // 假设部门列是第2列（索引为1）
// EasyExcel.write(fileName, Data.class)
// .registerWriteHandler(handler)
// .sheet("模板")
// .doWrite(dataList);
注意事项：
- 样式处理： 创建
CellStyle时，建议使用workbook.createCellStyle()并从cell.getCellStyle()克隆，这样可以避免影响全局样式，并继承已有的基础样式（如边框、对齐等）。 - 超链接： 添加超链接后，可以进一步设置专属样式，提升用户体验。
- 单元格合并的复杂性： 动态合并单元格是
WriteHandler中最复杂的场景之一。因为afterCellDispose是逐个单元格触发的，处理器本身无法预知后续数据。上述示例中的合并逻辑需要在数据写入全部完成后，对最后一部分相同的数据进行合并操作。在实际Web应用中，这可能需要在所有数据写入doWrite方法后，通过某种回调机制来触发最终的合并动作。
第三部分：多个WriteHandler的协作与冲突管理
在复杂导出场景中，我们可能会注册多个WriteHandler，每个处理器负责一部分单一的功能（例如一个负责全局样式，一个负责合并，一个负责特殊列处理）。此时，必须理解它们的执行机制以避免冲突。
3.1 执行顺序
EasyExcel中注册的多个WriteHandler会按照注册的先后顺序依次执行 。这意味着，后注册的处理器对单元格的修改会覆盖先注册处理器的相同修改。
例如，如果你先注册了一个设置所有单元格背景为灰色的Handler A，再注册一个设置特定单元格背景为红色的Handler B，那么最终结果是特定单元格为红色，其他单元格为灰色，这符合预期。但如果顺序颠倒，Handler B的设置将被Handler A覆盖，导致所有单元格都变成灰色。
3.2 最佳实践与冲突避免
- 遵循单一职责原则： 建议让每个
WriteHandler的功能尽可能单一、正交 。例如，创建一个DefaultStyleHandler负责基础样式，再创建一个MergeHandler专门负责合并逻辑。 - 谨慎管理注册顺序： 规划好
WriteHandler的注册顺序至关重要。通常，通用性、基础性的处理器（如全局样式）先注册，特殊性、覆盖性的处理器（如高亮、特殊格式）后注册。 - 避免在处理器中创建过多对象： 在处理大数据量导出时，如果在
WriteHandler的循环方法（如afterCellDispose）中频繁创建CellStyle、Font等对象，会极大地增加内存消耗和GC压力，导致性能下降 。- 优化策略： 可以在
WriteHandler的构造函数或beforeSheetCreate方法中预先创建好有限的几种样式对象，并缓存起来。在afterCellDispose中，根据条件逻辑从缓存中获取并应用样式，而不是每次都workbook.createCellStyle()。
- 优化策略： 可以在
- 组合优于继承： 如果一个
Handler的逻辑变得过于庞大，可以考虑将其拆分为多个小Handler，然后按顺序注册它们，而不是创建一个臃肿的“上帝类”。
第四部分：性能考量与优化策略
虽然EasyExcel本身性能优异，但在大量使用自定义WriteHandler进行大数据量导出（例如数十万行）时，不当的实现仍然可能成为性能瓶颈。
- 内存占用：
- 样式对象缓存： 如上文所述，缓存
CellStyle和Font对象是最高效的优化手段。一个Excel工作簿中样式的数量是有限制的（约64000个），无限制地创建新样式不仅会降低性能，还可能导致文件损坏。 - 合并策略的内存消耗： 需要合并单元格的策略，通常需要在内存中维护一个状态（如前一个单元格的值、合并起始行等）。对于超大数据集，确保这些状态变量不会占用过多内存 。
- 样式对象缓存： 如上文所述，缓存
- CPU消耗：
- 避免复杂计算： 在
afterCellDispose等高频调用的方法中，应避免执行复杂的计算或I/O操作。所有计算应尽可能简单直接。 - 流式处理： EasyExcel的底层设计就是基于SAX的流式处理，这保证了其在处理大文件时的低内存占用。自定义的
WriteHandler应该遵循这一思想，避免将大量数据一次性加载到内存中进行判断 。
- 避免复杂计算： 在
结语
EasyExcel通过其强大而灵活的WriteHandler拦截器机制，尤其是AbstractCellWriteHandler，为Java开发者提供了对Excel导出过程近乎像素级的控制能力。从动态设置单元格样式、实现复杂的合并策略，到添加超链接等交互元素，都可以通过继承和实现相应的方法来完成。
要精通并高效运用这一机制，核心在于深刻理解WriteHandler的生命周期、掌握多个处理器之间的执行顺序与覆盖规则，并始终贯彻性能优先的原则，特别是在处理大数据量时，要注意缓存样式对象和优化算法逻辑。
扫一扫
1181
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
