ASP.NET Core の基礎の概要

この記事では、依存関係の挿入 (DI)、構成、ミドルウェアなど、ASP.NET Core アプリを構築するための基礎の概要について説明します。

Program.cs

Web テンプレートを使用して作成した ASP.NET Core アプリでは、Program.cs ファイルにアプリケーション スタートアップ コードが入っています。 Program.cs ファイルは、次のような場所です。

• アプリで必要なサービスが構成されています。
• 要求を処理するアプリのパイプラインは、一連のミドルウェア コンポーネントとして定義されます。

以下をサポートするアプリ スタートアップ コードを示します。

• Razor Pages
• ビューのある MVC コントローラー
• コントローラーを使用した Web API
• Minimal Web API

var builder = WebApplication.CreateBuilder(args);

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

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

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

app.UseAuthorization();

app.MapGet("/hi", () => "Hello!");

app.MapDefaultControllerRoute();
app.MapRazorPages();

app.Run();

依存性の注入 (サービス)

ASP.NET Core には、構成済みのサービスをアプリ全体で利用できるようにする依存関係の挿入 (DI) が含まれています。 サービスは WebApplicationBuilder.Services (前述のコードの builder.Services) を使用して DI コンテナーに追加されます。 WebApplicationBuilder がインスタンス化されると、多くのフレームワークによって提供されるサービスが追加されます。 builder は、次のコードでは WebApplicationBuilder です。

var builder = WebApplication.CreateBuilder(args);

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

var app = builder.Build();

前述の強調表示されたコードでは、builder は、構成、ロギング、および DI コンテナーに追加されている他の多くのサービスを含みます。

次のコードでは、Razor ページ、ビューを備えた MVC コントローラー、およびカスタム DbContext を DI コンテナーに追加します。

using Microsoft.EntityFrameworkCore;
using RazorPagesMovie.Data;
var builder = WebApplication.CreateBuilder(args);

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

builder.Services.AddDbContext<RazorPagesMovieContext>(options =>
   options.UseSqlServer(builder.Configuration.GetConnectionString("RPMovieContext")));

var app = builder.Build();

サービスは通常、コンストラクター挿入を使用して DI から解決されます。 DI フレームワークでは、実行時にこのサービスのインスタンスが提供されます。

次のコードでは、コンストラクターの挿入を使用して、データベース コンテキストとロガーを DI から解決します。

public class IndexModel : PageModel
{
    private readonly RazorPagesMovieContext _context;
    private readonly ILogger<IndexModel> _logger;

    public IndexModel(RazorPagesMovieContext context, ILogger<IndexModel> logger)
    {
        _context = context;
        _logger = logger;
    }

    public IList<Movie> Movie { get;set; }

    public async Task OnGetAsync()
    {
        _logger.LogInformation("IndexModel OnGetAsync.");
        Movie = await _context.Movie.ToListAsync();
    }
}

ミドルウェア

要求を処理するパイプラインは、一連のミドルウェア コンポーネントとして構成されています。 各コンポーネントによって、HttpContext に対して操作が実行され、パイプラインの次のミドルウェアが呼び出されるか、または要求が終了されます。

通常、ミドルウェア コンポーネントは、Use{Feature} 拡張メソッドを呼び出すことでパイプラインに追加されます。 アプリに追加されたミドルウェアは、次のコードで強調表示されています。

var builder = WebApplication.CreateBuilder(args);

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

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

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

app.UseAuthorization();

app.MapGet("/hi", () => "Hello!");

app.MapDefaultControllerRoute();
app.MapRazorPages();

app.Run();

詳細については、「ASP.NET Core のミドルウェア」を参照してください。

Host

起動時に、ASP.NET Core アプリによってホストがビルドされます。 ホストにより、次のようなアプリのすべてのリソースがカプセル化されます。

• HTTP サーバーの実装
• ミドルウェア コンポーネント
• ログ機能
• 依存性の注入 (DI) サービス
• 構成

ASP.NET Core アプリを実行できる次の 3 つの異なるホストがあります。

• ASP.NET Core WebApplication (最小ホストとも呼ばれます)。
• .NET での汎用ホストと ASP.NET Core の ConfigureWebHostDefaults との組み合わせ
• ASP.NET Core WebHost

ASP.NET Core WebApplication と WebApplicationBuilder の種類は、すべての ASP.NET Core テンプレートで推奨されており、使用されます。 WebApplication は .NET での汎用ホストと同様に動作し、同じインターフェイスの多くを公開しますが、構成に必要なコールバックは少なくなります。 ASP.NET Core の WebHost は、下位互換性のためにのみ使用できます。

次の例では、WebApplication をインスタンス化しています。

