ASP.NET Core 7 & EF Core自引用循环：仅序列化一级Manager

针对你遇到的User类自引用循环，且需要序列化当前用户的Manager但忽略Manager的Manager的需求，以下是几个实用方案：

1. 用DTO（数据传输对象）精准控制返回字段 #

这是最稳妥的方案，避免直接序列化EF Core实体类，而是定义专门的DTO来控制输出内容：

// 基础用户DTO，仅包含必要字段，不带Manager
public class UserBasicDto
{
    public int Id { get; set; }
    public string UserName { get; set; }
    // 其他需要暴露的字段，比如Email、CreateTime等
}

// 带一级Manager的用户DTO
public class UserWithManagerDto
{
    public int Id { get; set; }
    public string UserName { get; set; }
    // 仅关联基础用户DTO，避免深层嵌套
    public UserBasicDto? Manager { get; set; }
}

查询时通过EF Core的投影直接生成DTO：

var currentUser = await _context.Users
    .Where(u => u.Id == currentUserId)
    .Select(u => new UserWithManagerDto
    {
        Id = u.Id,
        UserName = u.UserName,
        Manager = u.Manager != null ? new UserBasicDto
        {
            Id = u.Manager.Id,
            UserName = u.Manager.UserName
        } : null
    })
    .FirstOrDefaultAsync();

这种方式完全规避自引用问题，同时严格控制返回的字段，不会泄露多余数据，也符合分层架构的设计原则。

2. 配置System.Text.Json的序列化深度限制 #

如果不想额外定义DTO，可以全局配置Json序列化的最大深度，限制只序列化到二级：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 先忽略循环引用基础问题
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
        // 设置最大序列化深度为2：当前用户（深度1）→ Manager（深度2），不再继续序列化Manager的Manager
        options.JsonSerializerOptions.MaxDepth = 2;
    });

注意：这个方案是全局生效的，如果其他接口需要更深的嵌套序列化，可能会受到影响，适合全局统一要求的场景。

3. 自定义Json转换器实现条件忽略 #

如果只需要针对User类做特殊处理，可以编写自定义转换器，在序列化到第二层时忽略Manager属性：

public class UserManagerConverter : JsonConverter<User>
{
    private int _currentDepth;
    private readonly JsonConverter<User> _defaultConverter;

    public UserManagerConverter(JsonConverter<User> defaultConverter)
    {
        _defaultConverter = defaultConverter;
    }

    public override User Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        return _defaultConverter.Read(ref reader, typeToConvert, options);
    }

    public override void Write(Utf8JsonWriter writer, User value, JsonSerializerOptions options)
    {
        _currentDepth++;
        // 先用默认序列化得到JSON文档
        using var doc = JsonDocument.Parse(JsonSerializer.Serialize(value, _defaultConverter));
        
        writer.WriteStartObject();
        foreach (var prop in doc.RootElement.EnumerateObject())
        {
            // 当深度超过1时，跳过Manager属性
            if (prop.Name == nameof(User.Manager) && _currentDepth > 1)
                continue;
            
            prop.WriteTo(writer);
        }
        writer.WriteEndObject();
        
        _currentDepth--;
    }
}

注册转换器到服务中：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        var defaultUserConverter = options.JsonSerializerOptions.GetConverter(typeof(User)) as JsonConverter<User>;
        options.JsonSerializerOptions.Converters.Add(new UserManagerConverter(defaultUserConverter));
    });

这个方案灵活性高，但实现相对复杂，适合特殊业务场景的需求。

内容的提问来源于stack exchange，提问作者foulene