ASP.NET Core MVC アプリを開発する

[アーティクル]
03/10/2023

ヒント

このコンテンツは eBook の「ASP.NET Core および Azure での最新の Web アプリケーションの設計」からの抜粋です。.NET Docs で閲覧できるほか、PDF として無料ダウンロードすると、オンラインで閲覧できます。

PDF のダウンロード

"最初から正しく理解する必要はありません。しかし、最後に正しく理解していることは極めて重要です。" - Andrew Hunt と David Thomas

ASP.NET Core は、最新のクラウド向けに最適化された Web アプリケーションを構築するための、クロスプラットフォームのオープンソースフレームワークです。 ASP.NET Core アプリは、軽量なモジュール形式であり、依存関係の挿入の組み込みサポートを備え、テストと保守の容易性を大幅に向上させることができます。ビューベースのアプリだけでなく最新の Web API の構築をサポートする MVC と組み合わせて、ASP.NET Core は、エンタープライズ Web アプリケーション構築のための強力なフレームワークになります。

MVC と Razor Pages

ASP.NET Core MVC は、Web ベースの API やアプリを構築する際に便利な機能をたくさん備えています。 MVC という用語は "Model-View-Controller" の略です。これは、ユーザーからの要求に応答する責任をいくつかの部分に分割する UI パターンです。このパターンに従うだけでなく、ASP.NET Core アプリに各種機能を Razor Pages として実装することもできます。

Razor Pages は ASP.NET Core MVC に組み込まれ、ルーティング、モデルバインド、フィルター、承認などに同じ機能が使用されます。ただし、コントローラー、モデル、ビューなどに個別のフォルダーやファイルを使用したり、属性に基づくルーティングを行ったりする代わりに、Razor Pages は 1 つのフォルダー ("/Pages") に配置され、このフォルダー内の相対的な位置に基づいてルーティングを行い、コントローラーアクションではなくハンドラーで要求を処理します。そのため、Razor Pages を使用すると、通常、必要なファイルやクラスはすべて併置され、Web プロジェクト全体に分散しません。

eShopOnWeb サンプルアプリケーションでの MVC、Razor Pages、および関連パターンの適用方法について、詳細を確認してください。

新しい ASP.NET Core App を作成するとき、構築するアプリの書類に関して計画を立ててください。自分の IDE で、または dotnet new CLI コマンドを使用して新しいプロジェクトを作成する場合は、テンプレートをいくつかの候補の中から選択します。最も一般的なプロジェクトテンプレートは、Empty、Web API、Web アプリ、および Web アプリ (Model-View-Controller) です。これを決定できるのは最初にプロジェクトを作成するときのみですが、取り消し不可能な決定ではありません。 Web API プロジェクトでは、標準の Model-View-Controller コントローラーが使用されます。既定ではビューだけがありません。同様に、既定の Web アプリテンプレートでは Razor Pages が使用され、Views フォルダーがありません。このようなプロジェクトには Views フォルダーを後で追加し、ビューを基盤とする動作に対応できます。 Web API プロジェクトと Model-View-Controller プロジェクトには既定で Pages フォルダーがありませんが、後で追加し、Razor Pages を基盤とする動作に対応できます。以上の 3 つのテンプレートは、データ (Web API)、ページベース、ビューベースという 3 つの異なるデフォルトユーザーインタラクションをサポートするものであると考えることができます。しかし、必要であれば、これらのテンプレートのいずれかまたは全部を 1 つのプロジェクトに混在させることができます。

Razor Pages とは

Razor Pages は、Visual Studio における新しい Web アプリケーションの既定の手法です。 Razor Pages では、非 SPA フォームなど、ページベースのアプリケーション機能を一層簡単に構築できます。コントローラーやビューを使用し、さまざまな依存関係やビューモデルと連動し、さまざまなビューを返す大掛かりなコントローラーをアプリケーションに与えることが一般的でした。これにより、複雑さが増加しました。また、単一責任の原則または開放/閉鎖原則に効果的に従わないコントローラーが生じることがよくありました。 Razor Pages では、その Razor マークアップを使用し、Web アプリケーションで特定の論理 "ページ" に対してサーバー側ロジックをカプセル化することでこの問題に対処しています。サーバー側ロジックのない Razor ページは 1 つの Razor ファイル ("Index.cshtml" など) のみから構成されます。ただし、重要な Razor Pages にはほとんどの場合、ページモデルクラスが関連付けられます。これには慣例として Razor ファイルと同じ名前と ".cs" 拡張子が付けられます。たとえば、"Index.cshtml.cs" のようになります。

Razor ページのページモデルでは、MVC コントローラーとビューモデルの責任が組み合わされます。コントローラーアクションのメソッドで要求を処理する代わりに、"OnGet()" のようなページモデルハンドラーが実行され、関連付けられているページが既定でレンダリングされます。 Razor Pages では、ASP.NET Core アプリで個々のページを構築するプロセスが簡単になります。それでありながら、ASP.NET Core MVC のアーキテクチャ機能をすべて備えています。新しいページベース機能の既定の選択肢として最適です。

MVC を使用する場面

Web API を構築する場合、Razor Pages を使用してみるより、MVC パターンの方が合理的です。ご自分のプロジェクトで Web API エンドポイントだけを公開する場合は、Web API のプロジェクトテンプレートから始めるのが理想的です。それ以外の場合は、任意の ASP.NET Core アプリに、コントローラーと関連付けらた API エンドポイントを簡単に追加できます。バージョン 5 以前の ASP.NET MVC から ASP.NET Core MVC に既存のアプリケーションを移行する場合、その作業量を最小限に抑えるには、ビューベースの MVC 手法を使用します。最初の移行後、新しい機能のために、さらには大規模な移行として Razor Pages を採用することが合理的かどうかを判断できます。 .NET 4.x アプリを .NET 8 に移植する方法の詳細については、ASP.NET Core eBook への既存の ASP.NET アプリの移植に関する記事を参照してください。

Web アプリの構築方法として Razor Pages を選択した場合でも MVC ビューを選択した場合でも、アプリのパフォーマンスは同じようなものになり、依存関係の注入、フィルター、モデルバインド、妥当性確認などのサポートが含まれます。

応答と要求のマッピング

ASP.NET Core アプリの中心となる機能は、受信した要求を送信する応答にマップすることです。下位のレベルではこのマッピングはミドルウェアによって行われ、カスタムミドルウェアのみで簡単な ASP.NET Core アプリとマイクロサービスを構成することができます。 ASP.NET Core MVC を使うと、"ルート"、"コントローラー"、"アクション" など、さらに上位のレベルで操作することができます。着信した各要求はアプリケーションのルーティングテーブルと比較され、一致するルートが見つかった場合、関連付けられている (コントローラーに属する) アクションメソッドが呼び出されて要求を処理します。一致するルートが見つからない場合は、エラーハンドラーが呼び出されます (この場合、NotFound の結果を返します)。

ASP.NET Core MVC アプリは、規則ルートと属性ルートのどちらか一方または両方を使用できます。規則ルートはコードで定義されており、次の例のような構文を使ってルーティングの "規則" を指定します。

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllerRoute(name: "default", pattern: "{controller=Home}/{action=Index}/{id?}");
});

この例では、"default" という名前のルートがルーティングテーブルに追加されます。 controller、action、id のプレースホルダーでルートテンプレートを定義します。 controller と action のプレースホルダーには既定値が指定されており (それぞれ、Home と Index)、id プレースホルダーは ("?" が適用されているので) 省略可能です。ここで定義されている規則は、要求の最初の部分はコントローラーの名前に対応する必要があり、2 番目の部分はアクションに対応する必要があり、3 番目の部分は必要に応じて ID パラメーターを表す、というものです。規則ルートは、通常、要求ミドルウェアパイプラインが構成されている Program.cs など、アプリケーションに対して 1 か所で定義されます。

