Entity Framework 存储过程表值参数

75

我尝试调用一个接受表值参数的存储过程。我知道这在 Entity Framework 中不是直接支持的,但据我所了解,可以使用 ObjectContextExecuteStoreQuery 命令来实现它。我有一个通用的 Entity Framework 存储库,在其中我有以下 ExecuteStoredProcedure 方法:

public IEnumerable<T> ExecuteStoredProcedure<T>(string procedureName, params object[] parameters)
{
    StringBuilder command = new StringBuilder();
    command.Append("EXEC ");
    command.Append(procedureName);
    command.Append(" ");

    // Add a placeholder for each parameter passed in
    for (int i = 0; i < parameters.Length; i++)
    {
        if (i > 0)
            command.Append(",");

        command.Append("{" + i + "}");
    }

    return this.context.ExecuteStoreQuery<T>(command.ToString(), parameters);
}
命令字符串最终就像这样:
EXEC someStoredProcedureName {0},{1},{2},{3},{4},{5},{6},{7}

我尝试在接受表值参数的存储过程上运行此方法,但是失败了。我在这里读到了需要使用类型为SqlParameter的参数,并且表值参数需要将SqlDbType设置为Structured。所以我这样做了,但是收到了一个错误提示:

The table type parameter p6 must have a valid type name

所以,我将SqlParameter.TypeName设置为我在数据库上创建的用户定义类型的名称,当我运行查询时,我会得到以下真正有用的错误:

Incorrect syntax near '0'.

如果我回到ADO.NET并执行数据读取器,我可以使查询正常运行,但我希望使用数据上下文让它工作。

是否有一种方法可以使用ExecuteStoreQuery传递表值参数?另外,我实际上正在使用Entity Framework Code First,并将DbContext强制转换为ObjectContext以获得可用的ExecuteStoreQuery方法。这是必要的吗?还是我也可以对DbContext执行此操作?


目前似乎不可能:https://dev59.com/xk3Sa4cB1Zd3GeqPyMyn - Vertigo
1
我本来很担心,但根据下面的答案,似乎是可能的,尽管没有给出示例。我留了一个评论,并附上了这个问题的链接,看看他是否会回复:http://stackoverflow.com/questions/6084061/udt-as-a-parameter-in-ef4-query/6084728#6084728 - Nick Olsen
你最后解决了吗?能否贴上一个完整的例子? - Mike
6个回答

103

更新

我已经在Nuget Package上添加了对此的支持 - https://github.com/Fodsuk/EntityFrameworkExtras#nuget (EF4,EF5,EF6)。

请查看GitHub存储库以获取代码示例。


有点偏题,但对于尝试将用户定义的表传递到存储过程的人来说仍然很有用。 在玩弄Nick的示例和其他StackOverflow帖子后,我得出了以下结论:

class Program
{
    static void Main(string[] args)
    {
        var entities = new NewBusinessEntities();

        var dt = new DataTable();
        dt.Columns.Add("WarningCode");
        dt.Columns.Add("StatusID");
        dt.Columns.Add("DecisionID");
        dt.Columns.Add("Criticality");

        dt.Rows.Add("EO01", 9, 4, 0);
        dt.Rows.Add("EO00", 9, 4, 0);
        dt.Rows.Add("EO02", 9, 4, 0);

        var caseId = new SqlParameter("caseid", SqlDbType.Int);
        caseId.Value = 1;

        var userId = new SqlParameter("userid", SqlDbType.UniqueIdentifier);
        userId.Value = Guid.Parse("846454D9-DE72-4EF4-ABE2-16EC3710EA0F");

        var warnings = new SqlParameter("warnings", SqlDbType.Structured);
        warnings.Value= dt;
        warnings.TypeName = "dbo.udt_Warnings";

        entities.ExecuteStoredProcedure("usp_RaiseWarnings_rs", userId, warnings, caseId);
    }
}

public static class ObjectContextExt
{
    public static void ExecuteStoredProcedure(this ObjectContext context, string storedProcName, params object[] parameters)
    {
        string command = "EXEC " + storedProcName + " @caseid, @userid, @warnings";

        context.ExecuteStoreCommand(command, parameters);
    }
}

存储过程如下所示:

ALTER PROCEDURE [dbo].[usp_RaiseWarnings_rs]
    (@CaseID int, 
     @UserID uniqueidentifier = '846454D9-DE72-4EF4-ABE2-16EC3710EA0F', --Admin
     @Warnings dbo.udt_Warnings READONLY
)
AS

