在 MongoDB 中将枚举存储为字符串

Question

有没有办法将枚举存储为字符串名称而不是序数值？

示例：

假设我有这个枚举：

public enum Gender
{
    Female,
    Male
}

现在，如果某个虚构的用户存在，

...
Gender gender = Gender.Male;
...

它将以 { ... "Gender" : 1 ... } 的形式存储在 MongoDb 数据库中，

但我更喜欢这样的 { .. . “性别” : “男” ... }

这可能吗？自定义映射、反射技巧等等。

我的背景：我在 POCO 上使用强类型集合（嗯，我标记 AR 并偶尔使用多态性）。我有一个工作单元形式的薄数据访问抽象层。所以我不会序列化/反序列化每个对象，但我可以（并且确实）定义一些 ClassMap。我使用官方 MongoDb 驱动程序 + Fluent-mongodb。

Answer 1

using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;

using Newtonsoft.Json;
using Newtonsoft.Json.Converters;

public class Person
{
    [JsonConverter(typeof(StringEnumConverter))]  // JSON.Net
    [BsonRepresentation(BsonType.String)]         // Mongo
    public Gender Gender { get; set; }
}

Answer 2

MongoDB .NET 驱动程序允许您应用约定来确定确定的程度处理 CLR 类型和数据库元素之间的映射。

如果您希望将此应用于所有枚举，则只需为每个 AppDomain 设置一次约定（通常在启动应用程序时），而不是向所有类型添加属性或手动映射每种类型：

// Set up MongoDB conventions
var pack = new ConventionPack
{
    new EnumRepresentationConvention(BsonType.String)
};

ConventionRegistry.Register("EnumStringConvention", pack, t => true);

Answer 3

您可以为包含枚举的类自定义类映射，并指定该成员由字符串表示。这将处理枚举的序列化和反序列化。

if (!MongoDB.Bson.Serialization.BsonClassMap.IsClassMapRegistered(typeof(Person)))
      {
        MongoDB.Bson.Serialization.BsonClassMap.RegisterClassMap<Person>(cm =>
         {
           cm.AutoMap();
           cm.GetMemberMap(c => c.Gender).SetRepresentation(BsonType.String);

         });
      }

我仍在寻找一种方法来指定枚举全局表示为字符串，但这是我当前正在使用的方法。

Answer 4

我发现仅应用 Ricardo Rodriguez' 答案 在某些情况下不足以正确序列化枚举值以字符串到 MongoDb 中：

// Set up MongoDB conventions
var pack = new ConventionPack
{
    new EnumRepresentationConvention(BsonType.String)
};

ConventionRegistry.Register("EnumStringConvention", pack, t => true);

如果您的数据结构涉及将枚举值装箱到对象中，则 MongoDb 序列化将不会使用集合 EnumRepresentationConvention 对其进行序列化。

事实上，如果您查看 MongoDb 驱动程序 ObjectSerializer，它将解析装箱值的 TypeCode（Int32用于枚举值），并使用该类型将枚举值存储在数据库中。因此装箱的枚举值最终被序列化为 int 值。反序列化时它们也将保留为 int 值。

要更改此设置，可以编写一个自定义 ObjectSerializer，如果装箱值是枚举，它将强制设置 EnumRepresentationConvention。像这样的事情：

public class ObjectSerializer : MongoDB.Bson.Serialization.Serializers.ObjectSerializer
{
     public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value)
    {
        var bsonWriter = context.Writer;
        if (value != null && value.GetType().IsEnum)
        {
            var conventions = ConventionRegistry.Lookup(value.GetType());
            var enumRepresentationConvention = (EnumRepresentationConvention) conventions.Conventions.FirstOrDefault(convention => convention is EnumRepresentationConvention);
            if (enumRepresentationConvention != null)
            {
                switch (enumRepresentationConvention.Representation)
                {
                    case BsonType.String:
                        value = value.ToString();
                        bsonWriter.WriteString(value.ToString());
                        return;
                }
            }
        }

        base.Serialize(context, args, value);
    }
}

然后将自定义序列化器设置为用于序列化对象的序列化器：

BsonSerializer.RegisterSerializer(typeof(object), new ObjectSerializer());

这样做将确保装箱的枚举值将像未装箱的枚举值一样存储为字符串。

但请记住，反序列化文档时，装箱的值将保留为字符串。它不会被转换回原始枚举值。如果您需要将字符串转换回原始枚举值，则可能需要在文档中添加区分字段，以便序列化程序可以知道要反序列化的枚举类型。

一种方法是存储一个 bson 文档而不仅仅是一个字符串，其中将使用区分字段 (_t) 和值字段 (_v)存储枚举类型及其字符串值。

Answer 5

使用驱动程序 2.x，我使用 特定序列化器：

