[EF Core]设计时DbContext

[文章内容来源于Microsoft Doc ]

　　某些EF Core 工具命令（如迁移）需要在设计时创建一个派生DbContext实例，以便收集有关该应用程序的实体类型及其如何映射到数据库架构的详细信息。 

设计时 DbContext 配置

配置 DbContextOptions

　　DbContext 必须具有 DbContextOptions 的实例才能执行工作。

　　DbContextOptions实例包含如下配置：

1. 数据库提供程序 ，通常通过调用方法（UseSqlServer或者UseSqlite）进行选择。
2. 必须的数据库实例连接字符串或标识符，通常通过参数传递到上面的提供者选择方法。
3. 提供程序级别的可选行为选择器。
4. EF Core 行为选择器

配置示例如下：

?

1 2 3

optionsBuilder     .UseSqlServer(connectionString, providerOptions=>providerOptions.CommandTimeout(60))     .UseQueryTrackingBehavior(QueryTrackingBehavior.NoTracking);

配置DbContextOptions根据DbContext的构造函数有没有参数分两种类型：构造函数传参设置，重写OnConfiguring方法设置。

• 构造函数参数

有参构造函数，利用参数将DbContextOptions传递到DbContext

public class BloggingContext : DbContext
{
    public BloggingContext(DbContextOptions<BloggingContext> options)
        : base(options)
    { }

    public DbSet<Blog> Blogs { get; set; }
}

• OnConfiguring

无参构造函数，重写OnConfiguring方法。

public class BloggingContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlite("Data Source=blog.db");
    }
}

 

设计时 DbContext 创建

　　迁移工具有多种方式创建设计时DbContext:

1. 从应用程序服务创建。
2. 使用不带参数的构造函数创建。
3. 从设计时工厂创建。

 

• 从应用程序服务创建

 

　　如果启动项目使用ASP.NET Core Web 主机或.Net Core 泛型主机，则这些工具将尝试从应用程序的服务提供程序获取 DbContext 对象。

工具首先尝试通过调用Program.CreateHostBuilder()、调用Build()，然后访问Services属性来获取服务提供程序。DbContext及其构造函数中的任何依赖项都需要在应用程序的服务提供程序中注册为服务。

　　

public class Program
{
    public static void Main(string[] args)
        => CreateHostBuilder(args).Build().Run();

    // EF Core uses this method at design time to access the DbContext
    public static IHostBuilder CreateHostBuilder(string[] args)
        => Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(
                webBuilder => webBuilder.UseStartup<Startup>());
}

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
        => services.AddDbContext<ApplicationDbContext>();
}

public class ApplicationDbContext : DbContext
{
    public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options)
        : base(options)
    {
    }
}

• 使用不带参数的构造函数创建

 　　如果无法从应用程序服务提供程序获得 DbContext，则工具将查找项目中的DbContext派生类型。 然后，它们尝试使用不带参数的构造函数创建实例。该方式需要DbContext重写OnConfiguring方法，在该方法中配置DbContextOptions。

• 从设计时工厂创建

　　通过实现IDesignTimeDbContextFactory<TContext>接口来告诉工具如何创建 DbContext：如果在与派生DbContext的项目相同的项目中或在应用程序的启动项目中找到了实现此接口的类，则这些工具将绕过创建 DbContext 的其他方法并改用设计时工厂。如果需要以不同于运行时的方式配置 DbContext 的设计时， DbContext则设计时工厂特别有用。

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.EntityFrameworkCore.Infrastructure;

namespace MyProject
{
    public class BloggingContextFactory : IDesignTimeDbContextFactory<BloggingContext>
    {
        public BloggingContext CreateDbContext(string[] args)
        {
            var optionsBuilder = new DbContextOptionsBuilder<BloggingContext>();
            optionsBuilder.UseSqlite("Data Source=blog.db");

            return new BloggingContext(optionsBuilder.Options);
        }
    }
}