JsonException: 检测到可能的对象循环

当使用JsonSerializer进行序列化时，您可能会遇到以下异常：

JsonException: 检测到可能的对象循环。这可能是由于循环或对象深度大于最大允许深度 32.考虑在 JsonSerializerOptions 上使用 ReferenceHandler.Preserve 以支持循环。

这个异常通常会在以下情况下发生：

• 对象之间存在循环引用
• 对象的嵌套层次太深

循环引用

如果在序列化过程中，两个对象相互引用，就会形成一个循环引用的情况。例如：

public class Person
{
    public string Name { get; set; }
    public Address Address { get; set; }
}

public class Address
{
    public string Street { get; set; }
    public string City { get; set; }
    public Person Owner { get; set; }
}

var person = new Person
{
    Name = "John",
    Address = new Address
    {
        Street = "123 Main St",
        City = "Anytown",
        Owner = person
    }
};

var json = JsonSerializer.Serialize(person);

在这个例子中，Person和Address之间形成了循环引用，因为Address的Owner属性指向了Person对象本身。当我们尝试将person对象序列化为JSON字符串时，就会抛出上述异常。

为了解决这个问题，我们可以在JsonSerializerOptions上设置ReferenceHandler.Preserve属性，这样序列化器就会跟踪对象引用，避免循环引用的问题。

var options = new JsonSerializerOptions
{
    ReferenceHandler = ReferenceHandler.Preserve
};

var json = JsonSerializer.Serialize(person, options);

嵌套层次太深

另一个常见的问题是，对象嵌套层次太深。例如，如果我们有一个具有多个嵌套属性的复杂对象：

public class A
{
    public B B { get; set; }
}

public class B
{
    public C C { get; set; }
}

public class C
{
    public D D { get; set; }
}

// ...N多个类

如果这个对象被嵌套了许多层，那么就会导致堆栈溢出和类似于上述异常的问题。

为了解决这个问题，我们可以在JsonSerializerOptions上设置MaxDepth属性，限制对象嵌套的最大层数。

var options = new JsonSerializerOptions
{
    MaxDepth = 10
};

var json = JsonSerializer.Serialize(obj, options);

请注意，MaxDepth属性的默认值是32。