ASP.NET(C#) MVCモデル入門～コントローラーからDB操作を切り離す

2024年9月10日

データベース操作をコントローラーから切り離す

スキャフォールディングを使ってコントローラーとビューを作成すると、コントローラーの中でデータベースの操作を行うコードが生成されますが、MVC ではデータベースの操作をコントローラーの中で行わないのが一般的です。
今回はデータベースの処理をコントローラーから切り離して、データベースの処理を行うサービスを別途作成します。
作成したサービスは、DI(Dependency Injection)の機能を使って登録します。
DI とはオブジェクトに対して外部から機能を追加する仕組みで、オブジェクトの独立性を高める効果があり、日本語では「依存関係の挿入」とか「依存性の注入」などと訳されます。
ASP.NET では DI が標準で組み込まれており、前回作成したプログラムでも DI の技術が使われています。
DI に関する詳しい内容は、以下のマイクロソフトの公式サイトを参照してください。

ASP.NET Core での依存関係の挿入

新規にプロジェクトを作成する

今回は、新規にプロジェクトを作成し、コントローラーやビューはスキャフォールディングを使わないで、自分で作成することとします。
データベースの内容は、前回の記事で作成した構成で、新規のプロジェクト内に作成します。
今回作成するプロジェクト名は、「MvcApp3」とします。

NuGetパッケージのインストール

今回のプログラムでは、コントローラーとビューの作成にスキャフォールディングは使用しないので、以下の4つのパッケージをインストールします。

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

Microsoft.VisualStudio.Web.CodeGeneration.Design は不要です。

データベースとの接続情報を登録する

NuGetパッケージのインストールが完了したら、データベースに接続するための設定を行います。
ソリューションエクスプローラーの下の方にある「appsettings.json」に、8～10行目の内容を追加します。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "ConnectionStrings": {
    "MvcAppDb": "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=MvcAppDb"
  },
  "AllowedHosts": "*"
}

{

"Logging": {

"LogLevel": {

"Default": "Information",

"Microsoft.AspNetCore": "Warning"

}

"ConnectionStrings": {

"MvcAppDb": "Data Source=(localdb)\\MSSQLLocalDB;Initial Catalog=MvcAppDb"

"AllowedHosts": "*"

}

モデルクラスとDbContextクラスを作成する

メニューバーから「ツール」→「NuGetパッケージマネージャー」→「パッケージマネージャーコンソール」を選択し、パッケージマネージャーコンソールを起動します。
パッケージマネージャーコンソールから以下のスキャフォールディングコマンドを使って、モデルクラスと DbContextクラスを作成します。

Scaffold-DbContext 'Name=ConnectionStrings:MvcAppDb' Microsoft.EntityFrameworkCore.SqlServer -ContextDir Data -OutputDir Models/Entity -NoOnConfiguring

Program.csにデータベース接続情報を追加する

スキャフォールディングコマンドで、「-NoOnConfiguring」オプションを指定したので、「Program.cs」にデータベースの接続情報を追加します。

using Microsoft.EntityFrameworkCore;
using MvcApp3.Data;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllersWithViews();

builder.Services.AddDbContext<MvcAppDbContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("MvcAppDb"))
);

var app = builder.Build();

～　以下略　～

using Microsoft.EntityFrameworkCore;

using MvcApp3.Data;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllersWithViews();

builder.Services.AddDbContext<MvcAppDbContext>(options =>

options.UseSqlServer(builder.Configuration.GetConnectionString("MvcAppDb"))

);

var app = builder.Build();

～　以下略　～

インターフェイスと実装クラスを作成する

データベースの操作をするインターフェイスと実装クラスを新しく作成します。
インターフェイスは、AddScoped()メソッドの型として使用するため必須です。
今回は、プロジェクト直下に「Service」というフォルダーを作成し、そこにインターフェイスと実装クラスを配置します。
インターフェイス名は「IEmpsService.cs」、実装クラス名は「EmpsImpl.cs」とします。

using MvcApp3.Models.Entity;

namespace MvcApp3.Services
{
    public interface IEmpsService
    {
        public Task<List<Emp>> Index();
    }
}

using MvcApp3.Models.Entity;

namespace MvcApp3.Services

{

public interface IEmpsService

{

public Task<List<Emp>> Index();

}

using Microsoft.EntityFrameworkCore;
using MvcApp3.Data;
using MvcApp3.Models.Entity;

namespace MvcApp3.Services
{
    public class EmpsImpl : IEmpsService
    {
        private readonly MvcAppDbContext _context;

