淺談 EF CORE 遷移和實例化的幾種方式

出於學習和測試的簡單須要，使用 Console 來做爲 EF CORE 的承載程序是最合適不過的。今天筆者就將平時的幾種使用方式總結成文，以供參考，同時也是給本人一個溫故知新的機會。由於沒有一個完整的脈絡，因此也只是想起什麼寫點什麼，不通順的地方還請多多諒解。

本文對象數據庫默認爲 VS 自帶的 LocalDB

1. Normal & Simple

先介紹一種最簡單的構建方式，人人都會。

• 新建 Console 應用程序，命名自定

• 安裝相關Nuget 包

//Sql Server Database Provider
Install-Package Microsoft.EntityFrameworkCore.SqlServer
    
//提供熟悉的Add-Migration，Update-Database等Powershell命令，不區分關係型數據庫類型
Install-Package Microsoft.EntityFrameworkCore.Tools

• 自定義 DbContext

public class MyContext:DbContext
{
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=ConsoleApp;Trusted_Connection=True;MultipleActiveResultSets=true;");
    }
}

• 執行遷移和更新命令

Add-Migration Initialize
Update-Database

• 使用方式

using (var context = new MyContext())
{
    // TODO
}

剛以上，咱們便見識到了了一種最日常也是最簡單的使用方式，接下來，讓咱們用其餘方式去慢慢地改造它，從而儘量地接觸更多的用法。

2. Level Up

2.1 準備工做

將第一步生成的數據庫，遷移文件和使用方式內容所有刪除。

2.2 更新 MyContext 內容

刪除 MyContext 中的 OnConfiguring 方法及其內容，增長含有 DbContextOptions 類型參數的構造器，咱們的MyContext看起來應該是下面這個樣子。

public class MyContext : DbContext
{
    public MyContext(DbContextOptions options) : base(options)
    {
    }
}

假如咱們此時仍然再執行遷移命令，VS將提示如下錯誤

No parameterless constructor was found on 'MyContext'. Either add a parameterless constructor to 'MyContext' or add an implementation of 'IDbContextFactory ' in the same assembly as 'MyContext'.

添加無參構造器的方式以後再講解，先來按照提示信息添加一個 IDbContextFactory 的實現類。

public class MyContextFactory : IDbContextFactory<MyContext>
{
    public MyContext Create(DbContextFactoryOptions options)
    {
        var optionsBuilder = new DbContextOptionsBuilder<MyContext>();
        optionsBuilder.UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=ConsoleApp;Trusted_Connection=True;MultipleActiveResultSets=true;");
            
        return new MyContext(optionsBuilder.Options);
    }
}

以後再次運行遷移和更新數據庫的命令也是水到渠成。

2.3 使用方式：構造器實例化

既然 MyContext 含有 DbContextOptions 類型參數的構造器，那就手動建立一個參數實例注入便可。

var contextOptionsBuilder = new DbContextOptionsBuilder<MyContext>();
contextOptionsBuilder.UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=ConsoleApp;Trusted_Connection=True;MultipleActiveResultSets=true;");

// 注入配置選項
using (var context = new MyContext(contextOptionsBuilder.Options))
{
    // TODO
}

經此，咱們知道了遷移命令會檢測 Context 的相關配置入口，只有在知足存在 OnConfiguring 方法或者存在自建 IDbContextFactory 實現類的狀況下，命令才能成功運行。

3. Day Day Up

目前爲止，咱們已經知道如何手動遷移和實例化 Context 的步驟了因此讓咱們更進一步。寫過 ASP.NET CORE 的人可能知道在 ASP.NET CORE 中，Context 經常以依賴注入的方式引入到咱們的 Web 層，Service 層，或者 XXCore 層中（話說筆者最近最喜歡的解決方案開發架構就是僞 DDD 的四層架構，有空再介紹吧）。其實在 Console 應用中，這也能夠很容易實現，具體的依賴注入引入能夠參考筆者的上一篇博客，因此最終的代碼效果以下：

var serviceCollection = new ServiceCollection();
serviceCollection.AddDbContext<MyContext>(c =>
{
    c.UseSqlServer("Server=(localdb)\\mssqllocaldb;Database=ConsoleApp;Trusted_Connection=True;MultipleActiveResultSets=true;");
});

var serviceProvider = serviceCollection.BuildServiceProvider();

using (var context = serviceProvider.GetService<MyContext>())
{
    //context.Database.Migrate();
}

至此，咱們便基本完成了本文的主題，惟一有些美中不足的是咱們的數據庫鏈接字符串好像處處都是，這不是什麼大問題，筆者直接將 Configuration 的配置代碼貼在下面，這也是 ABP 中的方式。

public class AppConfigurations
{
    private static readonly ConcurrentDictionary<string, IConfigurationRoot> ConfigurationCache;

    static AppConfigurations()
    {
        ConfigurationCache = new ConcurrentDictionary<string, IConfigurationRoot>();
    }

    public static IConfigurationRoot Get(string environmentName = null)
    {
        var cacheKey = "#" + environmentName;
        return ConfigurationCache.GetOrAdd(
            cacheKey,
            _ => BuildConfiguration(environmentName)
        );
    }

    private static IConfigurationRoot BuildConfiguration(string environmentName = null)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(Directory.GetCurrentDirectory())
            .AddJsonFile("appsettings.json", true, true);

        if (!string.IsNullOrWhiteSpace(environmentName))
            builder = builder.AddJsonFile($"appsettings.{environmentName}.json", true);

        builder = builder.AddEnvironmentVariables();

        return builder.Build();
    }
}

這個工具類的使用方式就再也不贅述了。

4. 結尾

最後，想必會有人問爲何要折騰這樣一個小小的 Console 應用呢？其實經過這樣一步步下來，咱們能夠發現一些項目功能上的亮點，好比既然能夠自配置 DbContext 的 Option 選項，同時咱們也知道了如何在類庫和 Console 項目中添加依賴注入以及 Configuration 提取連接參數的功能，那針對三層架構或是 DDD 項目增長含真實數據庫或是內存數據庫（InMemory）的單元測試，或者是自動Migrate Context 和更新數據庫也將是十分簡單的一件事，至少看起來會比官方的示例更加真實和具備可操做性。而這部份內容筆者也將會在以後的博文中給出。

個人博客即將搬運同步至騰訊雲+社區，邀請你們一同入駐：https://cloud.tencent.com/developer/support-plan