Spring MongoDB如何配置空列表字段不存储而非保存为空数组

以下是三种常用的实现方案，可根据业务场景选择：

方案1：单个字段加注解控制（推荐局部场景使用） #

Spring Data MongoDB 3.0+ 版本支持在集合字段上添加 @Field 注解，通过 writeEmptyCollections 属性控制是否写入空集合，灵活性最高，只会作用于指定字段。
示例代码：

import org.springframework.data.mongodb.core.mapping.Field;

public class Identifier {
    private String use;
    private String system;
    private String value;
    // 空集合时不写入该字段
    @Field(writeEmptyCollections = false)
    private List<Extension> extension;

    // 省略getter、setter
}

方案2：全局配置统一控制（推荐全局统一规则场景使用） #

如果所有业务场景都需要忽略空集合写入，可以直接修改Mongo转换器的全局配置，无需逐个字段加注解。
示例配置：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
import org.springframework.data.mongodb.config.AbstractMongoClientConfiguration;

@Configuration
public class MongoConfig extends AbstractMongoClientConfiguration {
    // 省略其他必要配置：如数据库名称、MongoClient实例配置等

    @Bean
    @Override
    public MappingMongoConverter mappingMongoConverter(MongoDatabaseFactory databaseFactory, MongoCustomConversions customConversions, MongoMappingContext mappingContext) {
        MappingMongoConverter converter = super.mappingMongoConverter(databaseFactory, customConversions, mappingContext);
        // 全局关闭空集合写入
        converter.setWriteEmptyCollections(false);
        // 若同时需要忽略null值写入，可添加以下配置（默认已为false，按需调整）
        // converter.setWriteNullValues(false);
        return converter;
    }
}

方案3：自定义事件监听器处理（兼容低版本/自定义规则场景） #

如果使用低于3.0的Spring Data MongoDB版本，或者有更复杂的空值判断逻辑，可以通过Mongo的生命周期事件监听器，在数据保存前把空集合设为null，利用框架默认忽略null值字段的规则实现需求。
示例代码：

import org.springframework.data.mongodb.core.mapping.event.AbstractMongoEventListener;
import org.springframework.data.mongodb.core.mapping.event.BeforeSaveEvent;
import org.springframework.stereotype.Component;
import java.lang.reflect.Field;
import java.util.Collection;
import java.lang.reflect.Array;

@Component
public class EmptyCollectionCleanListener extends AbstractMongoEventListener<Object> {
    @Override
    public void onBeforeSave(BeforeSaveEvent<Object> event) {
        Object entity = event.getSource();
        Field[] fields = entity.getClass().getDeclaredFields();
        for (Field field : fields) {
            field.setAccessible(true);
            try {
                Object fieldValue = field.get(entity);
                // 空集合设为null
                if (fieldValue instanceof Collection && ((Collection<?>) fieldValue).isEmpty()) {
                    field.set(entity, null);
                }
                // 空数组也需要忽略的话可加以下逻辑
                if (fieldValue != null && fieldValue.getClass().isArray() && Array.getLength(fieldValue) == 0) {
                    field.set(entity, null);
                }
            } catch (IllegalAccessException e) {
                // 可按需补充异常处理逻辑
            }
        }
    }
}

注意事项 #

修改存储规则后需要对应调整查询逻辑：空列表存储时查询条件为{"extension": []}，忽略存储后查询不存在该字段的条件为{"extension": {"$exists": false}}，避免业务查询出错。

内容的提问来源于stack exchange，提问作者Jordi。