feature: Support Dynamic Column in Fill Operation for Collection Data by milixiang · Pull Request #455 · apache/fesod

milixiang · 2025-07-31T03:53:09Z

Purpose of the pull request

模板导出时不支持类似下图的需求，故做此次修改
from:

to

What's changed?

添加注解 cn.idev.excel.annotation.fill.DynamicColumn 标注该注解的属性会被新逻辑处理 该属性需要为Map类型
添加dynamicColumnKeys作为动态列的key 动态列会按照list的顺序排列
调整了dofill方法的fill逻辑
动态列填充时添加shiftcell操作，解决非末列动态列会覆盖后续列的问题
添加了个$变量规则

如图部分如果使用xxx.$格式进行fill，则会直接遍历集合元素并填充，适合表头横向填充时免去构造对象/map的操作。

psxjoy

A very useful extension. If possible, we hope to merge and release it in the next version :)
很有用的扩展。如果可以的话，我们希望下个版本尝试合并并发布它:)

yuzhi-jiang · 2025-09-28T02:10:36Z

Is it possible to use @ExcelProperty and @DynamicColumn together?

milixiang · 2025-09-28T09:03:38Z

DynamicColumn

之前没考虑过这个问题，但看代码应该是支持的，原本的convert方法都会被正常调用。

yuzhi-jiang · 2025-09-28T09:08:19Z

DynamicColumn

之前没考虑过这个问题，但看代码应该是支持的，原本的convert方法都会被正常调用。

代码还未合并，是哪一部分在生效呢，我要在当前version可以实现吗，通过SheetWriteHandler等方式啥的

milixiang · 2025-09-28T09:19:49Z

DynamicColumn

DynamicColumn

之前没考虑过这个问题，但看代码应该是支持的，原本的convert方法都会被正常调用。

代码还未合并，是哪一部分在生效呢，我要在当前version可以实现吗，通过SheetWriteHandler等方式啥的

不行，跟handler实现逻辑不一样。不确定owner什么时候会合并这个mergeRequest。想用的话可以fork我的分支
自己打包引用 https://github.com/milixiang/fastexcel

yuzhi-jiang · 2025-09-28T09:24:35Z

DynamicColumn

DynamicColumn

之前没考虑过这个问题，但看代码应该是支持的，原本的convert方法都会被正常调用。

代码还未合并，是哪一部分在生效呢，我要在当前version可以实现吗，通过SheetWriteHandler等方式啥的

不行，跟handler实现逻辑不一样。不确定owner什么时候会合并这个mergeRequest。想用的话可以fork我的分支自己打包引用 https://github.com/milixiang/fastexcel

好的

psxjoy · 2025-09-28T09:35:08Z

hi, @milixiang, sorry for not responding to this PR. There are still some conflicts, can you fix that?
I think we can discuss merging this pr into the main branch.

抱歉没有及时反馈。现在有些文件有冲突，你能处理一下吗？
我觉得现在我们可以讨论合并这个PR了。

如果我没有及时回复，随时pin我就好。

yuzhi-jiang · 2025-09-28T09:42:11Z

DynamicColumn

DynamicColumn

之前没考虑过这个问题，但看代码应该是支持的，原本的convert方法都会被正常调用。

代码还未合并，是哪一部分在生效呢，我要在当前version可以实现吗，通过SheetWriteHandler等方式啥的

不行，跟handler实现逻辑不一样。不确定owner什么时候会合并这个mergeRequest。想用的话可以fork我的分支自己打包引用 https://github.com/milixiang/fastexcel

好的

我clone你的项目后使用了FillTempTest的dynamicFill的数据，修改了导出方式，测试 @ExcelProperty和@DynamicColumn，似乎没有生效

public class DynamicFillData {
    @ExcelProperty("姓名")
    private String name;
    @ExcelProperty("编号")
    private double number;
    @DynamicColumn()
    private Map<String,String> qtyMap;

