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

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

スキャフォールディングを使ってコントローラーとビューを作成すると、コントローラーの中でデータベースの操作を行うコードが生成されますが、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();

～　以下略　～

_ViewImports.cshtmlに情報を追加する

Models/Entity 配下に Empテーブルのモデルが追加されたので、「_ViewImports.cshtml」に追加します。

@using MvcApp3
@using MvcApp3.Models
@using MvcApp3.Models.Entity
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

@using MvcApp3

@using MvcApp3.Models

@using MvcApp3.Models.Entity

@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

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

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

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.Services;

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モデル入門【記事一覧】