如何在Entity Framework中为含动态SQL的存储过程定义OBJECT_RESULT类型复杂返回值

我明白你遇到的困扰了——EF在设计时没法解析带动态表名的存储过程返回结构，导致抛出“所选存储过程未返回列”的错误。虽然你已经设置了SET FMTONLY OFF，但EF的元数据检测机制可能还是没法正确识别动态SQL的返回列。下面给你几个可行的解决方案：

方案1：给EF添加模拟的返回结构（推荐） #

在存储过程中加入一个永远不会执行的分支，专门给EF的元数据检测提供明确的列结构。这样EF在扫描存储过程时，能看到固定的返回列，从而生成对应的实体类型。

修改你的存储过程，在执行动态SQL之前添加这段代码：

-- 为EF元数据检测提供固定的返回列结构（此分支永远不会实际执行）
IF 1 = 0
BEGIN
    SELECT 
        CAST(NULL AS binary(10)) AS [__$start_lsn],
        CAST(NULL AS binary(10)) AS [__$end_lsn],
        CAST(NULL AS binary(10)) AS [__$seqval],
        CAST(NULL AS INT) AS [__$operation],
        CAST(NULL AS varbinary(128)) AS [__$update_mask],
        CAST(NULL AS INT) AS [ID],
        CAST(NULL AS NVARCHAR(MAX)) AS [LookupList],
        CAST(NULL AS NVARCHAR(MAX)) AS [LookupColumns],
        CAST(NULL AS NVARCHAR(MAX)) AS [LookupAdditionalColumns],
        CAST(NULL AS INT) AS [FormFieldsID],
        CAST(NULL AS DATETIME) AS [DateAdded],
        CAST(NULL AS DATETIME) AS [DateEdited],
        CAST(NULL AS NVARCHAR(50)) AS [CreatedBy],
        CAST(NULL AS NVARCHAR(50)) AS [EditedBy],
        CAST(NULL AS INT) AS [__$command_id]
END

这段代码的作用是：EF在检测存储过程时会执行这段逻辑（虽然1=0永远为假，不会返回实际数据），但它能识别到返回的列名和数据类型，从而正确生成返回类型。而实际执行存储过程时，动态SQL返回的列结构和这段模拟的完全一致，不会有映射问题。

方案2：手动创建实体类并映射 #

如果不想修改存储过程，可以手动定义一个和存储过程返回列完全匹配的实体类，然后让EF直接映射到这个类。

步骤1：创建实体类 #

public class FormFieldCDCResult
{
    public byte[] __$start_lsn { get; set; }
    public byte[] __$end_lsn { get; set; }
    public byte[] __$seqval { get; set; }
    public int __$operation { get; set; }
    public byte[] __$update_mask { get; set; }
    public int ID { get; set; }
    public string LookupList { get; set; }
    public string LookupColumns { get; set; }
    public string LookupAdditionalColumns { get; set; }
    public int FormFieldsID { get; set; }
    public DateTime DateAdded { get; set; }
    public DateTime DateEdited { get; set; }
    public string CreatedBy { get; set; }
    public string EditedBy { get; set; }
    public int __$command_id { get; set; }
}

步骤2：在DbContext中配置（EF Core） #

如果是EF Core，需要在OnModelCreating中标记这个实体为无主键（因为结果集没有唯一标识）：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<FormFieldCDCResult>().HasNoKey();
}

步骤3：调用存储过程 #

使用FromSqlRaw直接调用存储过程并映射到实体：

var formfieldId = 1;
var cOperation = 2;
var startLsn = new byte[10]; // 替换为实际的LSN值
var schemaName = "dbo";
var tableName = "YourTableName";

var result = context.Set<FormFieldCDCResult>()
    .FromSqlRaw("EXEC dbo.GetFormFieldCDC2 @formfieldId = {0}, @C___operation = {1}, @C___start_lsn = {2}, @schemaname = {3}, @tablename = {4}",
        formfieldId, cOperation, startLsn, schemaName, tableName)
    .ToList();

方案3：使用EF的“复杂类型”（EF6及之前版本） #

如果你使用的是EF6或更早版本，可以将返回类型定义为复杂类型：

1. 在EDMX模型中，手动添加一个复杂类型，属性和存储过程返回列一一对应。
2. 在导入存储过程时，选择这个复杂类型作为返回类型。
3. 调用存储过程时，EF会自动将结果映射到这个复杂类型。

为什么SET FMTONLY OFF没用？ #

EF的元数据检测机制并不完全依赖FMTONLY设置，它可能会实际执行存储过程（比如传入默认参数或空值），这时候动态SQL因为表名参数无效，不会返回任何列，导致EF无法识别返回结构。而方案1中的模拟分支，能确保EF在任何检测场景下都能看到明确的列结构。

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