ASP.NET Core でのアプリケーションのスタートアップ

作成者: Rick Anderson

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

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

• Razor Pages
• ビューのある MVC コントローラー
• コントローラーを使用した Web API
• 最小 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();

EventSource を使用するアプリでは、起動時間を測定して起動時のパフォーマンスを把握し、最適化できます。 Microsoft.AspNetCore.Hosting の ServerReady イベントは、サーバーが要求に応答する準備ができているポイントを表します。

アプリケーションの起動の詳細については、「ASP.NET Core の基礎の概要」を参照してください。

スタートアップ フィルターを使用した Startup の拡張

IStartupFilter を使用して次のことを行います。

• Use{Middleware} を明示的に呼び出さずに、アプリのミドルウェア パイプラインの先頭または末尾でミドルウェアを構成するには。 IStartupFilter を使用し、既定のミドルウェアを明示的に登録せず、パイプラインの先頭に既定値を追加します。 IStartupFilter により、アプリの作成者に代わって別のコンポーネントが Use{Middleware} を呼び出すことを許可します。
• Configure メソッドのパイプラインを作成します。 IStartupFilter.Configure では、ライブラリによって追加されたミドルウェアの前後に実行するように、ミドルウェアを設定することができます。

IStartupFilter には、Action<IApplicationBuilder> を受け取って返す Configure が実装されています。 IApplicationBuilder で、アプリケーションの要求パイプラインを構成するクラスを定義します。 詳細については、「Create a middleware pipeline with IApplicationBuilder」(IApplicationBuilder を使用したミドルウェア パイプラインの作成) を参照してください。

各 IStartupFilter によって、要求パイプラインで 1 つまたは複数のミドルウェアを追加できます。 フィルターは、サービス コンテナーに追加された順に呼び出されます。 フィルターは、コントロールを次のフィルターに渡す前または後にミドルウェアを追加できるため、アプリケーション パイプラインの先頭または末尾に追加されます。

IStartupFilter でミドルウェアを登録する方法を次の例に示します。 RequestSetOptionsMiddleware ミドルウェアによって、クエリ文字列パラメーターからオプション値が設定されます。

public class RequestSetOptionsMiddleware
{
    private readonly RequestDelegate _next;

    public RequestSetOptionsMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    // Test with https://localhost:5001/Privacy/?option=Hello
    public async Task Invoke(HttpContext httpContext)
    {
        var option = httpContext.Request.Query["option"];

        if (!string.IsNullOrWhiteSpace(option))
        {
            httpContext.Items["option"] = WebUtility.HtmlEncode(option);
        }

        await _next(httpContext);
    }
}

RequestSetOptionsMiddleware は RequestSetOptionsStartupFilter クラスで構成されています。

namespace WebStartup.Middleware;
// <snippet1>
public class RequestSetOptionsStartupFilter : IStartupFilter
{
    public Action<IApplicationBuilder> Configure(Action<IApplicationBuilder> next)
    {
        return builder =>
        {
            builder.UseMiddleware<RequestSetOptionsMiddleware>();
            next(builder);
        };
    }
}
// </snippet1>

IStartupFilter は Program.cs に登録されます。

using WebStartup.Middleware;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddTransient<IStartupFilter,
                      RequestSetOptionsStartupFilter>();

var app = builder.Build();

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

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

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

option のクエリ文字列パラメーターを指定すると、ミドルウェアでは ASP.NET Core ミドルウェアによって応答がレンダリングされる前に値の割り当てを処理します。

@page
@model PrivacyModel
@{
    ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>

<p> Append query string ?option=hello</p>
Option String: @HttpContext.Items["option"];

ミドルウェアの実行順序は、IStartupFilter の登録順に設定されています。

• 複数の IStartupFilter の実装が、同じオブジェクトとやり取りする可能性があります。 順序が重要な場合は、ミドルウェアの実行順序に合わせて IStartupFilter サービスの登録順序を指定してください。

• IStartupFilter に登録された他のアプリケーション ミドルウェアの前または後に実行される IStartupFilter の実装が 1 つまたは複数あるミドルウェアを、ライブラリで追加することができます。 ライブラリの IStartupFilter よって追加されたミドルウェアの前に IStartupFilter ミドルウェアを呼び出すには、次のようにします。

  • サービス コンテナーにライブラリを追加する前に、サービス登録を配置する
  • 後で呼び出すために、ライブラリが追加された後にサービス登録を配置する

注: Configure をオーバーライドするとき、ASP.NET Core アプリを拡張することはできません。 詳細については、こちらの GitHub issue を参照してください。

外部アセンブリからの起動時に構成を追加する

IHostingStartup の実装により、アプリの Program.cs ファイルの外部にある外部アセンブリから、起動時に拡張機能をアプリに追加できるようになります。 詳細については、「ASP.NET Core でホスティング スタートアップ アセンブリを使用する」を参照してください。

Startup、ConfigureServices、Configure

最小限のホスティング モデルで ConfigureServices メソッドと Configure メソッドを使用する方法の詳細については、以下を参照してください。

• 最小限のホスティング モデルでスタートアップを使用する
• この記事の ASP.NET Core 5.0 バージョン:
  • ConfigureServices メソッド
  • Configure メソッド