EntityFramework Core 8 中处理SQL Server大小写敏感主键的完整指南

前言

在EntityFramework Core 8中，微软对SQL Server字符串主键的默认比较行为做出了重要变更。这个变更影响了许多开发者，特别是那些需要处理大小写敏感标识符的应用场景。本文将深入探讨这一变更的背景、影响以及解决方案。

默认行为的变更

在EF Core 8之前，SQL Server字符串主键的默认比较是大小写敏感的。这意味着像"CaseSensitive"和"CASESensitiVE"这样的值会被视为不同的主键。然而，从EF Core 8开始，微软将默认行为改为大小写不敏感的比较方式。

这一变更背后的考虑是：

1. 大多数应用场景实际上不需要区分大小写
2. 与SQL Server的默认排序规则(通常是大小写不敏感的)保持一致
3. 减少开发者在常见场景下的配置工作

问题表现

当开发者尝试在EF Core 8中插入两个仅大小写不同的主键值时，会遇到如下错误：

System.InvalidOperationException: 'The instance of entity type 'CaseSensitiveEntity' cannot be tracked because another instance with the same key value for {'NamePK'} is already being tracked...'

即使数据库列配置了大小写敏感的排序规则(如SQL_Latin1_General_CP1_CS_AS)，EF Core的内存中跟踪机制仍然会认为这些值是相同的。

解决方案

要恢复大小写敏感的主键比较行为，开发者需要显式配置值比较器(ValueComparer)。以下是完整的实现方案：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    // 创建大小写敏感的比较器
    var caseSensitiveComparer = new ValueComparer<string>(
        (l, r) => string.Equals(l, r, StringComparison.Ordinal),  // 使用Ordinal比较
        v => v.GetHashCode(),  // 保持默认哈希计算
        v => v);  // 直接返回原值

    // 应用到实体主键
    modelBuilder.Entity<CaseSensitiveEntity>()
        .Property(e => e.NamePK)
        .Metadata.SetValueComparer(caseSensitiveComparer);
}

实现原理

这个解决方案的核心在于ValueComparer，它控制着EF Core如何：

1. 比较两个值是否相等
2. 计算值的哈希码
3. 快照值(用于变更跟踪)

通过指定StringComparison.Ordinal比较方式，我们确保了字符串比较是区分大小写的。

最佳实践

1. 一致性原则：确保所有引用该主键的外键属性也使用相同的比较器
2. 性能考虑：对于大型数据集，考虑使用更高效的比较方式
3. 明确注释：在代码中添加注释说明为何需要特殊比较器
4. 测试验证：编写单元测试验证大小写敏感行为是否符合预期

迁移注意事项

从EF Core 7或更早版本升级的项目需要特别注意：

1. 检查现有代码是否依赖大小写敏感行为
2. 评估是否需要全局修改比较方式
3. 考虑数据库排序规则与内存比较器的一致性

结论

EF Core 8对SQL Server字符串主键比较行为的变更是为了适应更常见的开发场景。对于需要大小写敏感比较的特殊情况，通过配置自定义ValueComparer可以灵活地满足需求。理解这一机制不仅有助于解决当前问题，也为处理更复杂的值比较场景奠定了基础。