如何在Entity Framework Core中使用UDF定义实体属性

步骤1：修改Customer实体类 #

先在Customer实体中添加用于存储状态的属性，该属性不在数据库Customer表中，仅用于承载UDF的返回结果：

public class Customer
{
    public int Id { get; set; }
    // 保留原有其他属性
    // 根据UDF返回值类型调整，比如返回int类型StatusId则改为int?
    public string Status { get; set; } 
}

步骤2：将自定义UDF映射到EF上下文 #

在你的DbContext类中，添加标记[DbFunction]特性的静态方法，让EF识别并转换为对应SQL调用：

public class YourDbContext : DbContext
{
    // 你的DbSet定义
    public DbSet<Customer> Customers { get; set; }

    // 映射数据库中的CustomerStatus函数，替换Schema为实际UDF所属架构（如dbo）
    [DbFunction("CustomerStatus", Schema = "dbo")]
    public static string CustomerStatus(int customerId)
    {
        // 此方法仅用于EF映射，无需实现逻辑，直接抛出异常防止直接调用
        throw new NotSupportedException("请通过LINQ查询使用该函数，不要直接调用");
    }
}

注意：方法的参数类型、返回类型必须和数据库中UDF的参数、返回值完全匹配。

步骤3：在Customer配置类中关联属性与UDF #

打开实现IEntityTypeConfiguration<Customer>的配置类，通过Fluent API将Status属性配置为调用UDF的计算列：

public class CustomerConfiguration : IEntityTypeConfiguration<Customer>
{
    public void Configure(EntityTypeBuilder<Customer> builder)
    {
        // 原有实体配置逻辑
        
        // 配置Status属性通过调用UDF获取值，替换Schema为实际架构
        builder.Property(c => c.Status)
               .HasComputedColumnSql("dbo.CustomerStatus([Id])")
               .IsRequired(false); // 根据UDF是否可能返回NULL调整该设置
    }
}

验证使用 #

完成配置后，查询Customer数据时，EF会自动生成包含调用CustomerStatus函数的SQL语句，将返回的状态值填充到Status属性中：

var customerList = dbContext.Customers.ToList();
// 每个customer的Status属性已自动填充UDF返回的结果

内容的提问来源于stack exchange，提问作者Sami.C