如何让Npgsql EF Core对ToJson映射的Owned Entity使用@>操作符？

问题描述 #

我按照Npgsql EF Core文档推荐，通过.ToJson()将JSONB列建模为Owned Entity：

modelBuilder.Entity<Notification>()
  .OwnsMany<NotificationEvent>(e => e.Events, d => { d.ToJson(); });

该配置能生成正确的DDL（jsonb列）和语义正确的查询，但我希望查询能利用GIN索引，而GIN索引依赖@>包含操作符，目标SQL如下：

select ... from "Notification" where "Events" @> '{"EventType":"r"}'::jsonb;

（右侧需替换为参数）

我尝试过以下方法但未达成目标：

• 直接使用.Where(n => n.Events.Any(e => e.EventType == "r"))：语义正确，但生成的查询未使用@>操作符，EXPLAIN ANALYSE确认未命中GIN索引。
• 定义自定义函数映射并使用.Where(n => myContains(n.Events, new() {EventType = "r"}))：自定义函数未被调用，因为LINQ转换器将n.Events视为关系，跳过了函数映射。
• 尝试过OwnsOne和OwnsMany两种映射方式。

请问除编写自定义内联SQL外，是否有办法让Npgsql EF Core对Owned Entity映射生成@>操作符？

解决方案 #

方法1：直接通过EF.Property访问JSONB列并使用原生JSON操作 #

绕过Owned Entity的关系封装，通过EF.Property直接访问底层的jsonb列，使用Npgsql提供的JSON扩展方法生成@>操作符：

使用System.Text.Json（JsonDocument）

using NpgsqlTypes;

var targetEvent = JsonDocument.Parse("{\"EventType\":\"r\"}");
var notifications = await context.Notifications
    .Where(n => EF.Property<JsonDocument>(n, "Events").Contains(targetEvent, NpgsqlJsonPathMatchMode.Simple))
    .ToListAsync();

使用Newtonsoft.Json（JArray/JObject）

using Newtonsoft.Json.Linq;

var targetEvent = JObject.Parse("{\"EventType\":\"r\"}");
var notifications = await context.Notifications
    .Where(n => EF.Property<JArray>(n, "Events").Contains(targetEvent))
    .ToListAsync();

以上写法会直接生成包含@>操作符的SQL，可命中GIN索引。

方法2：注册自定义LINQ方法映射到@>操作符 #

创建自定义LINQ扩展方法，并通过Npgsql的函数映射将其转换为@>操作符：

1. 定义静态扩展方法：

public static class NpgsqlJsonExtensions
{
    // 仅用于EF Core查询转换，运行时不会执行
    public static bool JsonContains<T>(this IEnumerable<T> ownedEntities, T value)
        => throw new NotImplementedException("此方法仅用于EF Core查询表达式转换");
}

2. 在OnModelCreating中注册函数映射：

using Npgsql.EntityFrameworkCore.PostgreSQL.Query.Expressions.Internal;
using NpgsqlTypes;

// 注册自定义函数的SQL转换
modelBuilder.HasDbFunction(typeof(NpgsqlJsonExtensions).GetMethod(nameof(NpgsqlJsonExtensions.JsonContains)))
    .HasTranslation(args => new PostgresBinaryExpression(
        PostgresExpressionType.JsonContains,
        args[0],
        args[1],
        typeof(bool),
        new NpgsqlDbTypeInfo(NpgsqlDbType.Jsonb)));

3. 在查询中使用自定义方法：

var notifications = await context.Notifications
    .Where(n => n.Events.JsonContains(new NotificationEvent { EventType = "r" }))
    .ToListAsync();

该方式会将JsonContains调用转换为@>操作符，同样能命中GIN索引。

内容的提问来源于stack exchange，提问作者Christian Klauser