EF Core存储无修改权限外部模型：JSON列配置遇主键错误求助

我正在处理一个无权修改的大型外部数据模型，需要将其作为另一条记录的字段，使用EF Core存储该记录。

我的数据结构如下：

public sealed record GameAnalysis
{
    public Guid AnalysisID { get; } = Guid.NewGuid();
    public string SomeField { get; init; }
    public Game Game { get; init; }
}

其中Game即为上述外部数据模型，该模型包含列表和嵌套对象：

public class Game
{
    public Guid GameID { get; } = Guid.NewGuid();
    public string SomeField { get; init; }
    public SomeClassWithoutID Stadium { get; init; }
    public List<Player> Players { get; init; }
    // more fields...
}

最初我尝试让EF Core自动完成配置，但出现错误：Game类中的部分嵌套对象未包含ID。

我调研了存储该模型的替代方案，尽管通常不建议将数据对象存储为JSON，但我认为这是当前场景的合适选择（如有错误请指正）。我可以使用.HasConversion()编写转换器，但理想情况下希望能通过LINQ对该数据模型进行索引查询。

EF Core 7新增了JSON列功能，似乎恰好能解决我的问题，但我无法使其正常工作。我的OnModelCreating配置如下：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<GameAnalysis>().OwnsOne(
        analysis => analysis.Game, ownedNavigationBuilder =>
        {
            ownedNavigationBuilder.ToJson();
        });
}

使用该配置时，我遇到了与让EF Core自动配置时相同的错误：

Unable to create a 'DbContext' of type ''. The exception 'The entity of type SomeClassWithoutID' requires a primary key to be defined.' was thrown while attempting to create an instance.

我可以通过逐个添加OwnsOne和OwnsMany调用消除错误，但为模型中新增的嵌套对象重复此操作非常繁琐。为何使用ToJson()仍需进行此操作？或者我是否遗漏了某些配置？

为什么ToJson()仍需配置嵌套对象？ #

EF Core的JSON列功能（ToJson()）本质上还是基于实体框架的导航属性机制工作的。即使将整个Game对象存储为JSON，EF Core仍然需要明确知晓所有嵌套类型的结构：

• 对于无ID的嵌套类（比如SomeClassWithoutID），EF Core需要通过OwnsOne标记它们为所属类型，否则会默认将其视为需要主键的独立实体。
• 对于集合类型（比如List<Player>），则需要用OwnsMany标记，告诉EF Core这是所属实体的集合，而非独立实体集合。

这是因为EF Core的模型发现逻辑默认会将所有引用类型视为潜在的独立实体，除非显式配置为所属类型（Owned Entity），即使它们最终会被序列化为JSON存储。

简化配置的方法 #

如果不想逐个手动配置所有嵌套对象，可以通过递归扫描约定自动配置所有嵌套类型：

1. 创建一个扩展方法，递归扫描目标类型的所有嵌套属性，自动添加对应的OwnsOne或OwnsMany配置：

public static void OwnsAllNestedTypes<TEntity, TOwned>(this OwnedNavigationBuilder<TEntity, TOwned> builder)
    where TEntity : class
    where TOwned : class
{
    var ownedType = typeof(TOwned);
    foreach (var property in ownedType.GetProperties())
    {
        var propertyType = property.PropertyType;
        // 处理非集合的引用类型（值对象）
        if (propertyType.IsClass && !propertyType.IsGenericType)
        {
            builder.OwnsOne(property.PropertyType, property.Name, b =>
            {
                b.ToJson();
                // 递归处理更深层级的嵌套
                b.OwnsAllNestedTypes();
            });
        }
        // 处理List集合类型
        else if (propertyType.IsGenericType && propertyType.GetGenericTypeDefinition() == typeof(List<>))
        {
            var elementType = propertyType.GetGenericArguments()[0];
            builder.OwnsMany(elementType, property.Name, b =>
            {
                b.ToJson();
                // 递归处理集合元素的嵌套结构
                b.OwnsAllNestedTypes();
            });
        }
    }
}

2. 在OnModelCreating中调用该扩展方法：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<GameAnalysis>().OwnsOne(
        analysis => analysis.Game, ownedNavigationBuilder =>
        {
            ownedNavigationBuilder.ToJson();
            // 自动配置所有嵌套类型
            ownedNavigationBuilder.OwnsAllNestedTypes();
        });
}

关于JSON存储的合理性 #

你的选择是合理的：在无法修改外部模型、需要保留完整结构且希望支持LINQ查询JSON内容的场景下，EF Core的JSON列功能是最优方案之一。相比自定义HasConversion()，它原生支持JSON路径查询（比如analysis.Game.Players.Any(p => p.Name == "xxx")），且无需手动处理序列化逻辑。

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