使用GUID调用MongoDB GraphLookup方法抛出BsonSerializationException

异常原因 #

1. 核心原因是你在调用GraphLookup时指定了最终输出类型为object，你给TestEntity加的[BsonGuidRepresentation]特性、全局注册的GUID序列化规则，仅会作用在明确指定实体类型的序列化/反序列化场景中。当驱动反序列化无类型的object结果时，会回退到通用的ObjectSerializer处理字段，处理GUID值时无法获取到Standard类型的GUID表示配置，就会抛出GuidRepresentation is Unspecified异常。
2. 额外注意：你将BsonDefaults.GuidRepresentationMode设置、全局GUID序列化器注册放在了业务方法内部，这两个是全局静态配置，仅需要在应用启动时初始化一次即可，在方法内重复注册可能引发线程安全问题，但这不是本次报错的直接原因。

解决方案 #

方案1（推荐）：定义专属的聚合结果实体 #

不要用object作为聚合输出类型，定义专门的结果类并给GUID字段加上特性标注：

public class TestEntityGraphResult
{
    public ObjectId Id { get; set; }

    [BsonGuidRepresentation(GuidRepresentation.Standard)]
    public Guid EntityId { get; set; }

    [BsonGuidRepresentation(GuidRepresentation.Standard)]
    public Guid ParentEntityId { get; set; }

    public string Name { get; set; }

    public IEnumerable<TestEntity> BreadCrumb { get; set; }

    public int order { get; set; }
}

修改GraphLookup调用的泛型参数，将最终输出类型改为TestEntityGraphResult即可。

方案2：显式配置客户端的GUID表示规则 #

如果确实需要用object作为返回类型，可以在构造Mongo客户端配置时显式指定GUID表示：

MongoClientSettings mongoClientSettings = MongoClientSettings.FromConnectionString("mongodb://HOSTNAME:27017");
// 新增这行配置
mongoClientSettings.GuidRepresentation = GuidRepresentation.Standard;
MongoClient mongoClient = new MongoClient(mongoClientSettings);

同时把全局的BsonDefaults.GuidRepresentationMode = GuidRepresentationMode.V3、全局序列化器注册逻辑迁移到应用启动入口（比如Program.Main方法的最开头），不要放在业务方法中。

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