EF Core 9.0.1 中 SQL Server 查询生成的一个特殊案例解析

在 Entity Framework Core 9.0.1 版本中，当使用 SQL Server 数据库提供程序时，开发者可能会遇到一个特殊的查询生成问题。这个问题涉及到在 LINQ 查询中使用 .Contains() 方法时传入 null 集合的情况，导致生成的 SQL 语句在 SQL Server 上执行时出现排序规则冲突错误。

问题现象

当开发者编写类似下面的代码时：

List<string> names = null;
var col = db.Foo.Where(f => names.Contains(f.Name)).ToList();

EF Core 会生成如下的 SQL 查询：

SELECT [f].[Id], [f].[Name]
FROM [Foo] AS [f]
WHERE [f].[Name] IN (
    SELECT [n].[value]
    FROM OPENJSON(NULL) AS [n]
)

这个查询在 SQL Server 上执行时会抛出错误：

Cannot resolve the collation conflict between "Latin1_General_BIN2" and "SQL_Latin1_General_CP1_CI_AS" in the equal to operation.

问题分析

这个问题的核心在于 EF Core 对于 null 集合的处理方式。当传入 null 集合时，EF Core 会生成使用 OPENJSON(NULL) 的 SQL 语句。SQL Server 在处理 OPENJSON(NULL) 时，会为结果集中的列分配默认的排序规则 Latin1_General_BIN2，而这与数据库表的排序规则 SQL_Latin1_General_CP1_CI_AS 不匹配，导致排序规则冲突。

值得注意的是，如果在本地执行相同的 LINQ 查询（即不转换为 SQL 查询），会抛出 NullReferenceException 异常。因此，从行为一致性的角度来看，EF Core 的这种处理方式也有其合理性。

解决方案

开发者可以采用以下几种方式避免这个问题：

1. 使用空集合代替 null：

   var names = new List<string>();
   

2. 在查询中添加 null 检查：

   var col = db.Foo.Where(f => names != null && names.Contains(f.Name)).ToList();
   

3. 使用空字符串字面量（虽然这不是官方推荐的方式）： EF Core 可以生成使用 OPENJSON(N'') 的 SQL 语句，这种方式不会导致排序规则冲突。

技术背景

这个问题涉及到几个关键技术点：

1. SQL Server 的 OPENJSON 函数：这是 SQL Server 2016 引入的函数，用于解析 JSON 文本。当传入 NULL 时，它会返回一个空结果集，但会为列分配默认的排序规则。

2. SQL Server 的排序规则处理：SQL Server 在执行比较操作时要求两边的排序规则一致，否则会抛出排序规则冲突错误。

3. EF Core 的查询转换机制：EF Core 需要将 LINQ 查询转换为 SQL 查询，对于集合包含操作，它会转换为 SQL 的 IN 子句，并使用 OPENJSON 来处理 .NET 集合。

最佳实践建议

1. 在使用集合进行查询时，始终确保集合已经初始化，避免使用 null 集合。

2. 对于可能为 null 的集合参数，在查询中添加显式的 null 检查。

3. 在设计 API 时，考虑使用空集合而不是 null 作为默认值，这样可以避免许多类似的边界情况问题。

虽然这个问题看起来像是一个 bug，但从设计一致性的角度来看，EF Core 团队认为不需要特别处理这种情况，因为本地执行也会抛出异常。开发者应该遵循良好的编程实践，避免在查询中使用 null 集合。