パート 4:ASP.NET Core MVC アプリにモデルを追加する

Note

これは、この記事の最新バージョンではありません。 現在のリリースについては、この記事の .NET 11 バージョンを参照してください。

このチュートリアルでは、データベースの映画を管理するためのクラスが追加されます。 これらのクラスは、MVC アプリの "モデル" 部分です。

これらのモデル クラスは、データベースを操作するために Entity Framework Core (EF Core) と共に使用されます。 EF Core は、記述する必要があるデータ アクセス コードを簡略化するオブジェクト関係マッピング (ORM) フレームワークです。

作成されたモデル クラスは、Plain Old CLR Objects の頭文字を取って、POCO クラスと呼ばれます。 POCO クラスには EF Core に対する依存関係はありません。 これらは、データベースに格納されるデータのプロパティのみを定義します。

このチュートリアルでは、まずモデル クラスが作成され、EF Core によってデータベースが作成されます。

データ モデル クラスの追加

Models フォルダーを右クリックし、>追加>クラスの順に選択します。 そのファイルに Movie.cs という名前を付けます。

Models/Movie.cs ファイルを次のコードで更新します。

using System.ComponentModel.DataAnnotations;

namespace MvcMovie.Models;

public class Movie
{
    public int Id { get; set; }
    public string? Title { get; set; }
    [DataType(DataType.Date)]
    public DateTime ReleaseDate { get; set; }
    public string? Genre { get; set; }
    public decimal Price { get; set; }
}

Movie クラスには、データベースで主キー用に必要となる Id フィールドが含まれています。

DataType の ReleaseDate 属性により、データの型 (Date) が指定されます。 この属性を使用する場合:

  • ユーザーは日付フィールドに時刻の情報を入力する必要はありません。
  • 日付のみが表示され、時刻の情報は表示されません。

DataAnnotations については、後のチュートリアルで説明します。

string の後の疑問符は、そのプロパティが Null 許容であることを示します。 詳細については、「null 許容参照型」を参照してください。

NuGet パッケージを追加する

Visual Studioは、必要なパッケージを自動的にインストールします。

コンパイラ エラーのチェックとしてプロジェクトをビルドします。

ムービー ページのスキャフォールディング

スキャフォールディング ツールを使用し、ムービー モデルの Create、Read、Update、Delete の (CRUD) のページを生成します。

ソリューション エクスプローラー で Controllers フォルダーを右クリックし、[新しいスキャフォールド アイテムの追加] を選択します。

新しいスキャフォールディング項目を追加するメニュー項目。

[新しいスキャフォールディング アイテムの追加] ダイアログで次のようにします。

  • 左側のペインで、[インストール済み]>[共通]>[MVC] を選びます。
  • [Entity Framework を使用したビューがある MVC コントローラー] を選択します。
  • [] を選択し、[] を追加します。

[スキャフォールディングの追加] ダイアログ。

[Entity Framework を使用したビューがある MVC コントローラーを追加する] ダイアログを完了します。

  • [モデル クラス] ドロップ ダウンで、 [Movie (MvcMovie.Models)] を選択します。
  • [データ コンテキスト クラス] 行で、[+] (プラス) 記号を選択します。
    • [データ コンテキストの追加] ダイアログで、クラス名 MvcMovie.Data.MvcMovieContext が生成されます。
    • [] を選択し、[] を追加します。
  • Database provider ドロップダウンで、SQL Server を選択します。
  • ビュー と コントローラー名: 既定のままにします。
  • [] を選択し、[] を追加します。

データ コンテキストを追加し、既定値のままにします。

エラー メッセージが表示された場合は、もう一度 [追加] を選択して再試行します。

スキャフォールディングにより、次のパッケージが追加されます。

  • Microsoft.EntityFrameworkCore.SqlServer
  • Microsoft.EntityFrameworkCore.Tools
  • Microsoft.VisualStudio.Web.CodeGeneration.Design

