You need to enable JavaScript to run this app. MongoDB插入键为Enum类型的Map变量报CodecConfigurationException如何解决
优惠活动
大模型
产品
解决方案
定价
更多

MongoDB插入键为Enum类型的Map变量报CodecConfigurationException如何解决

问题原因

BSON 文档强制要求键必须为字符串类型,MongoDB 官方 Java 驱动默认的 POJO 序列化器未内置 Enum 类型作为 Map 键时的自动转字符串逻辑,因此触发 CodecConfigurationException 异常。

解决方案

方案一:POJO 层适配(推荐,修改量小,无需调整全局配置)

通过 BSON 注解控制序列化逻辑,无需修改全局 Codec 配置,同时适配读写双向场景:
修改 InterMyType 类代码如下:

import org.bson.codecs.pojo.annotations.BsonCreator;
import org.bson.codecs.pojo.annotations.BsonIgnore;
import org.bson.codecs.pojo.annotations.BsonProperty;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Collectors;

public class InterMyType{
    // 忽略原Enum键Map的默认序列化
    @BsonIgnore
    private final Map<MyTypeEnum, Boolean> interaction = new HashMap<>();

    public InterMyType(Boolean result){
        Arrays.stream(MyTypeEnum.values()).forEach(myTypeEnum -> this.interaction.put(myTypeEnum,result));
    }

    // 反序列化时驱动自动调用该构造方法,将数据库读取的String键转为Enum键
    @BsonCreator
    public InterMyType(@BsonProperty("interaction") Map<String, Boolean> interactionMap) {
        interactionMap.forEach((key, value) -> this.interaction.put(MyTypeEnum.valueOf(key), value));
    }

    public Map<MyTypeEnum, Boolean> getInteraction() {
        return interaction;
    }

    // 序列化时自动输出String键的Map写入数据库
    @BsonProperty("interaction")
    public Map<String, Boolean> getSerializationInteraction() {
        return interaction.entrySet().stream()
                .collect(Collectors.toMap(entry -> entry.getKey().name(), Map.Entry::getValue));
    }

    // 原有equals、hashCode方法保持不变
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        InterMyType that = (InterMyType) o;
        return Objects.equals(interaction, that.interaction);
    }

    @Override
    public int hashCode() {
        return Objects.hash(interaction);
    }
}

修改完成后直接运行原有插入逻辑即可正常写入,读取数据时也会自动转换回 MyTypeEnum 类型的键。

方案二:全局注册自定义Codec(适合项目中存在大量Enum键Map的场景)

自定义通用的Enum键Map序列化Codec,注册到全局CodecRegistry后,所有对应类型的Map都会自动处理:

  1. 自定义Codec类:
import org.bson.BsonReader;
import org.bson.BsonType;
import org.bson.BsonWriter;
import org.bson.codecs.Codec;
import org.bson.codecs.DecoderContext;
import org.bson.codecs.EncoderContext;
import java.util.HashMap;
import java.util.Map;

public class EnumKeyMapCodec implements Codec<Map<MyTypeEnum, Boolean>> {
    @Override
    public void encode(BsonWriter writer, Map<MyTypeEnum, Boolean> map, EncoderContext encoderContext) {
        writer.writeStartDocument();
        map.forEach((key, value) -> writer.writeBoolean(key.name(), value));
        writer.writeEndDocument();
    }

    @Override
    public Map<MyTypeEnum, Boolean> decode(BsonReader reader, DecoderContext decoderContext) {
        Map<MyTypeEnum, Boolean> map = new HashMap<>();
        reader.readStartDocument();
        while (reader.readBsonType() != BsonType.END_OF_DOCUMENT) {
            String key = reader.readName();
            Boolean value = reader.readBoolean();
            map.put(MyTypeEnum.valueOf(key), value);
        }
        reader.readEndDocument();
        return map;
    }

    @Override
    public Class<Map<MyTypeEnum, Boolean>> getEncoderClass() {
        return (Class<Map<MyTypeEnum, Boolean>>) (Class) Map.class;
    }
}
  1. 修改原有Codec注册逻辑,新增自定义Codec:
ConnectionString connectionString = new ConnectionString( "mongodb://localhost:27017" );
// 注册自定义Codec,优先级高于默认Codec
CodecRegistry customCodecRegistry = fromCodecs(new EnumKeyMapCodec());
CodecRegistry pojoCodecRegistry = fromProviders(PojoCodecProvider.builder().automatic(true).build());
CodecRegistry codecRegistry = fromRegistries(customCodecRegistry, MongoClientSettings.getDefaultCodecRegistry(), pojoCodecRegistry);

MongoClientSettings clientSettings = MongoClientSettings.builder()
        .applyConnectionString(connectionString)
        .codecRegistry(codecRegistry)
        .build();
MongoClient mongoClient = MongoClients.create(clientSettings);

内容的提问来源于stack exchange,提问作者DevRols

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.08 01:36:02