Entity framework 调用存储过程

目前，EF对存储过程的支持并不完善。存在以下问题：

l        EF不支持存储过程返回多表联合查询的结果集。

l        EF仅支持返回返回某个表的全部字段，以便转换成对应的实体。无法支持返回部分字段的情况。

l        虽然可以正常导入返回标量值的存储过程，但是却没有为我们自动生成相应的实体.cs代码，我们还是无法在代码中直接调用或使用标量存储过程

l        EF不能直接支持存储过程中Output类型的参数。

l        其他一些问题。

本节，我们将学习如何手动添加/修改存储过程，如何使EF能够支持Output类型的参数。

l        添加/修改存储过程

有时候，某个SQL语句比较复杂，但是数据库中又没有定义相应的存储过程。这个时候，我们又想使上层代码比较简单、方便的方式来完成此项任务。那么，此时，我们便可以手工在实体模型（.edmx文件）中添加自己需要的存储过程了。这样既方便上层调用又方便后期的修改。

以手动修改实体模型edmx文件，添加名为CustomerByCommandText的存储过程为例。具体步骤如下：

修改实体模型文件，找到ssdl部分，添加如下代码：

1.         <Function Name="CustomerByCommandText" Aggregate="false" BuiltIn="false" NiladicFunction="false" IsComposable="false" ParameterTypeSemantics="AllowImplicitConversion" Schema="dbo" >
   
2. 
   
3.           <CommandText>
   
4. 
   
5.             select c.* from Customers c,Orders o where c.CustomerID=o.CustomerID
   
6. 
   
7.           </CommandText>
   
8. 
   
9.         </Function>
   

复制代码

然后，再找到csdl部分，添加如下代码：

<FunctionImport Name="CustomerByCommandText" EntitySet="Customers" ReturnType="Collection(NorthwindModel.Customers)"></FunctionImport>

接着，找到msl部分，添加如下代码：

<FunctionImportMapping Functi Functi/>

最后，在实体模型的.cs文件里面，添加一个执行此存储过程的方法，代码如下：

1.         public global::System.Data.Objects.ObjectResult<Customers> GetCustomerByCommandText()
   
2. 
   
3.         {
   
4. 
   
5.             return base.ExecuteFunction<Customers>("CustomerByCommandText");
   
6. 
   
7.         }
   

复制代码

至此，修改完毕。

现在，我们就可以在代码使用刚才手工定义的存储过程了。如下代码所示：

1. [Test]
   
2. 
   
3.         public void GetCustomerByCmdText()
   
4. 
   
5.         {
   
6. 
   
7.             using (var db = new NorthwindEntities())
   
8. 
   
9.             {
   
10. 
    
11.                 var csts = db.GetCustomerByCommandText().Take(10).Skip(0);
    
12. 
    
13.                 foreach (var c in csts)
    
14. 
    
15.                     Console.WriteLine(c.CustomerID);
    
16. 
    
17.             }
    
18. 
    
19.         }
    

复制代码

其实，关键的地方就是CommandText这个部分的内容，它里面就是要执行的SQL语句。另外，我们可以在修改实体模型emdx文件的同时，我们可以看到所有的实体类查询的SQL语句命令都可以在edmx文件里找到，我们都可以进行相应的修改。

l        Output类型参数

在实际应用当中，很多时候，我们需要使用output类型的存储过程参数，以便返回我们需要的值。但是，目前，EF不能直接支持output类型的存储过程参数。为此，我们需要对实体模型进行修改，以便使其支持output类型的输出参数。具体过程如下：

在数据库中建立一个为名的GetNameByCustomerId存储过程，代码如下：

1. CREATE PROCEDURE GetNameByCustomerId
   
2. 
   
3. @CustomerId varchar(5),
   
4. 
   
5. @ContactName varchar(30) output
   
6. 
   
7. AS
   
8. 
   
9. BEGIN
   
10. 
    
11. SET NOCOUNT ON;
    
12. 
    
13. SELECT @ContactName=ContactName
    
14. 
    
15. FROM Customers
    
16. 
    
17. WHERE CustomerID=@CustomerId;
    
18. 
    
19. END
    

复制代码

然后，开始修改实体模型edmx文件。

先找到ssdl定义的部分，添加如下代码：

1.       <Function Name="GetNameByCustomerId" Aggregate="false" BuiltIn="false" NiladicFunction="false" IsComposable="false" ParameterTypeSemantics="AllowImplicitConversion" Schema="dbo">
   
2. 
   
