![](/img/trans.png)
[英]Add manual DbSet to Partial class DbContext EntityFramework
[英]How to extend DbContext with partial class and partial OnModelCreating method in EntityFramework Core
我正在使用 EF Core 和 DatabaseFirst 方法。 我的 dbContext 是由Scaffold-DbContext
命令自动创建的。
我需要将一些新的 DbSet 添加到 dbContext 中,并将一些额外的代码添加到OnModelCreating
方法中,但是在每个脚手架之后,添加的代码都被删除了,我每次都必须再次添加它。
我想要做的是创建另一个部分 dbContext 类并将protected override void OnModelCreating(ModelBuilder modelBuilder)
方法标记为部分
但得到错误:
部分方法不能有访问修饰符或 virtual、abstract、override、new、sealed 或 extern 修饰符。
分部方法可能没有多个实现声明
这是一个伪代码:
MyDbContext1.cs
- 由Scaffold-DbContext
生成
public partial class MyDbContext : DbContext
{
public MyDbContext()
{
}
public MyDbContext(DbContextOptions<MyDbContext> options)
: base(options)
{
}
public virtual DbSet<Client> Clients { get; set; }
protected override partial void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Client>(entity =>
{
// some code ...
}
}
}
MyDbContext2.cs
- 我每次在搭建脚手架后都将这段代码添加到 dbContext 中:
public partial class MyDbContext
{
public virtual DbSet<JustAnotherEntity> AnotherEntity { get; set; }
protected override partial void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<JustAnotherEntity>(entity =>
{
entity.HasKey(e => new {e.Id, e.IdAction, e.IdState})
.ForSqlServerIsClustered(false);
});
}
}
您现在可以在像这样的OnModelCreatingPartial
类中实现OnModelCreatingPartial
。 注意class 和 method上的partial
关键字:
public partial class RRStoreContext : DbContext
{
partial void OnModelCreatingPartial(ModelBuilder builder)
{
builder.Entity<RepeatOrderSummaryView>().HasNoKey();
}
}
如果您查看生成的上下文文件 - 就在OnModelCreating(...)
最后,您会看到...
OnModelCreatingPartial(modelBuilder);
注意:我使用脚手架,但我需要为存储过程手动添加HasNoKey
(使用未以其他方式脚手架的自定义返回类型)。
另一种方法是创建另一个从 MyDbContext 继承的上下文类,它实际上包含所有自定义代码。 然后使用这个新类作为你的上下文。 这样,就不需要更新生成的代码。
public class MyDbContext2 : MyDbContext
{
public MyDbContext2()
{
}
public MyDbContext2(DbContextOptions<MyDbContext> options)
: base(options)
{
}
public virtual DbSet<JustAnotherEntity> AnotherEntity { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
modelBuilder.Entity<JustAnotherEntity>(entity =>
{
entity.HasKey(e => new {e.Id, e.IdAction, e.IdState})
.ForSqlServerIsClustered(false);
});
}
}
您不能覆盖分部类中的方法,因为所有“部分”都成为一个类。 但是您可以通过让主 OnModelCreating 调用部分方法来实现这一点。 像这样:
public partial class Db : DbContext
{
partial void OnModelCreating2(ModelBuilder modelBuilder)
{
//additional config
}
}
public partial class Db : DbContext
{
public DbSet<Person> Persons { get; set; }
partial void OnModelCreating2(ModelBuilder modelBuilder);
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
OnModelCreating2(modelBuilder);
}
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseSqlServer("Server=localhost;database=efcore2test;integrated security=true");
base.OnConfiguring(optionsBuilder);
}
}
分部类的目的是您可以创建另一个同名的分部类。 您可以在此处利用部分类的好处。
创建另一个与“MyDbContext”同名的类,但设置不同的文件名,例如“MyCustomDbContext”。
public partial class MyDbContext
{
partial void OnModelCreatingPartial(ModelBuilder modelBuilder){
// Right your custom code here
}
}
现在,无论何时您再次生成模型,它都不会重写您的自定义上下文类。
可以通过以下方式使用部分方法:
public partial class MyDbContext : DbContext
{
public MyDbContext()
{
}
public MyDbContext(DbContextOptions<MyDbContext> options)
: base(options)
{
}
...
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
OnModelCreatingPartial(modelBuilder);
}
partial void OnModelCreatingPartial(ModelBuilder modelBuilder);
}
这实际上是由 EF Core Power Tools 生成的:
https://marketplace.visualstudio.com/items?itemName=ErikEJ.EFCorePowerTools
鉴于自动生成的 DbContext 准备了一个未完全实现的方法,您可以自己在另一个文件的其他地方轻松实现它:
public partial class MyDbContext : DbContext
partial void OnModelCreatingPartial(ModelBuilder modelBuilder)
{
// Your own stuff here!
}
}
当然,上面要求您为生成的部分方法提供“模板”(就像这个工具一样)。 否则,您需要控制代码并能够在生成的类中修改几行代码。
有关如何使用部分方法的更多信息:
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.