用户自定义的表格如下所示:

CREATE TYPE [dbo].[udt_Warnings] AS TABLE(
    [WarningCode] [nvarchar](5) NULL,
    [StatusID] [int] NULL,
    [DecisionID] [int] NULL,
    [Criticality] [int] NULL DEFAULT ((0))
)

我发现的限制包括:

  1. 你传递给 ExecuteStoreCommand 的参数必须按照存储过程中的参数顺序进行排序。
  2. 你必须将每一列都传递到用户定义的表中,即使它们有默认值。因此,似乎我不能在我的 UDT 上有一个 IDENTITY(1,1) NOT NULL 列。

1
这正是我们最终所做的。很抱歉我没有更新帖子并公布解决方案。感谢您花时间处理此事!我已将正确答案授予给您。 - Nick Olsen
谢谢,你的问题帮助我找到了正确的方向 :) - Mike
我不确定ssilas777,但我认为DataContext的底层数据访问组件类似于DbContext或ObjectContext。我会查看我在Nuget上发布的NuGet包来支持它 :) - Mike
我认为最容易出现问题的是创建ado DataTable。请参见下面的答案,直接从IEnumerable<T>中创建/填充表格。 - Toby Couchman
1
解决了! TResult 惯例是使用 setter 而不是字段。 以下链接很有帮助..谢谢! http://msdn.microsoft.com/en-us/library/vstudio/ee358758(v=vs.100).aspx - Vaibhav
显示剩余4条评论

23

好的,这里是一个2018年的更新:端到端解决方案,描述如何在没有nuget包的情况下从Entity Framework调用带有表参数的存储过程。

我正在使用EF 6.xx、SQL Server 2012和VS2017。

1. 表值参数

假设您有一个简单的表类型定义如下(只有一列):

go
create type GuidList as table (Id uniqueidentifier)

2. 您的存储过程

以及一个带有多个参数的存储过程,例如:

go
create procedure GenerateInvoice
    @listIds GuidList readonly,
    @createdBy uniqueidentifier,
    @success int out,
    @errorMessage nvarchar(max) out
as
begin
    set nocount on;

    begin try
    begin tran;  

    -- 
    -- Your logic goes here, let's say a cursor or something:
    -- 
    -- declare gInvoiceCursor cursor forward_only read_only for
    -- 
    -- bla bla bla
    --
    --  if (@brokenRecords > 0)
    --  begin
    --      RAISERROR(@message,16,1);
    --  end
    -- 


    -- All good!
    -- Bonne chance mon ami!

    select @success = 1
    select @errorMessage = ''

    end try
    begin catch  
        --if something happens let's be notified
        if @@trancount > 0 
        begin
            rollback tran;  
        end

        declare @errmsg nvarchar(max)
        set @errmsg =       
            (select 'ErrorNumber: ' + cast(error_number() as nvarchar(50))+
            'ErrorSeverity: ' + cast(error_severity() as nvarchar(50))+
            'ErrorState: ' + cast(error_state() as nvarchar(50))+
            'ErrorProcedure: ' + cast(error_procedure() as nvarchar(50))+
            'ErrorLine: ' + cast(error_number() as nvarchar(50))+
            'error_message: ' + cast(error_message() as nvarchar(4000))
            )
        --save it if needed

        print @errmsg

        select @success = 0
        select @errorMessage = @message

        return;
    end catch;

    --at this point we can commit everything
    if @@trancount > 0 
    begin
        commit tran;  
    end

end
go

3. 使用此存储过程的 SQL 代码

在 SQL 中,您可以使用以下代码:

declare @p3 dbo.GuidList
insert into @p3 values('f811b88a-bfad-49d9-b9b9-6a1d1a01c1e5')
exec sp_executesql N'exec GenerateInvoice @listIds, @CreatedBy, @success',N'@listIds [dbo].[GuidList] READONLY,@CreatedBy uniqueidentifier',@listIds=@p3,@CreatedBy='FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF'

4. 使用此存储过程的 C# 代码