        public EmpsImpl(MvcAppDbContext context)
        {
            _context = context;
        }

        public async Task<List<Emp>> Index()
        {
            return await _context.Emps.ToListAsync();
        }
    }
}

using Microsoft.EntityFrameworkCore;

using MvcApp3.Data;

using MvcApp3.Models.Entity;

namespace MvcApp3.Services

{

public class EmpsImpl : IEmpsService

{

private readonly MvcAppDbContext _context;

public EmpsImpl(MvcAppDbContext context)

{

_context = context;

}

public async Task<List<Emp>> Index()

{

return await _context.Emps.ToListAsync();

}

DIコンテナーにサービスを追加する

Program.cs 内の DIコンテナーに、作成したサービスを追加します。
以下のように、Program.cs 内に、Service. AddScoped()メソッドを追加します。

Services.AddScoped<インターフェイス名, 実装クラス>()

using Microsoft.EntityFrameworkCore;
using MvcApp3.Data;
using MvcApp3.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllersWithViews();

builder.Services.AddDbContext<MvcAppDbContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("MvcAppDb"))
);

builder.Services.AddScoped<IEmpsService, EmpsImpl>();

var app = builder.Build();

～　以下略　～

using Microsoft.EntityFrameworkCore;

using MvcApp3.Data;

using MvcApp3.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllersWithViews();

builder.Services.AddDbContext<MvcAppDbContext>(options =>

options.UseSqlServer(builder.Configuration.GetConnectionString("MvcAppDb"))

);

builder.Services.AddScoped<IEmpsService, EmpsImpl>();

var app = builder.Build();

～　以下略　～

AddScoped()メソッドの詳しい内容は、以下のマイクロソフト公式サイトを参照してください。

ServiceCollectionServiceExtensions.AddScoped メソッド

コントローラーとビューを作成する

実際にデータベースの操作を行う実装クラスまで作成したら、次にそれを使うコントローラーとビューを作成します。

using Microsoft.AspNetCore.Mvc;
using MvcApp3.Services;

namespace MvcApp3.Controllers
{
    public class EmpsController : Controller
    {
        private readonly IEmpsService _empsService;

        public EmpsController(IEmpsService empsService)
        {
            _empsService = empsService;
        }

