在将enum序列化为字符串时，是否可以添加新的enum成员而不破坏与Newtonsoft json的约定

Question

以下是将破坏兼容性的示例。是否可以序列化为字符串并忽略新版本中的新枚举成员？

[JsonConverter(typeof(StringEnumConverter))]
public enum FooEnumV1
{
    OldMember,
    OldMember2,
}
[JsonConverter(typeof(StringEnumConverter))]
public enum FooEnumV2
{
        OldMember,
        OldMember2,
        NewMember
}
public class SeatPropertiesTests
{
    [Test]
    public void AddNewDataMember()
    {
        var properties = new List<FooEnumV2>()
        {
            FooEnumV2.OldMember,
            FooEnumV2.OldMember2,
            FooEnumV2.NewMember
        };
        var serialized = JsonConvert.SerializeObject(properties);
        var deserialized = JsonConvert.DeserializeObject<List<FooEnumV1>>(serialized);
        Assert.NotNull(deserialized);
    }
}

Answer 1

可以使用自定义EnumConverter而不是使用默认字符串EnumConverter。以下是为解决类似需求而创建的自定义TolerantEnumConverter。

现在，您将使用自定义转换器声明属性上的序列化属性。它基于有效值序列化枚举。这样您的合同就不会在反序列化时破裂。

[JsonConverter(typeof(TolerantEnumConverter))]
public enum FooEnumV1
{
    OldMember,
    OldMember2,
}
[JsonConverter(typeof(TolerantEnumConverter))]
public enum FooEnumV2
{
    OldMember,
    OldMember2,
    NewMember
}