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

Question

我只是运行在使用 Newtonsoft.Json SerializeObject 方法时出错。之前有人问过 here，但是与 Newtonsoft 合作的人没有回答为什么会这样。

基本上，当这样调用 SerializeObject 时：

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

我在 classes 中重写的很多 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!
}

当然，我意识到这是 "easy" 修复，通过这样检查：

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

    CapacityConfiguration cc = (CapacityConfiguration)obj;
}

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

对我来说，这很奇怪。如有任何意见，我们将不胜感激。

我正在根据 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

Why will JsonConvert.SerializeObject call the object.Equals method?

因为当你使用JsonConvert.SerializeObject时，有一个方法CheckForCircularReference被调用来检查属性是否重新引用你自己的对象，导致死循环。

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

在CheckForCircularReference方法中，部分代码使用了Contains方法，如果您的object没有实现IEquatable<T>，该方法将调用object.Equals ]界面。

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

说明

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

这是一个自引用循环的example：

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 });

我们会得到一个异常：

Self referencing loop detected for property 'test' with type 'Program+JsonTestClass'. Path ''.

但是如果我们这样做就不会出错:

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

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

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

Why does Json.Net call the Equals method on my objects when serializing?

c#

serialization

json

equals

json.net