属性ルートは、グローバルに指定されるのではなく、コントローラーとアクションに直接適用されます。この方法の場合、特定のメソッドを探しているときに検出しやすいという利点がありますが、ルーティング情報がアプリケーション内の 1 か所に保持されないことを意味します。属性ルートでは、特定のアクションに対する複数ルートや、コントローラーとアクションの組み合わせルートを、簡単に指定できます。次に例を示します。

[Route("Home")]
public class HomeController : Controller
{
    [Route("")] // Combines to define the route template "Home"
    [Route("Index")] // Combines to define route template "Home/Index"
    [Route("/")] // Does not combine, defines the route template ""
    public IActionResult Index() {}
}

ルートは [HttpGet] や同様の属性で指定することができ、[Route] 属性を別途追加する必要はありません。次に示すように、属性ルートではトークンを使って、コントローラーやアクションの名前を繰り返し指定する必要性を軽減することもできます。

[Route("[controller]")]
public class ProductsController : Controller
{
    [Route("")] // Matches 'Products'
    [Route("Index")] // Matches 'Products/Index'
    public IActionResult Index() {}
}

Razor Pages では、属性ルーティングは使用されません。 Razor Pages には、その @page ディレクティブの一部として追加の経路テンプレート情報を指定できます。

@page "{id:int}"

前の例の問題のページではルートと整数 id パラメーターが一致します。たとえば、/Pages のルートに置かれている Products.cshtml ページは、次のような要求に応答します。

/Products/123

特定の要求がルートと一致した後、アクションメソッドが呼び出される前に、ASP.NET Core MVC は要求に対してモデルバインドとモデル検証を実行します。モデルバインドでは、着信した HTTP データが、呼び出されるアクションメソッドのパラメーターとして指定されている .NET 型に変換されます。たとえば、アクションメソッドが int id パラメーターを必要としている場合、モデルバインドは要求の一部として指定された値からこのパラメーターを提供しようとします。そのために、モデルバインドは、ポストされたフォーム内、ルート自体、クエリ文字列で値を検索します。 id 値が見つかった場合は、整数に変換されてからアクションメソッドに渡されます。

モデルをバインドした後、アクションメソッドを呼び出す前に、モデルの検証が行われます。モデルの検証では、モデルの種類に対するオプション属性が使われ、指定されたモデルオブジェクトが特定のデータ要件に準拠していることを確認できます。特定の値を必須として指定したり、特定の長さや数値範囲に制限したりすることができます。検証属性が指定されていて、モデルがその要件に準拠していない場合は、ModelState.IsValid プロパティが false に設定され、準拠していない検証規則のセットを要求元のクライアントに送信できます。

モデルの検証を使う場合は常に、状態変更コマンドを実行する前にモデルが有効であることを確認し、無効なデータによってアプリが破損しないようにする必要があります。フィルターを使用すると、すべてのアクションにこの検証のコードを追加する必要がなくなります。 ASP.NET Core MVC フィルターを使うと、要求のグループをインターセプトして、共通のポリシーや横断的な事柄を特定の対象にだけ適用できます。フィルターは、個々のアクション、コントローラー全体、またはアプリケーション全体に適用できます。

Web API に対しては、ASP.NET Core MVC はコンテンツネゴシエーションをサポートしており、応答の書式設定方法を要求で指定することができます。要求で指定されたヘッダーに基づき、データを返すアクションは、XML、JSON、または他のサポートされている形式で応答を書式設定します。この機能を使うと、同じ API を、データ形式要件が異なる複数のクライアントで使用できます。

Web API プロジェクトでは [ApiController] 属性の使用を検討してください。この属性は個々のコントローラー、ベースコントローラークラス、アセンブリ全体に適用できます。この属性によって、自動モデル検証が追加されます。アクションのモデルが無効な場合、BadRequest と検証エラーの詳細が返されます。この属性ではまた、あらゆるアクションに、従来の経路を使用せず、属性経路を与えることが要求され、エラーに対する応答で、さらに詳しい ProblemDetails 情報が返されます。

コントローラーの制御

ページベースのアプリケーションの場合、Razor Pages は、コントローラーが大きくなりすぎないようにするために大いに役立ちます。個々のページには、専用のファイルとハンドラー専用のクラスが用意されます。 Razor Pages が導入される前は、多くのビュー中心のアプリケーションには、多数の異なるアクションやビューを担当する大きなコントローラークラスがありました。当然、これらのクラスは、多くの責任と依存関係を含めるために拡張され、保守が困難になっていきます。ビューベースのコントローラーが大きくなりすぎていることがわかった場合は、リファクタリングして Razor Pages を使用するか、メディエーターなどのパターンを導入することを検討してください。

メディエーター設計パターンを使用して、クラス間の通信を可能にしながら、クラス間の結合を削減します。 ASP.NET Core MVC アプリケーションで、"ハンドラー" を使用してアクションメソッドの作業を行うことにより、コントローラーをより小さな部分に分割するために、このパターンが頻繁に使用されます。これを実現するには、多くの場合、一般的な MediatR NuGet パッケージが使用されます。通常、コントローラーには、それぞれが特定の依存関係を必要とする多数の異なるアクションメソッドが含まれます。アクションで必要となるすべての依存関係のセットをコントローラーのコンストラクターに渡す必要があります。 MediatR を使用する場合、通常、コントローラーが持つ唯一の依存関係は、メディエーターのインスタンス上にあります。各アクションによって、メディエーターインスタンスを使用してメッセージが送信され、メッセージはハンドラーによって処理されます。ハンドラーは 1 つのアクション固有のものであるため、そのアクションに必要な依存関係のみを必要とします。 MediatR を使用するコントローラーの例を次に示します。

public class OrderController : Controller
{
    private readonly IMediator _mediator;

    public OrderController(IMediator mediator)
    {
        _mediator = mediator;
    }

    [HttpGet]
    public async Task<IActionResult> MyOrders()
    {
        var viewModel = await _mediator.Send(new GetMyOrders(User.Identity.Name));
        return View(viewModel);
    }
    // other actions implemented similarly
}

MyOrders アクションでは、GetMyOrdersメッセージの Send の呼び出しが、このクラスによって処理されます。

public class GetMyOrdersHandler : IRequestHandler<GetMyOrders, IEnumerable<OrderViewModel>>
{
    private readonly IOrderRepository _orderRepository;
    public GetMyOrdersHandler(IOrderRepository orderRepository)
    {
        _orderRepository = orderRepository;
    }

  public async Task<IEnumerable<OrderViewModel>> Handle(GetMyOrders request, CancellationToken cancellationToken)
    {
        var specification = new CustomerOrdersWithItemsSpecification(request.UserName);
        var orders = await _orderRepository.ListAsync(specification);
        return orders.Select(o => new OrderViewModel
            {
                OrderDate = o.OrderDate,
                OrderItems = o.OrderItems?.Select(oi => new OrderItemViewModel()
                  {
                    PictureUrl = oi.ItemOrdered.PictureUri,
                    ProductId = oi.ItemOrdered.CatalogItemId,
                    ProductName = oi.ItemOrdered.ProductName,
                    UnitPrice = oi.UnitPrice,
                    Units = oi.Units
                  }).ToList(),
                OrderNumber = o.Id,
                ShippingAddress = o.ShipToAddress,
                Total = o.Total()
        });
    }
}

このアプローチの最終的な結果として、コントローラーがはるかに小さくなり、主にルーティングとモデルバインドに集中し、個々のハンドラーが特定のエンドポイントに必要な特定のタスクを担当するようになります。このアプローチは、ApiEndpoints NuGet パッケージを使用すると、これにより Razor Pages でビューベースのコントローラーにもたらされるのと同じ利点を API コントローラーに提供することが試みられるため、MediatR を使用しなくても実現できます。

参照 – 応答と要求のマッピング

コントローラーアクションへのルーティング
https://learn.microsoft.com/aspnet/core/mvc/controllers/routing

モデルバインド
https://learn.microsoft.com/aspnet/core/mvc/models/model-binding

