如何阻止EF Core为自引用属性生成外键并序列化JSON？

要实现实体保留自身克隆引用并序列化为JSON存储的需求，核心是让EF Core不再将Snapshot属性识别为导航属性（避免生成外键），同时正确配置JSON转换。以下是两种可行方案：

方案一：使用非实体DTO类型（推荐） #

创建一个与Foo结构匹配但不属于EF实体的DTO类，让EF将其视为普通可序列化属性，而非关联实体。

代码示例 #

// 非实体快照类：仅用于序列化，无EF配置和DbSet注册
public class FooSnapshot
{
    public string StringProperty { get; set; }
    public int IntProperty { get; set; }
}

public class Foo
{
    public string StringProperty { get; set; }
    public int IntProperty { get; set; }
    public FooSnapshot Snapshot { get; set; }

    // 生成当前实例的快照
    public void CreateSnapshot()
    {
        Snapshot = new FooSnapshot
        {
            StringProperty = this.StringProperty,
            IntProperty = this.IntProperty
        };
    }
}

public class FooConfiguration : IEntityTypeConfiguration<Foo>
{
    public void Configure(EntityTypeBuilder<Foo> builder)
    {
        builder.Property(e => e.StringProperty);
        builder.Property(e => e.IntProperty).IsRequired();
        
        // 配置Snapshot属性的JSON序列化/反序列化
        builder.Property(e => e.Snapshot)
               .HasConversion(
                   // 序列化：将FooSnapshot转为JSON字符串
                   snapshot => JsonSerializer.Serialize(snapshot, JsonSerializerOptions.Default),
                   // 反序列化：将JSON字符串转回FooSnapshot
                   json => JsonSerializer.Deserialize<FooSnapshot>(json, JsonSerializerOptions.Default)
               )
               // 根据数据库类型调整列类型：PostgreSQL用jsonb，SQL Server用JSON或NVARCHAR(MAX)
               .HasColumnType("jsonb");
    }
}

方案二：直接标记属性为非导航（无需额外类） #

如果不想新增DTO类，可以手动告诉EF Core不要将Snapshot识别为导航属性，同时配置JSON转换处理实体类型。

代码示例 #

public class Foo
{
    public string StringProperty { get; set; }
    public int IntProperty { get; set; }
    public Foo Snapshot { get; set; }

    // 生成快照时避免嵌套快照导致序列化问题
    public void CreateSnapshot()
    {
        Snapshot = new Foo
        {
            StringProperty = this.StringProperty,
            IntProperty = this.IntProperty,
            Snapshot = null
        };
    }
}

public class FooConfiguration : IEntityTypeConfiguration<Foo>
{
    public void Configure(EntityTypeBuilder<Foo> builder)
    {
        builder.Property(e => e.StringProperty);
        builder.Property(e => e.IntProperty).IsRequired();
        
        // 定义实体与JSON字符串的转换逻辑
        var fooJsonConverter = new ValueConverter<Foo, string>(
            foo => JsonSerializer.Serialize(foo, new JsonSerializerOptions { ReferenceHandler = ReferenceHandler.IgnoreCycles }),
            json => JsonSerializer.Deserialize<Foo>(json, new JsonSerializerOptions { ReferenceHandler = ReferenceHandler.IgnoreCycles })
        );

        builder.Property(e => e.Snapshot)
               .HasConversion(fooJsonConverter)
               .HasColumnType("jsonb");

        // 关键：强制标记该属性为非导航，阻止EF生成外键
        builder.Property(e => e.Snapshot).Metadata.SetIsNavigation(false);
    }
}

注意事项 #

1. 数据库列类型适配：根据使用的数据库调整HasColumnType参数，例如SQL Server可使用JSON（2016+版本支持）或NVARCHAR(MAX)。
2. 序列化配置：添加ReferenceHandler.IgnoreCycles避免嵌套快照导致的循环引用序列化错误。
3. 性能考量：序列化实体到JSON会有一定性能开销，适合结构简单的小型实体。

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