如何用@BsonRepresentation将String id的POJO映射到MongoDB的ObjectId文档

你的场景是MongoDB中Users集合的_id为ObjectId类型，需要映射到POJO中String类型的id字段，使用@BsonId + @BsonRepresentation(BsonType.OBJECT_ID)后出现解码错误，核心问题在于CodecRegistry的配置未正确启用注解约定，以下是可落地的解决步骤：

1. 确保POJO注解配置正确 #

保持字段上的注解，注意@BsonRepresentation指定的是存储层的Bson类型（OBJECT_ID），而非POJO字段类型：

import org.bson.BsonType;
import org.springframework.data.mongodb.core.mapping.BsonId;
import org.springframework.data.mongodb.core.mapping.BsonRepresentation;

// 其他类定义...
@BsonId
@BsonRepresentation(BsonType.OBJECT_ID)
private String id;
// 对应生成getter/setter方法

2. 修正CodecRegistry配置 #

必须显式将Conventions.ANNOTATION_CONVENTION加入到PojoCodecProvider的约定列表中，才能让驱动正确识别@BsonRepresentation注解，实现ObjectId与String的自动转换：

import org.bson.codecs.configuration.CodecRegistries;
import org.bson.codecs.configuration.CodecRegistry;
import org.bson.codecs.pojo.Conventions;
import org.bson.codecs.pojo.PojoCodecProvider;
import java.util.Arrays;

// 配置CodecRegistry
CodecRegistry myRegistry = CodecRegistries.fromRegistries(
    MongoClientSettings.getDefaultCodecRegistry(),
    CodecRegistries.fromProviders(PojoCodecProvider.builder()
        .automatic(true)
        .conventions(Arrays.asList(Conventions.ANNOTATION_CONVENTION))
        .build())
);

3. 确保MongoClient使用该CodecRegistry #

创建MongoClient时必须绑定上述配置的CodecRegistry，避免使用默认配置：

import com.mongodb.MongoClientSettings;
import com.mongodb.client.MongoClients;
import com.mongodb.client.MongoClient;

MongoClientSettings settings = MongoClientSettings.builder()
    .codecRegistry(myRegistry)
    .build();
MongoClient mongoClient = MongoClients.create(settings);

如果你的项目中使用mongoClientProvider，需要确保该Provider返回的MongoClient是基于上述配置构建的。

4. 额外排查点 #

• 确认POJO的id字段有对应的getter/setter方法，或者给PojoCodecProvider添加.enableFieldAccess(true)配置以支持直接字段访问
• 检查是否存在其他自定义Codec干扰了ObjectId与String的转换逻辑

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