ASP.NET Core MVC の概要

[アーティクル]
11/06/2024

ASP.NET Core MVC は、モデルビューコントローラーデザインパターンを使用して、Web アプリと API をビルドするための豊富なフレームワークです。

MVC パターン

モデルビューコントローラー (MVC) アーキテクチャパターンでは、アプリケーションをモデル、ビュー、コントローラーという 3 つの主要なコンポーネントのグループに分けます。このパターンは、関心の分離を実現するのに役立ちます。このパターンを使用すると、ユーザーの要求が、ユーザーの操作を実行したり、クエリの結果を取得したりするためにモデルを操作する役割がある、コントローラーにルーティングされます。コントローラーでは、ユーザーに表示するビューを選び、必要なモデルデータと共に提供します。

次の図は、3 つの主要なコンポーネントと、どのコンポーネントがどのコンポーネントを参照するかを示しています。

MVC パターン

この責任の概念は、複雑さの観点からアプリケーションを計るために役立ちます。それは、単一のジョブを持つもの (モデル、ビュー、コントローラー) の方がコーディング、デバッグ、およびテストしやすいためです。これらの 3 つの領域の 2 つ以上に依存関係が広がるコードを更新、テスト、デバッグする方が難しいです。たとえば、ユーザーインターフェイスロジックは、ビジネスロジックよりも頻繁に変更される傾向があります。プレゼンテーションコードとビジネスロジックが 1 つのオブジェクトに結合されている場合は、ユーザーインターフェイスを変更するたびに、ビジネスロジックを含むオブジェクトは変更されます。これにより、エラーが発生することが多く、最小限のユーザーインターフェイスの変更後に毎回ビジネスロジックのテストを再実行する必要があります。

注意

ビューとコントローラーは両方ともモデルに依存します。ただし、モデルはビューにもコントローラーにも依存しません。これは、分離の主な利点の 1 つです。この分離によって、モデルをビルドし、視覚表示の独立をテストすることができます。

モデルの責任

MVC アプリケーションのモデルは、アプリケーションの状態、およびアプリケーションによって実行されるビジネスロジックや操作を表します。ビジネスロジックは、アプリケーションの状態を保持するための実装ロジックと共に、モデルにカプセル化される必要があります。通常、厳密に型指定されたビューでは、そのビューに表示するデータを含めるようにデザインされた ViewModel 型を使用します。コントローラーは、モデルからこれらの ViewModel インスタンスを作成します。

ビューの責任

ビューは、ユーザーインターフェイスを介してコンテンツを表示する役割があります。これらでは、Razor ビューエンジンを使用して、HTML マークアップに .NET コードを埋め込んでいます。ビュー内のロジックは最小限にする必要があり、そこに含まれるロジックはすべて、コンテンツの表示に関連する必要があります。複雑なモデルからデータを表示するために、ビューファイルで多くのロジックを実行する必要がある場合、ビューを簡略化するために、ビューのコンポーネント、ViewModel、テンプレートの表示を使用することを検討してください。

コントローラーの責任

コントローラーは、ユーザーの操作を処理し、モデルを操作し、最終的にレンダリングするビューを選択するコンポーネントです。 MVC アプリケーションでは、ビューは情報のみを表示し、コントローラーがユーザーの入力と操作を処理して応答します。 MVC パターンでは、コントローラーは最初のエントリポイントであり、処理するモデルの型およびレンダリングするビューを選択する役割があります (そのため、このような名前で呼ばれており、アプリが指定した要求に応答する方法を制御します)。

注意

コントローラーは責任が非常に多いので、過度に複雑にしないでください。コントローラーロジックが過度に複雑にならないように、ビジネスロジックをコントローラーから排除し、ドメインモデルに含めます。

ヒント

コントローラーのアクションで、頻繁に同じ種類のアクションを実行することがわかった場合、これらの一般的なアクションをフィルターに移動させます。

ASP.NET Core MVC

ASP.NET Core MVC フレームワークは、ASP.NET Core と共に使用するために最適化された、ライトウェイトかつオープンソースのテストしやすいプレゼンテーションフレームワークです。

ASP.NET Core MVC では、明確な関心の分離を可能にする動的な Web サイトをビルドするためのパターンベースの方法を提供します。ここでは、マークアップのフルコントロールが提供され、TDD 向けの開発をサポートし、最新の Web 標準を使用することができます。

ルーティング

ASP.NET Core MVC は、ASP.NET Core のルーティングの上にビルドされます。このルーティングは強力な URL マッピングコンポーネントで、わかりやすく検索可能な URL のアプリケーションをビルドできます。これにより、Web サーバー上のファイルを整理する方法に関係なく、検索エンジンの最適化 (SEO) およびリンクの作成に適しているアプリケーションの URL の名前付けパターンを定義できます。ルート値制約、既定値、省略可能な値をサポートする、便利なルートテンプレートの構文を使用して、ルートを定義できます。

