EF Core同一实体自关联及JSON循环引用问题排查

问题背景 #

在EF Core中实现Permission实体的自关联依赖（如ProfileView依赖ProfileGet和RoleGet），已解决权限插入重复问题，中间表数据也正常，但查询时用Include/ThenInclude加载关联后，序列化JSON时触发循环引用异常：

JsonException: A possible object cycle was detected. This can either be due to a cycle or if the object depth is larger than the maximum allowed depth of 32. Consider using ReferenceHandler.Preserve on JsonSerializerOptions to support cycles. Path: $.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.RelatedPermissions.Parent.PermissionId.

解决方案 #

1. 全局配置JSON序列化忽略循环引用 #

如果使用ASP.NET Core，直接在Program.cs中配置JSON序列化选项，忽略对象循环引用：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
    });

这种方式最简单，无需修改实体或查询代码，但要注意如果有其他需要保留循环引用的场景，需针对性调整。

2. 使用DTO隔离实体与返回结果 #

创建专门的数据传输对象（DTO），只暴露前端需要的字段，避免包含反向导航属性（如RelatedPermissionsTo）：

// 定义DTO
public class PermissionDTO
{
    public int PermissionId { get; set; }
    public string Name { get; set; }
    public List<PermissionRelationDTO> DependentPermissions { get; set; }
}

public class PermissionRelationDTO
{
    public PermissionDTO DependentPermission { get; set; }
}

查询时直接投影到DTO，避免加载不必要的导航属性：

var permissionList = _databaseContext.Permissions
    .Select(p => new PermissionDTO
    {
        PermissionId = p.PermissionId,
        Name = p.Name,
        DependentPermissions = p.RelatedPermissions.Select(r => new PermissionRelationDTO
        {
            DependentPermission = new PermissionDTO
            {
                PermissionId = r.Child.PermissionId,
                Name = r.Child.Name
                // 不递归加载子权限的依赖，避免深度循环
            }
        }).ToList()
    })
    .ToList();

这种方式最灵活，完全控制返回的数据结构，适合前端需要特定格式的场景。

3. 调整查询逻辑，避免加载反向导航 #

如果业务上不需要知道「哪些权限依赖当前权限」，查询时不要加载RelatedPermissionsTo属性，同时可关闭延迟加载（若开启），防止EF Core自动加载导致循环：

// 仅加载需要的关联，不包含RelatedPermissionsTo
var permissions = _databaseContext.Permissions
    .Include(p => p.RelatedPermissions)
        .ThenInclude(r => r.Child)
    .ToList();

若业务完全不需要反向关联，也可以直接从Permission实体类中删除RelatedPermissionsTo属性。

额外优化：插入关联数据的高效写法 #

原插入关联的代码可简化，无需调用_databaseContext.Permissions.Update(permission)，直接添加PermissionRelation到DbSet即可：

foreach (var permissionToAdd in permissions)
{
    var permission = await _databaseContext.Permissions.FirstOrDefaultAsync(p => p.Name == permissionToAdd.Key);
    if (permission != null)
    {
        foreach (var relatedName in permissionToAdd.Value)
        {
            var relatedPermission = await _databaseContext.Permissions.FirstOrDefaultAsync(p => p.Name == relatedName);
            if (relatedPermission != null)
            {
                await _databaseContext.AddAsync(new PermissionRelation
                {
                    ParentId = permission.PermissionId,
                    ChildId = relatedPermission.PermissionId
                });
            }
        }
    }
}
await _databaseContext.SaveChangesAsync();

这种写法避免了不必要的实体状态更新，性能更优。

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