EntityFramework Core 9.0中Cosmos DB的ID映射变更解析

背景介绍

在EntityFramework Core 9.0版本中，针对Cosmos DB提供程序进行了一项重要的设计变更，影响了实体ID属性的映射方式。这项变更旨在简化文档结构，使其更符合Cosmos DB的标准实践。

变更内容

在EF Core 8.x及更早版本中，当实体类包含名为"Id"的属性时，Cosmos DB文档会同时包含两个ID字段：

• 大写的"Id"（对应.NET实体属性）
• 小写的"id"（Cosmos DB标准ID字段）

这种设计导致了数据冗余，因为实际上这两个字段存储的是相同的值。从EF Core 9.0开始，默认行为改为仅保留小写的"id"字段，而不再生成大写的"Id"字段。

变更影响

这项变更主要影响以下场景：

1. 现有项目升级到EF Core 9.0时，如果容器已经使用大写的"/Id"作为分区键路径
2. 依赖大写的"Id"字段进行查询或操作的代码

当尝试在EF Core 9.0中调用EnsureCreatedAsync方法时，如果容器已经存在且使用大写的"/Id"作为分区键路径，系统会抛出ArgumentException异常，提示分区键路径不匹配。

解决方案

对于需要保持向后兼容性的项目，EF Core 9.0提供了两种解决方案：

1. 使用HasDefaultId方法

通过在模型配置中添加HasDefaultId方法，可以恢复旧版行为，同时生成大写的"Id"和小写的"id"字段：

modelBuilder.Entity<Gateway>()
    .ToContainer("Gateways")
    .HasPartitionKey(f => f.Id)
    .HasDefaultId();

2. 修改分区键路径

如果项目可以接受变更，最佳实践是更新容器的分区键路径为小写的"/id"，使其与Cosmos DB标准保持一致。

相关注意事项

1. 如果同时使用了无鉴别器配置(HasNoDiscriminator)，在添加HasDefaultId后可能需要额外处理鉴别器相关逻辑
2. EF Core 9.0还变更了鉴别器字段名称，从"Discriminator"改为标准的"$type"
3. 这些变更旨在使EF Core的Cosmos DB支持更符合NoSQL数据库的最佳实践

最佳实践建议

1. 新项目应直接采用EF Core 9.0的默认行为
2. 现有项目在升级时应评估是否可以直接迁移到新的ID映射方式
3. 如果必须保持向后兼容性，可以使用HasDefaultId方法作为过渡方案
4. 长期来看，建议将分区键路径更新为小写的"/id"，以符合Cosmos DB标准

这项变更是EF Core持续优化Cosmos DB支持的一部分，旨在提供更简洁、更标准的文档结构，减少不必要的字段冗余。