Update 更新 warm-flow 版本至 1.8.1

Add Excel工具类支持更灵活的自定义导出方式
Update 优化Excel单元格合并处理器代码逻辑分支

SERVER/VberAdminPlusV3/pom.xml

@@ -57,7 +57,7 @@
         <anyline.version>8.7.2-20250603</anyline.version>
 
         <!-- 工作流配置 -->
-        <warm-flow.version>1.8.0-m1</warm-flow.version>
+        <warm-flow.version>1.8.1</warm-flow.version>
 
         <!-- 插件版本 -->
         <maven-jar-plugin.version>3.4.2</maven-jar-plugin.version>

SERVER/VberAdminPlusV3/vber-common/vber-common-excel/src/main/java/com/vber/common/excel/core/CellMergeHandler.java

@@ -0,0 +1,200 @@
+package com.vber.common.excel.core;
+
+import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.util.ReflectUtil;
+import cn.hutool.core.util.StrUtil;
+import cn.idev.excel.annotation.ExcelIgnore;
+import cn.idev.excel.annotation.ExcelIgnoreUnannotated;
+import cn.idev.excel.annotation.ExcelProperty;
+import com.vber.common.core.utils.reflect.ReflectUtils;
+import com.vber.common.excel.annotation.CellMerge;
+import lombok.SneakyThrows;
+import org.apache.poi.ss.util.CellRangeAddress;
+
+import java.lang.reflect.Field;
+import java.util.*;
+
+/**
+ * 单元格合并处理器
+ *
+ * @author Iwb
+ */
+public class CellMergeHandler {
+
+    private final boolean hasTitle;
+    private int rowIndex;
+
+    private CellMergeHandler(final boolean hasTitle) {
+        this.hasTitle = hasTitle;
+        // 行合并开始下标
+        this.rowIndex = hasTitle ? 1 : 0;
+    }
+
+    @SneakyThrows
+    public List<CellRangeAddress> handle(List<?> rows) {
+        // 如果入参为空集合则返回空集
+        if (CollUtil.isEmpty(rows)) {
+            return Collections.emptyList();
+        }
+
+        // 获取有合并注解的字段
+        Map<Field, FieldColumnIndex> mergeFields = getFieldColumnIndexMap(rows.get(0).getClass());
+        // 如果没有需要合并的字段则返回空集
+        if (CollUtil.isEmpty(mergeFields)) {
+            return Collections.emptyList();
+        }
+
+        // 结果集
+        List<CellRangeAddress> result = new ArrayList<>();
+
+        // 生成两两合并单元格
+        Map<Field, RepeatCell> rowRepeatCellMap = new HashMap<>();
+        for (Map.Entry<Field, FieldColumnIndex> item : mergeFields.entrySet()) {
+            Field field = item.getKey();
+            FieldColumnIndex itemValue = item.getValue();
+            int colNum = itemValue.colIndex();
+            CellMerge cellMerge = itemValue.cellMerge();
+
+            for (int i = 0; i < rows.size(); i++) {
+                // 当前行数据
+                Object currentRowObj = rows.get(i);
+                // 当前行数据字段值
+                Object currentRowObjFieldVal = ReflectUtils.invokeGetter(currentRowObj, field.getName());
+
+                // 空值跳过不处理
+                if (currentRowObjFieldVal == null || "".equals(currentRowObjFieldVal)) {
+                    continue;
+                }
+
+                // 单元格合并Map是否存在数据，如果不存在则添加当前行的字段值
+                if (!rowRepeatCellMap.containsKey(field)) {
+                    rowRepeatCellMap.put(field, RepeatCell.of(currentRowObjFieldVal, i));
+                    continue;
+                }
+
+                // 获取 单元格合并Map 中字段值
+                RepeatCell repeatCell = rowRepeatCellMap.get(field);
+                Object cellValue = repeatCell.value();
+                int current = repeatCell.current();
+
+                // 检查是否满足合并条件
+                // currentRowObj 当前行数据
+                // rows.get(i - 1) 上一行数据 注：由于 if (!rowRepeatCellMap.containsKey(field)) 条件的存在，所以该 i 必不可能小于1
+                // cellMerge 当前行字段合并注解
+                boolean merge = isMerge(currentRowObj, rows.get(i - 1), cellMerge);
+
+                // 是否添加到结果集
+                boolean isAddResult = false;
+                // 最新行
+                int lastRow = i + rowIndex - 1;
+
+                // 如果当前行字段值和缓存中的字段值不相等，或不满足合并条件，则替换
+                if (!currentRowObjFieldVal.equals(cellValue) || !merge) {
+                    rowRepeatCellMap.put(field, RepeatCell.of(currentRowObjFieldVal, i));
+                    isAddResult = true;
+                }
+
+                // 如果最后一行不能合并，检查之前的数据是否需要合并；如果最后一行可以合并，则直接合并到最后
+                if (i == rows.size() - 1) {
+                    isAddResult = true;
+                    if (i > current) {
+                        lastRow = i + rowIndex;
+                    }
+                }
+
+                if (isAddResult && i > current) {
+                    result.add(new CellRangeAddress(current + rowIndex, lastRow, colNum, colNum));
+                }
+            }
+        }
+        return result;
+    }
+
+    /**
+     * 获取带有合并注解的字段列索引和合并注解信息Map集
+     */
+    private Map<Field, FieldColumnIndex> getFieldColumnIndexMap(Class<?> clazz) {
+        boolean annotationPresent = clazz.isAnnotationPresent(ExcelIgnoreUnannotated.class);
+        Field[] fields = ReflectUtils.getFields(clazz, field -> {
+            if ("serialVersionUID".equals(field.getName())) {
+                return false;
+            }
+            if (field.isAnnotationPresent(ExcelIgnore.class)) {
+                return false;
+            }
+            return !annotationPresent || field.isAnnotationPresent(ExcelProperty.class);
+        });
+
+        // 有注解的字段
+        Map<Field, FieldColumnIndex> mergeFields = new HashMap<>();
+        for (int i = 0; i < fields.length; i++) {
+            Field field = fields[i];
+            if (!field.isAnnotationPresent(CellMerge.class)) {
+                continue;
+            }
+            CellMerge cm = field.getAnnotation(CellMerge.class);
+            int index = cm.index() == -1 ? i : cm.index();
+            mergeFields.put(field, FieldColumnIndex.of(index, cm));
+
+            if (hasTitle) {
+                ExcelProperty property = field.getAnnotation(ExcelProperty.class);
+                rowIndex = Math.max(rowIndex, property.value().length);
+            }
+        }
+        return mergeFields;
+    }
+
+    private boolean isMerge(Object currentRow, Object preRow, CellMerge cellMerge) {
+        final String[] mergeBy = cellMerge.mergeBy();
+        if (StrUtil.isAllNotBlank(mergeBy)) {
+            //比对当前行和上一行的各个属性值一一比对 如果全为真 则为真
+            for (String fieldName : mergeBy) {
+                final Object valCurrent = ReflectUtil.getFieldValue(currentRow, fieldName);
+                final Object valPre = ReflectUtil.getFieldValue(preRow, fieldName);
+                if (!Objects.equals(valPre, valCurrent)) {
+                    //依赖字段如有任一不等值,则标记为不可合并
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    /**
+     * 单元格合并
+     */
+    record RepeatCell(Object value, int current) {
+        static RepeatCell of(Object value, int current) {
+            return new RepeatCell(value, current);
+        }
+    }
+
+    /**
+     * 字段列索引和合并注解信息
+     */
+    record FieldColumnIndex(int colIndex, CellMerge cellMerge) {
+        static FieldColumnIndex of(int colIndex, CellMerge cellMerge) {
+            return new FieldColumnIndex(colIndex, cellMerge);
+        }
+    }
+
+    /**
+     * 创建一个单元格合并处理器实例
+     *
+     * @param hasTitle 是否合并标题
+     * @return 单元格合并处理器
+     */
+    public static CellMergeHandler of(final boolean hasTitle) {
+        return new CellMergeHandler(hasTitle);
+    }
+
+    /**
+     * 创建一个单元格合并处理器实例（默认不合并标题）
+     *
+     * @return 单元格合并处理器
+     */
+    public static CellMergeHandler of() {
+        return new CellMergeHandler(false);
+    }
+
+}

SERVER/VberAdminPlusV3/vber-common/vber-common-excel/src/main/java/com/vber/common/excel/core/CellMergeStrategy.java

@@ -1,175 +1,59 @@
 package com.vber.common.excel.core;
 
 import cn.hutool.core.collection.CollUtil;
-import cn.hutool.core.util.ReflectUtil;
-import cn.hutool.core.util.StrUtil;
-import cn.idev.excel.annotation.ExcelIgnore;
-import cn.idev.excel.annotation.ExcelIgnoreUnannotated;
-import cn.idev.excel.annotation.ExcelProperty;
 import cn.idev.excel.metadata.Head;
 import cn.idev.excel.write.handler.WorkbookWriteHandler;
 import cn.idev.excel.write.handler.context.WorkbookWriteHandlerContext;
 import cn.idev.excel.write.merge.AbstractMergeStrategy;
-import com.vber.common.core.utils.reflect.ReflectUtils;
-import com.vber.common.excel.annotation.CellMerge;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.poi.ss.usermodel.Cell;
 import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.util.CellRangeAddress;
 
-import java.lang.reflect.Field;
-import java.util.*;
+import java.util.List;
 
 /**
  * 列值重复合并策略
  *
- * @author Iwb
+ * @author Lion Li
  */
 @Slf4j
 public class CellMergeStrategy extends AbstractMergeStrategy implements WorkbookWriteHandler {
 
     private final List<CellRangeAddress> cellList;
-    private final boolean hasTitle;
-    private int rowIndex;
+
+    public CellMergeStrategy(List<CellRangeAddress> cellList) {
+        this.cellList = cellList;
+    }
 
     public CellMergeStrategy(List<?> list, boolean hasTitle) {
-        this.hasTitle = hasTitle;
-        // 行合并开始下标
-        this.rowIndex = hasTitle ? 1 : 0;
-        this.cellList = handle(list, hasTitle);
+        this.cellList = CellMergeHandler.of(hasTitle).handle(list);
     }
 
     @Override
     protected void merge(Sheet sheet, Cell cell, Head head, Integer relativeRowIndex) {
+        if (CollUtil.isEmpty(cellList)) {
+            return;
+        }
         //单元格写入了,遍历合并区域,如果该Cell在区域内,但非首行,则清空
         final int rowIndex = cell.getRowIndex();
-        if (CollUtil.isNotEmpty(cellList)) {
-            for (CellRangeAddress cellAddresses : cellList) {
-                final int firstRow = cellAddresses.getFirstRow();
-                if (cellAddresses.isInRange(cell) && rowIndex != firstRow) {
-                    cell.setBlank();
-                }
+        for (CellRangeAddress cellAddresses : cellList) {
+            final int firstRow = cellAddresses.getFirstRow();
+            if (cellAddresses.isInRange(cell) && rowIndex != firstRow) {
+                cell.setBlank();
             }
         }
     }
 
     @Override
     public void afterWorkbookDispose(final WorkbookWriteHandlerContext context) {
-        //当前表格写完后，统一写入
-        if (CollUtil.isNotEmpty(cellList)) {
-            for (CellRangeAddress item : cellList) {
-                context.getWriteContext().writeSheetHolder().getSheet().addMergedRegion(item);
-            }
+        if (CollUtil.isEmpty(cellList)) {
+            return;
         }
-    }
-
-    @SneakyThrows
-    private List<CellRangeAddress> handle(List<?> list, boolean hasTitle) {
-        List<CellRangeAddress> cellList = new ArrayList<>();
-        if (CollUtil.isEmpty(list)) {
-            return cellList;
-        }
-        Class<?> clazz = list.get(0).getClass();
-        boolean annotationPresent = clazz.isAnnotationPresent(ExcelIgnoreUnannotated.class);
-        Field[] fields = ReflectUtils.getFields(clazz, field -> {
-            if ("serialVersionUID".equals(field.getName())) {
-                return false;
-            }
-            if (field.isAnnotationPresent(ExcelIgnore.class)) {
-                return false;
-            }
-            return !annotationPresent || field.isAnnotationPresent(ExcelProperty.class);
-        });
-        // 有注解的字段
-        List<Field> mergeFields = new ArrayList<>();
-        List<Integer> mergeFieldsIndex = new ArrayList<>();
-        for (int i = 0; i < fields.length; i++) {
-            Field field = fields[i];
-            if (field.isAnnotationPresent(CellMerge.class)) {
-                CellMerge cm = field.getAnnotation(CellMerge.class);
-                mergeFields.add(field);
-                mergeFieldsIndex.add(cm.index() == -1 ? i : cm.index());
-                if (hasTitle) {
-                    ExcelProperty property = field.getAnnotation(ExcelProperty.class);
-                    rowIndex = Math.max(rowIndex, property.value().length);
-                }
-            }
-        }
-
-        Map<Field, RepeatCell> map = new HashMap<>();
-        // 生成两两合并单元格
-        for (int i = 0; i < list.size(); i++) {
-            Object rowObj = list.get(i);
-            for (int j = 0; j < mergeFields.size(); j++) {
-                Field field = mergeFields.get(j);
-                Object val = ReflectUtils.invokeGetter(rowObj, field.getName());
-
-                int colNum = mergeFieldsIndex.get(j);
-                if (!map.containsKey(field)) {
-                    map.put(field, new RepeatCell(val, i));
-                } else {
-                    RepeatCell repeatCell = map.get(field);
-                    Object cellValue = repeatCell.getValue();
-                    if (cellValue == null || "".equals(cellValue)) {
-                        // 空值跳过不合并
-                        continue;
-                    }
-
-                    if (!cellValue.equals(val)) {
-                        if ((i - repeatCell.getCurrent() > 1)) {
-                            cellList.add(new CellRangeAddress(repeatCell.getCurrent() + rowIndex, i + rowIndex - 1, colNum, colNum));
-                        }
-                        map.put(field, new RepeatCell(val, i));
-                    } else if (i == list.size() - 1) {
-                        if (!isMerge(list, i, field)) {
-                            // 如果最后一行不能合并，检查之前的数据是否需要合并
-                            if (i - repeatCell.getCurrent() > 1) {
-                                cellList.add(new CellRangeAddress(repeatCell.getCurrent() + rowIndex, i + rowIndex - 1, colNum, colNum));
-                            }
-                        } else if (i > repeatCell.getCurrent()) {
-                            // 如果最后一行可以合并，则直接合并到最后
-                            cellList.add(new CellRangeAddress(repeatCell.getCurrent() + rowIndex, i + rowIndex, colNum, colNum));
-                        }
-                    } else if (!isMerge(list, i, field)) {
-                        if ((i - repeatCell.getCurrent() > 1)) {
-                            cellList.add(new CellRangeAddress(repeatCell.getCurrent() + rowIndex, i + rowIndex - 1, colNum, colNum));
-                        }
-                        map.put(field, new RepeatCell(val, i));
-                    }
-                }
-            }
-        }
-        return cellList;
-    }
-
-    private boolean isMerge(List<?> list, int i, Field field) {
-        boolean isMerge = true;
-        CellMerge cm = field.getAnnotation(CellMerge.class);
-        final String[] mergeBy = cm.mergeBy();
-        if (StrUtil.isAllNotBlank(mergeBy)) {
-            //比对当前list(i)和list(i - 1)的各个属性值一一比对 如果全为真 则为真
-            for (String fieldName : mergeBy) {
-                final Object valCurrent = ReflectUtil.getFieldValue(list.get(i), fieldName);
-                final Object valPre = ReflectUtil.getFieldValue(list.get(i - 1), fieldName);
-                if (!Objects.equals(valPre, valCurrent)) {
-                    //依赖字段如有任一不等值,则标记为不可合并
-                    isMerge = false;
-                }
-            }
+        //当前表格写完后，统一写入
+        for (CellRangeAddress item : cellList) {
+            context.getWriteContext().writeSheetHolder().getSheet().addMergedRegion(item);
         }
-        return isMerge;
     }
 
-    @Data
-    @AllArgsConstructor
-    static class RepeatCell {
-
-        private Object value;
-
-        private int current;
-
-    }
 }

SERVER/VberAdminPlusV3/vber-common/vber-common-excel/src/main/java/com/vber/common/excel/utils/ExcelUtil.java

@@ -27,6 +27,7 @@ import java.io.UnsupportedEncodingException;
 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
+import java.util.function.Consumer;
 
 /**
  * Excel相关处理
@@ -203,6 +204,44 @@ public class ExcelUtil {
         builder.doWrite(list);
     }
 
+    /**
+     * 导出excel
+     *
+     * @param headType 带Excel注解的类型
+     * @param os       输出流
+     * @param options  Excel下拉可选项
+     * @param consumer 导出助手消费函数
+     */
+    public static <T> void exportExcel(Class<T> headType, OutputStream os, List<DropDownOptions> options, Consumer<ExcelWriterWrapper<T>> consumer) {
+        try (ExcelWriter writer = FastExcel.write(os, headType)
+                .autoCloseStream(false)
+                // 自动适配
+                .registerWriteHandler(new LongestMatchColumnWidthStyleStrategy())
+                // 大数值自动转换 防止失真
+                .registerConverter(new ExcelBigNumberConvert())
+                // 批注必填项处理
+                .registerWriteHandler(new DataWriteHandler(headType))
+                // 添加下拉框操作
+                .registerWriteHandler(new ExcelDownHandler(options))
+                .build()) {
+            // 执行消费函数
+            consumer.accept(ExcelWriterWrapper.of(writer));
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * 导出excel
+     *
+     * @param headType 带Excel注解的类型
+     * @param os       输出流
+     * @param consumer 导出助手消费函数
+     */
+    public static <T> void exportExcel(Class<T> headType, OutputStream os, Consumer<ExcelWriterWrapper<T>> consumer) {
+        exportExcel(headType, os, null, consumer);
+    }
+
     /**
      * 单表多数据模板导出 模板格式为 {.属性}
      *

SERVER/VberAdminPlusV3/vber-common/vber-common-excel/src/main/java/com/vber/common/excel/utils/ExcelWriterWrapper.java

@@ -0,0 +1,127 @@
+package com.vber.common.excel.utils;
+
+import cn.idev.excel.ExcelWriter;
+import cn.idev.excel.FastExcel;
+import cn.idev.excel.context.WriteContext;
+import cn.idev.excel.write.builder.ExcelWriterSheetBuilder;
+import cn.idev.excel.write.builder.ExcelWriterTableBuilder;
+import cn.idev.excel.write.metadata.WriteSheet;
+import cn.idev.excel.write.metadata.WriteTable;
+import cn.idev.excel.write.metadata.fill.FillConfig;
+
+import java.util.Collection;
+import java.util.function.Supplier;
+
+/**
+ * ExcelWriterWrapper Excel写出包装器
+ * <br>
+ * 提供了一组与 ExcelWriter 一一对应的写出方法，避免直接提供 ExcelWriter 而导致的一些不可控问题（比如提前关闭了IO流等）
+ *
+ * @author Iwb
+ * @see ExcelWriter
+ */
+public record ExcelWriterWrapper<T>(ExcelWriter excelWriter) {
+
+    public void write(Collection<T> data, WriteSheet writeSheet) {
+        excelWriter.write(data, writeSheet);
+    }
+
+    public void write(Supplier<Collection<T>> supplier, WriteSheet writeSheet) {
+        excelWriter.write(supplier.get(), writeSheet);
+    }
+
+    public void write(Collection<T> data, WriteSheet writeSheet, WriteTable writeTable) {
+        excelWriter.write(data, writeSheet, writeTable);
+    }
+
+    public void write(Supplier<Collection<T>> supplier, WriteSheet writeSheet, WriteTable writeTable) {
+        excelWriter.write(supplier.get(), writeSheet, writeTable);
+    }
+
+    public void fill(Object data, WriteSheet writeSheet) {
+        excelWriter.fill(data, writeSheet);
+    }
+
+    public void fill(Object data, FillConfig fillConfig, WriteSheet writeSheet) {
+        excelWriter.fill(data, fillConfig, writeSheet);
+    }
+
+    public void fill(Supplier<Object> supplier, WriteSheet writeSheet) {
+        excelWriter.fill(supplier, writeSheet);
+    }
+
+    public void fill(Supplier<Object> supplier, FillConfig fillConfig, WriteSheet writeSheet) {
+        excelWriter.fill(supplier, fillConfig, writeSheet);
+    }
+
+    public WriteContext writeContext() {
+        return excelWriter.writeContext();
+    }
+
+    /**
+     * 创建一个 ExcelWriterWrapper
+     *
+     * @param excelWriter ExcelWriter
+     * @return ExcelWriterWrapper
+     */
+    public static <T> ExcelWriterWrapper<T> of(ExcelWriter excelWriter) {
+        return new ExcelWriterWrapper<>(excelWriter);
+    }
+
+    // -------------------------------- sheet start
+
+    public static WriteSheet buildSheet(Integer sheetNo, String sheetName) {
+        return sheetBuilder(sheetNo, sheetName).build();
+    }
+
+    public static WriteSheet buildSheet(Integer sheetNo) {
+        return sheetBuilder(sheetNo).build();
+    }
+
+    public static WriteSheet buildSheet(String sheetName) {
+        return sheetBuilder(sheetName).build();
+    }
+
+    public static WriteSheet buildSheet() {
+        return sheetBuilder().build();
+    }
+
+    public static ExcelWriterSheetBuilder sheetBuilder(Integer sheetNo, String sheetName) {
+        return FastExcel.writerSheet(sheetNo, sheetName);
+    }
+
+    public static ExcelWriterSheetBuilder sheetBuilder(Integer sheetNo) {
+        return FastExcel.writerSheet(sheetNo);
+    }
+
+    public static ExcelWriterSheetBuilder sheetBuilder(String sheetName) {
+        return FastExcel.writerSheet(sheetName);
+    }
+
+    public static ExcelWriterSheetBuilder sheetBuilder() {
+        return FastExcel.writerSheet();
+    }
+
+    // -------------------------------- sheet end
+
+    // -------------------------------- table start
+
+    public static WriteTable buildTable(Integer tableNo) {
+        return tableBuilder(tableNo).build();
+    }
+
+    public static WriteTable buildTable() {
+        return tableBuilder().build();
+    }
+
+    public static ExcelWriterTableBuilder tableBuilder(Integer tableNo) {
+        return FastExcel.writerTable(tableNo);
+    }
+
+    public static ExcelWriterTableBuilder tableBuilder() {
+        return FastExcel.writerTable();
+    }
+
+    // -------------------------------- table end
+
+}