EF Core 8中SqlQuery方法使用时的主键定义问题解析

问题背景

在使用Entity Framework Core 8.0.1版本时，开发者尝试通过Database.SqlQuery方法执行原始SQL查询并映射到自定义类型时，遇到了一个关于主键定义的异常。这个问题的特殊之处在于，错误信息中提到了一个看似无关的实体类型AllTenantChildrenItem，而实际上开发者正在尝试查询的是完全不同的类型IdName。

问题现象

开发者定义了一个简单的DTO类IdName，仅包含Id和Name两个属性：

class IdName
{
    public int Id { get; set; }
    public string Name { get; set; }
}

然后尝试使用以下代码执行SQL查询：

var query = db.Database
    .SqlQuery<IdName>($"select Id, Name from Tenants where Id > {1000}");

var result = query.ToList();

执行时却收到错误提示：

The entity type 'AllTenantChildrenItem' requires a primary key to be defined...

问题分析

这个错误看似奇怪，因为错误信息中提到的AllTenantChildrenItem并不是当前查询的目标类型。实际上，AllTenantChildrenItem是开发者在项目中定义的另一个类型，用于映射存储函数的返回结果：

public class AllTenantChildrenItem
{
    public int TenantId { get; set; }
}

在DbContext的OnModelCreating方法中，开发者已经为这个类型配置了主键：

modelBuilder.Entity<AllTenantChildrenItem>(e => e.HasKey(i => i.TenantId));

根本原因

这个问题实际上是EF Core 8.0.1版本中的一个已知bug。当项目中同时存在以下两种情况时，EF Core会错误地将SqlQuery方法与项目中的其他实体类型关联起来：

1. 使用了DbFunction特性映射存储过程/函数
2. 同时使用了SqlQuery方法执行原始SQL查询

这个bug会导致EF Core在解析SqlQuery的类型映射时，错误地关联到项目中的其他实体类型配置，从而引发看似无关的主键定义错误。

解决方案

微软已经在EF Core 8.0.12版本中修复了这个bug。开发者只需要将项目升级到EF Core 8.0.12或更高版本即可解决这个问题。

升级后，SqlQuery方法将能够正确识别目标类型的映射配置，不再错误关联到其他实体类型。

技术建议

1. 版本升级：始终使用最新的稳定版本EF Core，以避免已知的bug。

2. 类型隔离：对于仅用于查询结果的DTO类型，考虑使用以下方式之一：

   • 标记为[Keyless]特性
   • 在DbContext中配置.HasNoKey()

3. 查询方式选择：对于简单查询，也可以考虑使用LINQ查询而非原始SQL，以获得更好的类型安全性。

4. 错误排查：当遇到看似不相关的错误信息时，检查项目中是否有其他可能产生冲突的配置。

总结

EF Core 8.0.1中SqlQuery方法与存储函数映射的交互存在bug，会导致错误的主键定义异常。这个问题已在8.0.12版本中修复。开发者应保持EF Core版本更新，并合理组织项目中的实体类型配置，以避免类似问题的发生。