BsonClassMap.RegisterClassMap<Person>(cm =>
            {
                cm.AutoMap();
                cm.MapMember(c => c.Gender).SetSerializer(new EnumSerializer<Gender>(BsonType.String));
            });

Answer 6

使用 MemberSerializationOptionsConvention 定义有关如何保存枚举的约定。

new MemberSerializationOptionsConvention(typeof(Gender), new RepresentationSerializationOptions(BsonType.String))

Answer 7

如果您使用 .NET Core 3.1 及更高版本，请使用 Microsoft 最新的超快速 Json 序列化器/反序列化器 System.Text.Json (https://www.nuget.org/packages/System.Text.Json）。

请参阅 https://medium.com/@ 的指标比较samichkhachkhi/system-text-json-vs-newtonsoft-json-d01935068143

using System;
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;
using System.Text.Json.Serialization;;

public class Person
{
    [JsonConverter(typeof(JsonStringEnumConverter))]  // System.Text.Json.Serialization
    [BsonRepresentation(BsonType.String)]         // MongoDB.Bson.Serialization.Attributes
    public Gender Gender { get; set; }
}

Answer 8

此处发布的答案适用于 TEnum 和 TEnum[]，但不适用于 Dictionary。您可以在使用代码初始化序列化器时实现此目的，但是我想通过属性来实现此目的。我创建了一个灵活的 DictionarySerializer，可以使用键和值的序列化器进行配置。

public class DictionarySerializer<TDictionary, KeySerializer, ValueSerializer> : DictionarySerializerBase<TDictionary>
    where TDictionary : class, IDictionary, new()
    where KeySerializer : IBsonSerializer, new()
    where ValueSerializer : IBsonSerializer, new()
{
    public DictionarySerializer() : base(DictionaryRepresentation.Document, new KeySerializer(), new ValueSerializer())
    {
    }

    protected override TDictionary CreateInstance()
    {
        return new TDictionary();
    }
}

public class EnumStringSerializer<TEnum> : EnumSerializer<TEnum>
    where TEnum : struct
{
    public EnumStringSerializer() : base(BsonType.String) { }
}

像这样的用法，其中键和值都是枚举类型，但可以是序列化器的任意组合：

    [BsonSerializer(typeof(DictionarySerializer<
        Dictionary<FeatureToggleTypeEnum, LicenseFeatureStateEnum>, 
        EnumStringSerializer<FeatureToggleTypeEnum>,
        EnumStringSerializer<LicenseFeatureStateEnum>>))]
    public Dictionary<FeatureToggleTypeEnum, LicenseFeatureStateEnum> FeatureSettings { get; set; }

Answer 9

.NET 7.0

在 @sboisse 非常好的答案上进行改进，我找到了一种满足我所有用例的方法。

通用枚举序列化程序

// for boxed enums
BsonSerializer.RegisterSerializer(typeof(object), new BoxedEnumStringSerializer());
// for specifix unboxed enum
BsonSerializer.RegisterSerializer(typeof(MyEnum), new EnumStringSerializer<MyEnum>());

// serializer class
public class BoxedEnumStringSerializer : ObjectSerializer
{
    public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value)
    {
        var bsonWriter = context.Writer;
        string? serialized = null;

        if (value.GetType().IsEnum && value.ToString() is string valStr)
        {
            var conventions = ConventionRegistry.Lookup(value.GetType());
            var enumRpz = conventions.Conventions.FirstOrDefault(convention => convention is EnumRepresentationConvention) as EnumRepresentationConvention;

            switch (enumRpz?.Representation)
            {
                case BsonType.String:
                    serialized = valStr;
                    break;
            }
        }

        if (serialized != null)
            base.Serialize(context, args, serialized);
        else
            base.Serialize(context, args, value);
    }

    public override object Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
    {
        var val = context.Reader.ReadString();

        return Enum.Parse(args.NominalType, val);
    }
}

public class EnumStringSerializer<T> : BoxedEnumStringSerializer, IBsonSerializer<T> where T : struct, Enum
{
    public new Type ValueType => typeof(T);

    public void Serialize(BsonSerializationContext context, BsonSerializationArgs args, T value)
    {
        base.Serialize(context, args, value);
    }

    T IBsonSerializer<T>.Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
    {
        return (T)base.Deserialize(context, args);
    }
}

注册程序集中的每个枚举

var enums = Assembly.GetExecutingAssembly()
                            .GetTypes()
                            .Where(t => t.IsEnum && t.IsPublic);
foreach (var e in enums)
{
    var serializer = typeof(EnumStringSerializer<>).MakeGenericType(e);
    BsonSerializer.RegisterSerializer(e, Activator.CreateInstance(serializer) as IBsonSerializer);
}

注意：

• 如果您想自动注册程序集中的所有枚举，您可以考虑创建自己的枚举属性以标记它们，而不是盲目地全部获取它们
• 这是使用自定义枚举序列化的好模板案例，我使用蛇形案例，所以约定包无法工作