002从零开始入门Entity Framework Core——DbContext生存期、配置和初始化

阅读须知：本文为入门介绍、指引文章，所示代码皆为最简易（或仅为实现功能）的演示示例版本，不一定切实符合个人（企业）实际开发需求。

一、DbContext生存期

DbContext 的生存期从创建实例时开始，并在释放实例时结束。 DbContext 实例旨在用于单个工作单元。这意味着 DbContext 实例的生存期通常很短。

使用 Entity Framework Core (EF Core) 时的典型工作单元包括：

• 创建 DbContext 实例
• 根据上下文跟踪实体实例。 实体将在以下情况下被跟踪
  • 正在从查询返回
  • 正在添加或附加到上下文
• 根据需要对所跟踪的实体进行更改以实现业务规则
• 调用 SaveChanges 或 SaveChangesAsync。 EF Core 检测所做的更改，并将这些更改写入数据库
• 释放 DbContext 实例

注意事项：
1、使用后释放 DbContext 非常重要。这可确保释放所有非托管资源，并注销任何事件或其他挂钩，以防止在实例保持引用时出现内存泄漏。
2、DbContext 不是线程安全的。不要在线程之间共享上下文。请确保在继续使用上下文实例之前，等待所有异步调用。
3、EF Core 代码引发的 InvalidOperationException 可以使上下文进入不可恢复的状态。此类异常指示程序错误，并且不旨在从其中恢复。

二、ASP.NET Core 依赖关系注入中的 DbContext

在许多 Web 应用程序中，每个 HTTP 请求都对应于单个工作单元。这使得上下文生存期与请求的生存期相关，成为 Web 应用程序的一个良好默认值。

使用依赖关系注入配置 ASP.NET Core 应用程序。可以在 Startup.cs 文件的 ConfigureServices 方法中，用 AddDbContext 扩展方法将 EF Core 添加到此处进行配置。

本文中我使用的是 MySQL 数据库，例如：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    #region 配置MySQL数据库
    var connectionString = "server=数据库部署的服务器地址;user=数据库登录用户名;password=数据库登录密码;database=数据库名;charset=utf8";
    var serverVersion = new MySqlServerVersion(new Version(5, 7, 22));
    services.AddDbContext<CustomAppDbContext>(
        dbContextOptions => dbContextOptions
            .UseMySql(connectionString, serverVersion)
    );
    #endregion
}

此示例将名为 CustomAppDbContext 的 DbContext 子类注册为 ASP.NET Core 应用程序服务提供程序（也称为依赖关系注入容器）中的作用域服务。上下文配置为使用 MySQL 数据库提供程序，并将从 ASP.NET Core 配置读取连接字符串。在 ConfigureServices 中的何处调用 AddDbContext 通常不重要。

F12转到 DbContext 类的定义，发现其有参构造函数定义形式为：

public DbContext([NotNullAttribute] DbContextOptions options);

CustomAppDbContext 类必须公开具有 DbContextOptions<CustomAppDbContext> 参数的公共构造函数。这是将 AddDbContext 的上下文配置传递到 DbContext 的方式。例如：

public class CustomAppDbContext : DbContext
{
    public CustomAppDbContext(DbContextOptions<CustomAppDbContext> options) : base(options)//调用父类的构造函数
    {
    }

    public DbSet<Student> Student { get; set; }
}

其中 Student 类如下所示：

public partial class Student
{
    public string Id { get; set; }
    public string Name { get; set; }
    public DateTime? JoinTime { get; set; }
    public int Sex { get; set; }
}

然后，CustomAppDbContext 可以通过构造函数注入在 ASP.NET Core 控制器或其他服务中使用。例如：

public class MyController : Controller
{
    private readonly CustomAppDbContext _context;

    public MyController(CustomAppDbContext context)//构造函数
    {
        _context = context;
    }

    public JsonResult Index()
    {
        _context.Student.Add(new Student
        {
            Id = "10001",
            Name = "张三",
            JoinTime = DateTime.Now,
            Sex = 1
        });
        _context.SaveChanges();
        return new JsonResult("success");
    }
}

最终结果是为每个请求创建一个 CustomAppDbContext 实例，并传递给控制器，以在请求结束后释放前执行工作单元。

三、使用“new”的简单的 DbContext 初始化

可以按照常规的 .NET 方式构造 DbContext 实例，例如，使用 C# 中的 new。可以通过重写 OnConfiguring 方法或通过将选项传递给构造函数来执行配置。