モデル検証
https://learn.microsoft.com/aspnet/core/mvc/models/validation

フィルター
https://learn.microsoft.com/aspnet/core/mvc/controllers/filters

ApiController 属性
https://learn.microsoft.com/aspnet/core/web-api/

依存関係の使用

ASP.NET Core は、依存関係の挿入と呼ばれる手法の組み込みサポートを備えており、内部的に使用します。依存関係の挿入は、アプリケーションの異なる部分間を疎結合できる手法です。結合を緩くすることを、アプリケーションの各部分の分離が容易になり、部分ごとにテストや置換が可能になるため、望ましいことです。また、アプリケーションの 1 つの部分に対する変更が、アプリケーションの別の場所に予期しない影響を与える可能性も低くなります。依存関係の挿入は、依存関係逆転 (Dependency Inversion) の原則に基づいており、多くの場合、開放/閉鎖 (Open/closed) の原則の実現に不可欠です。アプリケーションによる依存関係の処理方法を評価するときは、静的な結び付きを持つコードのにおいに注意し、"new は接着剤である" という格言を思い出してください。

静的な結び付きは、クラスが静的メソッドを呼び出したとき、または静的プロパティにアクセスしたときに発生し、インフラストラクチャに対する副作用または依存関係があります。たとえば、あるメソッドが静的メソッドを呼び出し、その静的メソッドがデータベースに書き込む場合、元のメソッドはデータベースに密に結合されます。何かによってデータベース呼び出しが中断されると、メソッドも中断されます。このようなメソッドのテストは、静的な呼び出しを模倣するために市販のモックライブラリが必要になるか、またはテストデータベースを使ってしかテストできないため、非常に困難です。インフラストラクチャに対する依存関係のない静的呼び出しは (特に、完全にステートレスな呼び出し)、問題なく呼び出すことができて、結合や (コードの結合だけでなく静的な呼び出し自体の) テスト可能性に影響を与えません。

多くの開発者は、静的な結び付きとグローバルな状態のリスクを理解していますが、それでも直接的なインスタンス化によって特定の実装にコードを密接に結合します。 "new は接着剤である" という格言は、この結合を喚起するものであり、new キーワードの使用を全般に非難しているわけではありません。静的メソッドの呼び出しと同様に、外部依存関係を持たない型の新しいインスタンスは通常、実装の詳細にコードを密接に結合したり、テストを困難にしたりすることはありません。ただし、クラスをインスタンス化するたびに、その特定のインスタンスをその特定の場所にハードコーディングすることに意味があるかどうか、またはそのインスタンスを依存関係として要求する方が優れた設計ではないかということを、少し検討してください。

依存関係の宣言

ASP.NET Core のメソッドとクラスは依存関係を宣言するようになっており、引数としてそれを要求します。 ASP.NET アプリケーションは、通常、Program.cs または Startup クラスで設定されます。

Note

.NET 6 (およびそれ以降) と Visual Studio 2022 アプリでは、Program.cs でアプリを完全に構成する方法が既定のアプローチとなっています。この新しいアプローチを容易に開始できるように、プロジェクトテンプレートが更新されました。 ASP.NET Core プロジェクトでは、必要に応じて、引き続き Startup クラスを使用することができまます。

Program.cs でサービスを構成する

非常に単純なアプリの場合は、Program.cs ファイル内で WebApplicationBuilder を使用して依存関係を直接接続できます。必要なすべてのサービスが追加されたら、ビルダーを使用してアプリを作成します。

var builder = WebApplication.CreateBuilder(args);

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

var app = builder.Build();

Startup.cs でサービスを構成する

Startup.cs 自体は、いくつかのポイントで依存関係の挿入をサポートするように構成されています。 Startup クラスを使用する場合は、このクラスにコンストラクターを指定することができます。そして、次のように、それを介して依存関係を要求することができます。

public class Startup
{
    public Startup(IHostingEnvironment env)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true);
    }
}

Startup クラスの興味深い点は、明示的な型の要件がないことです。特別な Startup 基底クラスを継承することなく、特定のインターフェイスも実装していません。コンストラクターを提供してもしなくてもよく、コンストラクターでは必要なだけいくつでもパラメーターを指定できます。アプリケーション用に構成した Web ホストは、開始すると、Startup クラスを呼び出し (それを使用するように指示されている場合)、依存関係の挿入を使用して Startup クラスに必要なすべての依存関係を設定します。もちろん、ASP.NET Core によって使われるサービスコンテナーで構成されていないパラメーターを要求すると、例外が発生しますが、コンテナーが認識している依存関係を使っている限り、何でも自由に要求できます。

依存関係の挿入は、最初に Startup インスタンスを作成したときから、ASP.NET Core アプリに組み込まれています。依存関係の挿入は Startup クラスだけの機能ではありません。 Configure メソッド内で依存関係を要求することもできます。

public void Configure(IApplicationBuilder app,
    IHostingEnvironment env,
    ILoggerFactory loggerFactory)
{

}

ただし、ConfigureServices メソッドはこの動作の例外であり、IServiceCollection 型のパラメーターを 1 つだけ受け取る必要があります。このメソッドは、サービスコンテナーにオブジェクトを追加する役割を持ち、IServiceCollection パラメーターを介して現在構成されているすべてのサービスにアクセスできるため、依存関係の挿入をサポートする必要はまったくありません。したがって、Startup クラスのすべての部分で、ASP.NET Core のサービスコレクションで定義されている依存関係を使用するには、必要なサービスをパラメーターとして要求するか、ConfigureServices で IServiceCollection を使用します。

Note

特定のサービスを Startup クラスで確実に利用できるようにする必要がある場合は、IWebHostBuilder とその ConfigureServices メソッドを、CreateDefaultBuilder 呼び出しの中で使用して、それらのサービスを構成します。

Startup クラスは、独自のサービスに対するコントローラーからミドルウェアやフィルターまで、ASP.NET Core アプリケーションの他の部分で必要な構成方法のモデルになります。いずれの場合も、明示的な依存関係の原則に従い、依存関係を直接作成するのではなく要求し、アプリケーション全体で依存関係の挿入を利用する必要があります。実装を直接インスタンス化する場所と方法に注意する必要があります (特に、インフラストラクチャを使用する、または副作用があるサービスとオブジェクトの場合)。特定の実装の種類に対する参照をハードコーディングするのではなく、抽象化をアプリケーションコアで定義し、引数として渡すようにします。

アプリケーションの構成

通常、モノリシックなアプリケーションのエントリポイントは 1 つです。 ASP.NET Core Web アプリケーションの場合は、ASP.NET Core Web プロジェクトがエントリポイントになります。ただし、これは、ソリューションは 1 つのプロジェクトだけで構成する必要があるという意味ではありません。懸念事項の分離に従って、アプリケーションを複数の異なるレイヤーに分割するのは役に立ちます。レイヤーに分割した後は、フォルダーだけでなくプロジェクトも分割して、カプセル化を向上させることができます。 ASP.NET Core アプリケーションでこれらの目標を実現するための最善の方法は、第 5 章で説明されているクリーンアーキテクチャのバリエーションです。この方法に従うと、アプリケーションのソリューションは、UI、Infrastructure、ApplicationCore に対する個別のライブラリで構成されるようになります。

これらのプロジェクトだけでなく、テストプロジェクトも別に含まれます (テストについては 9 章で説明します)。

アプリケーションのオブジェクトモデルとインターフェイスは、ApplicationCore プロジェクトに置く必要があります。このプロジェクトの依存関係は可能な限り少なくします (また、特定のインフラストラクチャに関する懸念事項も存在しないようにします)。このプロジェクトは、ソリューション内の他のプロジェクトによって参照されます。永続化する必要があるビジネスエンティティと、インフラストラクチャに直接依存していないサービスは、ApplicationCore プロジェクトで定義します。

