【ASP.NET】Database用プロジェクトのみでマイグレーションを実行したい #ASP.NET

はじめに

本記事は「ASP.NET MVCにデータベースを接続する」の派生記事です。本記事内でのコードは元記事で記載したものがベースとなっています。

実現したいこと

多くの記事ではアプリケーション側の依存性注入でマイグレーションを行う手法が採られているようですが、複数アプリケーションを用意する場合などはDatabase用プロジェクトで完結させることが望ましい場合もあります。

そこで、いろいろと試行錯誤して上手くいく方法を考えてみました。先行事例やより良い手法があれば、コメントいただければ幸いです。

本記事の全体像は以下画像のようになります。

Entity Framework Core ToolsをDatabaseプロジェクトのみにインストール

「Entity Framework Core Tools」はマイグレーション実行時のスタートアッププロジェクトに指定されたプロジェクトで必要になるため、「Database」プロジェクトのみにインストールします。

接続文字列をDatabaseプロジェクト内の設定ファイルに定義

対象Contextの接続文字列が固定である場合、各アプリケーション内に別々に定義するのではなくDatabaseプロジェクトに独自の設定ファイルを作成し、このファイルに定義します。（設定ファイル名は任意）

なお、独自ファイルを作成した場合は実行フォルダ内に含める設定を明示的に行う必要があるため、プロパティ内の「出力ディレクトリにコピー」を「新しい場合はコピーする」または「常にコピーする」に設定します。
※今回の追加ファイルは動的に変更されるものではないため「新しい場合はコピーする」で問題ありません。

コンテキストクラスで接続文字列を直接受け取る

Databaseプロジェクトで設定ファイルの読み取りを行うため、Webプロジェクトでは依存関係により同梱されていた以下2パッケージを、NugetでDatabaseプロジェクトに対してインストールする必要があります。

Microsoft.Extensions.Configuration
Microsoft.Extensions.Configuration.Json

コンテキストクラスの OnConfiguring メソッド内に設定値の取得処理と接続文字列設定処理を追加します。
なお、設定ファイルの取得で Path.GetFullPath ~ としている理由は、マイグレーション以外の場合には別プロジェクトの設定ファイルを参照するという処理になり、明示的にDatabaseプロジェクトの設定ファイルを読み込む必要があるためです。

例．WebプロジェクトでDBアクセスを行うと、Directory.GetCurrentDirectory();ではWebの実行ファイルのパスが返却され、Web配下に設定ファイルがないとして例外が発生する。

GourmetDbContext

  using Database.Entities;
  using Microsoft.EntityFrameworkCore;
+ using Microsoft.Extensions.Configuration;

  namespace Database
  {
      public class GourmetDbContext : DbContext
      {
-         // 依存性の注入用コンストラクタ
-         public GourmetDbContext(DbContextOptions<GourmetDbContext> options) : base(options) { }
-
           // エンティティ定義（作成したエンティティと名前が揃うように設定）
          public DbSet<Gourmet> Gourmet { get; set; }
          public DbSet<Prefecture> Prefecture { get; set; }

+         protected override void OnConfiguring(DbContextOptionsBuilder options)
+         {
+             /* 起動時の設定など */
+
+             // 設定ファイルから設定値を取得（）
+             var config = new ConfigurationBuilder()
+                 .SetBasePath(Path.GetFullPath(Path.Combine("../", typeof(GourmetDbContext).Namespace!)))
+                 .AddJsonFile("dbconfig.json")
+                 .Build();
+
+             // DBの接続文字列設定
+             options.UseSqlServer(config.GetConnectionString(nameof(GourmetDbContext)));
+         }

          protected override void OnModelCreating(ModelBuilder modelBuilder)
          {
              /* エンティティの追加設定など */
          }
      }
  }

Web側のDI部分での接続文字列設定を削除

コンテキストクラス側で接続文字列の設定を行ったのでコンテキストのDIでは接続文字列設定が不要になります。（AddDbContextの際にDbContextのOnConfiguringが実行されるため、接続文字列が設定できる）
設定ファイルの読み込み処理は必要なければ削除してください。

Program.cs

  var builder = WebApplication.CreateBuilder(args);

- // 設定ファイルから設定値を取得
- var config = new ConfigurationBuilder()
-     .AddJsonFile("appsettings.json")
-     .Build();
-
  // Add services to the container.
  builder.Services.AddControllersWithViews();
- builder.Services.AddDbContext<GourmetDbContext>(options => {
-     options.UseSqlServer(config.GetConnectionString(nameof(GourmetDbContext)));
- });
+ builder.Services.AddDbContext<GourmetDbContext>();

  var app = builder.Build();

  (... 省略 ...)

マイグレーション実行

1．スタートアッププロジェクト、既定のプロジェクトを両方とも「Database」プロジェクトに設定します。

2．Add-Migrationコマンドを入力してマイグレーションを実行

Add-Migration {任意の名前}

3．Update-Databaseコマンドを入力してマイグレーションファイルの内容をDBに反映させる。

Update-Database