有选择地使用默认的JSON转换器

时间:2016-09-28 05:28:31

标签: c# asp.net asp.net-web-api json.net

我在我的Web API项目Startup.cs中使用以下内容将JSON序列化枚举为字符串:

// Configure JSON Serialization
var jsonSerializationSettings = GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings;
jsonSerializationSettings.Formatting = Newtonsoft.Json.Formatting.None;
jsonSerializationSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter());

这是为了避免使用[JsonConverter(typeof(StringEnumConverter))]

装饰每个枚举属性

现在,如何选择退出某些Enum属性的全局序列化设置并使用转换为整数的默认序列化器?

1 个答案:

答案 0 :(得分:4)

您可以将虚拟转换器添加到有问题的属性中,但不执行任何操作:

public class NoConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        // Note - not called when attached directly via [JsonConverter(typeof(NoConverter))]
        throw new NotImplementedException();
    }

    public override bool CanRead { get { return false; } }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }

    public override bool CanWrite { get { return false; } }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

然后使用[JsonConverter(typeof(NoConverter))]将其附加到媒体资源。完成此操作后,JsonConverter属性的转换器将取代全局指定的转换器,但由于CanReadCanWrite都返回false,因此不会执行转换。对于枚举的集合,您可以使用[JsonProperty(ItemConverterType = typeof(NoConverter))]

例如,如果您定义类型:

public enum Foo { A, B, C }

public class RootObject
{
    [JsonConverter(typeof(NoConverter))]
    public Foo FooAsInteger { get; set; }

    public Foo FooAsString { get; set; }
}

然后

var root = new RootObject { FooAsInteger = Foo.B, FooAsString = Foo.B };

var json = JsonConvert.SerializeObject(root, Formatting.Indented, new StringEnumConverter());

Console.WriteLine(json);

生成输出

{
  "FooAsInteger": 1,
  "FooAsString": "B"
}

请注意,如果您希望所有数据模型中所有出现的枚举都被序列化为整数,您也可以将NoConverter直接应用于枚举:

[JsonConverter(typeof(NoConverter))]
public enum FooAlwaysAsInteger { A, B, C }

示例fiddle