var builder = WebApplication.CreateBuilder(args);

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

var app = builder.Build();

WebApplicationBuilder.Build メソッドでは、次のような一連の既定のオプションを使用してホストを構成します。

• Web サーバーとして Kestrel を使用し、IIS の統合を有効にします。
• 構成を、appsettings.json、環境変数、コマンド ライン引数、およびその他の構成ソースから読み込みます。
• ログ出力をコンソールとデバッグ プロバイダーに送ります。

Web 以外のシナリオ

汎用ホストにより、他の種類のアプリで、ログ記録、依存性の注入 (DI)、構成、およびアプリの有効期間管理などの横断的なフレームワーク拡張機能を使えるようになります。 詳細については、「ASP.NET Core の .NET 汎用ホスト」および「ASP.NET Core でホステッド サービスを使用するバックグラウンド タスク」を参照してください。

サーバー

ASP.NET Core アプリは、HTTP 要求をリッスンするために HTTP サーバー実装を使用します。 サーバーは、HttpContext に構成した要求機能のセットとして、アプリへの要求を公開します。

Windows

ASP.NET Core では、次のサーバー実装が提供されます。

• Kestrel は、クロスプラットフォームの Web サーバーです。 Kestrel は IIS を使用してリバース プロキシ構成で実行されることがよくあります。 Kestrel は、ASP.NET Core 2.0 以降で、インターネットに直接公開される一般向けエッジ サーバーとして実行することもできます。
• IIS HTTP サーバーは、IIS を使用する Windows のサーバーです。 このサーバーでは、ASP.NET Core アプリと IIS が同じプロセスで実行されます。
• HTTP.sys は、IIS とは一緒に使用しない Windows のサーバーです。

macOS

ASP.NET Core により、Kestrel クロスプラットフォーム サーバーの実装が提供されます。 Kestrel は、ASP.NET Core 2.0 以降で、インターネットに直接公開される一般向けエッジ サーバーとして実行することもできます。 Kestrel は Nginx または Apache を使用してリバース プロキシ構成で実行されることがよくあります。

Linux

ASP.NET Core により、Kestrel クロスプラットフォーム サーバーの実装が提供されます。 Kestrel は、ASP.NET Core 2.0 以降で、インターネットに直接公開される一般向けエッジ サーバーとして実行することもできます。 Kestrel は Nginx または Apache を使用してリバース プロキシ構成で実行されることがよくあります。

詳細については、「ASP.NET Core での Web サーバーの実装」を参照してください。

構成

ASP.NET Core は、構成プロバイダーの順序付けされたセットから、名前と値のペアの設定を取得する構成フレームワークとなります。 組み込み構成プロバイダーは、.json ファイル、.xml ファイル、環境変数、コマンドライン引数などのさまざまなソースで使用できます。 他のソースをサポートするには、カスタム構成プロバイダーを作成します。

既定では、ASP.NET Core アプリは、appsettings.json、環境変数、コマンド ラインなどから読み取るように構成されます。 アプリの構成が読み込まれると、環境変数からの値によって appsettings.json からの値がオーバーライドされます。

.NET Core には、パスワードなどの機密の構成データの管理に Secret Manager が用意されています。 実稼働の機密情報には、Azure Key Vault を使用することをお勧めします。

詳細については、「ASP.NET Core の構成」を参照してください。

環境

Development、Staging、Production などの実行環境は ASP.NET Core で使用できます。 アプリが実行している環境は、ASPNETCORE_ENVIRONMENT 環境変数を設定することにより指定します。 ASP.NET Core は、アプリの起動時にその環境変数を読み取り、その値を IWebHostEnvironment 実装に格納します。 この実装は、依存性の注入 (DI) を介して、アプリ内の任意の場所で使用できます。

次の例では、Development 環境で実行されて "いない" 場合に、例外ハンドラーと HTTP Strict Transport Security プロトコル (HSTS) ミドルウェアを構成します。

var builder = WebApplication.CreateBuilder(args);

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

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

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

app.UseAuthorization();

app.MapGet("/hi", () => "Hello!");

app.MapDefaultControllerRoute();
app.MapRazorPages();

app.Run();

詳細については、「ASP.NET Core で複数の環境を使用する」を参照してください。

ログ機能

ASP.NET Core では、さまざまな組み込みのサードパーティ製のログ記録プロバイダーと連携するログ記録 API がサポートされています。 使用可能なプロバイダーは次のとおりです。

• コンソール
• デバッグ
• Event Tracing on Windows
• Windows イベント ログ
• TraceSource
• Azure App Service
• Azure Application Insights

ログを作成するには、依存性の挿入 (DI) から ILogger<TCategoryName> サービスを解決し、LogInformation などのログ メソッドを呼び出します。 次に例を示します。