永続化を実行する方法や、ユーザーに通知を送信する方法など、実装の詳細は、Infrastructure プロジェクトで保持します。このプロジェクトは、Entity Framework Core などの実装固有のパッケージを参照しますが、これらの実装に関する詳細をプロジェクトの外部に公開しないようにする必要があります。インフラストラクチャサービスとリポジトリは ApplicationCore プロジェクトで定義されているインターフェイスを実装する必要があり、このプロジェクトの永続化の実装が、ApplicationCore で定義されているエンティティの取得と格納を行います。

ASP.NET Core UI プロジェクトは、UI レベルの処理を行いますが、ビジネスロジックまたはインフラストラクチャの詳細を含まないようにする必要があります。実際に、理想的なのは Infrastructure プロジェクトに対する依存関係さえ持つべきではなく、これにより 2 つのプロジェクト間に誤って依存関係が発生するのを防ぐことができます。これは、Autofac などのサードパーティ製 DI コンテナーを使って実現でき、各プロジェクトの Module クラスで DI 規則を定義することができます。

実装の詳細からアプリケーションを分離するもう 1 つの方法は、通常は個別の Docker コンテナーで展開されているマイクロサービスをアプリケーションで呼び出すことです。この方法を使うと、2 つのプロジェクト間に DI を利用する場合より、懸念事項の分離と分割はさらに大きくなりますが、複雑さは増大します。

機能の編成

既定では、ASP.NET Core アプリケーションは、コントローラーとビューさらに多くの場合は ViewModels を含むように、フォルダー構造を編成します。通常、これらのサーバー側構造をサポートするためのクライアント側のコードは、wwwroot フォルダーに個別に格納されます。ただし、大規模なアプリケーションでは、特定の機能を使用するためにこれらのフォルダー間を移動する必要があるため、このような編成では問題が発生する可能性があります。各フォルダー内のファイルとサブフォルダーの数が増えるとますます困難になり、ソリューションエクスプローラーのスクロール量が膨大になります。この問題の 1 つの解決策は、アプリケーションのコードをファイルの種類別ではなく "機能" 別に整理することです。通常、この編成スタイルは機能フォルダーまたは機能スライスと呼ばれます (「Vertical Slices」(垂直スライス) も参照してください)。

ASP.NET Core MVC では、この目的のために区分 (Area) がサポートされています。区分を使うと、各区分フォルダー内にコントローラーフォルダーとビューフォルダー (および関連するすべてのモデル) のセットを個別に作成できます。図 7-1 は、区分を使用したフォルダー構造の例です。

区分編成の例

図 7-1。区分編成の例

区分を使う場合は、属性を使って、コントローラーが属する区分の名前でコントローラーを装飾する必要があります。

[Area("Catalog")]
public class HomeController
{}

また、区分のサポートをルートに追加する必要があります。

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllerRoute(name: "areaRoute", pattern: "{area:exists}/{controller=Home}/{action=Index}/{id?}");
    endpoints.MapControllerRoute(name: "default", pattern: "{controller=Home}/{action=Index}/{id?}");
});

区分の組み込みサポートに加えて、独自のフォルダー構造を作成し、属性とカスタムルートの代わりの規則を使うこともできます。このようにすると、機能フォルダーにビューやコントローラーなどのフォルダーが個別に含まれないようにして、フラットな階層を維持し、各機能について 1 つの場所ですべての関連ファイルを簡単に見ることができるようになります。 API の場合、フォルダーを使用してコントローラーを置き換えることができ、各フォルダーにはすべての API エンドポイントとそれに関連付けられた DTO を含めることができます。

ASP.NET Core は、組み込みの規則の種類を使って、その動作を制御します。これらの規則は変更したり置き換えたりできます。たとえば、名前空間に基づいて特定のコントローラーの機能名を自動的に取得する規則を作成できます (これは通常、コントローラーが存在するフォルダーに関連付けられます)。

public class FeatureConvention : IControllerModelConvention
{
    public void Apply(ControllerModel controller)
    {
        controller.Properties.Add("feature",
        GetFeatureName(controller.ControllerType));
    }

    private string GetFeatureName(TypeInfo controllerType)
    {
        string[] tokens = controllerType.FullName.Split('.');
        if (!tokens.Any(t => t == "Features")) return "";
        string featureName = tokens
            .SkipWhile(t => !t.Equals("features", StringComparison.CurrentCultureIgnoreCase))
            .Skip(1)
            .Take(1)
            .FirstOrDefault();
        return featureName;
    }
}

その後、ConfigureServices で (または Program.cs で) アプリケーションに MVC のサポートを追加するときに、オプションとしてこの規則を指定します。

// ConfigureServices
services.AddMvc(o => o.Conventions.Add(new FeatureConvention()));

// Program.cs
builder.Services.AddMvc(o => o.Conventions.Add(new FeatureConvention()));

また、ASP.NET Core MVC はビューを配置する場合にも規則を使います。これをカスタム規則でオーバーライドして、ビューが独自の機能フォルダーに配置されるようにすることができます (上の FeatureConvention によって提供される機能名を使用)。この方法について詳しくは、MSDN Magazine の記事「ASP.NET Core MVC 向け機能スライス」をご覧ください。実際に動くサンプルをダウンロードすることもできます。

API と Blazor アプリケーション

セキュリティ保護が必要な一連の Web API がアプリケーションに含まれている場合、これらの API をビューまたは Razor Pages アプリケーションとは別のプロジェクトとして構成するのが理想的です。 API (特にパブリック API) をサーバー側の Web アプリケーションから分離すると、多くの利点があります。多くの場合、これらのアプリケーションには、固有のデプロイと負荷特性があります。また、さまざまなセキュリティメカニズムを採用する可能性も非常に高く、標準のフォームベースのアプリケーションによって、Cookie ベースの認証と、トークンベースの認証を使用する可能性が最も高い API が利用されます。

さらに、Blazor サーバーと BlazorWebAssembly のどちらを使用するかにかかわらず、Blazor は、個別のプロジェクトとして構築する必要があります。セキュリティモデルと共に、アプリケーションのランタイム特性はそれぞれ異なります。これらによって、サーバー側の Web アプリケーション (または API プロジェクト) と共通の種類が共有される可能性があるため、これらの種類は共通の共用プロジェクトで定義する必要があります。

BlazorWebAssembly 管理インターフェイスを eShopOnWeb に追加するには、いくつかの新しいプロジェクトを追加する必要があります。 BlazorWebAssembly プロジェクト自体 (BlazorAdmin) です。 BlazorAdmin で使用され、トークンベースの認証を使用するように構成されている新しいパブリック API エンドポイントセットは、PublicApi プロジェクトで定義されます。さらに、これらの両方のプロジェクトで使用される特定の共有の種類は、新しい BlazorShared プロジェクトに保持されます。

PublicApi と BlazorAdmin の両方で必要とされる種類を共有するために使用できる共通の ApplicationCore プロジェクトが既にあるのに、なぜ別の BlazorShared プロジェクトを追加するか、と疑問に思う人もいるかもしれません。その答えは、このプロジェクトには、アプリケーションのすべてのビジネスロジックが含まれているため、必要以上に大きく、サーバー上でセキュリティを維持する必要がある可能性がはるかに高いということです。 Blazor アプリケーションが読み込まれると、BlazorAdmin で参照されるすべてのライブラリがユーザーのブラウザーにダウンロードされることにご注意ください。

フロントエンド用バックエンド (BFF) パターンを使用しているかどうかによって、BlazorWebAssembly アプリで使用される API で、その種類を 100% Blazor と共有しない可能性があります。特に、多くの異なるクライアントで使用することを目的としたパブリック API では、クライアント固有の共有プロジェクト内で共有するのではなく、独自の要求と結果の種類を定義することができます。 eShopOnWeb サンプルの場合、PublicApi プロジェクトによって、実際にはパブリック API がホストされていると想定されているため、その要求と応答の種類のすべてが BlazorShared プロジェクトから取得されるとは限りません。

横断的関心事

