为什么Json.Net在序列化时会在我的对象上调用Equals方法？

Question

我在使用Newtonsoft.Json SerializeObject方法时遇到了一个错误.之前有人问过这个问题,但与Newtonsoft合作的人没有回答为什么会这样.

基本上,这样打电话时SerializeObject:

string json = Newtonsoft.Json.JsonConvert.SerializeObject(from, new JsonSerializerSettings() { TypeNameHandling = TypeNameHandling.All });

我Equals在我的类中覆盖了很多方法中的错误:

public override bool Equals(object obj)
{
    if (obj == null)
        return false;

    CapacityConfiguration cc = (CapacityConfiguration)obj; // <-- TypeCastException here; other Properties of the same class are sent in as parameter!
}

当然,通过这样检查,我意识到修复起来很"容易":

public override bool Equals(object obj)
{
    if (obj is CapacityConfiguration == false)
        return false;

    CapacityConfiguration cc = (CapacityConfiguration)obj;
}

但真正的问题是: 为什么Json.Net在类的Equals方法中发送其他类型的对象？更具体地说,Json.Net似乎在类中发送了许多其他属性,而不是相同类型的另一个对象.

对我来说,这完全是奇怪的.任何输入将不胜感激.

我根据Visual Studio使用"Version 8.0.0.0".

更新1

它很容易测试,因为它是可重复的:

public class JsonTestClass
{
    public string Name { get; set; }
    public List<int> MyIntList { get; set; }

    public override bool Equals(object obj)
    {
        if (obj == null)
            return false;

        JsonTestClass jtc = (JsonTestClass)obj;
        return true;
    }
}

然后将此代码放在Program.cs或其他任何地方:

JsonTestClass c = new JsonTestClass();
c.Name = "test";
c.MyIntList = new List<int>();
c.MyIntList.Add(1);

string json = Newtonsoft.Json.JsonConvert.SerializeObject(c, new JsonSerializerSettings() { TypeNameHandling = TypeNameHandling.All });

你会得到TypeCast异常:

Answer 1

为什么JsonConvert.SerializeObject会调用该object.Equals方法？

因为在使用时JsonConvert.SerializeObject,会调用CheckForCircularReference方法来检查属性是否重新引用自己的对象,从而导致无限循环.

 private bool CheckForCircularReference(JsonWriter writer, object value, JsonProperty property, JsonContract contract, JsonContainerContract containerContract, JsonProperty containerProperty)

在该CheckForCircularReference方法中,部分代码使用该Contains方法,object.Equals如果您object没有实现 IEquatable<T>接口,则会调用该方法.

bool exists = (Serializer._equalityComparer != null)
                ? _serializeStack.Contains(value, Serializer._equalityComparer)
                : _serializeStack.Contains(value);

说明

1. _serializeStack 是当前正在序列化的对象列表.
2. 该List<T>.Contains方法检查集合中是否包含当前属性.
3. List<T>.Contains使用EqualityComparer<T>.Default,IEquatable<T>如果类型实现它,则使用,object.Equals否则.
4. 该object value参数是您当前的Property对象.

以下是自引用循环的示例:

public class JsonTestClass
{
    public string Name { get; set; }
    public List<int> MyIntList { get; set; }
    public JsonTestClass Test{get;set;}
    public override bool Equals(object obj)
    {
        if (obj == null)
            return false;
        JsonTestClass jtc = (JsonTestClass)obj;
        return true;
   }
}

JsonTestClass c = new JsonTestClass();
c.Name = "test";
c.Test = c;
string json = JsonConvert.SerializeObject
               (c, new JsonSerializerSettings() { TypeNameHandling = TypeNameHandling.All });

我们会得到一个例外:

使用类型"Program + JsonTestClass"检测属性"test"的自引用循环.路径''.

但如果我们这样做就没有错误:

JsonTestClass c = new JsonTestClass();
c.Name = "test";
c.Test = new JsonTestClass();

string json = JsonConvert.SerializeObject
       (c, new JsonSerializerSettings() { TypeNameHandling = TypeNameHandling.All });