EntityFramework Core 9 中 Cosmos DB 文档 ID 包含竖线字符的查询问题解析

在 EntityFramework Core 9 版本中，开发人员在使用 Cosmos DB 时遇到了一个关于文档 ID 的特殊问题。当文档 ID 中包含竖线字符"|"时，EF Core 9 无法正确查询这些文档，而之前的 EF Core 8 版本则能正常工作。

问题现象

当应用程序尝试查询 ID 中包含"|"字符的 Cosmos DB 文档时，EF Core 9 会在内部查询过程中自动在 ID 中插入一个额外的"^"字符。例如，当查询 ID 为"Cat|1"的文档时，EF Core 9 实际会查询"Cat^|1"，这自然会导致查询失败。

问题根源

这个问题的根本原因在于 EF Core 9 对 Cosmos DB 文档 ID 生成机制的改变。在 EF Core 9 中，团队对键值生成方式进行了重构，这是有意为之的破坏性变更。新的实现方式在处理特殊字符时与之前版本有所不同。

解决方案

对于需要保持旧有行为的应用程序，EF Core 提供了明确的解决方案：

1. 在模型构建时调用 HasDiscriminatorInJsonIds 方法：

modelBuilder.HasDiscriminatorInJsonIds();

这个方法会恢复 EF Core 8 及之前版本的 ID 处理行为，确保包含"|"字符的 ID 能够被正确查询。

深入分析

值得注意的是，这个问题只出现在查询阶段。在文档创建阶段，EF Core 9 仍然能够正确地将包含特殊字符的 ID 写入 Cosmos DB。通过检查数据库中的实际文档可以看到，ID 字段保持了应用程序设置的原始值，没有被修改。

这个问题特别影响那些从其他数据库迁移过来的系统，其中 ID 可能包含各种特殊字符。虽然 Cosmos DB 官方文档建议仅使用字母数字作为 ID，但实际业务场景中往往需要支持这些特殊字符。

最佳实践建议

1. 对于新项目，尽量遵循 Cosmos DB 的最佳实践，使用简单的字母数字作为文档 ID
2. 对于需要迁移的现有系统，如果必须保留特殊字符：
   • 考虑使用 EF Core 的 HasDiscriminatorInJsonIds 方法
   • 或者对 ID 进行编码转换（如 Base64），但要注意这可能影响业务逻辑
3. 在升级到 EF Core 9 前，充分测试所有涉及文档 ID 查询的功能

总结

EF Core 9 对 Cosmos DB 的 ID 处理机制进行了改进，这虽然带来了更好的默认行为，但也导致了某些特殊场景下的兼容性问题。通过理解这一变更的背景和解决方案，开发人员可以更顺利地完成版本升级，同时确保现有功能的稳定性。