規約に基づくルーティングでは、アプリケーションが受け入れる URL 形式、およびそれらの各形式を指定したコントローラー上の特定のアクションメソッドにマップする方法をグローバルに定義することができます。受信要求を受け取ると、ルーティングエンジンは URL を解析し、定義された URL 形式のいずれかに合わせて、関連するコントローラーのアクションメソッドを呼び出します。

routes.MapRoute(name: "Default", template: "{controller=Home}/{action=Index}/{id?}");

属性のルーティングでは、アプリケーションのルートを定義する属性でコントローラーとアクションを装飾して、ルーティング情報を指定できます。つまり、ルート定義は、関連付けられているコントローラーとアクションの横に配置されるということです。

[Route("api/[controller]")]
public class ProductsController : Controller
{
    [HttpGet("{id}")]
    public IActionResult GetProduct(int id)
    {
      ...
    }
}

モデルバインド

ASP.NET Core MVC のモデルバインドは、クライアント要求データ (フォームの値、ルートデータ、クエリ文字列のパラメーター、HTTP ヘッダー) をコントローラーが処理できるオブジェクトに変換します。その結果、コントローラーロジックは、受信要求データを判断する作業を行う必要はありません。そのアクションメソッドに対するパラメーターとしてデータを持つだけです。

public async Task<IActionResult> Login(LoginViewModel model, string returnUrl = null) { ... }

モデルの検証

ASP.NET Core MVC では、データ注釈の検証属性でモデルオブジェクトを装飾することで、検証をサポートします。検証属性は、値をサーバーにポストする前に、クライアント側でチェックされ、コントローラーアクションが呼び出される前に、サーバー側でチェックされます。

using System.ComponentModel.DataAnnotations;
public class LoginViewModel
{
    [Required]
    [EmailAddress]
    public string Email { get; set; }

    [Required]
    [DataType(DataType.Password)]
    public string Password { get; set; }

    [Display(Name = "Remember me?")]
    public bool RememberMe { get; set; }
}

コントローラーアクション:

public async Task<IActionResult> Login(LoginViewModel model, string returnUrl = null)
{
    if (ModelState.IsValid)
    {
      // work with the model
    }
    // At this point, something failed, redisplay form
    return View(model);
}

フレームワークでは、クライアントとサーバーの両方で要求データの検証を処理します。モデルの型に指定された検証ロジックは、控えめな注釈としてレンダリングされたビューに追加され、jQuery Validation を使ってブラウザーに適用されます。

依存関係の挿入

ASP.NET Core には、依存関係の挿入 (DI) の組み込みのサポートがあります。 ASP.NET Core MVC では、コントローラーは、明示的な依存関係の原則に従うことを許可して、コンストラクターを介して必要なサービスを要求できます。

また、自分のアプリで、@inject ディレクティブを使用して、ビューファイルに依存関係の挿入を使用することもできます。

@inject SomeService ServiceName

<!DOCTYPE html>
<html lang="en">
<head>
    <title>@ServiceName.GetTitle</title>
</head>
<body>
    <h1>@ServiceName.GetTitle</h1>
</body>
</html>

フィルター

フィルターは、開発者が例外処理や承認など、横断的関心事をカプセル化するのに役立ちます。フィルターでは、アクションメソッドの前処理と後処理ロジックを実行できるようにします。また、指定した要求の実行パイプライン内のある時点で実行するように構成することもできます。フィルターは、属性としてコントローラーまたはアクションに適用できます (または、グローバルに実行できます)。いくつかのフィルター (Authorize など) は、フレームワークに含まれます。 [Authorize] は MVC 承認フィルターの作成のために使用される属性です.

[Authorize]
public class AccountController : Controller

Areas

区分は、大きな ASP.NET Core MVC Web アプリを小さな機能グループに分割するための方法を提供します。区分は、アプリケーション内の MVC 構造体となります。 MVC プロジェクトでは、モデル、コントローラー、ビューなどの論理コンポーネントが異なるフォルダーに保持され、MVC では名前付け規則を使用して、これらのコンポーネント間のリレーションシップを作成します。大きなアプリでは、アプリを機能の個別の高レベル区分に分割すると便利な場合があります。たとえば、清算、請求、検索などの複数の事業分野がある eコマースアプリです。これらの各分野に、独自の論理コンポーネントビュー、コントローラー、およびモデルがあります。

Web API

Web サイトのビルドに最適なプラットフォームというだけでなく、ASP.NET Core MVC には Web API のビルドに適したサポートがあります。ブラウザーやモバイルデバイスなど、さまざまなクライアントに提供されるサービスをビルドできます。

フレームワークには、JSON または XML として書式のデータの組み込みサポートと共に、HTTP コンテンツネゴシエーションのサポートが含まれます。カスタムフォーマッタを作成して、独自の書式のサポートを追加します。

