如何使用JSON.net将枚举序列化为null值

时间:2014-07-30 15:56:29

标签: c# json.net

我正在使用第三方REST API,其中一个字段(类型string)具有一组已知的值,我在我的代码中将其建模为enum。来自JSON.NET的StringEnumConverter正确地序列化了[EnumMemberAttribute]注释所描述的除了其中一个值之外的所有值。特别是对于此字段,REST API将null值转换为第三方系统中的“系统默认值”;但是,当JSON.NET序列化时,它使用成员名称而不是注释中描述的值。我知道我可以编写一个自定义转换器来处理这个,但我的问题是,如果有一种方法可以让它在没有一个的情况下工作,因为它只是null值没有正确序列化?

我在代码中定义的enum

[JsonConverter(typeof(StringEnumConverter))]
public enum InitialScanLevel
{
    [EnumMember(Value = null)]
    SystemDefault,

    [EnumMember(Value = "0")]
    ModelDeviceOnly,

    [EnumMember(Value = "1")]
    InitialAppPopulation,

    [EnumMember(Value = "2")]
    DiscoverSslCerts,

    [EnumMember(Value = "3")]
    DiscoverOpenPorts,

    [EnumMember(Value = "4")]
    AdvancedPortDiscovery,

    [EnumMember(Value = "5")]
    DeepDiscovery
}

对于InitialScanLevel.SystemDefault,生成的JSON(不是第三方API所期望的)

{
    other fields...,
    "initialScanLevel":"SystemDefault",
    other fields...
}

但应该是

{
    other fields...,
    "initialScanLevel":null,
    other fields...
}

对于InitialScanLevel.DeepDiscovery,生成的JSON是(这是第三方API期望的)

{
    other fields...,
    "initialScanLevel":"5",
    other fields...
}

1 个答案:

答案 0 :(得分:5)

我认为最简单的方法是使用自定义StringEnumConverter

public class MyStringEnumConverter : Newtonsoft.Json.Converters.StringEnumConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        if (value.Equals(InitialScanLevel.SystemDefault)) value = null;
        base.WriteJson(writer, value, serializer);
    }
}

[JsonConverter(typeof(MyStringEnumConverter))]
public enum InitialScanLevel
{
 .....
}