以下是如何从 Entity Framework(在 WebAPI 中)调用该存储过程的方法:

    [HttpPost]
    [AuthorizeExtended(Roles = "User, Admin")]
    [Route("api/BillingToDo/GenerateInvoices")]
    public async Task<IHttpActionResult> GenerateInvoices(BillingToDoGenerateInvoice model)
    {
        try
        {
            using (var db = new YOUREntities())
            {
                //Build your record
                var tableSchema = new List<SqlMetaData>(1)
                {
                    new SqlMetaData("Id", SqlDbType.UniqueIdentifier)
                }.ToArray();

                //And a table as a list of those records
                var table = new List<SqlDataRecord>();

                for (int i = 0; i < model.elements.Count; i++)
                {
                    var tableRow = new SqlDataRecord(tableSchema);
                    tableRow.SetGuid(0, model.elements[i]);
                    table.Add(tableRow);
                }

                //Parameters for your query
                SqlParameter[] parameters =
                {
                    new SqlParameter
                    {
                        SqlDbType = SqlDbType.Structured,
                        Direction = ParameterDirection.Input,
                        ParameterName = "listIds",
                        TypeName = "[dbo].[GuidList]", //Don't forget this one!
                        Value = table
                    },
                    new SqlParameter
                    {
                        SqlDbType = SqlDbType.UniqueIdentifier,
                        Direction = ParameterDirection.Input,
                        ParameterName = "createdBy",
                        Value = CurrentUser.Id
                    },
                    new SqlParameter
                    {
                        SqlDbType = SqlDbType.Int,
                        Direction = ParameterDirection.Output, // output!
                        ParameterName = "success"
                    },
                    new SqlParameter
                    {
                        SqlDbType = SqlDbType.NVarChar,
                        Size = -1,                             // "-1" equals "max"
                        Direction = ParameterDirection.Output, // output too!
                        ParameterName = "errorMessage"
                    }
                };

                //Do not forget to use "DoNotEnsureTransaction" because if you don't EF will start it's own transaction for your SP.
                //In that case you don't need internal transaction in DB or you must detect it with @@trancount and/or XACT_STATE() and change your logic
                await db.Database.ExecuteSqlCommandAsync(TransactionalBehavior.DoNotEnsureTransaction,
                    "exec GenerateInvoice @listIds, @createdBy, @success out, @errorMessage out", parameters);

                //reading output values:
                int retValue;
                if (parameters[2].Value != null && Int32.TryParse(parameters[2].Value.ToString(), out retValue))
                {
                    if (retValue == 1)
                    {
                        return Ok("Invoice generated successfully");
                    }
                }

                string retErrorMessage = parameters[3].Value?.ToString();

                return BadRequest(String.IsNullOrEmpty(retErrorMessage) ? "Invoice was not generated" : retErrorMessage);
            }
        }
        catch (Exception e)
        {
            return BadRequest(e.Message);
        }
    }
}

希望这能有所帮助!


1
2018版本是将2012 NuGet代码粘贴到StackOverflow上的:P - Mike