リンクの生成を使って、ハイパーメディアのサポートを有効にします。自分の Web API を複数の Web アプリケーション間で共有できるように、クロスオリジンリソース共有 (CORS) のサポートを簡単に有効化します。

Testability

フレームワークでインターフェイスと依存関係の挿入を使用して、単体テストに適するようにします。また、フレームワークには、統合テストもすばやく簡単にする機能 (Entity Framework の TestHost と InMemory プロバイダーなど) が含まれます。詳細については、コントローラーロジックのテスト方法に関するページを参照してください。

Razor ビューエンジン

ASP.NET Core MVC ビューでは、Razor ビューエンジンを使用してビューをレンダリングします。 Razor は、埋め込みの C# コードを使用してビューを定義するコンパクトで豊富な表現がある、流動的なテンプレートのマークアップ言語です。 Razor は、サーバーに Web コンテンツを動的に作成するために使用されます。サーバーコードを、クライアント側のコンテンツとコードにクリーンに混在させることができます。

<ul>
    @for (int i = 0; i < 5; i++) {
        <li>List item @i</li>
    }
</ul>

Razor ビューエンジンを使用して、レイアウト、部分ビュー、置き換え可能なセクションを定義できます。

厳密に型指定されたビュー

MVC の Razor ビューは、お使いのモデルを基にして厳密に型指定できます。コントローラーは、ビューの型チェックと IntelliSense サポートを有効にして、厳密に型指定されたモデルをビューに渡すことができます。

たとえば、次のビューでは、モデルの型 IEnumerable<Product> をレンダリングします。

@model IEnumerable<Product>
<ul>
    @foreach (Product p in Model)
    {
        <li>@p.Name</li>
    }
</ul>

タグヘルパー

タグヘルパーを使うと、Razor ファイルでの HTML 要素の作成とレンダリングに、サーバー側コードを組み込むことができます。タグヘルパーを使って、カスタムタグ (例: <environment>) を定義したり、既存のタグ (例: <label>) の動作を変更したりすることができます。タグヘルパーは、要素名とその属性に基づいて特定の要素をバインドします。タグヘルパーでは、HTML の編集操作を保持しながら、サーバー側のレンダリングの利点を提供します。

フォームやリンクの作成、資産の読み込みなど、一般的なタスクの組み込みのタグヘルパーは数多くあります。パブリック GitHub リポジトリで NuGet パッケージとして使用することもできます。タグヘルパーは C# で作成され、要素名、属性名、または親タグに基づく HTML 要素をターゲットとします。たとえば、組み込みの LinkTagHelper を使用して、AccountsController の Login へのリンクを作成することができます。

<p>
    Thank you for confirming your email.
    Please <a asp-controller="Account" asp-action="Login">Click here to Log in</a>.
</p>

EnvironmentTagHelper を使用して、開発、ステージング、運用など、ランタイム環境に基づいて、ビュー (未加工、縮小など) にさまざまなスクリプトを含めることができます。

<environment names="Development">
    <script src="~/lib/jquery/dist/jquery.js"></script>
</environment>
<environment names="Staging,Production">
    <script src="https://ajax.aspnetcdn.com/ajax/jquery/jquery-2.1.4.js"
            asp-fallback-src="~/lib/jquery/dist/jquery.js"
            asp-fallback-test="window.jQuery">
    </script>
</environment>

タグヘルパーは、HTML で利用しやすい開発機能、および HTML および Razor マークアップを作成するための豊富な IntelliSense 環境を提供します。組み込みのタグヘルパーのほとんどは、既存の HTML 要素をターゲットとし、要素に対してサーバー側の属性を提供します。

ビューコンポーネント

ビューコンポーネントを使用すると、レンダリングロジックをパッケージ化し、アプリケーション全体で再利用することができます。これは部分ビューと似ていますが、関連するロジックを含みます。

互換バージョン

SetCompatibilityVersion メソッドを使用すると、ASP.NET Core MVC 2.1 以降に導入されている、互換性に影響する重大な変更をオプトインまたはオプトアウトすることができます。

詳細については、「ASP.NET Core MVC の互換バージョン」を参照してください。

その他のリソース

MyTested.AspNetCore.Mvc - ASP.NET Core MVC 用の Fluent テストライブラリ: MVC と Web API アプリをテストするための fluent インターフェイスを提供する厳密に型指定された単体テストライブラリ。 ("Microsoft では保守管理もサポートも行っていません。")
ASP.NET Core での依存関係の挿入

次の方法で共有

ASP.NET Core MVC の概要

MVC パターン

モデルの責任

ビューの責任

コントローラーの責任

ASP.NET Core MVC

ルーティング

モデル バインド

モデルの検証

依存関係の挿入

フィルター

Areas

Web API

Testability

Razor ビュー エンジン

厳密に型指定されたビュー

タグ ヘルパー

ビュー コンポーネント

互換バージョン

その他のリソース

その他のリソース

モデルバインド

Razor ビューエンジン

タグヘルパー

ビューコンポーネント