.NET 6 MongoDB C#：无法序列化JObject类型的Metadata字段

针对你遇到的object类型Metadata属性写入MongoDB时的序列化错误，以下是几种无需修改属性类型的解决方案：

方案一：全局配置MongoDB驱动允许JObject等类型序列化 #

错误核心是MongoDB驱动的ObjectSerializer默认不允许序列化JObject、JProperty这类Json.NET类型，你可以在初始化MongoClient时全局配置允许这些类型：

var mongoSettings = MongoClientSettings.FromConnectionString("你的MongoDB连接字符串");

// 自定义ObjectSerializer，添加允许的类型
mongoSettings.SerializerRegistry = BsonSerializerRegistry.Create(new BsonSerializerSettings
{
    ObjectSerializer = new ObjectSerializer(type => 
        ObjectSerializer.DefaultAllowedTypes(type) || 
        type == typeof(JObject) || 
        type == typeof(JProperty) ||
        type == typeof(JToken)
    )
});

var mongoClient = new MongoClient(mongoSettings);

这种方式一次性解决所有object属性的类似序列化问题，适合全局统一处理的场景。

方案二：为Metadata属性添加自定义Bson序列化器 #

如果不想修改全局配置，可以为Metadata属性单独实现自定义序列化器，精准处理该字段的序列化逻辑：

1. 实现自定义序列化器 #

public class DynamicMetadataSerializer : IBsonSerializer<object>
{
    public Type ValueType => typeof(object);

    public object Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
    {
        var currentBsonType = context.Reader.GetCurrentBsonType();
        switch (currentBsonType)
        {
            case BsonType.Document:
                var bsonDoc = BsonDocumentSerializer.Instance.Deserialize(context, args);
                return JObject.Parse(bsonDoc.ToJson());
            case BsonType.Null:
                context.Reader.ReadNull();
                return null;
            default:
                throw new NotSupportedException($"不支持序列化Bson类型：{currentBsonType}");
        }
    }

    public void Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value)
    {
        if (value == null)
        {
            context.Writer.WriteNull();
            return;
        }

        switch (value)
        {
            case JObject jObj:
                var bsonDocFromJObj = BsonDocument.Parse(jObj.ToString());
                BsonDocumentSerializer.Instance.Serialize(context, args, bsonDocFromJObj);
                break;
            case IDictionary<string, object> dict:
                var bsonDocFromDict = new BsonDocument(
                    dict.Select(kv => new BsonElement(kv.Key, BsonValue.Create(kv.Value)))
                );
                BsonDocumentSerializer.Instance.Serialize(context, args, bsonDocFromDict);
                break;
            default:
                // 处理字符串、数字等简单类型
                BsonValueSerializer.Instance.Serialize(context, args, BsonValue.Create(value));
                break;
        }
    }

    // 实现非泛型IBsonSerializer接口的方法
    object IBsonSerializer.Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
        => Deserialize(context, args);

    void IBsonSerializer.Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value)
        => Serialize(context, args, value);
}

2. 为Metadata属性绑定序列化器 #

修改VersionAttributeModel中的Metadata属性，添加[BsonSerializer]特性：

[BsonElement(MetadataPropertyName)]
[JsonProperty(MetadataPropertyName)]
[BsonSerializer(typeof(DynamicMetadataSerializer))] // 添加这行
public object Metadata { get; set; }

这个序列化器支持处理JObject、Dictionary<string,object>以及简单类型，既兼容REST API传入的JObject，也能正确序列化为MongoDB的Bson格式。

方案三：使用BsonDocument私有字段包装（备选） #

如果允许调整属性实现逻辑但不对外暴露类型，可以用私有BsonDocument字段存储数据，对外仍保留object类型的属性：

public class VersionAttributeModel : BaseNamedModel
{
    // 其他常量和属性保持不变...

    private BsonDocument _metadata;

    // 供MongoDB序列化使用的私有映射字段
    [BsonElement(MetadataPropertyName)]
    private BsonDocument MetadataBson
    {
        get => _metadata;
        set => _metadata = value;
    }

    [JsonProperty(MetadataPropertyName)]
    [BsonIgnore] // 告诉MongoDB忽略这个属性，用上面的私有字段序列化
    public object Metadata
    {
        get => _metadata != null ? JObject.Parse(_metadata.ToJson()) : null;
        set
        {
            if (value == null)
            {
                _metadata = null;
                return;
            }

            switch (value)
            {
                case JObject jObj:
                    _metadata = BsonDocument.Parse(jObj.ToString());
                    break;
                case IDictionary<string, object> dict:
                    _metadata = new BsonDocument(dict.Select(kv => new BsonElement(kv.Key, BsonValue.Create(kv.Value))));
                    break;
                default:
                    _metadata = BsonDocument.Parse(JsonConvert.SerializeObject(value));
                    break;
            }
        }
    }
}

这种方式对外保持object类型的API不变，内部用MongoDB原生支持的BsonDocument存储，避免序列化冲突。

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