アプリケーションが大きくなるほど、横断的な事柄を抽出して、重複を排除し、整合性を維持することの重要性が増します。 ASP.NET Core アプリケーションでの横断的な事柄の例としては、認証、モデル検証規則、出力キャッシュ、エラー処理などがありますが、その他にも多くのことがあります。 ASP.NET Core MVC でフィルターを使うと、要求処理パイプラインの特定のステップの前または後にコードを実行できます。たとえば、フィルターは、モデルバインドの前後、アクションの前後、またはアクションの結果の前後に実行できます。また、承認フィルターを使って、パイプラインの残りの部分へのアクセスを制御することができます。図 7-2 では、フィルターを構成した場合に要求の実行がそれをどのように通過するかを示します。

要求は、承認フィルター、リソースフィルター、モデルバインド、アクションフィルター、アクションの実行とアクションの結果変換、例外フィルター、結果フィルター、および結果の実行によって処理されます。要求は、クライアントに送信される応答になる前に、結果フィルターとリソースフィルターによってのみ処理されます。

図 7-2。フィルターと要求パイプラインを通過する要求実行の流れ。

通常、フィルターは属性として実装されるので、コントローラーまたはアクションにフィルターを適用できます (グローバルでも可能)。この方法で追加したフィルターをアクションレベルで指定すると、コントローラーレベルで指定されたフィルターをオーバーライドするか、その上に構築されて、それ自体がグローバルフィルターをオーバーライドします。たとえば、[Route] 属性を使って、コントローラーとアクションの間にルートを作成できます。同様に、コントローラーレベルで承認を構成した後、次の例に示すように、個々のアクションでオーバーライドできます。

[Authorize]
public class AccountController : Controller
{
    [AllowAnonymous] // overrides the Authorize attribute
    public async Task<IActionResult> Login() {}
    public async Task<IActionResult> ForgotPassword() {}
}

最初の Login メソッドでは、[AllowAnonymous] フィルター (属性) を使って、コントローラーレベルで設定されている Authorize フィルターをオーバーライドします。 ForgotPassword アクション (および AllowAnonymous 属性を持たないクラスの他のすべてのアクション) では、認証された要求が必要です。

フィルターを使うと、API に対する共通エラー処理ポリシーの形式で、重複を除去できます。たとえば、一般的な API ポリシーでは、存在しないキーを参照している要求に対しては NotFound 応答を返し、モデルの検証が失敗した場合は BadRequest 応答を返します。次の例では、アクションでのこれら 2 つのポリシーを示します。

[HttpPut("{id}")]
public async Task<IActionResult> Put(int id, [FromBody]Author author)
{
    if ((await _authorRepository.ListAsync()).All(a => a.Id != id))
    {
        return NotFound(id);
    }
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    author.Id = id;
    await _authorRepository.UpdateAsync(author);
    return Ok();
}

このような条件付きコードで、アクションメソッドを乱雑にしないようにしてください。代わりに、必要に応じて適用できるフィルターにポリシーを格納します。この例では、コマンドが API に送られるたびに実行する必要があるモデルの検証チェックを、次の属性で置き換えることができます。

public class ValidateModelAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            context.Result = new BadRequestObjectResult(context.ModelState);
        }
    }
}

Ardalis.ValidateModel パッケージを含めることで、NuGet 依存関係として ValidateModelAttribute をプロジェクトに追加できます。 API の場合、ApiController 属性を使用することで、別個の ValidateModel フィルターがなくてもこの動作を強制できます。

同様に、フィルターを使ってレコードが存在するかどうかをチェックし、アクションが実行される前に 404 を返して、アクションでこれらのチェックを実行する必要がないようにできます。共通の規則を抽出し、インフラストラクチャコードとビジネスロジックを UI から分離するようにソリューションを構成すると、MVC アクションメソッドは非常にスリムになるはずです。

[HttpPut("{id}")]
[ValidateAuthorExists]
public async Task<IActionResult> Put(int id, [FromBody]Author author)
{
    await _authorRepository.UpdateAsync(author);
    return Ok();
}

フィルターの実装の詳細については、MSDN Magazine の記事「実際の ASP.NET Core MVC フィルター」を参照してください。また、実際に動作するサンプルをダウンロードすることもできます。

検証エラー (無効な要求)、リソースが見つからない、サーバーエラーなど、一般的なシナリオに基づく一般的な応答が API から多数あることが判明した場合は、"結果" の抽象化を使用することを検討してください。結果の抽象化は、API エンドポイントによって使用されるサービスから返され、コントローラーのアクションまたはエンドポイントでは、フィルターを使用してそれらを IActionResults に変換します。

参照 – アプリケーションの構成

領域
https://learn.microsoft.com/aspnet/core/mvc/controllers/areas

MSDN マガジン – ASP.NET Core MVC 向け機能スライス
https://learn.microsoft.com/archive/msdn-magazine/2016/september/asp-net-core-feature-slices-for-asp-net-core-mvc

フィルター
https://learn.microsoft.com/aspnet/core/mvc/controllers/filters

MSDN Magazine – 実際の ASP.NET Core MVC フィルター
https://learn.microsoft.com/archive/msdn-magazine/2016/august/asp-net-core-real-world-asp-net-core-mvc-filters

eShopOnWeb の結果
https://github.com/dotnet-architecture/eShopOnWeb/wiki/Patterns#result

セキュリティ

Web アプリケーションのセキュリティ保護は大きなトピックであり、さまざまな考慮事項があります。最も基本的なレベルのセキュリティには、特定の要求を行ったユーザーを認識し、その要求が必要なリソースだけにアクセスできるようにすることが含まれます。認証は、要求で提供された資格情報を、信頼できるデータストア内の資格情報と比較して、要求を既知のエンティティから送信されたものとして扱う必要があるかどうかを確認するプロセスです。承認は、ユーザーの ID に基づいて特定のリソースへのアクセスを制限するプロセスです。セキュリティに関する 3 番目の考慮事項は、第三者による傍受から要求を保護することであり、少なくともアプリケーションが SSL を使っていることを確認する必要があります。

ID

ASP.NET Core Identity は、アプリケーションのログイン機能をサポートするために使うことができるメンバーシップシステムです。ローカルユーザーアカウントをサポートするだけでなく、Microsoft アカウント、Twitter、Facebook、Google などのプロバイダーからの外部ログインプロバイダーもサポートします。 ASP.NET Core Identity だけでなく、アプリケーションでは Windows 認証や、Identity Server のようなサードパーティの ID プロバイダーを使うこともできます。

[個別のユーザーアカウント] オプションを選択した場合、新しいプロジェクトテンプレートには ASP.NET Core Identity が含まれます。このテンプレートには、登録、ログイン、外部ログイン、パスワードを忘れた場合、および追加機能のサポートが含まれています。

[個別のユーザーアカウント] を選択して Identity を事前構成する

図 7-3。 [個別のユーザーアカウント] を選択して Identity を事前構成する。

Identity のサポートは Program.cs または Startup で構成され、それには、サービス並びにミドルウェアの構成が含まれます。

Program.cs で Identity を構成する

Program.cs では、WebHostBuilder インスタンスからサービスを構成し、次に、アプリが作成されたら、そのミドルウェアを構成します。注意すべき重要なポイントは、必要なサービスのための AddDefaultIdentity の呼び出しと、必須のミドルウェアを追加するための UseAuthentication および UseAuthorization の呼び出しです。

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
var connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
builder.Services.AddDbContext<ApplicationDbContext>(options =>
    options.UseSqlServer(connectionString));
builder.Services.AddDatabaseDeveloperPageExceptionFilter();

builder.Services.AddDefaultIdentity<IdentityUser>(options => options.SignIn.RequireConfirmedAccount = true)
    .AddEntityFrameworkStores<ApplicationDbContext>();
