.NET Core のWebアプリからスキャフォールディングで既存のDBへ接続する

前提条件としてソフトはインストール済み、データベース、テーブルはすでにあるものとして話を進める。

Microsoft Visual Studio Community 2019
SQL Server 2019 Express

この記事では以下の構成のDBを使用して説明する。

プロジェクトの新規作成
「新しいプロジェクトの作成」を選択する。

新しいプロジェクトの作成で「ASP.NET Core Webアプリケーション」を選択する。

「新しいプロジェクトの構成」で以下の項目を入力する。
プロジェクト名：「MyWebApp」
場所：「C:\Source\」
　　※ソリューションルートフォルダが「C:\Source\MyWebApp」となる。
ソリューションとプロジェクトを同じディレクトリに配置する：有効

「Webアプリケーション（モデル ビュー コントローラー）」を選ぶ。

プロジェクトの作成が終わり、

「ソリューションエクスプローラー」を開くとファイルの状態が確認できる。

プロジェクトへのパッケージ追加
メニューバー＞プロジェクト＞NuGetパッケージの管理を選択する。「NuGetパッケージマネージャー」が開く。
「参照」を選び、キーワード入力欄の検索を使って次の3つを探し、画面の指示通りにそれぞれインストールする。

Microsoft.EntityFrameworkCore.Tools
Microsoft.EntityFrameworkCore.Design
Microsoft.EntityFrameworkCore.SqlServer

「NuGetパッケージマネージャー」を閉じる。
「ソリューションエクスプローラー」を開くと追加パッケージの状態が確認できる。
メニューバー＞ファイル＞すべて保存（または、すべてを保存ボタンを押下し）を選択し、ソリューションを保存する。

スキャフォールディングで DbContext を生成する
メニューバー＞表示＞その他のウィンドウ＞パッケージマネージャコンソールを選択する。
「パッケージマネージャコンソール」ウィンドウが開く。
次のコマンドを張り付ける（※文字列部分は各SQLサーバーの環境ごとに書き換える）。

Scaffold-DbContext  "Data Source=localhost\SQLEXPRESS;Initial Catalog=MyTestDB;User ID=****;Password=****" Microsoft.EntityFrameworkCore.SqlServer -Tables "UserTable","DivisionTable" -ContextDir DbContexts -OutputDir "DbContexts/Entities" -Force

オプションの補足説明
-Force 既存のファイル上書き
-Tablesテーブル名を指定。"TableA","TableB",...で複数指定可能。省略すると全テーブルに対して操作する。
-Context DBコンテキストのクラス名を指定すると、任意のDBコンテキストのクラス名を指定可能。省略するとDB名から自動生成。

成功すると、以下のように表示される。

「ソリューションエクスプローラー」から追加されたファイルが確認できる。

先ほどと同じく、一旦すべてのファイルを保存する。

DBの接続情報を追記する
■MyTestDBContext.csを編集する。
OnConfiguringメソッド内の接続情報は不要なので削除する。

■appsettings.jsonを編集する。
次の様に、接続情報を追加する。

キー名は任意。今回はDB名と同一。

"ConnectionStrings": {
    "MyTestDB": "Data Source=localhost\\SQLEXPRESS;Initial Catalog=MyTestDB;User ID=****;Password=****"
}    

■Startup.csを編集する。
ファイル冒頭に参照を追加する。

using Microsoft.EntityFrameworkCore;
using MyWebApp.DbContexts;

ConfigureServicesメソッドに、以下のコードを張り付ける。 キー名はappsettings.jsonで指定したものに書き換える。

services.AddDbContext<MyTestDBContext>(options =>
    options.UseSqlServer(Configuration.GetConnectionString("MyTestDB")));

ここまででDB接続の下準備は終わりです。

コントローラ、ビューを編集する
ここからは各コントローラ、ビューを編集し、DBからデータを取得、表示します。

■Controllers\HomeController.csを編集する。
ファイル冒頭に参照を追加する。

using MyWebApp.DbContexts;

_context変数の宣言をする。

また、既存のコンストラクタに引数を追加し、コンテキストを受け取るようにする。

これにより、このコントローラ内では_contextを使用してDBへアクセスできるようになる。

編集後のコードは次の様になる。

private readonly ILogger<HomeController> _logger;
private readonly MyTestDBContext _context; // 追加

public HomeController(ILogger<HomeController> logger, MyTestDBContext context /*追加*/)
{
    _logger = logger;
    _context = context;  // 追加
}

Indexアクションを編集する。

次のコードを追加し、UserTableからデータを取得する。

var item = _context.UserTable.FirstOrDefault();
if (item != null)
{
    ViewBag.mydata = item.Name;
}

■Views\Home\Index.cshtmlを編集する。
Indexアクションを次の様に書き換え、データを表示する。

<h1>こんにちは@(ViewBag.mydata)さん</h1>

デバッグ実行

ブラウザでデータの取得・表示が確認できる。

参考サイト

https://docs.microsoft.com/ja-jp/ef/core/miscellaneous/cli/powershell
https://docs.microsoft.com/ja-jp/ef/core/miscellaneous/connection-strings
https://docs.microsoft.com/ja-jp/ef/core/miscellaneous/configuring-dbcontext