スキャフォールディング機能によって次のものが作成されます。

  • ムービー コントローラー: Controllers/MoviesController.cs
  • Razor [作成]、[削除]、[詳細]、[編集]、[インデックス] ページのビュー ファイル: Views/Movies/*.cshtml
  • データベース コンテキスト クラス: Data/MvcMovieContext.cs

スキャフォールディングによって次が更新されます。

  • 必要なパッケージ参照を MvcMovie.csproj プロジェクト ファイルに挿入します。
  • Program.cs ファイルでデータベース コンテキストを登録します。
  • appsettings.json ファイルにデータベース接続文字列を追加します。

これらのファイルとファイル更新の自動作成は、"スキャフォールディング" と呼ばれます。

データベースが存在しないため、スキャフォールディング ページをまだ使用できません。 アプリを実行し、 [Movie App] リンクを選択すると、 [データベースを開けません] または [そのようなテーブルはありません: Movie] エラー メッセージが表示されます。

アプリをビルドして、エラーがないことを確認します。

初期移行

EF Core 移行機能を使用し、データベースを作成します。 Migrations は、データ モデルに合わせてデータベースを作成および更新する一連のツールです。

Tools メニューから、NuGet パッケージ マネージャー>パッケージ マネージャー Console を選択します。

パッケージ マネージャー コンソール (PMC) で、次のコマンドを入力します。

Add-Migration InitialCreate

  • Add-Migration InitialCreate: Migrations/{timestamp}_InitialCreate.cs マイグレーション ファイルを生成します。 InitialCreate 引数は、移行の名前です。 任意の名前を使用できますが、慣例により、移行を説明する名前が選択されます。 これは最初の移行であるため、生成されたクラスには、データベース スキーマを作成するコードが含まれています。 データベース スキーマは、MvcMovieContext クラスで指定されたモデルに基づきます。

次の警告が表示されますが、これは後の手順で対処します。

エンティティ型 "Movie" の decimal プロパティ "Price" に、ストアの種類が指定されていませんでした。 これにより、値が既定の有効桁数と小数点以下桁数に収まらない場合、自動的に切り捨てられます。 "HasColumnType" を使用して "OnModelCreating" 内のすべての値を格納できる SQL Server の列型を明示的に指定するか、"HasPrecision" を使用して有効桁数と小数点以下桁数を指定するか、"HasConversion" を使用して値コンバーターを構成します。

PMC で、次のコマンドを入力します。

Update-Database

  • Update-Database: 前のコマンドで作成した移行に基づいてデータベースを最新の状態に更新します。 このコマンドにより Up ファイルで Migrations/{time-stamp}_InitialCreate.cs メソッドが実行され、データベースが作成されます。

EF Core 用 PMC ツールの詳細については、「EF Core ツール リファレンス - Visual Studio の PMC」を参照してください。

アプリのテスト

アプリを実行し、 [Movie App] リンクを選択します。

[ムービー アプリ] ビューが表示されているアプリ。

次のような例外が表示された場合、Update-Databaseでコマンドを実行するのを忘れた可能性があります。

SqlException: Cannot open database "MvcMovieContext-1" requested by the login. The login failed.

Note

Price フィールドに小数点のコンマを入力できない場合があります。 小数点にコンマ (",") を使う英語以外のロケール、および英語 (米国) 以外の日付形式で、jQuery 検証をサポートするには、アプリをグローバル化する必要があります。 グローバリゼーションの手順については、このGitHubの問題を参照してください。

生成されたデータベース コンテキスト クラスと登録を調べる

EF Core では、データ アクセスはモデルを利用して実行されます。 モデルはエンティティ クラスと、データベースとのセッションを表すコンテキスト オブジェクトから構成されます。 このコンテキスト オブジェクトにより、データのクエリと保存が可能になります。 データベース コンテキストは、Microsoft から派生します。EntityFrameworkCore.DbContext データ モデルに含めるエンティティを指定します。

スキャフォールディングにより、Data/MvcMovieContext.cs データベース コンテキスト クラスが作成されます。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using MvcMovie.Models;

namespace MvcMovie.Data
{
    public class MvcMovieContext : DbContext
    {
        public MvcMovieContext (DbContextOptions<MvcMovieContext> options)
            : base(options)
        {
        }

        public DbSet<MvcMovie.Models.Movie> Movie { get; set; } = default!;
    }
}

上記のコードによって、データベース内のムービーを表す DbSet<Movie> プロパティが作成されます。

依存関係の挿入

ASP.NET Coreは、dependency インジェクション (DI) を使用して構築されます。 データベース コンテキストなどのサービスは、Program.cs の DI に登録されます。 これらのサービスは、それを必要とするコンポーネントにコンストラクター パラメーターを介して提供されます。

Controllers/MoviesController.cs ファイルでは、コンストラクターが依存性の注入を使って MvcMovieContext データベース コンテキストがコントローラーに挿入されています。 データベース コンテキストは、コントローラーの各 CRUD メソッドで使用されます。

スキャフォールディングによって、Program.cs で次の強調表示されたコードが生成されました。

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDbContext<MvcMovieContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("MvcMovieContext") ?? throw new InvalidOperationException("Connection string 'MvcMovieContext' not found.")));

ASP.NET Core 構成システムは、 "MvcMovieContext" データベースの接続文字列を読み取ります。

生成されたデータベース接続文字列を確認する

スキャフォールディングにより、appsettings.json ファイルに接続文字列が追加されました。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "MvcMovieContext": "Server=(localdb)\\mssqllocaldb;Database=MvcMovieContext-4ebefa10-de29-4dea-b2ad-8a8dc6bcf374;Trusted_Connection=True;MultipleActiveResultSets=true"
  }
}

ローカル開発の場合、ASP.NET Core 構成システムは、ConnectionString ファイルから appsettings.json キーを読み取ります。

InitialCreate クラス

Migrations/{timestamp}_InitialCreate.cs 移行ファイルを調べます。

using System;
using Microsoft.EntityFrameworkCore.Migrations;

#nullable disable

namespace MvcMovie.Migrations
{
    /// <inheritdoc />
    public partial class InitialCreate : Migration
    {
        /// <inheritdoc />
        protected override void Up(MigrationBuilder migrationBuilder)
        {
            migrationBuilder.CreateTable(
                name: "Movie",
                columns: table => new
                {
                    Id = table.Column<int>(type: "int", nullable: false)
                        .Annotation("SqlServer:Identity", "1, 1"),
                    Title = table.Column<string>(type: "nvarchar(max)", nullable: true),
                    ReleaseDate = table.Column<DateTime>(type: "datetime2", nullable: false),
                    Genre = table.Column<string>(type: "nvarchar(max)", nullable: true),
                    Price = table.Column<decimal>(type: "decimal(18,2)", nullable: false)
                },
                constraints: table =>
                {
                    table.PrimaryKey("PK_Movie", x => x.Id);
                });
        }

        /// <inheritdoc />
        protected override void Down(MigrationBuilder migrationBuilder)
        {
            migrationBuilder.DropTable(
                name: "Movie");
        }
    }
}

上のコードでは以下の操作が行われます。

  • InitialCreate.Up は Movie テーブルを作成し、Id を主キーとして設定します。
  • InitialCreate.Down は、Up マイグレーションによって行われたスキーマの変更を元に戻します。

コントローラーへの依存性注入

Controllers/MoviesController.cs ファイルを開いて、コンストラクターを調べます。

public class MoviesController : Controller
{
    private readonly MvcMovieContext _context;

    public MoviesController(MvcMovieContext context)
    {
        _context = context;
    }

コンストラクターでは、依存性の注入を使ってデータベース コンテキスト (MvcMovieContext) がコントローラーに挿入されています。 データベース コンテキストは、コントローラーの各 CRUD メソッドで使用されます。

Create ページをテストします。 データを入力して送信します。

[編集] 、 [詳細] 、 [削除] の各ページをテストします。

厳密に型指定されたモデルと @model ディレクティブ

コントローラーで ViewData ディクショナリを使ってビューにデータまたはオブジェクトを渡す方法を前に示しました。 ViewData ディクショナリは動的オブジェクトであり、ビューに情報を渡すための便利な遅延バインディングの方法を提供します。

MVC には、厳密に型指定されたモデル オブジェクトをビューに渡す機能があります。 この厳密に型指定された方法では、コンパイル時にコードを確認できます。 スキャフォールディング メカニズムでは、 MoviesController クラスとビューで、型指定されたモデルを渡しました。

Details ファイルで生成された Controllers/MoviesController.cs メソッドを確認します。

// GET: Movies/Details/5
public async Task<IActionResult> Details(int? id)
{
    if (id == null)
    {
        return NotFound();
    }

    var movie = await _context.Movie
        .FirstOrDefaultAsync(m => m.Id == id);
    if (movie == null)
    {
        return NotFound();
    }

    return View(movie);
}

通常、id パラメーターはルート データとして渡されます。 たとえば、https://localhost:{PORT}/movies/details/1 は次のように設定します。

  • コントローラーを movies コントローラーに (最初の URL セグメント)。
  • アクションを details に (2 番目の URL セグメント)。
  • id を 1 に (最後の URL セグメント)。

id は、次の例で示すようにクエリ文字列で渡すことができます。

https://localhost:{PORT}/movies/details?id=1

id 値が指定されていない場合、 パラメーターは int? (null 許容型) として定義されます。

ルート データまたはクエリ文字列の値と一致するムービー エンティティを選択するため、ラムダ式が FirstOrDefaultAsync メソッドに渡されます。

var movie = await _context.Movie
    .FirstOrDefaultAsync(m => m.Id == id);

ムービーが見つかった場合、Movie モデルのインスタンスが Details ビューに渡されます。

return View(movie);

Views/Movies/Details.cshtml ファイルの内容を確認します。

@model MvcMovie.Models.Movie

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

<h1>Details</h1>

<div>
    <h4>Movie</h4>
    <hr />
    <dl class="row">
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Title)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Title)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.ReleaseDate)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.ReleaseDate)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Genre)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Genre)
        </dd>
        <dt class = "col-sm-2">
            @Html.DisplayNameFor(model => model.Price)
        </dt>
        <dd class = "col-sm-10">
            @Html.DisplayFor(model => model.Price)
        </dd>
    </dl>
</div>
<div>
    <a asp-action="Edit" asp-route-id="@Model.Id">Edit</a> |
    <a asp-action="Index">Back to List</a>
</div>

ビュー ファイルの一番上にある @model ステートメントにより、ビューで求められるオブジェクトの型が指定されます。 ムービー コントローラーが作成されたとき、次の @model ステートメントが含まれました。

@model MvcMovie.Models.Movie

この @model ディレクティブにより、コントローラーでビューに渡されたムービーにアクセスできます。 Model オブジェクトは厳密に型指定されます。 たとえば、Details.cshtml ビューでは、コードで厳密に型指定された DisplayNameFor オブジェクトを使って、DisplayFor と Model の HTML ヘルパーに各ムービー フィールドを渡しています。 Create および Edit のメソッドとビューも、Movie モデル オブジェクトを渡します。

Movies コントローラーの Index.cshtml ビューと Index メソッドを確認します。 コードで List メソッドを呼び出すときの View オブジェクトの作成方法に注意してください。 コードでは、この Movies リストを Index アクション メソッドからビューに渡しています。

// GET: Movies
public async Task<IActionResult> Index()
{
    return View(await _context.Movie.ToListAsync());
}

データ コンテキストの プロパティが null の場合、コードはMovieを返します。

ムービー コントローラーが作成されたとき、スキャフォールディングにより、@model ファイルの一番上に次の Index.cshtml ステートメントが含まれました。

@model IEnumerable<MvcMovie.Models.Movie>

@model ディレクティブにより、厳密に型指定された Model オブジェクトを使って、コントローラーがビューに渡したムービーのリストにアクセスできます。 たとえば、Index.cshtml ビューでは、厳密に型指定された Model オブジェクトを foreach ステートメントで処理し、ムービーを順番に取り出します。

@model IEnumerable<MvcMovie.Models.Movie>

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

<h1>Index</h1>

<p>
    <a asp-action="Create">Create New</a>
</p>
<table class="table">
    <thead>
        <tr>
            <th>
                @Html.DisplayNameFor(model => model.Title)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.ReleaseDate)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Genre)
            </th>
            <th>
                @Html.DisplayNameFor(model => model.Price)
            </th>
            <th></th>
        </tr>
    </thead>
    <tbody>
@foreach (var item in Model) {
        <tr>
            <td>
                @Html.DisplayFor(modelItem => item.Title)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.ReleaseDate)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.Genre)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.Price)
            </td>
            <td>
                <a asp-action="Edit" asp-route-id="@item.Id">Edit</a> |
                <a asp-action="Details" asp-route-id="@item.Id">Details</a> |
                <a asp-action="Delete" asp-route-id="@item.Id">Delete</a>
            </td>
        </tr>
}
    </tbody>
</table>

Model オブジェクトは IEnumerable<Movie> オブジェクトとして厳密に型指定されているので、ループ内の各項目は Movie として型指定されます。 それ以外の利点として、コンパイラはコードで使用されている型を検証します。