将全局转换器应用于Json.NET

时间:2013-02-05 04:28:26

标签: c# json.net

假设我有一个示例类:

public class SomeObject
{
    private FlagEnumerable _someFlagValue = FlagEnumerable.Flag1;

    public SomeObject()
    {
    }

    [DataMember(Name = "someFlagValue")]
    [Browsable(false)]
    public FlagEnumerable SomeFlagValue
    {
        get { return _someFlagValue; }
        set { _someFlagValue= value; }
    }
}

这就是我描述FlagEnumerable

的方式
[DataContract]
[Flags]
[JsonConverter(typeof(JsonEnumConverter))]
public enum FlagEnumerable
{
    [EnumMember]
    Flag1 = 1,

    [EnumMember]
    Flag2 = 2,

    [EnumMember]
    Flag3 = 4
}

此外,我有一个自定义JSON转换器,可将我的枚举转换为字符串,将枚举标记为字符串数组,反之亦然。

此代码运行良好,并成功反序列化示例JSON:

{
    someFlagValue: [
        "Flag1"
    ]
}

问题是如何将全局转换器应用于JsonSerializer?当我从[JsonConverter(typeof(JsonEnumConverter))]中删除FlagEnumerable,然后通过调用

添加它
MyJsonSerializer.Converters.Add(new JsonEnumConverter());

我收到了这个错误:

  

无法将当前JSON数组(例如[1,2,3])反序列化为类型'FlagEnumerable',因为该类型需要JSON原语值(例如string,number,boolean,null)才能正确反序列化。   要修复此错误,请将JSON更改为JSON原始值(例如string,number,boolean,null)或将反序列化类型更改为数组或实现集合接口的类型(例如ICollection,IList),如List可以从JSON数组反序列化。 JsonArrayAttribute也可以添加到类型中,以强制它从JSON数组反序列化。

任何帮助表示赞赏!对不起,如果不清楚,请随时提问。

2 个答案:

答案 0 :(得分:1)

我有同样的需要将可枚举的标志序列化为字符串数组。我认为自你发布问题以来发生了一些变化。 我目前能够通过使用以下转换器来实现这一目标:

[Flags]
enum FlagEnumerable
{
    Flag1 = 1,
    Flag2 = 2,
    Flag3 = 4
}

class FlagsEnumConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType.IsEnum && objectType.GetCustomAttributes(typeof(FlagsAttribute), false).Any();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var values = serializer.Deserialize<string[]>(reader);

        return values
            .Select(x => Enum.Parse(objectType, x))
            .Aggregate(0, (current, value) => current | (int) value);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var enumArr = Enum.GetValues(value.GetType())
            .Cast<int>()
            .Where(x => (x & (int) value) == x)
            .Select(x => Enum.ToObject(value.GetType(), x).ToString())
            .ToArray();

        serializer.Serialize(writer, enumArr);
    }
}

class Program
{
    static void Main(string[] args)
    {
        JsonConvert.DefaultSettings = () => new JsonSerializerSettings()
        {
            Converters = new List<JsonConverter>() {new FlagsEnumConverter()}
        };

        var targetObj = new { MyField = FlagEnumerable.Flag1 | FlagEnumerable.Flag3 };
        var str = JsonConvert.SerializeObject(targetObj);
        var deserializedObj = JsonConvert.DeserializeObject(str, targetObj.GetType());
    }
}

答案 1 :(得分:0)

根据此问题的最高评分答案:JSON serialization of enum as string您需要的是StringEnumConverter

使用它,这段代码:

SomeObject someObject = new SomeObject() { SomeFlagValue = FlagEnumerable.Flag3 };
string json = JsonConvert.SerializeObject(someObject,
    Newtonsoft.Json.Formatting.Indented,
    new Newtonsoft.Json.Converters.StringEnumConverter());

将产生这个JSON:

{
    "SomeFlagValue": "Flag3"
}

请注意,在反序列化时传递StringEnumConverter似乎没有必要 - 上面的JSON块可以被反序列化。