builder.Services.AddRazorPages();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseMigrationsEndPoint();
}
else
{
  app.UseExceptionHandler("/Error");
  // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
  app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthentication();
app.UseAuthorization();

app.MapRazorPages();

app.Run();

アプリのスタートアップでの Identity の構成

// Add framework services.
builder.Services.AddDbContext<ApplicationDbContext>(options =>
    options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
builder.Services.AddIdentity<ApplicationUser, IdentityRole>()
    .AddEntityFrameworkStores<ApplicationDbContext>()
    .AddDefaultTokenProviders();
builder.Services.AddMvc();

var app = builder.Build();

if (app.Environment.IsDevelopment())
{
    app.UseMigrationsEndPoint();
}
else
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthentication();
app.UseAuthorization();

app.MapRazorPages();

UseAuthentication と UseAuthorization が MapRazorPages の前にあることが重要です。 Identity サービスを構成する場合は、AddDefaultTokenProviders の呼び出しに注目してください。これは、Web 通信をセキュリティ保護するために使われる場合があるトークンとは関係なく、ユーザーによる ID 確認のために SMS またはメールでユーザーに送信できるプロンプトを作成するプロバイダーを参照しています。

詳しくは、ASP.NET Core の公式ドキュメントで 2 要素認証の構成および外部ログインプロバイダーの有効化に関する記事をご覧ください。

認証

認証は、システムにアクセスしているユーザーを判別するプロセスです。前のセクションで示した ASP.NET Core Identity と構成メソッドを使用すると、アプリケーションの一部の認証の既定値が自動的に構成されます。ただし、これらの既定値を手動で構成することも、AddIdentity で設定された値をオーバーライドすることもできます。 Identity を使用している場合、既定の "スキーム" として Cookie ベースの認証が構成されます。

Web ベースの認証では、通常、システムのクライアントを認証する過程で、最大 5 つのアクションを実行できます。これらは次のとおりです:

認証。クライアントから提供された情報を使用して、アプリケーション内で使用する ID を作成します。
チャレンジ。このアクションを使用して、クライアントに自身を識別するように要求します。
禁止。アクションの実行が禁止されていることをクライアントに通知します。
サインイン。何らかの方法で既存のクライアントを保持します。
サインアウト。クライアントを永続化から削除します。

Web アプリケーションで認証を実行するには、いくつかの一般的な手法があります。これらは、スキームと呼ばれます。特定のスキームで、上記のオプションの一部またはすべてのアクションを定義します。一部のスキームでは、アクションのサブセットのみがサポートされ、サポートされていないアクションを実行するために個別のスキームが必要になります。たとえば、OpenId-Connect (OIDC) スキームによって、サインインとサインアウトはサポートされませんが、一般的に、この永続化には Cookie 認証を使用するように構成されます。

ASP.NET Core アプリケーションでは、前述の各アクションに対して DefaultAuthenticateScheme とオプションの特定のスキームを構成できます。たとえば、DefaultChallengeScheme とDefaultForbidScheme です。 AddIdentity を呼び出すと、アプリケーションのさまざまな側面が構成され、多くの必要なサービスが追加されます。これには、認証スキームを構成するためのこの呼び出しも含まれます。

builder.Services.AddAuthentication(options =>
{
    options.DefaultAuthenticateScheme = IdentityConstants.ApplicationScheme;
    options.DefaultChallengeScheme = IdentityConstants.ApplicationScheme;
    options.DefaultSignInScheme = IdentityConstants.ExternalScheme;
});

これらのスキームにより、既定で、永続化と認証用のログインページへのリダイレクトに Cookie が使用されます。これらのスキームは、Web ブラウザーを介してユーザーとやりとりする Web アプリケーションに適していますが、API には推奨されません。代わりに、API では、通常、別の形式の認証 (たとえば、JWT ベアラートークン) が使用されます。

Web API は、.NET アプリケーションの HttpClient や他のフレームワークの同等の型などのコードによって使用されます。これらのクライアントでは、API 呼び出しからの使用可能な応答、または発生した問題がある場合は、それを示す状態コードを想定しています。これらのクライアントでは、ブラウザーを介してやりとりしておらず、API が返す可能性のある HTML をレンダリングまたは操作することもありません。このため、クライアントが認証されない場合、API エンドポイントによってそれらをログインページにリダイレクトするのは適切ではありません。別のスキームの方が適切です。

API の認証を構成するには、次のような認証を設定できます。これは、eShopOnWeb 参照アプリケーションの PublicApi プロジェクトで使用されます。

builder.Services
    .AddAuthentication(config =>
    {
      config.DefaultScheme = JwtBearerDefaults.AuthenticationScheme;
    })
    .AddJwtBearer(config =>
    {
        config.RequireHttpsMetadata = false;
        config.SaveToken = true;
        config.TokenValidationParameters = new TokenValidationParameters
        {
            ValidateIssuerSigningKey = true,
            IssuerSigningKey = new SymmetricSecurityKey(key),
            ValidateIssuer = false,
            ValidateAudience = false
        };
    });

1 つのプロジェクト内に複数の異なる認証スキームを構成できますが、1 つの既定のスキームを構成する方がはるかに簡単です。このため、特に、eShopOnWeb 参照アプリケーションでは、アプリケーションのビューと Razor Pages を含むメインの Web プロジェクトとは別個の独自のプロジェクト PublicApi に API を分離します。

Blazor アプリでの認証

Blazor サーバーアプリケーションでは、他の ASP.NET Core アプリケーションと同じ認証機能を利用できます。ただし、BlazorWebAssembly アプリケーションはブラウザーで実行されるため、組み込みの ID および認証プロバイダーを使用できません。 BlazorWebAssembly アプリケーションによって、ユーザーの認証状態がローカルに保存し、要求にアクセスされ、ユーザーが実行する必要があるアクションが決定されます。ただし、ユーザーは簡単にアプリをバイパスして API と直接やりとりすることができるため、BlazorWebAssembly アプリ内に実装されているロジックに関係なく、すべての認証および承認のチェックをサーバーで実行する必要があります。

参照 - 認証

認証アクションと既定値
https://stackoverflow.com/a/52493428

SPA の認証と承認
https://learn.microsoft.com/aspnet/core/security/authentication/identity-api-authorization

ASP.NET Core Blazor の認証と認可
https://learn.microsoft.com/aspnet/core/blazor/security/

セキュリティ: ASP.NET Web Forms および Blazor での認証と認可
https://learn.microsoft.com/dotnet/architecture/blazor-for-web-forms-developers/security-authentication-authorization

承認

承認の最も単純な形式には、匿名ユーザーに対するアクセスの制限が含まれます。この機能は、特定のコントローラーまたはアクションに [Authorize] 属性を適用すると実現できます。ロールを使っている場合は、次のように、特定のロールに属しているユーザーのアクセス制限まで、属性をさらに拡張できます。

[Authorize(Roles = "HRManager,Finance")]
public class SalaryController : Controller
{

}

この例では、HRManager ロールと Finance ロールのどちらか一方または両方に属しているユーザーは、SalaryController にアクセスできます。ユーザーが (複数のロールの 1 つだけでなく) 複数のロールに属していることを必要とするには、属性を複数回適用し、そのたびに必要なロールを指定できます。

特定のロールセットを文字列として多くの異なるコントローラーやアクションで指定すると、望ましくない繰り返しにつながります。少なくとも、これらの文字列リテラルに定数を定義し、その文字列を指定する必要がある場所でその定数を使用します。さらに、承認規則をカプセル化する承認ポリシーを構成し、[Authorize] 属性を適用する場合に、そのポリシーを個々のロールの代わりに指定することもできます:

[Authorize(Policy = "CanViewPrivateReport")]
public IActionResult ExecutiveSalaryReport()
{
    return View();
}

この方法でポリシーを使うと、適用される特定のロールまたは規則から、制限されるアクションの種類を切り離すことができます。後で、特定のリソースへのアクセスを必要とする新しいロールを作成する場合は、ポリシーを更新するだけでよく、すべての [Authorize] 属性ですべてのロールリストを更新する必要はありません。

請求

クレームは、認証済みユーザーのプロパティを表す名前と値のペアです。たとえば、ユーザーの従業員番号をクレームとして格納できます。その後、承認ポリシーの一部としてクレームを使用できます。次の例では、"EmployeeNumber" という名前のクレームが存在する必要のある "EmployeeOnly" というポリシーを作成しています:

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    services.AddAuthorization(options =>
    {
        options.AddPolicy("EmployeeOnly", policy => policy.RequireClaim("EmployeeNumber"));
    });
}

その後、上記のように、このポリシーを [Authorize] 属性で使って、コントローラーやアクションを保護できます。

Web API のセキュリティ保護

ほとんどの Web API は、トークンベースの認証システムを実装する必要があります。トークン認証はステートレスであり、拡張できるように設計されています。トークンベースの認証システムでは、クライアントは最初に認証プロバイダーで認証を行う必要があります。それが成功した場合、クライアントはトークンを発行されます。トークンは、単に暗号化された意味のある文字列です。トークンの最も一般的な形式は、JSON Web トークン (JWT、多くの場合 "ジョット" と発音します) です。その後、クライアントが API に要求を発行する必要があるときは、このトークンを要求のヘッダーとして追加します。サーバーは、要求を完了する前に、要求ヘッダーに含まれるトークンを検証します。図 7-4 はこのプロセスを示したものです。

TokenAuth

図 7-4。 Web API に対するトークンベースの認証。

独自の認証サービスを作成したり、Azure AD や OAuth と統合したり、IdentityServer のようなオープンソースのツールを利用してサービスを実装したりできます。

JWT トークンにはユーザーに関する要求を埋め込むことができ、これらはクライアントまたはサーバーで読み取ることができます。 JWT トークンの内容を表示するには、jwt.io などのツールを使用することができます。パスワードやキーなどの機密データは、簡単に読み取られてしまうため、JTW トークンに格納しないでください。

SPA または BlazorWebAssembly アプリケーションで JWT トークンを使用する場合、クライアント上の任意の場所に格納し、すべての API 呼び出しに追加する必要があります。次のコードで示すように、通常、このアクティビティはヘッダーとして実行されます。

// AuthService.cs in BlazorAdmin project of eShopOnWeb
private async Task SetAuthorizationHeader()
{
      var token = await GetToken();
      _httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
}

上記のメソッドが呼び出されると、_httpClient で作成された要求の要求ヘッダーにトークンが埋め込まれます。これにより、サーバー側の API で要求の認証と承認を行うことができます。

カスタムセキュリティ

注意

一般的な規則として、独自のカスタムセキュリティ実装を実装することは避けてください。

暗号化、ユーザーメンバーシップ、トークン生成システムの実装を "独自に展開する" 場合、特別な注意が必要です。代案がたくさん売られているし、オープンソースも利用できます。ほぼ間違いなく、カスタム実装よりセキュリティが優れています。

参照 – セキュリティ

セキュリティドキュメントの概要
https://learn.microsoft.com/aspnet/core/security/

ASP.NET Core アプリで SSL を適用する
https://learn.microsoft.com/aspnet/core/security/enforcing-ssl

Identity の概要
https://learn.microsoft.com/aspnet/core/security/authentication/identity

承認の概要
https://learn.microsoft.com/aspnet/core/security/authorization/introduction

Azure App Service での API Apps に対する認証および承認
https://learn.microsoft.com/azure/app-service-api/app-service-api-authentication

Identity Server
https://github.com/IdentityServer

クライアントの通信

Web API によりページを提供してデータの要求に応答するだけでなく、ASP.NET Core アプリは接続されているクライアントと直接通信できます。この送信通信では、さまざまなトランスポートテクノロジを使うことができ、最も一般的なものは WebSocket です。 ASP.NET Core SignalR は、サーバーとクライアントの間のリアルタイム通信機能をアプリケーションに容易に追加できるようにするライブラリです。 SignalR は、WebSocket などのさまざまなトランスポートテクノロジをサポートしており、多くの実装の詳細を開発者から抽象化します。

WebSocket を直接使うか、他の技法を使うかに関係なく、リアルタイムのクライアント通信は、さまざまなアプリケーションシナリオで役に立ちます。次に例をいくつか示します。

ライブチャットルームアプリケーション
アプリケーションの監視
ジョブの進行状況の更新
通知
対話型のフォームアプリケーション

クライアント通信をアプリケーションに組み込むときは、通常、2 つのコンポーネントがあります。

サーバー側の接続マネージャー (SignalR Hub、WebSocketManager WebSocketHandler)
クライアント側のライブラリ

クライアントはブラウザーに限定されず、モバイルアプリ、コンソールアプリ、他のネイティブアプリも SignalR/WebSocket を使って通信できます。次の簡単なプログラムは、WebSocketManager サンプルアプリケーションの一部として、チャットアプリケーションに送信されたすべての内容をコンソールにエコーします。

public class Program
{
    private static Connection _connection;
    public static void Main(string[] args)
    {
        StartConnectionAsync();
        _connection.On("receiveMessage", (arguments) =>
        {
            Console.WriteLine($"{arguments[0]} said: {arguments[1]}");
        });
        Console.ReadLine();
        StopConnectionAsync();
    }

    public static async Task StartConnectionAsync()
    {
        _connection = new Connection();
        await _connection.StartConnectionAsync("ws://localhost:65110/chat");
    }

    public static async Task StopConnectionAsync()
    {
        await _connection.StopConnectionAsync();
    }
}

アプリケーションがクライアントアプリケーションと直接通信する方法を検討し、リアルタイム通信によってアプリのユーザーエクスペリエンスが向上するかどうかを検討します。

参照 – クライアントの通信

ASP.NET Core SignalR
https://github.com/dotnet/aspnetcore/tree/main/src/SignalR

WebSocket マネージャー
https://github.com/radu-matei/websocket-manager

ドメイン駆動設計 – 適用する必要があるか?

ドメイン駆動設計 (DDD) は、"ビジネスドメイン" に注目するソフトウェア構築のためのアジャイルな方法です。実際のシステムのしくみについて開発者に関わることができるビジネスドメインの専門家とのコミュニケーションと対話に重点が置かれます。たとえば、株取引を処理するシステムを構築する場合のドメインの専門家は、経験豊富な株式ブローカーなどです。 DDD は、大規模で複雑なビジネスの問題に対処するように設計されており、多くの場合、ドメインの理解とモデリングに対する投資に見合わないため、小さくて単純なアプリケーションには適しません。

DDD 手法でソフトウェアを作成する場合、チーム (非技術的な利害関係者や貢献者を含む) は問題領域のための "ユビキタス言語" を開発する必要があります。つまり、モデル化される実際の概念、それに相当するソフトウェア、概念を保持するために存在する構造 (データベーステーブルなど) に、同じ用語を使う必要があります。したがって、ユビキタス言語で説明される概念は、"ドメインモデル" の基礎を形成する必要があります。

ドメインモデルは、相互に対話してシステムの動作を表すオブジェクトで構成されます。これらのオブジェクトは以下のカテゴリに分けられます。

エンティティは、ID のスレッドでオブジェクトを表します。エンティティは、通常、後で取得できるキーを使って永続的に格納されます。
集約は、単位として永続化する必要のあるオブジェクトのグループを表します。
値オブジェクトは、プロパティ値の合計に基づいて比較できる概念を表します。たとえば、開始日と終了日で構成される DateRange などです。
ドメインイベントは、システムの他の部分にとって重要な、システム内で発生している出来事を表します。

DDD ドメインモデルでは、モデル内に複雑な動作をカプセル化する必要があります。特にエンティティは、プロパティの単なるコレクションであってはなりません。ドメインモデルに動作が欠如していて、システムの状態を表しているだけの場合は、貧血症のモデルと呼ばれ、DDD では望ましくないことです。

これらのモデルの種類に加えて、通常、DDD ではさまざまなパターンが使用されます。

リポジトリは、永続化の詳細を抽象化します。
ファクトリは、複雑なオブジェクトの作成をカプセル化します。
サービスは、複雑な動作やインフラストラクチャの実装の詳細をカプセル化します。
コマンドは、コマンドの発行とコマンド自体の実行を切り離します。
仕様は、クエリの詳細をカプセル化します。

また、DDD では、疎結合、カプセル化、単体テストを使って簡単に検証できるコードに対応するため、前に説明したクリーンアーキテクチャを使うことも推奨されます。

DDD を適用する必要がある場合

DDD は、(技術的だけでなく) ビジネス的にも非常に複雑な大規模アプリケーションに適しています。アプリケーションでは、ドメイン専門家の知識が必要になります。ドメインモデル自体にも重要な動作が存在する必要があり、データストアからさまざまなレコードの現在の状態を単に取得するだけでなく、ビジネスルールや相互作用を表します。

DDD を適用してはならない場合

DDD では、モデリング、アーキテクチャ、コミュニケーションへの投資が伴い、小規模なアプリケーションや基本的に CRUD (作成/読み取り/更新/削除) だけのアプリケーションでは正当化されない可能性があります。アプリケーション開発のアプローチに DDD を選んだ場合でも、ドメインに動作を持たない貧血症のモデルがあることがわかったときは、アプローチの再考が必要な場合があります。アプリケーションで DDD を使う必要がないか、またはデータベースやユーザーインターフェイスではなくドメインモデルにビジネスロジックをカプセル化するためのアプリケーションのリファクタリングにサポートが必要な可能性があります。

ハイブリッドアプローチでは、アプリケーションのトランザクション部分やさらに複雑な部分にだけ DDD を使い、アプリケーションの簡単な CRUD 部分や読み取り専用の部分には使わないようにします。たとえば、レポートを表示したり、ダッシュボードにデータを視覚化したりするためにデータをクエリする場合、集約を制約する必要はありません。このような要件に対しては、独立したシンプルな読み取りモデルでまったく問題ありません。

参照 – ドメイン駆動設計

わかりやすい英語での DDD (StackOverflow の回答)
https://stackoverflow.com/questions/1222392/can-someone-explain-domain-driven-design-ddd-in-plain-english-please/1222488#1222488

展開

ホストされる場所に関係なく、ASP.NET Core アプリケーションを展開するプロセスには複数のステップがあります。最初のステップであるアプリケーションの発行は、dotnet publish CLI コマンドを使用して実行できます。このステップでは、アプリケーションがコンパイルされて、アプリケーションの実行に必要なすべてのファイルが指定したフォルダーに配置されます。 Visual Studio から展開する場合、このステップは自動的に実行されます。 publish フォルダーには、アプリケーションとその依存関係の .exe ファイルと .dll ファイルが格納されます。自己充足型のアプリケーションには、.NET ランタイムのバージョンも含まれます。 ASP.NET Core アプリケーションには、構成ファイル、静的クライアント資産、MVC ビューも含まれます。

ASP.NET Core アプリケーションはコンソールアプリケーションであり、サーバーの起動時、およびアプリケーション (またはサーバー) がクラッシュした場合の再起動時に、起動される必要があります。プロセスマネージャーを使って、このプロセスを自動化できます。 ASP.NET Core の最も一般的なプロセスマネージャーは、Linux の場合は Nginx と Apache、Windows の場合は IIS と Windows Service です。

プロセスマネージャーに加え、ASP.NET Core アプリケーションでは、リバースプロキシサーバーも使用できます。リバースプロキシサーバーはインターネットから HTTP 要求を受け取り、事前にいくつかの処理を行ってから Kestrel に転送します。リバースプロキシサーバーによって、アプリケーションにセキュリティ層が提供されます。また、Kestrel は同じポートでの複数アプリケーションのホストもサポートしていないので、ホストヘッダーなどの手法を使って同じポートと IP アドレスで複数のアプリケーションをホストすることはできません。

インターネットに対する Kestrel

図 7-5。リバースプロキシサーバーの背後の Kestrel でホストされている ASP.NET

リバースプロキシが役に立つもう 1 つのシナリオは、SSL/HTTPS を使って複数のアプリケーションをセキュリティ保護する場合です。この場合、リバースプロキシでは SSL だけを構成する必要があります。リバースプロキシサーバーと Kestrel の間の通信は、HTTP で行われます (図 7-6 を参照)。

HTTPS で保護されたリバースプロキシサーバーの背後でホストされている ASP.NET

図 7-6。 HTTPS で保護されたリバースプロキシサーバーの背後でホストされている ASP.NET

急速に普及しているアプローチは ASP.NET Core アプリケーションを Docker コンテナーでホストする方法で、ローカルにホストしたり、クラウドベースのホスト用に Azure に展開したりできます。 Docker コンテナーは、Kestrel で実行されるアプリケーションのコードを格納することができ、上記のように、リバースプロキシサーバーの背後に展開されます。

Azure でアプリケーションをホストしている場合は、専用の仮想アプライアンスとして Microsoft Azure Application Gateway を使って、複数のサービスを提供できます。個々のアプリケーションに対するリバースプロキシとして動作するだけでなく、Application Gateway は次の機能を提供することもできます。

HTTP の負荷分散
SSL のオフロード (インターネットに対する SSL のみ)
エンドツーエンドの SSL
複数サイトのルーティング (最大 20 個のサイトを 1 つの Application Gateway に統合)
Web アプリケーションファイアウォール
WebSocket のサポート
高度な診断

Azure のデプロイオプションについては、10 章で説明します。

参照 – 展開

ホスティングとデプロイの概要
https://learn.microsoft.com/aspnet/core/publishing/

Kestrel とリバースプロキシを使用するタイミング
https://learn.microsoft.com/aspnet/core/fundamentals/servers/kestrel#when-to-use-kestrel-with-a-reverse-proxy

Docker で ASP.NET Core アプリをホストする
https://learn.microsoft.com/aspnet/core/publishing/docker

Azure Application Gateway の概要
https://learn.microsoft.com/azure/application-gateway/application-gateway-introduction

前へ次へ

次の方法で共有

ASP.NET Core MVC アプリを開発する

MVC と Razor Pages

Razor Pages とは

MVC を使用する場面

応答と要求のマッピング

コントローラーの制御

参照 – 応答と要求のマッピング

依存関係の使用

依存関係の宣言

Program.cs でサービスを構成する

Startup.cs でサービスを構成する

アプリケーションの構成

機能の編成

API と Blazor アプリケーション

横断的関心事

参照 – アプリケーションの構成

セキュリティ

ID

Program.cs で Identity を構成する

アプリのスタートアップでの Identity の構成

認証

Blazor アプリでの認証

参照 - 認証

承認

請求

Web API のセキュリティ保護

カスタムセキュリティ

参照 – セキュリティ

クライアントの通信

参照 – クライアントの通信

ドメイン駆動設計 – 適用する必要があるか?

DDD を適用する必要がある場合

DDD を適用してはならない場合

参照 – ドメイン駆動設計

展開

参照 – 展開

その他のリソース

次の方法で共有

ASP.NET Core MVC アプリを開発する

MVC と Razor Pages

Razor Pages とは

MVC を使用する場面

応答と要求のマッピング

コントローラーの制御

参照 – 応答と要求のマッピング

依存関係の使用

依存関係の宣言

Program.cs でサービスを構成する

Startup.cs でサービスを構成する

アプリケーションの構成

機能の編成

API と Blazor アプリケーション

横断的関心事

参照 – アプリケーションの構成

セキュリティ

ID

Program.cs で Identity を構成する

アプリのスタートアップでの Identity の構成

認証

Blazor アプリでの認証

参照 - 認証

承認

請求

Web API のセキュリティ保護

カスタム セキュリティ

参照 – セキュリティ

クライアントの通信

参照 – クライアントの通信

ドメイン駆動設計 – 適用する必要があるか?

DDD を適用する必要がある場合

DDD を適用してはならない場合

参照 – ドメイン駆動設計

展開

参照 – 展開

その他のリソース

カスタムセキュリティ