3.           <Parameter Name="CustomerId" Type="varchar" Mode="In" MaxLength="5"></Parameter>
   
4. 
   
5.           <Parameter Name="ContactName" Type="varchar" Mode="Out" MaxLength="30"></Parameter>
   
6. 
   
7.       </Function>
   

复制代码

接着，在找到csdl定义的部分，添加如下代码：

1.       <FunctionImport Name="GetNameByCustomerId">
   
2. 
   
3.             <Parameter Name="CustomerId" Mode="In" Type="String" MaxLength="5"></Parameter>
   
4. 
   
5.             <Parameter Name="ContactName" Mode="Out" Type="String" MaxLength="30"></Parameter>
   
6. 
   
7.       </FunctionImport>
   

复制代码

最后，找到msl定义的部分，添加如下代码：

1. <FunctionImportMapping FunctionImportName="GetNameByCustomerId" FunctionName="NorthwindModel.Store.GetNameByCustomerId"></FunctionImportMapping>
   

复制代码

至此，实体模型emdx文件修改完毕。

接下来，我们需要在实体模型的.cs文件中，增加相应的调用方法。代码如下：

1. public partial class NorthwindEntities1
   
2. 
   
3. {
   
4. 
   
5. 
   
6. 
   
7. //执行GetNameByCustomerId的方法
   
8. 
   
9.         public void GetNameByCustomerId(string CustomerId, out string ContactName)
   
10. 
    
11.         {
    
12. 
    
13.           ContactName = string.Empty;
    
14. 
    
15.             var Pars = new System.Data.EntityClient.EntityParameter[] 
    
16. 
    
17.             {
    
18. 
    
19.                 new System.Data.EntityClient.EntityParameter{ ParameterName="CustomerId", DbType=System.Data.DbType.String,Value=CustomerId},
    
20. 
    
21.                 new System.Data.EntityClient.EntityParameter{ParameterName="ContactName", DbType=System.Data.DbType.String, Direction=System.Data.ParameterDirection.Output}
    
22. 
    
23.             };
    
24. 
    
25.             this.ExecuteNonQuery("GetNameByCustomerId", Pars);
    
26. 
    
27.             ContactName = Pars[1].Value.ToString();
    
28. 
    
29. 
    
30. 
    
31.         }
    
32. 
    
33.       
    
34. 
    
35.       //辅助方法，执行SQL命令
    
36. 
    
37.         private void ExecuteNonQuery(string functionName, System.Data.EntityClient.EntityParameter[] parameters)
    
38. 
    
39.         {
    
40. 
    
41.             System.Data.EntityClient.EntityCommand cmd = ((System.Data.EntityClient.EntityConnection)this.Connection).CreateCommand();
    
42. 
    
43.             cmd.CommandType = System.Data.CommandType.StoredProcedure;
    
44. 
    
45.             cmd.Parameters.AddRange(parameters);
    
46. 
    
47.             cmd.CommandText = this.DefaultContainerName + "." + functionName;
    
48. 
    
49.             try
    
50. 
    
51.             {
    
52. 
    
53.                 if (cmd.Connection.State != System.Data.ConnectionState.Open)
    
54. 
    
55.                     cmd.Connection.Open();
    
56. 
    
57.                 cmd.ExecuteNonQuery();
    
58. 
    
59.             }
    
60. 
    
61.             catch (System.Exception)
    
62. 
    
63.             {
    
64. 
    
65.                 throw;
    
66. 
    
67.             }
    
68. 
    
69.             finally
    
70. 
    
71.             {
    
72. 
    
73.                 cmd.Connection.Close();
    
74. 
    
75.             }
    
76. 
    
77.         }
    
78. 
    
79. }
    

复制代码

现在，所有的修改工作都做完了。接下来，我们就可以在代码中直接调用此存储过程了。示例代码如下：

1. [Test]
   
2. 
   
3.         public void OutputTest()
   
4. 
   
5.         {
   
6. 
   
7.             using (var db = new NorthwindModel.NorthwindEntities1())
   
8. 
   
9.             {
   
10. 
    
11.                 string contactname = string.Empty;
    
12. 
    
13.                 db.GetNameByCustomerId("ALFKI", out contactname);
    
14. 
    
15.                 Assert.IsTrue(!string.IsNullOrEmpty(contactname));
    
16. 
    
17.                 Console.WriteLine(contactname);
    
18. 
    
19.             }
    
20. 
    
21.         }
    

复制代码

至此，我们便可以使用Output类型的输出参数了。