1、重写 OnConfiguring 方法。

F12转到 DbContext 类的定义，发现 OnConfiguring 方法的定义形式为：

protected internal virtual void OnConfiguring(DbContextOptionsBuilder optionsBuilder);

DbContext 子类的代码示例如下所示：

public class NewCustomAppDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseMySql("server=数据库部署的服务器地址;user=数据库登录用户名;password=数据库登录密码;database=数据库名;charset=utf8", new MySqlServerVersion(new Version(5, 7, 22)));
    }

    public DbSet<Student> Student { get; set; }
}

此种方式构造的 DbContext 实例在控制器方法中调用如下所示：

public class MyNewController : Controller
{
    public string Index()
    {
        using  var db = new NewCustomAppDbContext();
        var list = db.Student.ToList();
        return JsonConvert.SerializeObject(list);
    }
}

2、通过 DbContext 构造函数传递配置

通过此模式，我们还可以轻松地通过 DbContext 构造函数传递配置（如连接字符串）。例如：

public class NewCustomAppDbContext : DbContext
{
    private readonly string _connectionString;

    public NewCustomAppDbContext(string connectionString)
    {
        _connectionString = connectionString;
    }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseMySql(_connectionString, new MySqlServerVersion(new Version(5, 7, 22)));
    }

    public DbSet<Student> Student { get; set; }
}

此种方式构造的 DbContext 实例在控制器方法中调用如下所示：

public class MyNewController : Controller
{
    public string Index()
    {
        using  var db = new NewCustomAppDbContext("server=数据库部署的服务器地址;user=数据库登录用户名;password=数据库登录密码;database=数据库名;charset=utf8");
        var list = db.Student.ToList();
        return JsonConvert.SerializeObject(list);
    }
}

3、使用 DbContextOptionsBuilder 创建 DbContextOptions 对象

可以使用 DbContextOptionsBuilder 创建 DbContextOptions 对象，然后将该对象传递到 DbContext 构造函数。这使得为依赖关系注入配置的 DbContext 也能显式构造。例如：

public class DICustomAppDbContext:DbContext
{
    public DICustomAppDbContext(DbContextOptions<DICustomAppDbContext> optionsBuilder):base(optionsBuilder)
    {
    }

    public DbSet<Student> Student { get; set; }
}

此种构造方式，在 Controller 中可以创建 DbContextOptions，并可以显式调用构造函数，代码如下所示：

public class MyDIController : Controller
{
    private readonly string _connectionString = "server=数据库部署的服务器地址;user=数据库登录用户名;password=数据库登录密码;database=数据库名;charset=utf8";
    private readonly MySqlServerVersion _serverVersion = new MySqlServerVersion(new Version(5, 7, 22));

    public string Index()
    {
        var contextOptions = new DbContextOptionsBuilder<DICustomAppDbContext>()
            .UseMySql(_connectionString, _serverVersion)
            .Options;
        using var context = new DICustomAppDbContext(contextOptions);
        var list = context.Student.ToList();
        return JsonConvert.SerializeObject(list);
    }
}

四、使用 DbContext 工厂

某些应用程序类型（例如 ASP.NET Core Blazor）使用依赖关系注入，但不创建与所需的 DbContext 生存期一致的服务作用域。即使存在这样的对齐方式，应用程序也可能需要在此作用域内执行多个工作单元。例如，单个 HTTP 请求中的多个工作单元。

在这些情况下，可以使用 AddDbContextFactory 来注册工厂以创建 DbContext 实例。例如：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    #region 配置MySQL数据库
    var connectionString = "server=数据库部署的服务器地址;user=数据库登录用户名;password=数据库登录密码;database=数据库名;charset=utf8";
    var serverVersion = new MySqlServerVersion(new Version(5, 7, 22));
    services.AddDbContextFactory<FactoryCustomAppDbContext>(
        dbContextOptions => dbContextOptions
            .UseMySql(connectionString, serverVersion)
    );
    #endregion
}

FactoryCustomAppDbContext 类必须公开具有 DbContextOptions<FactoryCustomAppDbContext> 参数的公共构造函数。此模式与上面传统 ASP.NET Core 部分中使用的模式相同。例如：

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

    public DbSet<Student> Student { get; set; }
}

然后，可以通过构造函数注入在其他服务中使用 DbContextFactory 工厂。最后，可以使用注入的工厂在服务代码中构造 DbContext 实例。例如：

