EasyExcel 的 registerWriteHandler 方法用于注册自定义的写入处理器。
- 样式处理器：样式处理器用于设置单元格的样式，例如字体、颜色、对齐方式等。
import com.alibaba.excel.write.handler.RowWriteHandler;
import com.alibaba.excel.write.handler.context.RowWriteHandlerContext;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.DateUtil;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellRangeAddress;
import java.util.*;
/**
* @author admin
* @date 2024/9/14 9:49
* @description: 默认构造方法，用于创建一个默认的合并列处理器,默认情况下，所有列都会被合并。
*/
public class MergeColumnHandler implements RowWriteHandler {
private final List<Integer> columnsToMerge;
private final boolean mergeAllColumns;
private final Map<Integer, Object> previousValues;
private final Map<Integer, Integer> previousRowIndices;
/**
* 构造方法，用于创建一个自定义列合并处理器。
*
* @param columnsToMerge 需要合并的列的索引列表。
*/
public MergeColumnHandler(int... columnsToMerge) {
this.columnsToMerge = new ArrayList<>();
for (int column : columnsToMerge) {
this.columnsToMerge.add(column);
}
this.mergeAllColumns = false;
this.previousValues = new HashMap<>();
this.previousRowIndices = new HashMap<>();
}
/**
* 在行写入后处理逻辑，用于处理单元格合并。
* 当前方法会在每一行写入完成后被调用，用于检查是否需要合并单元格。
* 合并单元格的条件是：与第一列合并行数相同
*
* @param context 行写入上下文，包含当前行的索引、当前行对象以及相关写入配置。
*/
@Override
public void afterRowDispose(RowWriteHandlerContext context) {
// 获取当前操作的Sheet对象
Sheet sheet = context.getWriteSheetHolder().getSheet();
// 获取当前行索引
int currentRowIndex = context.getRowIndex();
// 第一类合并最大行数
int maxRow = 0;
// 获取当前行对象
Row currentRow = context.getRow();
// 遍历当前行的所有单元格
for (Cell cell : currentRow) {
// 获取当前单元格的列索引
int columnIndex = cell.getColumnIndex();
// 如果不合并所有列且当前列不在合并列列表中，则跳过当前列
if (!mergeAllColumns && !columnsToMerge.contains(columnIndex)) {
continue;
}
// 获取当前单元格的值
String currentValue = (getCellValue(cell) == null ? "" : getCellValue(cell).toString());
// 如果当前值不为空
if (currentValue != null) {
int row = 0;
int startRow = 0;
int endRow = 0;
// 获取第一列可以合并的最大的单元格个数（结束行 - 当前行）
if (currentRowIndex != 0) {
// 获取第一例的开始行数
startRow = previousRowIndices.get(columnsToMerge.get(0));
endRow = currentRowIndex;
// 合并最大的行数
row = endRow - startRow;
}
// 设置第一列合并最大行数
if(columnIndex == 0) {
maxRow = row;
}
// 如果当前值与前一值相同，则合并单元格,并设置了最大的合并单元格的个数（与第一个单元格保持一致）
if (currentValue.equals(previousValues.get(columnIndex)) && maxRow <= row ) {
// 合并单元格
mergeCells(sheet, startRow, endRow, columnIndex);
} else {
// 否则，更新前一值和前一行索引为当前值和当前行索引
previousValues.put(columnIndex, currentValue);
previousRowIndices.put(columnIndex, currentRowIndex);
}
}
}
}
/**
* 合并单元格。
* 本方法用于将指定范围的单元格合并。它首先检查是否存在已经合并的区域起点与指定的起始行和列相同，
* 如果存在，它将调整已合并区域的终点为指定的结束行，然后重新添加这个调整后的合并区域。
* 如果不存在这样的合并区域，则创建一个新的合并区域并添加到工作表中。
*
* @param sheet 工作表对象，表示要操作的工作表。
* @param startRow 合并范围的起始行索引。
* @param endRow 合并范围的结束行索引。
* @param column 合并范围的列索引。
*/
private void mergeCells(Sheet sheet, int startRow, int endRow, int column) {
// 遍历工作表中所有的合并区域
for (int i = 0; i < sheet.getNumMergedRegions(); i++) {
CellRangeAddress region = sheet.getMergedRegion(i);
// 检查当前合并区域是否与指定的起始行和列匹配
if (region.getFirstRow() == startRow && region.getFirstColumn() == column) {
// 如果匹配，移除当前合并区域，以便可以重新设置它的范围
sheet.removeMergedRegion(i);
// 调整合并区域的结束行为指定的结束行
region.setLastRow(endRow);
// 重新添加调整后的合并区域
sheet.addMergedRegion(region);
// 返回，完成合并
return;
}
}
// 如果没有找到匹配的合并区域，则创建一个新的合并区域并添加到工作表中
sheet.addMergedRegion(new CellRangeAddress(startRow, endRow, column, column));
}
/**
* 根据单元格类型获取单元格的值。
* 此方法用于处理不同类型的Excel单元格，根据单元格的类型（字符串、数字、布尔、公式等），
* 返回相应的单元格值。对于日期格式的数值单元格，将返回Date类型，否则返回Double类型。
* 对于字符串、布尔值和公式单元格，直接返回相应的字符串、布尔值或公式。
*
* @param cell 单元格对象，可能为null。
* @return 单元格的值，根据单元格类型返回不同类型的值，如果单元格为null，则返回null。
*/
private Object getCellValue(Cell cell) {
if (cell == null) {
return null;
}
return switch (cell.getCellType()) {
case STRING -> cell.getStringCellValue();
case NUMERIC -> DateUtil.isCellDateFormatted(cell) ? cell.getDateCellValue() : cell.getNumericCellValue();
case BOOLEAN -> cell.getBooleanCellValue();
case FORMULA -> cell.getCellFormula();
default -> null;
};
}
}
- 合并单元格处理器：合并单元格处理器用于合并特定的单元格范围。
import com.alibaba.excel.write.handler.RowWriteHandler;
import com.alibaba.excel.write.handler.context.RowWriteHandlerContext;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.DateUtil;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellRangeAddress;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
/**
* @author 合并单元格
*/
public class MergeColumnHandler implements RowWriteHandler {
private final Set<Integer> columnsToMerge;
private final boolean mergeAllColumns;
private final Map<Integer, Object> previousValues;
private final Map<Integer, Integer> previousRowIndices;
/**
* 默认构造方法，用于创建一个默认的合并列处理器。
* 默认情况下，所有列都会被合并。
*/
public MergeColumnHandler() {
this.columnsToMerge = new HashSet<>();
this.mergeAllColumns = true;
this.previousValues = new HashMap<>();
this.previousRowIndices = new HashMap<>();
}
/**
* 构造方法，用于创建一个自定义列合并处理器。
*
* @param columnsToMerge 需要合并的列的索引列表。
*/
public MergeColumnHandler(int... columnsToMerge) {
this.columnsToMerge = new HashSet<>();
for (int column : columnsToMerge) {
this.columnsToMerge.add(column);
}
this.mergeAllColumns = false;
this.previousValues = new HashMap<>();
this.previousRowIndices = new HashMap<>();
}
/**
* 在行写入后处理逻辑，用于处理单元格合并。
* 当前方法会在每一行写入完成后被调用，用于检查是否需要合并单元格。
* 合并单元格的条件是：当前列需要合并，且当前值与前一值相同。
*
* @param context 行写入上下文，包含当前行的索引、当前行对象以及相关写入配置。
*/
@Override
public void afterRowDispose(RowWriteHandlerContext context) {
// 获取当前操作的Sheet对象
Sheet sheet = context.getWriteSheetHolder().getSheet();
// 获取当前行索引
int currentRowIndex = context.getRowIndex();
// 第一类合并最大行数
int maxRow = 0;
// 获取当前行对象
Row currentRow = context.getRow();
// 遍历当前行的所有单元格
for (Cell cell : currentRow) {
// 获取当前单元格的列索引
int columnIndex = cell.getColumnIndex();
// 如果不合并所有列且当前列不在合并列列表中，则跳过当前列
if (!mergeAllColumns && !columnsToMerge.contains(columnIndex)) {
continue;
}
// 获取当前单元格的值
Object currentValue = getCellValue(cell);
// 如果当前值不为空
if (currentValue != null) {
Integer row = 0;
Integer startRow = 0;
Integer endRow = 0;
// 获取第一列可以合并的最大的单元格个数（结束行 - 当前行）
if (currentRowIndex != 0) {
// 获取第一例的开始行数
startRow = previousRowIndices.get(0);
endRow = currentRowIndex;
// 合并最大的行数
row = endRow - startRow;
}
// 设置第一列合并最大行数
if(columnIndex == 0) {
maxRow = row;
}
// 如果当前值与前一值相同，则合并单元格,并设置了最大的合并单元格的个数（与第一个单元格保持一致）
if (currentValue.equals(previousValues.get(columnIndex)) && maxRow <= row ) {
// 合并单元格
mergeCells(sheet, startRow, endRow, columnIndex);
} else {
// 否则，更新前一值和前一行索引为当前值和当前行索引
previousValues.put(columnIndex, currentValue);
previousRowIndices.put(columnIndex, currentRowIndex);
}
}
}
}
/**
* 合并单元格。
* 本方法用于将指定范围的单元格合并。它首先检查是否存在已经合并的区域起点与指定的起始行和列相同，
* 如果存在，它将调整已合并区域的终点为指定的结束行，然后重新添加这个调整后的合并区域。
* 如果不存在这样的合并区域，则创建一个新的合并区域并添加到工作表中。
*
* @param sheet 工作表对象，表示要操作的工作表。
* @param startRow 合并范围的起始行索引。
* @param endRow 合并范围的结束行索引。
* @param column 合并范围的列索引。
*/
private void mergeCells(Sheet sheet, int startRow, int endRow, int column) {
// 遍历工作表中所有的合并区域
for (int i = 0; i < sheet.getNumMergedRegions(); i++) {
CellRangeAddress region = sheet.getMergedRegion(i);
// 检查当前合并区域是否与指定的起始行和列匹配
if (region.getFirstRow() == startRow && region.getFirstColumn() == column) {
// 如果匹配，移除当前合并区域，以便可以重新设置它的范围
sheet.removeMergedRegion(i);
// 调整合并区域的结束行为指定的结束行
region.setLastRow(endRow);
// 重新添加调整后的合并区域
sheet.addMergedRegion(region);
// 返回，完成合并
return;
}
}
// 如果没有找到匹配的合并区域，则创建一个新的合并区域并添加到工作表中
sheet.addMergedRegion(new CellRangeAddress(startRow, endRow, column, column));
}
/**
* 根据单元格类型获取单元格的值。
* 此方法用于处理不同类型的Excel单元格，根据单元格的类型（字符串、数字、布尔、公式等），
* 返回相应的单元格值。对于日期格式的数值单元格，将返回Date类型，否则返回Double类型。
* 对于字符串、布尔值和公式单元格，直接返回相应的字符串、布尔值或公式。
*
* @param cell 单元格对象，可能为null。
* @return 单元格的值，根据单元格类型返回不同类型的值，如果单元格为null，则返回null。
*/
private Object getCellValue(Cell cell) {
if (cell == null) {
return null;
}
switch (cell.getCellType()) {
case STRING:
return cell.getStringCellValue();
case NUMERIC:
if (DateUtil.isCellDateFormatted(cell)) {
return cell.getDateCellValue();
} else {
// 转换为 int
return (int) cell.getNumericCellValue();
}
case BOOLEAN:
return cell.getBooleanCellValue();
case FORMULA:
return cell.getCellFormula();
default:
return null;
}
}
}
测试方法。
@GetMapping("download")
public void download(HttpServletResponse response) throws IOException {
List<SysUserExcelVO> list = new ArrayList<>();
list.add(new SysUserExcelVO("1","1n","n"));
list.add(new SysUserExcelVO("1","1n","n"));
list.add(new SysUserExcelVO("2","1n","n"));
list.add(new SysUserExcelVO("2","1n","n"));
list.add(new SysUserExcelVO("2","1n","n"));
list.add(new SysUserExcelVO("3","3n","n"));
// 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
String fileName= URLEncoder.encode("测试","UTF-8").replaceAll("\\+","%20");
response.setHeader("Content-disposition","attachment;filename*=utf-8''"+fileName+".xlsx");
EasyExcel.write(response.getOutputStream(), SysUserExcelVO.class)
.registerWriteHandler(CenterAlignCellStyleStrategy.getCenterAlignStrategy())
.registerWriteHandler(new MergeColumnHandler(0,1,2))
.sheet("模板").doWrite(list);
}
扫一扫
8331
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
