使用 TypeNameHandling 对 System.Drawing.Color 进行 JSON.NET 序列化

我想序列化一个Dictionary<string, object>可能包含System.Drawing.Color值或其他类型作为值。我创建了一个序列化器TypeNameHandling.Auto，这适用于大多数课程，但不适用于Color.

示例代码：（DotNetFiddle：https://dotnetfiddle.net/UvphQO)

public class Program
{
    class A { }
    class B { }

    public static void Main()
    {
        Dictionary<string, object> dict = new Dictionary<string, object>();
        dict["Foo"] = new A();
        dict["Bar"] = new B();
        dict["Baz"] = new object();
        dict["Rainbow"] = Color.FromArgb(20, 20, 20, 20);

        var ser = new JsonSerializer
        {
            TypeNameHandling = TypeNameHandling.Auto
        };
        var w = new JsonTextWriter(Console.Out)
        {
            Formatting = Formatting.Indented
        };
        ser.Serialize(w, dict);
    }
}

结果输出：

{
  "Foo": {
    "$type": "Program+A, mi1i2eqo"
  },
  "Bar": {
    "$type": "Program+B, mi1i2eqo"
  },
  "Baz": {},
  "Rainbow": "20, 20, 20, 20"
}

正如预期的那样，实例A or B字典里有需要的$type用于重建的元数据。但实例Color不要。当这个json被反序列化时，dict["Rainbow"] is a System.String.

有很多方法可以解决这个问题，但首选的解决方案是找出序列化器执行看似不正确的操作的原因$type在这种情况下。

问题是System.Drawing.Color有一个关联的TypeConverter，Json.Net 使用它来将类型转换为字符串值并返回。但是，由于输出值是字符串（不是复杂对象），因此 Json.Net 不会为其输出任何类型信息。如果您的属性定义为，这会在反序列化期间导致问题object而不是强类型：Json.Net 将无法找到TypeConverter，因此它将无法将字符串值转换回Color.

解决该问题的一种方法是将Color在另一个具有强类型颜色值属性的类中。

class ColorHolder
{
    public System.Drawing.Color Value { get; set; }
}

然后，Json.Net 将写出包装类的类型信息，这将允许嵌套Color要正确反序列化的结构。这是一个往返演示：

class Program
{
    static void Main(string[] args)
    {
        Dictionary<string, object> dict = new Dictionary<string, object>();
        dict["Rainbow"] = new ColorHolder { Value = Color.FromArgb(10, 20, 30, 40) };

        JsonSerializerSettings settings = new JsonSerializerSettings
        {
            TypeNameHandling = TypeNameHandling.Auto,
            Formatting = Formatting.Indented
        };

        string json = JsonConvert.SerializeObject(dict, settings);
        Console.WriteLine(json);
        Console.WriteLine();

        var d = JsonConvert.DeserializeObject<Dictionary<string, object>>(json, settings);

        ColorHolder holder = (ColorHolder)d["Rainbow"];
        Console.WriteLine("A=" + holder.Value.A);
        Console.WriteLine("R=" + holder.Value.R);
        Console.WriteLine("G=" + holder.Value.G);
        Console.WriteLine("B=" + holder.Value.B);
    }
}

Output:

{
  "Rainbow": {
    "$type": "JsonTest.ColorHolder, JsonTest",
    "Value": "10, 20, 30, 40"
  }
}

A=10
R=20
G=30
B=40