    @DynamicColumn()
    private Map<String,DynamicFillDataObj> priceMap;
}

    @Test
    public void dynamicFill() {
      String fileName = TestFileUtil.getPath() + "dynamicColumnFill" + System.currentTimeMillis() + ".xlsx";

        DynamicFillData fillData1 = new DynamicFillData();
        fillData1.setName("Zhang San");
        fillData1.setNumber(5.2);
        HashMap<String,String> qtyMap = new HashMap<>();
        qtyMap.put("2023-01-01", "100");
        qtyMap.put("2023-01-02", "200");
        qtyMap.put("2023-01-03", "300");
        fillData1.setQtyMap(qtyMap);
        HashMap<String,DynamicFillDataObj> priceMap = new HashMap<>();
        priceMap.put("2023-01-01", new DynamicFillDataObj("100个", 100));
        priceMap.put("2023-01-02", new DynamicFillDataObj("200个", 200));
        priceMap.put("2023-01-03", new DynamicFillDataObj("300个", 300));
        fillData1.setPriceMap(priceMap);


        DynamicFillData fillData2 = new DynamicFillData();
        fillData2.setName("Li Si");
        fillData2.setNumber(6.3);
        HashMap<String,String> qtyMap2 = new HashMap<>();
        qtyMap2.put("2023-01-01", "100");
        qtyMap2.put("2023-01-02", "200");
        qtyMap2.put("2023-01-03", "300");
        fillData2.setQtyMap(qtyMap2);
        HashMap<String,DynamicFillDataObj> priceMap2 = new HashMap<>();
        priceMap2.put("2023-01-01", new DynamicFillDataObj("100", 100));
        priceMap2.put("2023-01-02", new DynamicFillDataObj("200", 200));
        priceMap2.put("2023-01-03", new DynamicFillDataObj("300", 300));
        fillData2.setPriceMap(priceMap2);

        List<DynamicFillData> fillDataList = new ArrayList<>();
        fillDataList.add(fillData1);
        fillDataList.add(fillData2);

        FastExcel.write(fileName,DynamicFillData.class)
                .excelType(ExcelTypeEnum.XLS)
                .use1904windowing(Boolean.TRUE)
                .sheet()
                .doWrite(fillDataList);

错误信息如下：

cn.idev.excel.exception.ExcelWriteDataConvertException: DynamicColumn annotation must be used with FillConfig.dynamicColumnInfoMap

	at cn.idev.excel.write.executor.AbstractExcelWriteExecutor.converterAndSet(AbstractExcelWriteExecutor.java:130)
	at cn.idev.excel.write.executor.ExcelWriteAddExecutor.addJavaObjectToExcel(ExcelWriteAddExecutor.java:186)
	at cn.idev.excel.write.executor.ExcelWriteAddExecutor.addOneRowOfDataToExcel(ExcelWriteAddExecutor.java:78)
	at cn.idev.excel.write.executor.ExcelWriteAddExecutor.add(ExcelWriteAddExecutor.java:55)
	at cn.idev.excel.write.ExcelBuilderImpl.addContent(ExcelBuilderImpl.java:57)
	at cn.idev.excel.ExcelWriter.write(ExcelWriter.java:70)
	at cn.idev.excel.ExcelWriter.write(ExcelWriter.java:47)
	at cn.idev.excel.write.builder.ExcelWriterSheetBuilder.doWrite(ExcelWriterSheetBuilder.java:61)

- 新增 DynamicColumnInfo 类封装动态列信息 - 修改 FillConfig 类，使用 Map 存储多个动态列信息 - 更新动态列相关的处理逻辑和异常提示 - 优化单元测试用例

- 新增自引用变量标识符 "$" - 在单元格填充时，如果变量为自引用标识符，则使用当前行数据进行替换 - 优化了变量替换逻辑，增加了对自引用变量的处理

milixiang · 2025-09-28T10:07:57Z

@yuzhi-jiang 这个改动是给模板填充使用的不支持write 而且如提示，使用的时候要配置好FillConfig.dynamicColumnInfoMap

milixiang · 2025-09-28T10:19:25Z

@psxjoy 冲突已解决，请重新review。

Copilot

Pull Request Overview

This PR adds support for dynamic columns in Excel fill operations, allowing fields with the @DynamicColumn annotation to generate multiple columns based on runtime data. The implementation enables templates to dynamically expand horizontally based on Map-type data structures.

Key changes:

Introduces @DynamicColumn annotation to mark fields for dynamic column processing
Adds DynamicColumnInfo class to store configuration for dynamic column keys and group sizes
Implements cell shifting logic to prevent column overwriting when expanding dynamic columns
Adds $ variable rule for direct collection element traversal in fill operations

Reviewed Changes

Copilot reviewed 9 out of 11 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
FillConfig.java	Adds dynamic column configuration storage and builder methods
DynamicColumnInfo.java	New class to hold dynamic column metadata (keys and group size)
CellWriteHandlerContext.java	Adds cloning support and dynamic column context storage
ExcelWriteFillExecutor.java	Implements core dynamic column logic, cell shifting, and `$` variable handling
AbstractExcelWriteExecutor.java	Refactors cell conversion logic to handle dynamic columns
DynamicColumn.java	New annotation to mark fields for dynamic column processing
Test files	Adds comprehensive test cases for dynamic column functionality

Comments suppressed due to low confidence (1)

fesod/src/main/java/org/apache/fesod/excel/write/executor/ExcelWriteFillExecutor.java:131

[nitpick] Missing space after 'else'. Should be 'else {' for consistent code formatting.

        } else {

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-28T10:37:21Z

fesod/src/main/java/org/apache/fesod/excel/write/metadata/fill/FillConfig.java

+        if (null == fieldName || !dynamicColumnInfoMap.containsKey(fieldName)) {
+            return dynamicColumnInfoMap.get(DEFAULT_DYNAMIC_INFO_KEY);
+        }else{


Potential null pointer exception if dynamicColumnInfoMap is null. The method should check if dynamicColumnInfoMap is null before calling containsKey() or get() methods.

Suggested change

if (null == fieldName || !dynamicColumnInfoMap.containsKey(fieldName)) {

return dynamicColumnInfoMap.get(DEFAULT_DYNAMIC_INFO_KEY);

}else{

if (dynamicColumnInfoMap == null) {

return null;

}

if (fieldName == null || !dynamicColumnInfoMap.containsKey(fieldName)) {

return dynamicColumnInfoMap.get(DEFAULT_DYNAMIC_INFO_KEY);

} else {

Copilot · 2025-09-28T10:37:22Z

fesod/src/main/java/org/apache/fesod/excel/write/executor/ExcelWriteFillExecutor.java

+            cellWriteHandlerContext.getCellMap().put(lastRowIndex + "_" + lastColumnIndex, cellWriteHandlerContext);
+            DynamicColumnInfo dynamicColumnInfo = fillConfig.getDynamicColumnInfo(field.getName());
+            if (null == dynamicColumnInfo || CollectionUtils.isEmpty(dynamicColumnInfo.getKeys())) {
+                throw new ExcelGenerateException(String.format("Plase set dynamic column keys for %s in fillConfig", field.getName()));


Spelling error: 'Plase' should be 'Please'.

Suggested change

throw new ExcelGenerateException(String.format("Plase set dynamic column keys for %s in fillConfig", field.getName()));

throw new ExcelGenerateException(String.format("Please set dynamic column keys for %s in fillConfig", field.getName()));

Copilot · 2025-09-28T10:37:22Z

fesod/src/main/java/org/apache/fesod/excel/write/executor/ExcelWriteFillExecutor.java

+                List<String> variableList = analysisCell.getVariableList();
+                for (String fieldName : dynamicFieldMap.keySet()) {
+                    for (String variable : variableList) {
+                        String variableFieldName = variable.split("\\.")[0];


Potential IndexOutOfBoundsException if the variable doesn't contain a dot. Should check if the split result has at least one element before accessing index 0.

Copilot · 2025-09-28T10:37:22Z

fesod/src/main/java/org/apache/fesod/excel/write/executor/ExcelWriteFillExecutor.java

+                } else if (variable.contains(COLLECTION_PREFIX)) {
+                    variable = variable.split("\\.")[0];


Same issue as above - potential IndexOutOfBoundsException if the variable doesn't contain a dot after the contains() check passes. Should verify the split result has elements.

Copilot · 2025-09-28T10:37:22Z

fesod/src/main/java/org/apache/fesod/excel/write/executor/AbstractExcelWriteExecutor.java

+                    key = originalVariable.split("\\.")[1];
+                    Object itemBean = o;
+                    if (null == itemBean) {
+                        o = null;
+                    }else{
+                        BeanMap beanMap = BeanMapUtils.create(itemBean);
+                        o = beanMap.get(key);


Potential IndexOutOfBoundsException if the originalVariable contains a dot but the split result doesn't have at least 2 elements. Should check array length before accessing index 1.

Suggested change

key = originalVariable.split("\\.")[1];

Object itemBean = o;

if (null == itemBean) {

o = null;

}else{

BeanMap beanMap = BeanMapUtils.create(itemBean);

o = beanMap.get(key);

String[] splitVar = originalVariable.split("\\.");

if (splitVar.length >= 2) {

key = splitVar[1];

Object itemBean = o;

if (null == itemBean) {

o = null;

}else{

BeanMap beanMap = BeanMapUtils.create(itemBean);

o = beanMap.get(key);

}

} else {

// Optionally handle the case where there is no second part

key = null;

o = null;

Copilot · 2025-09-28T10:37:23Z

fesod/src/main/java/org/apache/fesod/excel/write/executor/AbstractExcelWriteExecutor.java

+        if (null != field && field.isAnnotationPresent(DynamicColumn.class)) {
+            Map<String, Object> dynamicColumnMap = (Map<String, Object>) originalValue;
+            FillConfig fillConfig = cellWriteHandlerContext.getFillConfig();
+            if(null == fillConfig || null == fillConfig.getDynamicColumnInfoMap()){


The method getDynamicColumnInfoMap() doesn't exist in the FillConfig class. It should be dynamicColumnInfoMap field access or a proper getter method.

Suggested change

if(null == fillConfig || null == fillConfig.getDynamicColumnInfoMap()){

if(null == fillConfig || null == fillConfig.dynamicColumnInfoMap){

Copilot · 2025-09-28T10:37:23Z

fesod-examples/src/test/java/org/apache/fesod/excel/temp/fill/FillTempTest.java

        excelWriter.fill(data(), fillConfig, writeSheet);

-        Map<String, Object> map = new HashMap<String, Object>();
+        Map<String, Object> map = new HashMap();


Raw type usage. Should use new HashMap<>() or new HashMap<String, Object>() for type safety.

Suggested change

Map<String, Object> map = new HashMap();

Map<String, Object> map = new HashMap<String, Object>();

yuzhi-jiang · 2025-09-29T00:31:22Z

@yuzhi-jiang 这个改动是给模板填充使用的不支持write 而且如提示，使用的时候要配置好FillConfig.dynamicColumnInfoMap

确实我看代码就觉得怪怪的，因为都涉及到fill，而我的需求是使用wirte,去写类中有map的，不知道能不能支持

milixiang · 2025-09-29T01:10:41Z

@yuzhi-jiang write的需求我理解了，后边我会看看怎么实现，但是应该没那么快，你可以先看看fill能满足需求不。

yuzhi-jiang · 2025-09-29T02:21:32Z

@yuzhi-jiang write的需求我理解了，后边我会看看怎么实现，但是应该没那么快，你可以先看看fill能满足需求不。

好的，不过fill的方式确实满足不了需求，因为map中的key都是动态的，无法使用固定模板

milixiang · 2025-10-09T06:16:08Z

@psxjoy 之前merge好像没成功还需要我做什么吗？

psxjoy

Start coding review ,wait.....

milixiang requested review from jipengfei-jpf and psxjoy as code owners July 31, 2025 03:53

psxjoy reviewed Aug 7, 2025

View reviewed changes

psxjoy added the PR: developing This feature will be added in future releases label Aug 7, 2025

milixiang added 5 commits September 28, 2025 17:43

feature: Support Dynamic Column in Fill Operation for Collection Data

e57a2a7

refactor(fill): 重构动态列处理逻辑

1e2cdad

- 新增 DynamicColumnInfo 类封装动态列信息 - 修改 FillConfig 类，使用 Map 存储多个动态列信息 - 更新动态列相关的处理逻辑和异常提示 - 优化单元测试用例

feat(write): 增加自引用变量替换功能

2fe3694

- 新增自引用变量标识符 "$" - 在单元格填充时，如果变量为自引用标识符，则使用当前行数据进行替换 - 优化了变量替换逻辑，增加了对自引用变量的处理

fix: 删除错误逻辑代码

e8863d3

fix: 横向填充复制列宽

68dbedd

fix: fix merge conflicts

2fb9bc7

milixiang force-pushed the dynamicColumnInCollectionFill branch from a86aacf to 2fb9bc7 Compare September 28, 2025 10:15

psxjoy requested review from Copilot and removed request for jipengfei-jpf September 28, 2025 10:36

Copilot AI reviewed Sep 28, 2025

View reviewed changes

chore(license): add license header

0245b39

Merge branch 'main' into dynamicColumnInCollectionFill

ce222f2

fix: fix Copilot review issue

9801ac9

psxjoy reviewed Oct 13, 2025

View reviewed changes

psxjoy and others added 3 commits October 13, 2025 15:33

Merge branch 'main' into dynamicColumnInCollectionFill

e7fd883

fix: spotless apply

4b4a62c

Merge branch 'apache:main' into dynamicColumnInCollectionFill

baabaab

	throw new ExcelGenerateException(String.format("Plase set dynamic column keys for %s in fillConfig", field.getName()));
	throw new ExcelGenerateException(String.format("Please set dynamic column keys for %s in fillConfig", field.getName()));

		} else if (variable.contains(COLLECTION_PREFIX)) {
		variable = variable.split("\\.")[0];

	if(null == fillConfig \|\| null == fillConfig.getDynamicColumnInfoMap()){
	if(null == fillConfig \|\| null == fillConfig.dynamicColumnInfoMap){

	Map<String, Object> map = new HashMap();
	Map<String, Object> map = new HashMap<String, Object>();

Conversation

milixiang commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of the pull request

What's changed?

Uh oh!

psxjoy left a comment

Choose a reason for hiding this comment

Uh oh!

yuzhi-jiang commented Sep 28, 2025

Uh oh!

milixiang commented Sep 28, 2025

Uh oh!

yuzhi-jiang commented Sep 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

milixiang commented Sep 28, 2025

Uh oh!

yuzhi-jiang commented Sep 28, 2025

Uh oh!

psxjoy commented Sep 28, 2025

Uh oh!

yuzhi-jiang commented Sep 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

milixiang commented Sep 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

milixiang commented Sep 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

yuzhi-jiang commented Sep 29, 2025

Uh oh!

milixiang commented Sep 29, 2025

Uh oh!

yuzhi-jiang commented Sep 29, 2025

Uh oh!

milixiang commented Oct 9, 2025

Uh oh!

psxjoy left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

milixiang commented Jul 31, 2025 •

edited

Loading

yuzhi-jiang commented Sep 28, 2025 •

edited

Loading

yuzhi-jiang commented Sep 28, 2025 •

edited

Loading

milixiang commented Sep 28, 2025 •

edited

Loading