public class IndexModel : PageModel
{
    private readonly RazorPagesMovieContext _context;
    private readonly ILogger<IndexModel> _logger;

    public IndexModel(RazorPagesMovieContext context, ILogger<IndexModel> logger)
    {
        _context = context;
        _logger = logger;
    }

    public IList<Movie> Movie { get;set; }

    public async Task OnGetAsync()
    {
        _logger.LogInformation("IndexModel OnGetAsync.");
        Movie = await _context.Movie.ToListAsync();
    }
}

詳細については、「.NET Core と ASP.NET Core でのログ記録」を参照してください。

ルート指定

ルートとは、ハンドラーにマップされている URL のパターンです。 このハンドラーは一般的には Razor ページ、MVC コントローラーのアクション メソッドまたはミドルウェアです。 ASP.NET Core のルーティングでは、アプリで使用する URL を制御できます。

ASP.NET Core Web アプリケーション テンプレートによって生成された次のコードは、UseRouting を呼び出します。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

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

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

詳細については、「ASP.NET Core のルーティング」を参照してください。

エラー処理

ASP.NET Core には、次などのエラー処理用の機能が組み込まれています。

• 開発者例外ページ
• カスタム エラー ページ
• 静的状態コード ページ
• 起動時の例外処理

詳細については、「 ASP.NET Core のエラーを処理する」を参照してください。

HTTP 要求を行う

HttpClient インスタンスの作成に、IHttpClientFactory の実装を使用できます。 ファクトリは次のことを行います。

• 論理 HttpClient インスタンスの名前付けと構成を一元化します。 たとえば、GitHub にアクセスするために、github クライアントを登録して構成します。 既定のクライアントを別の目的で登録して構成します。
• 複数のデリゲート ハンドラーを登録してチェーン化し、送信要求ミドルウェア パイプラインを構築するのをサポートしています。 このパターンは、ASP.NET Core の受信ミドルウェア パイプラインに似ています。 このパターンでは、キャッシュ、エラー処理、シリアル化、ログ記録など、HTTP 要求に関する横断的関心事を管理するためのメカニズムが提供されます。
• 一時的な障害処理用の人気のサードパーティ製ライブラリ、Polly と統合できます。
• 基になっている HttpClientHandler インスタンスのプールと有効期間を管理し、HttpClient の有効期間を手動で管理するときに発生する一般的な DNS の問題を防ぎます。
• ファクトリによって作成されたクライアントから送信されるすべての要求に対し、構成可能なログ エクスペリエンスを ILogger を介して追加します。

詳細については、「ASP.NET Core で IHttpClientFactory を使用して HTTP 要求を行う」を参照してください。

コンテンツ ルート

コンテンツ ルートは、以下に対する基本パスです。

• アプリをホストしている実行可能ファイル (.exe)。
• アプリを構成するコンパイル済みアセンブリ (.dll)。
• 次のような、アプリで使用されるコンテンツ ファイル。
  • Razor ファイル (.cshtml、.razor)
  • 構成ファイル (.json、.xml)
  • データ ファイル (.db)
• Web ルート (通常は wwwroot フォルダー)。

開発中、コンテンツ ルートの既定値は、プロジェクトのルート ディレクトリです。 このディレクトリは、アプリのコンテンツ ファイルと Web ルートの両方の基本パスでもあります。 ホストを構築するときは、それ自体のパスを設定して別のコンテンツ ルートを指定します。 詳細については、コンテンツ ルートに関するページを参照してください。

Web ルート

Web ルートは、次のような、パブリックで静的なリソース ファイルへの基本パスです。

• スタイルシート (.css)
• JavaScript (.js)
• イメージ (.png、.jpg)

既定では、静的ファイルは Web ルート ディレクトリとそのサブディレクトリからのみ提供されます。 Web ルートのパスの既定値は、{コンテンツ ルート}/wwwroot です。 ホストを構築するときは、それ自体のパスを設定して別の Web ルートを指定します。 詳細については、「Web ルート」を参照してください。

プロジェクト ファイル内の <コンテンツ> プロジェクト項目を使用して、wwwroot にファイルを発行できないようにします。 次の例では、wwwroot/local とそのサブディレクトリにコンテンツを公開しないようにします。

<ItemGroup>
  <Content Update="wwwroot\local\**\*.*" CopyToPublishDirectory="Never" />
</ItemGroup>

Razor.cshtml ファイルの場合、~/ が Web ルートを指します。 ~/ で始まるパスは、"仮想パス" と呼ばれます。

詳細については、「ASP.NET Core の静的ファイル」をご覧ください。

その他のリソース

• WebApplicationBuilder のソース コード