        public async Task<IActionResult> Index()
        {
            return View(await _empsService.Index());
        }
    }
}

using Microsoft.AspNetCore.Mvc;

using MvcApp3.Services;

namespace MvcApp3.Controllers

{

public class EmpsController : Controller

{

private readonly IEmpsService _empsService;

public EmpsController(IEmpsService empsService)

{

_empsService = empsService;

}

public async Task<IActionResult> Index()

{

return View(await _empsService.Index());

}

@model IEnumerable<Emp>

@{
    ViewData["Title"] = "Index";
}

<h1>Index</h1>

<table class="table">
    <thead>
        <tr>
            <th>@Html.DisplayNameFor(model => model.Name)</th>
            <th>@Html.DisplayNameFor(model => model.ZipCode)</th>
            <th>@Html.DisplayNameFor(model => model.Address)</th>
            <th>@Html.DisplayNameFor(model => model.Birthday)</th>
            <th>@Html.DisplayNameFor(model => model.Email)</th>
        </tr>
    </thead>
    <tbody>
        @foreach (var item in Model)
        {
            <tr>
                <td>@Html.DisplayFor(modelItem => item.Name)</td>
                <td>@Html.DisplayFor(modelItem => item.ZipCode)</td>
                <td>@Html.DisplayFor(modelItem => item.Address)</td>
                <td>@Html.DisplayFor(modelItem => item.Birthday)</td>
                <td>@Html.DisplayFor(modelItem => item.Email)</td>
            </tr>
        }
    </tbody>
</table>

@model IEnumerable<Emp>

ViewData["Title"] = "Index";

}

<h1>Index</h1>

<thead>

<tr>

<th>@Html.DisplayNameFor(model => model.Name)</th>

<th>@Html.DisplayNameFor(model => model.ZipCode)</th>

<th>@Html.DisplayNameFor(model => model.Address)</th>

<th>@Html.DisplayNameFor(model => model.Birthday)</th>

<th>@Html.DisplayNameFor(model => model.Email)</th>

</tr>

</thead>

<tbody>

@foreach (var item in Model)

{

<tr>

<td>@Html.DisplayFor(modelItem => item.Name)</td>

<td>@Html.DisplayFor(modelItem => item.ZipCode)</td>

<td>@Html.DisplayFor(modelItem => item.Address)</td>

<td>@Html.DisplayFor(modelItem => item.Birthday)</td>

<td>@Html.DisplayFor(modelItem => item.Email)</td>

</tr>

}

</tbody>

</table>

プログラムを実行する

プログラムを実行して、表示されたホーム画面のアドレスバーに「https://localhost:<ポート番号>/Emps」と入力します。

ポート番号は、環境によって異なります。

データベースの内容を表示する画面に遷移します。

記事一覧

ASP.NET(C#) MVCモデル入門【記事一覧】

-C#, PROGRAM
-C#, mvc

comment コメントをキャンセル

: 初心者のためのbash超入門【第10回配列】

配列の使い方配列を個別に設定する配列に値を設定するには、以下のようにします。添字(そえじ)は配列内の番号を表します。添字は0(ゼロ)から ...

PROGRAM SHELL

bash実践シェルスクリプト【ログバックアップ】

ログをバックアップするシェルスクリプトです。このシェルスクリプトの仕様は、以下のようになります。

#!/bin/bash

### 定数
readonly LIST=backup.lst        # バックアップ対象リスト
readonly LOG=backup.log         # バックアップ結果ログ

### 変数
INF_COUNT=0                     # バックアップ成功数
ERR_COUNT=0                     # バックアップ失敗数
YMDHMS=$(date +"%Y%m%d%H%M%S")  # 現在年月日時分秒

### リストファイル確認
if [[ ! -r "$LIST" ]]
then
  echo "ERR [$LIST] リストファイルが存在しない" >> $LOG 2>&1
  exit 1
fi

### リストファイル読み込み
while read target pattern backup option dummy
do
  ### コメントまたは空白の場合は読み飛ばす
  if [[ "$target" == \#* ]] || [[ -z "$target" ]]
  then
    continue
  fi

  ### パラメーター不正
  if [[ "$pattern" == \#* ]] || [[ -z "$pattern" ]] || \
     [[ "$backup"  == \#* ]] || [[ -z "$backup"  ]] || \
     [[ "$option"  == \#* ]] || [[ -z "$option"  ]]
  then
    (( ERR_COUNT++ ))
    echo "ERR [$target][$pattern][$backup][$option] パラメーター不正" >> $LOG 2>&1
    continue
  fi

  ### バックアップ先ディレクトリ確認
  if [[ ! -d "$backup" ]]
  then
    (( ERR_COUNT++ ))
    echo "ERR [$backup] ディレクトリーなし" >> $LOG 2>&1
    continue
  fi

  ### バックアップ対象ファイル取得
  files=$(ls -1 $target/$pattern 2>/dev/null)

  ### 該当ファイルチェック
  if [[ -z "$files" ]]
  then
    echo "WAR [$target/$pattern] 該当ファイルなし" >> $LOG 2>&1
    continue
  fi

  ### オプション毎のコマンドを作成
  for buf in $files
  do
    case "$option" in
      c)  # コピーのみ
        cmd_cpy="/bin/cp -p $buf $backup/$(basename $buf).$YMDHMS"
        cmd_del=""
        ;;
      d)  # コピー後に削除
        cmd_cpy="/bin/cp -p $buf $backup/$(basename $buf).$YMDHMS"
        cmd_del="/bin/rm -f $buf"
        ;;
      *)  # オプション不正
        (( ERR_COUNT++ ))
        echo "ERR [$target/$pattern][$option] オプション不正" >> $LOG 2>&1
        break
        ;;
    esac

    ### バックアップコマンド実行
    $cmd_cpy > /dev/null 2>&1
    if (( $? == 0 ))
    then
      (( INF_COUNT++ ))
      echo "INF CPY $buf" >> $LOG 2>&1

      ### 削除コマンド確認
      if [[ -z "$cmd_del" ]]
      then
        continue
      fi

      ### 削除コマンド実行
      $cmd_del > /dev/null 2>&1
      if (( $? == 0 ))
      then
        echo "INF DEL $buf" >> $LOG 2>&1
      else
        (( ERR_COUNT++ ))
        echo "ERR DEL $buf" >> $LOG 2>&1
      fi
    else
      (( ERR_COUNT++ ))
      echo "ERR CPY $buf" >> $LOG 2>&1
    fi
  done
done < "$LIST"

### 総合エラーチェック
echo "INF バックアップ数=[$INF_COUNT] バックアップエラー数=[$ERR_COUNT]" >> $LOG 2>&1

### 終了処理
if (( ERR_COUNT == 0 ))
then
  exit 0
else
  exit 1
fi

100

101

102

103

104

105

106

107

108

109

110

111

112

113

#!/bin/bash

### 定数

readonly LIST=backup.lst # バックアップ対象リスト

readonly LOG=backup.log # バックアップ結果ログ

### 変数

INF_COUNT=0 # バックアップ成功数

ERR_COUNT=0 # バックアップ失敗数

YMDHMS=$(date +"%Y%m%d%H%M%S") # 現在年月日時分秒

### リストファイル確認

if [[ ! -r "$LIST" ]]

then

echo "ERR [$LIST] リストファイルが存在しない" >> $LOG 2>&1

exit 1

### リストファイル読み込み

while read target pattern backup option dummy

### コメントまたは空白の場合は読み飛ばす

if [[ "$target" == \#* ]] || [[ -z "$target" ]]

then

continue

### パラメーター不正

if [[ "$pattern" == \#* ]] || [[ -z "$pattern" ]] || \

[[ "$backup" == \#* ]] || [[ -z "$backup" ]] || \

[[ "$option" == \#* ]] || [[ -z "$option" ]]

then

(( ERR_COUNT++ ))

echo "ERR [$target][$pattern][$backup][$option] パラメーター不正" >> $LOG 2>&1

continue

### バックアップ先ディレクトリ確認

if [[ ! -d "$backup" ]]

then

(( ERR_COUNT++ ))

echo "ERR [$backup] ディレクトリーなし" >> $LOG 2>&1

continue

### バックアップ対象ファイル取得

files=$(ls -1 $target/$pattern 2>/dev/null)

### 該当ファイルチェック

if [[ -z "$files" ]]

then

echo "WAR [$target/$pattern] 該当ファイルなし" >> $LOG 2>&1

continue

### オプション毎のコマンドを作成

for buf in $files

case "$option" in

c) # コピーのみ

cmd_cpy="/bin/cp -p $buf $backup/$(basename $buf).$YMDHMS"

cmd_del=""

;;

d) # コピー後に削除

cmd_cpy="/bin/cp -p $buf $backup/$(basename $buf).$YMDHMS"

cmd_del="/bin/rm -f $buf"

;;

*) # オプション不正

(( ERR_COUNT++ ))

echo "ERR [$target/$pattern][$option] オプション不正" >> $LOG 2>&1

break

;;

esac

### バックアップコマンド実行

$cmd_cpy > /dev/null 2>&1

if (( $? == 0 ))

then

(( INF_COUNT++ ))

echo "INF CPY $buf" >> $LOG 2>&1

### 削除コマンド確認

if [[ -z "$cmd_del" ]]

then

continue

### 削除コマンド実行

$cmd_del > /dev/null 2>&1

if (( $? == 0 ))

then

echo "INF DEL $buf" >> $LOG 2>&1

else

(( ERR_COUNT++ ))

echo "ERR DEL $buf" >> $LOG 2>&1

else

(( ERR_COUNT++ ))

echo "ERR CPY $buf" >> $LOG 2>&1

done

done < "$LIST"

### 総合エラーチェック

echo "INF バックアップ数=[$INF_COUNT] バックアップエラー数=[$ERR_COUNT]" >> $LOG 2>&1

### 終了処理

if (( ERR_COUNT == 0 ))

then

exit 0

else

exit 1

メモ 20行目のdu ...

PROGRAM SHELL

: Pythonスクリプト【配布したカードからペアのカードを除外する】

配布したカードの中からペアのカードを除外しよう前回は53枚のカードを3人に配布するプログラムを作成しました。今回は配布したカードの中から同じ数字のカードが2枚あったら除 ...

PROGRAM PYTHON

: Pythonスクリプト【MySQLにリモート接続しよう⑦～平均値】

PythonスクリプトからMySQLのDBのデータの平均値を求めよう今回は新しくテーブルを作成して、そのデータの平均値を取得してみましょう。テーブル名を「tb2」として ...

PROGRAM PYTHON

: Pygame超入門【第4回文字背景色変更】

Pygameを使って文字の背景色を変更しよう前回はPygameを使って文字を表示するところまで説明しました。今回は文字の背景色を一定間隔ごとに変更させてみましょう。 & ...

PROGRAM PYTHON

ASP.NET(C#) MVCモデル入門～データベース接続

ASP.NET(C#) MVCモデル入門～拡張メソッドを使用したサービスのグループ化