EntityFramework Core 9 中 CosmosDB 对自定义值类型处理的变更解析

背景介绍

在 EntityFramework Core 与 CosmosDB 集成的使用场景中，开发者经常会遇到需要存储自定义值类型的情况。在 .NET 8 及之前的版本中，EF Core 对 CosmosDB 的支持相对宽松，允许直接存储和检索各种自定义结构体类型（如 Ulid 和自定义的 DateTimeRange 结构体）。然而，升级到 .NET 9 后，这种行为发生了变化，导致许多现有代码无法正常工作。

问题现象

在 .NET 8 环境下，以下场景可以正常工作：

• 实体中使用 Ulid 类型作为 ID（非 Guid 类型）
• 实体中包含自定义的 DateTimeRange 结构体类型属性（包括可为 null 的版本）

这些类型能够自动被序列化和反序列化到 CosmosDB 中，无需额外配置。但在升级到 .NET 9 后，EF Core 会抛出类型映射错误，提示这些类型不是已知的原始类型。

技术原因

这一变化源于 EF Core 9 对 CosmosDB 类型映射器的调整。在之前的版本中，CosmosDB 类型映射器允许所有值类型通过，而 .NET 9 中则改为仅映射已知兼容的类型。这一变更是为了与其他类型映射器保持一致，但同时也限制了某些在 CosmosDB 中本可以正常工作的场景。

解决方案

1. 使用复杂类型映射

对于非可为 null 的自定义结构体，可以通过显式配置为复杂类型来解决：

modelBuilder.Entity<Enquiry>().ComplexProperty(o => o.DateRange);

2. 自定义类型映射源

更通用的解决方案是替换默认的 CosmosDB 类型映射源，创建一个允许所有值类型的自定义映射器：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    optionsBuilder.ReplaceService<ITypeMappingSource, ReplacementCosmosTypeMappingSource>();
}

public class ReplacementCosmosTypeMappingSource(TypeMappingSourceDependencies dependencies)
    : CosmosTypeMappingSource(dependencies)
{
    protected override CoreTypeMapping? FindMapping(in TypeMappingInfo mappingInfo)
    {
        var mapping = base.FindMapping(mappingInfo);
        
        if (mapping is null
            && mappingInfo.ClrType?.IsValueType == true)
        {
            return new CosmosTypeMapping(mappingInfo.ClrType);
        }

        return mapping;
    }
}

3. 使用值转换器

对于简单类型（如 Ulid），可以使用值转换器：

modelBuilder.Entity<MyEntity>()
    .Property(e => e.UlidProperty)
    .HasConversion(
        v => v.ToString(),
        v => Ulid.Parse(v));

但需要注意，这种方法会将整个结构体序列化为字符串，可能不适合需要保持 JSON 结构的复杂类型。

最佳实践建议

1. 评估类型复杂度：对于简单值类型，优先考虑值转换器；对于复杂结构体，使用复杂类型映射或自定义映射源。

2. 测试验证：在应用任何解决方案后，务必测试保存和加载操作，确保数据完整性和一致性。

3. 关注未来更新：EF Core 团队计划在未来的版本中通过自定义序列化功能（#17306）提供更优雅的解决方案。

4. 文档记录：对任何自定义映射配置进行详细文档记录，便于团队维护和理解。

总结

EF Core 9 对 CosmosDB 的类型处理更加严格，这是框架向更一致、更安全方向发展的必然结果。虽然这带来了短期内的适配成本，但通过合理的配置和自定义，开发者仍然可以实现原有的功能需求。理解这些变更背后的设计理念，有助于我们构建更健壮、更可维护的数据访问层。

对于正在从 .NET 8 迁移到 .NET 9 的项目，建议尽早测试涉及自定义值类型的 CosmosDB 操作，并根据实际情况选择合适的适配方案。