public class MyFactoryController : Controller
{
    private readonly IDbContextFactory<FactoryCustomAppDbContext> _contextFactory;

    public MyFactoryController(IDbContextFactory<FactoryCustomAppDbContext> contextFactory)
    {
        _contextFactory = contextFactory;
    }

    public string Index()
    {
        using (var context = _contextFactory.CreateDbContext())
        {
            var list = context.Student.ToList();
            return JsonConvert.SerializeObject(list);
        }
    }
}

请注意，以这种方式创建的 DbContext 实例并非由应用程序的服务提供程序进行管理，因此必须由应用程序释放。

五、DbContextOptions

所有 DbContext 配置的起始点都是 DbContextOptionsBuilder。可以通过以下三种方式获取此生成器：

1. 在 AddDbContext 和相关方法中
2. 在 OnConfiguring 中
3. 使用 new 显式构造

每种配置方式的示例在本文上述内容中都进行了讲解和代码展示。无论生成器来自何处，都可以应用相同的配置。此外，无论如何构造上下文，都将始终调用 OnConfiguring。这意味着即使使用 AddDbContext，OnConfiguring 也可用于执行其他配置。

六、配置数据库提供程序

每个 DbContext 实例都必须配置为使用一个且仅一个数据库提供程序。（DbContext 子类型的不同实例可用于不同的数据库提供程序，但一个实例只能使用一个。）一个数据库提供程序要使用一个特定的 Use* 调用进行配置。

例如，若要使用 MySQL 数据库提供程序：

public class MySQLAppDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseMySql("数据库连接字符串", new MySqlServerVersion(new Version(5, 7, 22)));
    }
}

例如，若要使用 SQL Server 数据库提供程序：

public class SQLServerApplicationDbContext : DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer("数据库连接字符串");
    }
}

这些 Use* 方法是由数据库提供程序实现的扩展方法。 这意味着必须先安装数据库提供程序 NuGet 包，然后才能使用扩展方法。

EF Core 数据库提供程序广泛使用扩展方法。如果编译器指示找不到方法，请确保已安装提供程序的 NuGet 包，并且在代码中已有 using Microsoft.EntityFrameworkCore;。

下表包含常见数据库提供程序的示例。

数据库系统	配置示例	NuGet 程序包
SQL Server 或 Azure SQL	.UseSqlServer(connectionString)	Microsoft.EntityFrameworkCore.SqlServer
Azure Cosmos DB	.UseCosmos(connectionString, databaseName)	Microsoft.EntityFrameworkCore.Cosmos
SQLite	.UseSqlite(connectionString)	Microsoft.EntityFrameworkCore.Sqlite
EF Core 内存中数据库	.UseInMemoryDatabase(databaseName)	Microsoft.EntityFrameworkCore.InMemory
PostgreSQL	.UseNpgsql(connectionString)	Npgsql.EntityFrameworkCore.PostgreSQL
MySQL/MariaDB	.UseMySql(connectionString)	Pomelo.EntityFrameworkCore.MySql
Oracle	.UseOracle(connectionString)	Oracle.EntityFrameworkCore

六、避免 DbContext 线程处理问题

Entity Framework Core 不支持在同一 DbContext 实例上运行多个并行操作。这包括异步查询的并行执行以及从多个线程进行的任何显式并发使用。因此，始终立即 await 异步调用，或对并行执行的操作使用单独的 DbContext 实例。

当 EF Core 检测到尝试同时使用 DbContext 实例的情况时，你将看到 InvalidOperationException，其中包含类似于以下内容的消息：

A second operation started on this context before a previous operation completed. This is usually caused by different threads using the same instance of DbContext, however instance members are not guaranteed to be thread safe.

翻译成中文就是：

在上一个操作完成之前，在此上下文上启动了第二个操作。这通常是由不同线程使用相同的DbContext实例引起的，但不保证实例成员是线程安全的。

当并发访问未被检测到时，可能会导致未定义的行为、应用程序崩溃和数据损坏。

七、异步操作缺陷

使用异步方法，EF Core 可以启动以非阻挡式访问数据库的操作。但是，如果调用方不等待其中一个方法完成，而是继续对 DbContext 执行其他操作，则 DbContext 的状态可能会（并且很可能会）损坏。

应始终立即等待 EF Core 异步方法。

-------------------------------本篇文章到此结束-------------------------------------