Render and fill the template with automatic handling of cell merging functionality 渲染填充模板自动处理单元格合并功能

fastexcel-core/src/main/java/cn/idev/excel/write/executor/ExcelWriteFillExecutor.java

@@ -10,6 +10,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import cn.idev.excel.context.WriteContext;
 import cn.idev.excel.enums.CellDataTypeEnum;
@@ -42,6 +43,7 @@
 import org.apache.poi.ss.usermodel.CellType;
 import org.apache.poi.ss.usermodel.Row;
 import org.apache.poi.ss.usermodel.Sheet;
+import org.apache.poi.ss.util.CellRangeAddress;
 
 /**
  * Fill the data into excel
@@ -69,6 +71,10 @@ public class ExcelWriteFillExecutor extends AbstractExcelWriteExecutor {
      */
     private final Map<UniqueDataFlagKey, Map<AnalysisCell, CellStyle>> collectionFieldStyleCache
         = MapUtils.newHashMap();
+    /**
+     * Record the merged region information of the initial row, to be used for setting the merged regions for newly added rows
+     */
+    private final Map<AnalysisCell,List<CellRangeAddress>> originalMergeRegionMap = MapUtils.newHashMap();
     /**
      * Row height cache for collection
      */
@@ -125,11 +131,25 @@ public void fill(Object data, FillConfig fillConfig) {
             while (iterator.hasNext()) {
                 doFill(analysisCellList, iterator.next(), fillConfig, getRelativeRowIndex());
             }
+            // handle merge
+            if (!originalMergeRegionMap.isEmpty()) {
+                Sheet cachedSheet = writeContext.writeSheetHolder().getCachedSheet();
+                originalMergeRegionMap.forEach((analysisCell, regionList) -> {
+                    for (int index = analysisCell.getRowIndex(); index < analysisCell.getRowIndex() + collectionData.size(); index++) {
+                        for (CellRangeAddress cellAddresses : regionList) {
+                            cachedSheet.addMergedRegionUnsafe(new CellRangeAddress(index, index, cellAddresses.getFirstColumn(), cellAddresses.getLastColumn()));
+                        }
+                    }
+                });
+            }
         } else {
             doFill(readTemplateData(templateAnalysisCache), realData, fillConfig, null);
         }
     }
 
+    /**
+     * Leave space for the newly added data rows and shift the existing data down
+     */
     private void shiftRows(int size, List<AnalysisCell> analysisCellList) {
         if (CollectionUtils.isEmpty(analysisCellList)) {
             return;
@@ -367,9 +387,23 @@ private void createCell(AnalysisCell analysisCell, FillConfig fillConfig,
         cellWriteHandlerContext.setCell(cell);
 
         if (isOriginalCell) {
+            // Record the style of the original row so that the subsequent rows can inherit its style
             Map<AnalysisCell, CellStyle> collectionFieldStyleMap = collectionFieldStyleCache.computeIfAbsent(
                 currentUniqueDataFlag, key -> MapUtils.newHashMap());
             collectionFieldStyleMap.put(analysisCell, cell.getCellStyle());
+            // Find the column merges in the initial row
+            List<CellRangeAddress> mergedRegions = cachedSheet.getMergedRegions();
+            if (WriteDirectionEnum.VERTICAL.equals(fillConfig.getDirection()) && fillConfig.getForceNewRow()
+                && fillConfig.getAutoStyle()) {
+                List<CellRangeAddress> oneRowRegionList = mergedRegions.stream()
+                    // if the merge spans across rows, do not process it
+                    .filter(region -> region.getFirstRow() == region.getLastRow() && region.getFirstRow() == row.getRowNum())
+                    .filter(region -> region.getFirstColumn() <= cell.getColumnIndex() && region.getLastColumn() >= cell.getColumnIndex())
+                    .collect(Collectors.toList());
+                if (!CollectionUtils.isEmpty(oneRowRegionList)) {
+                    originalMergeRegionMap.put(analysisCell, oneRowRegionList);
+                }
+            }
         }
     }
 

fastexcel-test/src/test/java/cn/idev/excel/test/core/template/TemplateMergeTest.java

@@ -0,0 +1,58 @@
+package cn.idev.excel.test.core.template;
+
+import cn.idev.excel.FastExcel;
+import cn.idev.excel.test.util.TestFileUtil;
+import cn.idev.excel.write.metadata.fill.FillConfig;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author wangmeng
+ */
+public class TemplateMergeTest {
+
+    private static File file01;
+
+    @BeforeAll
+    public static void init() {
+        file01 = TestFileUtil.createNewFile("template" + File.separator + "template_out01.xlsx");
+    }
+
+    @Test
+    public void testMerge() throws IOException {
+        write(file01);
+    }
+
+    public static void write(File file) {
+        FastExcel.write(file)
+            .withTemplate(TestFileUtil.readFile("template" + File.separator + "template01.xlsx"))
+            .sheet()
+            .doFill(data(), FillConfig.builder()
+                .forceNewRow(true)
+                .autoStyle(true)
+                .build());
+    }
+
+    private static List<Map<String, String>> data() {
+        List<Map<String, String>> list = new LinkedList<>();
+        for (int i = 0; i < 10; i++) {
+            Map<String, String> map = new HashMap<>();
+            map.put("name", "name- " + i);
+            map.put("number", String.valueOf(i));
+            map.put("age", String.valueOf(i));
+            map.put("orderNo", "order-" + i);
+            map.put("status", "1");
+            list.add(map);
+        }
+        return list;
+    }
+
+
+}