EF Core无法将UDF映射到CLR方法的问题排查

问题场景 #

已定义SQL用户定义函数：

create function dbo.GetConsumerNextId()
returns int
as
begin
  return 123;
end;

在EF Core的DbContext中按文档映射CLR方法：

public class FLContext : DbContext
{
  public DbSet<Consumer> Consumers => Set<Consumer>();
  public FLContext(DbContextOptions<FLContext> options) : base(options) { }
  
  // UDF映射方法
  public int GetConsumerNextId() => throw new NotSupportedException();

  protected override void OnModelCreating(ModelBuilder modelBuilder)
  {
    var nextIdMethod = typeof(FLContext).GetMethod(nameof(GetConsumerNextId))!;
    modelBuilder.HasDbFunction(nextIdMethod);
  }
}

调用时出现两个问题：

1. 首次调用API直接执行GetConsumerNextId()时，OnModelCreating未执行，抛出NotSupportedException；
2. 先执行数据库查询触发OnModelCreating后，再次调用该方法仍抛出相同异常。

尝试显式指定UDF名称、架构、存储类型均无效。

核心原因 #

EF Core的DbFunction映射仅用于LINQ查询中的方法转译，不能直接调用DbContext的实例方法来触发SQL UDF执行。你定义的GetConsumerNextId()本质是普通CLR方法，直接调用会执行你写的throw new NotSupportedException()逻辑，和EF的UDF映射无关。

另外，OnModelCreating的触发条件是DbContext执行数据库相关操作（如查询、保存变更），直接调用该实例方法不会触发任何数据库交互，因此首次调用时OnModelCreating不会执行。

正确解决方案 #

方案1：通过LINQ查询调用UDF

利用EF Core的查询转译能力，在LINQ查询中使用映射的方法，EF会自动将其转为对应的SQL UDF调用：

// 在Minimal API中的调用示例
app.MapGet("/next-consumer-id", async (FLContext context) =>
{
    // 通过LINQ查询触发UDF调用
    var nextId = await context.Consumers
        .Select(_ => context.GetConsumerNextId())
        .FirstOrDefaultAsync();
    
    return Results.Ok(nextId);
});

方案2：使用FromSqlRaw直接执行UDF

如果不需要LINQ转译，也可以直接通过原生SQL调用UDF：

app.MapGet("/next-consumer-id", async (FLContext context) =>
{
    var nextId = await context.Set<int>()
        .FromSqlRaw("SELECT dbo.GetConsumerNextId()")
        .FirstOrDefaultAsync();
    
    return Results.Ok(nextId);
});

优化UDF映射（可选）

为确保映射准确，可显式指定UDF的架构和名称：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    var nextIdMethod = typeof(FLContext).GetMethod(nameof(GetConsumerNextId))!;
    modelBuilder.HasDbFunction(nextIdMethod)
        .HasName("GetConsumerNextId")
        .HasSchema("dbo");
}

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