EF6：创建存储过程。使用 Fluent API 还是 DBMigrations？
EF6: Create stored procedure. Use Fluent API or DBMigrations?
我首先使用 EF6 代码创建我的数据库。我了解语法、DbContext 和模型构建器。我使用 LINQ 进行了几个详尽的查询，一切正常。
但现在我需要做一些使用 linq 在一次查询中无法完成的事情。我需要使用存储过程执行 Merge 语句。
我看到了几个关于如何创建存储过程的问题，例如：
Create Stored Procedures using Entity Framework Code First?
大多数答案都在谈论为 DbMigrations 创建派生的 class 并覆盖 Up() 函数。我明白我应该在 Up 函数中写些什么来确保存储过程被创建。
But what should I do to make that during database creation this Up function is called?
我应该在 DbContext.OnModelCreating 做些什么吗？
我认为我不应该实例化 DbMigrations 的子class 并调用 Up()。
上面说的link说的是"Open the Package Manager Control"。那是什么？或者你真的在从旧版本迁移到新版本时使用这种方法吗？
经过一些调查，我发现了如何确保在创建数据库时创建存储过程。我发现了两种方法，每种方法各有优缺点。因此，我描述了它们。很抱歉，如果这让答案变得相当长。
这里介绍的两种方法是：
- 创建一个 DataBase Initializer，一个实现 IDataBaseInitializer 的 class。这可能是从 DropCreateDatabaseIfModelChanges 或类似的派生的 class。覆盖 Seed 函数并在该函数中使用 context.Database.ExecuteSqlCommand(...).
创建存储过程
- 使用 Entity Framework 迁移 创建存储过程。
第一种方法比较简单。每当创建数据库时，都会调用 Seed 并创建存储过程。然而，这种方法有一个缺点，即每当存储过程的名称或参数类型发生变化时，直到运行时才检测到。
DbMigration 方法使用 lambda 表达式匹配存储过程的参数，因此只要参数的类型或名称发生变化，编译器就会检测远程过程的定义是否与参数匹配。
我将介绍这两种方法。这两个示例都有相同的简单 Hello World！过程和一个有很多参数的大合并过程。
The definition of the merge statement is not really important. What it
does is that it checks if there is already a record matching several
properties, and if so it adds costs to the existing costs. If not it
creates a record and initializes the costs with costs. This is a
typical example where using linq statement and IQueryable wouldn't suffice.
Using linq, one would have to retrieve the record, update it and call
SaveChanges, with the problems (1) that in
the meantime someone else might have added a value and (2) it needs at
least two roundtrips. Hence the need for a stored procedure.
方法 IDatabaseInitializer
在您的项目中，您创建实体 classes 和一个 class 派生形式 DbContext，其中包含要访问的数据库表的 DbSet 属性。
例如：
public class UsageCosts
{
public int Id {get; set; }
public DateTime InvoicePeriod { get; set; }
public long CustomerContractId { get; set; }
public string TypeA { get; set; }
public string TypeB { get; set; }
public decimal VatValue { get; set; }
// the value to invoice
public decimal PurchaseCosts { get; set; }
public decimal RetailCosts { get; set; }
}
public class DemoContext : DbContext
{
public DemoContext(string nameOrConnectionString) : base(nameOrConnectionString) {}
public DbSet<UsageCosts> UsageCosts { get; set; }
protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
// add entity framework fluent api statements here
}
}
除了你的数据库 classes，创建一个数据库初始化程序，它有一个函数 Seed，在创建数据库时将被调用。
internal class DataBaseInitializer : DropCreateDatabaseIfModelChanges<DemoContext>
{
protected override void Seed(DemoContext context)
{
base.Seed(context);
// create stored procedures here
this.CreateStoredProcedureHelloWorld(context)
this.CreateStoredProcedureUpdateUsageCosts(context)
}
显示如何创建存储过程的简单示例（Hello World！）
private void CreateStoredProcedureHelloWorld(DemoContext context)
{
context.Database.ExecuteSqlCommand("create procedure HelloWorld as begin Select 'Hello World' end;");
}
创建一个带有输入参数的存储过程：
private void CreateStoredProcedureUpdateUsageCosts(DemoContext context)
{
var x = new StringBuilder();
x.AppendLine(@"create procedure updateusagecosts");
x.AppendLine(@"@InvoicePeriod datetime,");
x.AppendLine(@"@CustomerContractId bigint,");
x.AppendLine(@"@TypeA nvarChar(80),");
x.AppendLine(@"@TypeB nvarChar(80),");
x.AppendLine(@"@VatValue decimal(18, 2),");
x.AppendLine(@"@PurchaseCosts decimal(18, 2),");
x.AppendLine(@"@RetailCosts decimal(18, 2)");
x.AppendLine(@"as");
x.AppendLine(@"begin");
x.AppendLine(@"Merge [usagecosts]");
x.AppendLine(@"Using (Select @InvoicePeriod as invoicePeriod,");
x.AppendLine(@" @CustomerContractId as customercontractId,");
x.AppendLine(@" @TypeA as typeA,");
x.AppendLine(@" @TypeB as typeB,");
x.AppendLine(@" @VatValue as vatvalue)");
x.AppendLine(@" As tmp ");
x.AppendLine(@"On ([usagecosts].[invoiceperiod] = tmp.invoiceperiod");
x.AppendLine(@"AND [usagecosts].[customercontractId] = tmp.customercontractid");
x.AppendLine(@"AND [usagecosts].[typeA] = tmp.typeA");
x.AppendLine(@"AND [usagecosts].[typeB] = tmp.typeB");
x.AppendLine(@"AND [usagecosts].[vatvalue] = tmp.Vatvalue)");
x.AppendLine(@"When Matched Then ");
x.AppendLine(@" Update Set [usagecosts].[purchasecosts] = [usagecosts].[purchasecosts] + @purchasecosts,");
x.AppendLine(@" [usagecosts].[retailcosts] = [usagecosts].[retailcosts] + @retailcosts");
x.AppendLine(@"When Not Matched Then");
x.AppendLine(@" Insert (InvoicePeriod, CustomerContractId, typea, typeb, vatvalue, purchasecosts, retailcosts)");
x.AppendLine(@" Values (@invoiceperiod, @CustomerContractId, @TypeA, @TypeB, @VatValue, @PurchaseCosts, @RetailCosts);");
x.AppendLine(@"end");
context.Database.ExecuteSqlCommand(x.ToString());
}
}
The hello world example can be found here on Whosebug
StringBuilder 的方法也可以在 Whosebug 的某个地方找到，可惜我找不到。
在创建数据库期间调用 DatabaseInitializer.Seed(...)。此处命令上下文执行 SQL 语句。这个语句是一个字符串。
这就是为什么编译器不会注意到函数参数名称或类型的变化。
DbMigration 方法
有关迁移，请参阅：
想法是让 visual studio 包管理器创建 DbManager 的派生 class，它具有 Up() 函数。每当数据库向上迁移到派生 class.
的版本时，都会调用此函数
在 Up() 中你可以调用基数 class DbMigration.CreateStoredProcedure。这种方法的好处是从实体类型到参数的转换是使用委托（使用 lambda 表达式）完成的，因此在编译时检查：属性是否仍然存在并且它们是否具有正确的类型？
唉，从 DbMigration 构造派生的 class 并从您的 Seed() 函数中调用 Up() 函数是不够的。
要确保调用 Up() 函数，最简单的方法是让 visual studio 执行此操作。
- 创建您的项目
- 为 entity framework
添加 Nuget 包
- 使用实体 classes
的 DbSet 属性创建实体 classes 和 DbContext
- 在 visual studio 中，通过“工具”菜单启动 Nuget 包管理器控制台
- 使用 Nuget 包管理器控制台使用命令启用迁移 Enable-Migrations
- 使用 Nuget 程序包管理器控制台添加一个迁移并为其命名，例如 InitialCreation 使用命令 add-Migration InitialCreation
您会注意到有几个 class 已添加到您的项目中。
- Configuration 从具有函数 Seed()
的 DbMigratinConfiguration 派生
- InitialCreation 派生自 DbMigration，带有一个函数 Up()（和一个函数 Down()）。在这个 Up 中，您将看到一个或多个 CreateTable 函数
如果您仍然有一个数据库播种器 class，如前例所述，并且您使用 DataBase.SetInitializer 对其进行初始化，那么每当需要重新创建数据库时，各种 Up( ) 和 Seed() 函数按以下顺序调用：
- 配置构造函数
- InitialCreation.Up()
- DatabaseSeeder.Seed()
由于某些原因 Configuration.Seed() 未被调用。
这让我们有机会在 InitialCraeation.Up()
中创建存储过程
public override void Up()
{
CreateTable("dbo.UsageCosts",
c => new
{
Id = c.Int(nullable: false, identity: true),
InvoicePeriod = c.DateTime(nullable: false),
CustomerContractId = c.Long(nullable: false),
TypeA = c.String(),
TypeB = c.String(),
VatValue = c.Decimal(nullable: false, precision: 18, scale: 2),
PurchaseCosts = c.Decimal(nullable: false, precision: 18, scale: 2),
RetailCosts = c.Decimal(nullable: false, precision: 18, scale: 2),
})
.PrimaryKey(t => t.Id);
}
“Hello World”存储过程创建如下：
base.CreateStoredProcedure("dbo.HelloWorld3", "begin Select 'Hello World' end;");
输入参数的存储过程：
base.CreateStoredProcedure("dbo.update2", p => new
{
InvoicePeriod = p.DateTime(),
CustomerContractId = p.Long(),
TypeA = p.String(maxLength: 80),
TypeB = p.String(maxLength: 80),
VatValue = p.Decimal(10, 8),
PurchaseCosts = p.Decimal(10, 8),
RetailCosts = p.Decimal(10, 8),
},
@"begin
Merge [usagecosts]
Using (Select
@InvoicePeriod as invoicePeriod,
@CustomerContractId as customercontractId,
@TypeA as typeA,
@TypeB as typeB,
@VatValue as vatvalue)
As tmp
On ([usagecosts].[invoiceperiod] = tmp.invoiceperiod
AND [usagecosts].[customercontractId] = tmp.customercontractid
AND [usagecosts].[typeA] = tmp.typeA
AND [usagecosts].[typeB] = tmp.typeB
AND [usagecosts].[vatvalue] = tmp.Vatvalue)
When Matched Then
Update Set [usagecosts].[purchasecosts] = [usagecosts].[purchasecosts] + @purchasecosts, [usagecosts].[retailcosts] = [usagecosts].[retailcosts] + @retailcosts
When Not Matched Then
Insert (InvoicePeriod, CustomerContractId, typea, typeb, vatvalue, purchasecosts, retailcosts)
Values (@invoiceperiod, @CustomerContractId, @TypeA, @TypeB, @VatValue, @PurchaseCosts, @RetailCosts);
end;");
}
记住Down()方法：
public override void Down()
{
this.DropStoredProcedure("dbo.update2");
}
为了完整性：远程过程调用
using (var dbContext = new DemoContext())
{
object[] functionParameters = new object[]
{
new SqlParameter(@"InvoicePeriod", usageCosts.InvoicePeriod),
new SqlParameter(@"CustomerContractId", usageCosts.CustomerContractId),
new SqlParameter(@"TypeA", usageCosts.TypeA),
new SqlParameter(@"TypeB", usageCosts.TypeB),
new SqlParameter(@"VatValue", usageCosts.VatValue),
new SqlParameter(@"PurchaseCosts", 20M),
new SqlParameter(@"RetailCosts", 30M),
};
string sqlCommand = String.Format(@"Exec {0} @InvoicePeriod, @CustomerContractId, @TypeA, @TypeB, @VatValue, @PurchaseCosts, @RetailCosts", functionName);
dbContext.Database.ExecuteSqlCommand(sqlCommand, functionParameters);
dbContext.SaveChanges();
}
我认为最好将它放在 DbSet 的扩展方法中。只要 UsageCosts 发生变化，编译器就可以检查名称和 属性 类型。
我首先使用 EF6 代码创建我的数据库。我了解语法、DbContext 和模型构建器。我使用 LINQ 进行了几个详尽的查询，一切正常。
但现在我需要做一些使用 linq 在一次查询中无法完成的事情。我需要使用存储过程执行 Merge 语句。
我看到了几个关于如何创建存储过程的问题，例如： Create Stored Procedures using Entity Framework Code First?
大多数答案都在谈论为 DbMigrations 创建派生的 class 并覆盖 Up() 函数。我明白我应该在 Up 函数中写些什么来确保存储过程被创建。
But what should I do to make that during database creation this Up function is called?
我应该在 DbContext.OnModelCreating 做些什么吗？
我认为我不应该实例化 DbMigrations 的子class 并调用 Up()。
上面说的link说的是"Open the Package Manager Control"。那是什么？或者你真的在从旧版本迁移到新版本时使用这种方法吗？
经过一些调查，我发现了如何确保在创建数据库时创建存储过程。我发现了两种方法，每种方法各有优缺点。因此，我描述了它们。很抱歉，如果这让答案变得相当长。
这里介绍的两种方法是：
- 创建一个 DataBase Initializer，一个实现 IDataBaseInitializer 的 class。这可能是从 DropCreateDatabaseIfModelChanges 或类似的派生的 class。覆盖 Seed 函数并在该函数中使用 context.Database.ExecuteSqlCommand(...). 创建存储过程
- 使用 Entity Framework 迁移 创建存储过程。
第一种方法比较简单。每当创建数据库时，都会调用 Seed 并创建存储过程。然而，这种方法有一个缺点，即每当存储过程的名称或参数类型发生变化时，直到运行时才检测到。
DbMigration 方法使用 lambda 表达式匹配存储过程的参数，因此只要参数的类型或名称发生变化，编译器就会检测远程过程的定义是否与参数匹配。
我将介绍这两种方法。这两个示例都有相同的简单 Hello World！过程和一个有很多参数的大合并过程。
The definition of the merge statement is not really important. What it does is that it checks if there is already a record matching several properties, and if so it adds costs to the existing costs. If not it creates a record and initializes the costs with costs. This is a typical example where using linq statement and IQueryable wouldn't suffice. Using linq, one would have to retrieve the record, update it and call SaveChanges, with the problems (1) that in the meantime someone else might have added a value and (2) it needs at least two roundtrips. Hence the need for a stored procedure.
方法 IDatabaseInitializer
在您的项目中，您创建实体 classes 和一个 class 派生形式 DbContext，其中包含要访问的数据库表的 DbSet 属性。
例如：
public class UsageCosts
{
public int Id {get; set; }
public DateTime InvoicePeriod { get; set; }
public long CustomerContractId { get; set; }
public string TypeA { get; set; }
public string TypeB { get; set; }
public decimal VatValue { get; set; }
// the value to invoice
public decimal PurchaseCosts { get; set; }
public decimal RetailCosts { get; set; }
}
public class DemoContext : DbContext
{
public DemoContext(string nameOrConnectionString) : base(nameOrConnectionString) {}
public DbSet<UsageCosts> UsageCosts { get; set; }
protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
// add entity framework fluent api statements here
}
}
除了你的数据库 classes，创建一个数据库初始化程序，它有一个函数 Seed，在创建数据库时将被调用。
internal class DataBaseInitializer : DropCreateDatabaseIfModelChanges<DemoContext>
{
protected override void Seed(DemoContext context)
{
base.Seed(context);
// create stored procedures here
this.CreateStoredProcedureHelloWorld(context)
this.CreateStoredProcedureUpdateUsageCosts(context)
}
显示如何创建存储过程的简单示例（Hello World！）
private void CreateStoredProcedureHelloWorld(DemoContext context)
{
context.Database.ExecuteSqlCommand("create procedure HelloWorld as begin Select 'Hello World' end;");
}
创建一个带有输入参数的存储过程：
private void CreateStoredProcedureUpdateUsageCosts(DemoContext context)
{
var x = new StringBuilder();
x.AppendLine(@"create procedure updateusagecosts");
x.AppendLine(@"@InvoicePeriod datetime,");
x.AppendLine(@"@CustomerContractId bigint,");
x.AppendLine(@"@TypeA nvarChar(80),");
x.AppendLine(@"@TypeB nvarChar(80),");
x.AppendLine(@"@VatValue decimal(18, 2),");
x.AppendLine(@"@PurchaseCosts decimal(18, 2),");
x.AppendLine(@"@RetailCosts decimal(18, 2)");
x.AppendLine(@"as");
x.AppendLine(@"begin");
x.AppendLine(@"Merge [usagecosts]");
x.AppendLine(@"Using (Select @InvoicePeriod as invoicePeriod,");
x.AppendLine(@" @CustomerContractId as customercontractId,");
x.AppendLine(@" @TypeA as typeA,");
x.AppendLine(@" @TypeB as typeB,");
x.AppendLine(@" @VatValue as vatvalue)");
x.AppendLine(@" As tmp ");
x.AppendLine(@"On ([usagecosts].[invoiceperiod] = tmp.invoiceperiod");
x.AppendLine(@"AND [usagecosts].[customercontractId] = tmp.customercontractid");
x.AppendLine(@"AND [usagecosts].[typeA] = tmp.typeA");
x.AppendLine(@"AND [usagecosts].[typeB] = tmp.typeB");
x.AppendLine(@"AND [usagecosts].[vatvalue] = tmp.Vatvalue)");
x.AppendLine(@"When Matched Then ");
x.AppendLine(@" Update Set [usagecosts].[purchasecosts] = [usagecosts].[purchasecosts] + @purchasecosts,");
x.AppendLine(@" [usagecosts].[retailcosts] = [usagecosts].[retailcosts] + @retailcosts");
x.AppendLine(@"When Not Matched Then");
x.AppendLine(@" Insert (InvoicePeriod, CustomerContractId, typea, typeb, vatvalue, purchasecosts, retailcosts)");
x.AppendLine(@" Values (@invoiceperiod, @CustomerContractId, @TypeA, @TypeB, @VatValue, @PurchaseCosts, @RetailCosts);");
x.AppendLine(@"end");
context.Database.ExecuteSqlCommand(x.ToString());
}
}
The hello world example can be found here on Whosebug
StringBuilder 的方法也可以在 Whosebug 的某个地方找到，可惜我找不到。
在创建数据库期间调用 DatabaseInitializer.Seed(...)。此处命令上下文执行 SQL 语句。这个语句是一个字符串。 这就是为什么编译器不会注意到函数参数名称或类型的变化。
DbMigration 方法
有关迁移，请参阅：
想法是让 visual studio 包管理器创建 DbManager 的派生 class，它具有 Up() 函数。每当数据库向上迁移到派生 class.
的版本时，都会调用此函数在 Up() 中你可以调用基数 class DbMigration.CreateStoredProcedure。这种方法的好处是从实体类型到参数的转换是使用委托（使用 lambda 表达式）完成的，因此在编译时检查：属性是否仍然存在并且它们是否具有正确的类型？
唉，从 DbMigration 构造派生的 class 并从您的 Seed() 函数中调用 Up() 函数是不够的。
要确保调用 Up() 函数，最简单的方法是让 visual studio 执行此操作。
- 创建您的项目
- 为 entity framework 添加 Nuget 包
- 使用实体 classes 的 DbSet 属性创建实体 classes 和 DbContext
- 在 visual studio 中，通过“工具”菜单启动 Nuget 包管理器控制台
- 使用 Nuget 包管理器控制台使用命令启用迁移 Enable-Migrations
- 使用 Nuget 程序包管理器控制台添加一个迁移并为其命名，例如 InitialCreation 使用命令 add-Migration InitialCreation
您会注意到有几个 class 已添加到您的项目中。
- Configuration 从具有函数 Seed() 的 DbMigratinConfiguration 派生
- InitialCreation 派生自 DbMigration，带有一个函数 Up()（和一个函数 Down()）。在这个 Up 中，您将看到一个或多个 CreateTable 函数
如果您仍然有一个数据库播种器 class，如前例所述，并且您使用 DataBase.SetInitializer 对其进行初始化，那么每当需要重新创建数据库时，各种 Up( ) 和 Seed() 函数按以下顺序调用：
- 配置构造函数
- InitialCreation.Up()
- DatabaseSeeder.Seed()
由于某些原因 Configuration.Seed() 未被调用。
这让我们有机会在 InitialCraeation.Up()
中创建存储过程public override void Up()
{
CreateTable("dbo.UsageCosts",
c => new
{
Id = c.Int(nullable: false, identity: true),
InvoicePeriod = c.DateTime(nullable: false),
CustomerContractId = c.Long(nullable: false),
TypeA = c.String(),
TypeB = c.String(),
VatValue = c.Decimal(nullable: false, precision: 18, scale: 2),
PurchaseCosts = c.Decimal(nullable: false, precision: 18, scale: 2),
RetailCosts = c.Decimal(nullable: false, precision: 18, scale: 2),
})
.PrimaryKey(t => t.Id);
}
“Hello World”存储过程创建如下：
base.CreateStoredProcedure("dbo.HelloWorld3", "begin Select 'Hello World' end;");
输入参数的存储过程：
base.CreateStoredProcedure("dbo.update2", p => new
{
InvoicePeriod = p.DateTime(),
CustomerContractId = p.Long(),
TypeA = p.String(maxLength: 80),
TypeB = p.String(maxLength: 80),
VatValue = p.Decimal(10, 8),
PurchaseCosts = p.Decimal(10, 8),
RetailCosts = p.Decimal(10, 8),
},
@"begin
Merge [usagecosts]
Using (Select
@InvoicePeriod as invoicePeriod,
@CustomerContractId as customercontractId,
@TypeA as typeA,
@TypeB as typeB,
@VatValue as vatvalue)
As tmp
On ([usagecosts].[invoiceperiod] = tmp.invoiceperiod
AND [usagecosts].[customercontractId] = tmp.customercontractid
AND [usagecosts].[typeA] = tmp.typeA
AND [usagecosts].[typeB] = tmp.typeB
AND [usagecosts].[vatvalue] = tmp.Vatvalue)
When Matched Then
Update Set [usagecosts].[purchasecosts] = [usagecosts].[purchasecosts] + @purchasecosts, [usagecosts].[retailcosts] = [usagecosts].[retailcosts] + @retailcosts
When Not Matched Then
Insert (InvoicePeriod, CustomerContractId, typea, typeb, vatvalue, purchasecosts, retailcosts)
Values (@invoiceperiod, @CustomerContractId, @TypeA, @TypeB, @VatValue, @PurchaseCosts, @RetailCosts);
end;");
}
记住Down()方法：
public override void Down()
{
this.DropStoredProcedure("dbo.update2");
}
为了完整性：远程过程调用
using (var dbContext = new DemoContext())
{
object[] functionParameters = new object[]
{
new SqlParameter(@"InvoicePeriod", usageCosts.InvoicePeriod),
new SqlParameter(@"CustomerContractId", usageCosts.CustomerContractId),
new SqlParameter(@"TypeA", usageCosts.TypeA),
new SqlParameter(@"TypeB", usageCosts.TypeB),
new SqlParameter(@"VatValue", usageCosts.VatValue),
new SqlParameter(@"PurchaseCosts", 20M),
new SqlParameter(@"RetailCosts", 30M),
};
string sqlCommand = String.Format(@"Exec {0} @InvoicePeriod, @CustomerContractId, @TypeA, @TypeB, @VatValue, @PurchaseCosts, @RetailCosts", functionName);
dbContext.Database.ExecuteSqlCommand(sqlCommand, functionParameters);
dbContext.SaveChanges();
}
我认为最好将它放在 DbSet 的扩展方法中。只要 UsageCosts 发生变化，编译器就可以检查名称和 属性 类型。