EF Core 7中使用JsonDocument操作SQL Server时LINQ表达式无法转换

问题根源 #

你当前的自定义转换器仅将JsonDocument序列化为NVARCHAR(MAX)字符串，但EF Core无法把JsonDocument.RootElement.GetProperty()这类.NET方法翻译为SQL Server可识别的JSON查询语法（如JSON_VALUE、JSON_QUERY），导致查询抛出无法转换的异常。

解决方案1：改用EF Core原生SQL Server JSON列支持（推荐） #

EF Core 7及以上版本对SQL Server的JSON列有原生支持，无需自定义转换器，就能自动将JsonDocument的操作翻译为SQL Server的JSON函数。

1. 移除自定义转换器：删除JsonDocumentConverter类，以及OnModelCreating中对应的HasConversion配置。
2. 配置SQL Server JSON列类型：在OnModelCreating中针对SQL Server单独配置属性为JSON类型（SQL Server 2016及以上版本支持）：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    var entityBuilder = modelBuilder.Entity<SomeEntity>();
    
    if (Database.ProviderName == "Microsoft.EntityFrameworkCore.SqlServer")
    {
        entityBuilder.Property(e => e.JsonDocument)
            .HasColumnType("json")
            .HasJsonConversion(); // EF Core 7+内置的JSON转换，替代自定义转换器
    }
}

3. 保留原有查询代码：此时EF Core会自动将JsonDocument.RootElement.GetProperty()翻译为JSON_VALUE函数，你原本的查询代码可以正常执行。

解决方案2：使用EF.Functions手动调用SQL Server JSON函数 #

如果必须保持NVARCHAR(MAX)的存储方式，可以直接通过EF.Functions调用SQL Server的JSON函数，让LINQ表达式可被翻译：

修改查询代码如下：

await _dataContext.SomeEntities
    // 用JSON_VALUE获取Name属性，搭配LIKE实现模糊匹配
    .Where(x => EF.Functions.Like(EF.Functions.JsonValue(x.JsonDocument.RootElement.ToString(), "$.Name"), $"%{name}%"))
    // 用JSON_VALUE获取DOB属性用于排序
    .OrderBy(x => EF.Functions.JsonValue(x.JsonDocument.RootElement.ToString(), "$.DOB"))
    .ToListAsync();

• EF.Functions.JsonValue对应SQL Server的JSON_VALUE函数，第一个参数为JSON字符串，第二个参数是JSON路径（如$.Name表示根节点下的Name属性）。
• EF.Functions.Like对应SQL的LIKE操作，实现模糊匹配逻辑。

解决方案3：改用JsonElement代替JsonDocument #

JsonElement是值类型，无需实现IDisposable，EF Core对其的JSON查询支持更友好，且无需手动管理资源释放：

1. 修改实体类：

public class SomeEntity
{
    [Key]
    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
    public int Id { get; set; }
    public string Name { get; set; }

    public JsonElement JsonElement { get; set; }
}

2. 配置SQL Server列类型（同方案1）：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    if (Database.ProviderName == "Microsoft.EntityFrameworkCore.SqlServer")
    {
        modelBuilder.Entity<SomeEntity>()
            .Property(e => e.JsonElement)
            .HasColumnType("json")
            .HasJsonConversion();
    }
}

3. 调整查询代码：

await _dataContext.SomeEntities
    .Where(x => x.JsonElement.GetProperty("Name").GetString().Contains(name))
    .OrderBy(x => x.JsonElement.GetProperty("DOB"))
    .ToListAsync();

内容的提问来源于stack exchange，提问作者Ghyath Serhal