9
我希望分享我对这个问题的解决方案:
我有一些带有几个表值参数的存储过程,我发现如果按以下方式调用它:
var query = dbContext.ExecuteStoreQuery<T>(@"
EXECUTE [dbo].[StoredProcedure] @SomeParameter, @TableValueParameter1, @TableValueParameter2", spParameters[0], spParameters[1], spParameters[2]);
var list = query.ToList();

你得到了一个没有记录的列表。
但我进一步尝试后,这行代码给了我一个想法:
var query = dbContext.ExecuteStoreQuery<T>(@"
EXECUTE [dbo].[StoredProcedure] 'SomeParameterValue', @TableValueParameter1, @TableValueParameter2",  spParameters[1], spParameters[2]);
var list = query.ToList();

我修改了命令文本中参数@SomeParameter的实际值为'SomeParameterValue'

然后它就可以工作了 :)

这意味着如果我们的参数不是SqlDbType.Structured,它可能无法正确传递所有参数,最终返回空值。

因此,解决方案如下:

替换实际参数与其值。
public static List<T> ExecuteStoredProcedure<T>(this ObjectContext dbContext, string storedProcedureName, params SqlParameter[] parameters)
{
    var spSignature = new StringBuilder();
    object[] spParameters;
    bool hasTableVariables = parameters.Any(p => p.SqlDbType == SqlDbType.Structured);

    spSignature.AppendFormat("EXECUTE {0}", storedProcedureName);
    var length = parameters.Count() - 1;

    if (hasTableVariables)
    {
        var tableValueParameters = new List<SqlParameter>();

        for (int i = 0; i < parameters.Count(); i++)
        {
            switch (parameters[i].SqlDbType)
            {
                case SqlDbType.Structured:
                    spSignature.AppendFormat(" @{0}", parameters[i].ParameterName);
                    tableValueParameters.Add(parameters[i]);
                    break;
                case SqlDbType.VarChar:
                case SqlDbType.Char:
                case SqlDbType.Text:
                case SqlDbType.NVarChar:
                case SqlDbType.NChar:
                case SqlDbType.NText:
                case SqlDbType.Xml:
                case SqlDbType.UniqueIdentifier:
                case SqlDbType.Time:
                case SqlDbType.Date:
                case SqlDbType.DateTime:
                case SqlDbType.DateTime2:
                case SqlDbType.DateTimeOffset:
                case SqlDbType.SmallDateTime:
                    // TODO: some magic here to avoid SQL injections
                    spSignature.AppendFormat(" '{0}'", parameters[i].Value.ToString());
                    break;
                default:
                    spSignature.AppendFormat(" {0}", parameters[i].Value.ToString());
                    break;
            }

            if (i != length) spSignature.Append(",");
        }
        spParameters = tableValueParameters.Cast<object>().ToArray();
    }
    else
    {
        for (int i = 0; i < parameters.Count(); i++)
        {
            spSignature.AppendFormat(" @{0}", parameters[i].ParameterName);
            if (i != length) spSignature.Append(",");
        }
        spParameters = parameters.Cast<object>().ToArray();
    }

    var query = dbContext.ExecuteStoreQuery<T>(spSignature.ToString(), spParameters);


    var list = query.ToList();
    return list;
}

代码肯定可以更加优化,但我希望这可以有所帮助。


1
这不容易受到 SQL 注入攻击吗? - jag
@jag 我在代码中留下了一个TODO,这样你就可以开发自己的逻辑来克服注入问题。同时我也不确定8年后这个解决方案是否仍然适用。 - Andrey Borisko

5
var sqlp = new SqlParameter("@param3", my function to get datatable);
sqlp.SqlDbType = System.Data.SqlDbType.Structured;
sqlp.TypeName = "dbo.mytypename";

  var v = entitycontext.Database.SqlQuery<bool?>("exec [MyStorProc] @param1,@param2,@param3,@param4", new SqlParameter[]
                    {
                        new SqlParameter("@param1",value here),
                        new SqlParameter("@param2",value here),

                        sqlp,
                        new SqlParameter("@param4",value here)

                    }).FirstOrDefault();

请在代码周围添加一些上下文,并格式化代码。 - Sid
我是一个新手,我不知道你在说什么。 - souvik sett
我的意思是代码格式不好,为什么你认为这会起作用应该被提到。 - Sid
我不知道该如何在这里描述。实际上,param3 需要声明为 System.Data.SqlDbType.Structured。因此,我在参数声明范围之外初始化了它,并在该范围内使用了该变量。 - souvik sett

2

DataTable方法是唯一的方式,但手动构建和填充DataTable非常麻烦。我希望能够直接从IEnumerable定义我的DataTable,以类似于EF流畅模型生成器的方式。所以:

var whatever = new[]
            {
                new
                {
                    Id = 1,
                    Name = "Bacon",
                    Foo = false
                },
                new
                {
                    Id = 2,
                    Name = "Sausage",
                    Foo = false
                },
                new
                {
                    Id = 3,
                    Name = "Egg",
                    Foo = false
                },
            };

            //use the ToDataTable extension method to populate an ado.net DataTable
            //from your IEnumerable<T> using the property definitions.
            //Note that if you want to pass the datatable to a Table-Valued-Parameter,
            //The order of the column definitions is significant.
            var dataTable = whatever.ToDataTable(
                whatever.Property(r=>r.Id).AsPrimaryKey().Named("item_id"),
                whatever.Property(r=>r.Name).AsOptional().Named("item_name"),
                whatever.Property(r=>r.Foo).Ignore()
                );

我已经在dotnetfiddle上发布了这个东西:https://dotnetfiddle.net/ZdpYM3(请注意,您无法在那里运行它,因为并非所有程序集都加载到了fiddle中)


那怎么回答这个问题呢? - Suncat2000

-2

将您的字符串连接代码更改为生成类似于以下内容的内容:

EXEC someStoredProcedureName @p0,@p1,@p2,@p3,@p4,@p5,@p6,@p7

OP说EXEC someStoredProcedureName {0},{1},{2},{3},{4},{5},{6},{7}不起作用,所以参数化也不会起作用。 - Sergey Kalinichenko

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接