EntityFramework Core 中 Cosmos DB 复杂类型映射问题解析

在使用 EntityFramework Core 操作 Cosmos DB 时，开发者可能会遇到复杂类型属性无法正确映射的问题。本文将深入分析这一常见问题的原因，并提供解决方案。

问题现象

当开发者使用 EF Core 9.0.0 连接 Cosmos DB 时，可能会发现查询结果中复杂类型的属性始终为 null，即使数据库中该字段已正确存储了 JSON 数据。这种情况通常表现为：

1. 实体类中的基本类型属性（如 Guid、string 等）能够正常映射
2. 嵌套的复杂类型属性（如自定义类或记录类型）始终返回 null
3. 没有抛出任何异常，但数据无法完整加载

根本原因分析

这个问题主要由两个关键因素导致：

1. 记录类型(record)的构造函数绑定特性：C# 的记录类型在反序列化时有其特殊行为，EF Core 默认的绑定机制可能无法正确处理记录类型的构造函数绑定。

2. JsonPropertyName 属性不适用：在 EF Core 中，特别是与 Cosmos DB 交互时，不能使用 System.Text.Json 的 JsonPropertyName 属性来指定属性映射，而应该使用 EF Core 专门提供的配置方法。

解决方案

针对上述问题，正确的配置方式如下：

1. 避免在 EF Core 实体中使用记录类型的构造函数绑定：改为使用常规类或调整记录类型的定义方式。

2. 使用 EF Core 的 Fluent API 配置属性映射：通过 OnModelCreating 方法中的配置来指定 JSON 属性名。

具体实现示例：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<MyType>(entity =>
    {
        entity.HasNoDiscriminator()
              .ToContainer("MyContainer")
              .UseETagConcurrency()
              .HasKey(a => a.Id);
        
        // 配置复杂类型的属性映射
        entity.OwnsOne(x => x.Doodad, doodad =>
        {
            doodad.ToJsonProperty("doodad");  // 指定 JSON 属性名
            doodad.Property(x => x.Name).ToJsonProperty("name");
        });
    });
}

最佳实践建议

1. 对于 EF Core 实体：优先使用类(class)而非记录(record)来定义实体类型，除非你完全理解记录类型在序列化/反序列化时的行为。

2. 属性映射配置：始终使用 EF Core 提供的 Fluent API 方法来配置与数据库的映射关系，而不是依赖 JSON 序列化器的属性。

3. 复杂类型处理：对于嵌套的复杂类型，使用 OwnsOne 方法来明确指定它们的所有权关系，这能确保正确的加载和保存行为。

4. 测试验证：在实现后，建议编写单元测试验证复杂类型的加载和保存是否按预期工作。

通过遵循这些实践，可以避免大多数与复杂类型映射相关的问题，确保应用程序能够正确处理 Cosmos DB 中的嵌套数据结构。