EntityFramework Core 8.0中SqlQuery方法使用注意事项

在EntityFramework Core 8.0版本中，使用SqlQuery方法进行原始SQL查询时，开发者可能会遇到一个关于主键定义的错误提示。这个问题主要出现在EF Core 8.0.1版本中，当尝试执行原始SQL查询并映射到自定义类型时。

问题现象

当开发者使用类似以下代码时：

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

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'实际上是项目中另一个完全无关的实体类型。

问题根源

这个问题的出现是因为在EF Core 8.0.1版本中存在一个内部缺陷，导致在执行SqlQuery方法时错误地关联了项目中其他已定义的实体类型配置。特别是当项目中包含使用DbFunction特性的自定义函数映射时，EF Core可能会错误地将这些配置应用到SqlQuery查询结果上。

解决方案

微软在后续的EF Core 8.0.12版本中修复了这个问题。升级到8.0.12或更高版本后，SqlQuery方法能够正常工作，不再会错误地关联其他实体类型的配置。

最佳实践

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

2. 类型定义：当使用SqlQuery方法时，确保目标类型是一个简单的DTO类，不包含任何EF Core特定的配置或特性。

3. 查询隔离：将原始SQL查询与常规的EF Core操作分开管理，避免潜在的配置冲突。

4. 错误排查：当遇到类似问题时，检查项目中所有实体类型的配置，确认是否有不相关的配置被错误应用。

5. 替代方案：考虑使用FromSqlRaw或FromSqlInterpolated方法作为SqlQuery的替代方案，这些方法通常有更稳定的行为表现。

总结

EF Core 8.0.1版本中的这个缺陷展示了框架在复杂场景下可能出现的不稳定行为。通过升级到修复版本，开发者可以避免这类问题。同时，这也提醒我们在使用ORM框架时，需要关注版本更新和已知问题，以确保应用程序的稳定性。