次の方法で共有


ASP.NET Core でのファクトリ ベースのミドルウェアのアクティブ化

Note

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

警告

このバージョンの ASP.NET Core はサポート対象から除外されました。 詳細については、「.NET および .NET Core サポート ポリシー」を参照してください。 現在のリリースについては、この記事の .NET 8 バージョンを参照してください。

重要

この情報はリリース前の製品に関する事項であり、正式版がリリースされるまでに大幅に変更される可能性があります。 Microsoft はここに示されている情報について、明示か黙示かを問わず、一切保証しません。

現在のリリースについては、この記事の .NET 8 バージョンを参照してください。

IMiddlewareFactory/IMiddleware は、次のベネフィットを提供するミドルウェアのアクティブ化の機能拡張ポイントです。

  • クライアント要求ごとにアクティブ化 (スコープ サービスの挿入)
  • ミドルウェアの厳密な型指定

UseMiddleware 拡張メソッドでは、ミドルウェアの登録済みの型で IMiddleware が実装されているかが確認されます。 実装されている場合、規則に基づくミドルウェアのライセンス認証ロジックを使用する代わりに、コンテナーに登録されている IMiddlewareFactory インスタンスが IMiddleware の実装の解決に使用されます。 ミドルウェアは、アプリのサービス コンテナーで、スコープ サービスまたは一時的サービスとして登録されています。

IMiddleware はクライアント要求 (接続) ごとにアクティブ化されているので、スコープ サービスをミドルウェアのコンストラクターに挿入することができます。

IMiddleware

IMiddleware では、アプリの要求パイプライン用にミドルウェアが定義されます。 要求は、InvokeAsync (HttpContext, RequestDelegate) メソッドによって処理され、ミドルウェアの実行を表す Task が返されます。

規則でアクティブ化されるミドルウェア:

public class ConventionalMiddleware
{
    private readonly RequestDelegate _next;

    public ConventionalMiddleware(RequestDelegate next)
        => _next = next;

    public async Task InvokeAsync(HttpContext context, SampleDbContext dbContext)
    {
        var keyValue = context.Request.Query["key"];

        if (!string.IsNullOrWhiteSpace(keyValue))
        {
            dbContext.Requests.Add(new Request("Conventional", keyValue));

            await dbContext.SaveChangesAsync();
        }

        await _next(context);
    }
}

MiddlewareFactory でアクティブ化されるミドルウェア:

public class FactoryActivatedMiddleware : IMiddleware
{
    private readonly SampleDbContext _dbContext;

    public FactoryActivatedMiddleware(SampleDbContext dbContext)
        => _dbContext = dbContext;

    public async Task InvokeAsync(HttpContext context, RequestDelegate next)
    {
        var keyValue = context.Request.Query["key"];

        if (!string.IsNullOrWhiteSpace(keyValue))
        {
            _dbContext.Requests.Add(new Request("Factory", keyValue));

            await _dbContext.SaveChangesAsync();
        }

        await next(context);
    }
}

ミドルウェア用に拡張機能が作成されます。

public static class MiddlewareExtensions
{
    public static IApplicationBuilder UseConventionalMiddleware(
        this IApplicationBuilder app)
        => app.UseMiddleware<ConventionalMiddleware>();

    public static IApplicationBuilder UseFactoryActivatedMiddleware(
        this IApplicationBuilder app)
        => app.UseMiddleware<FactoryActivatedMiddleware>();
}

UseMiddleware では、ファクトリでアクティブ化されたミドルウェアにオブジェクトを渡すことはできません。

public static IApplicationBuilder UseFactoryActivatedMiddleware(
    this IApplicationBuilder app, bool option)
{
    // Passing 'option' as an argument throws a NotSupportedException at runtime.
    return app.UseMiddleware<FactoryActivatedMiddleware>(option);
}

ファクトリでアクティブ化されたミドルウェアは、Program.cs の組み込みのコンテナーに追加されます。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDbContext<SampleDbContext>
    (options => options.UseInMemoryDatabase("SampleDb"));

builder.Services.AddTransient<FactoryActivatedMiddleware>();

この 2 つのミドルウェアは、要求処理パイプライン (これも Program.cs) に登録されます。

var app = builder.Build();

app.UseConventionalMiddleware();
app.UseFactoryActivatedMiddleware();

IMiddlewareFactory

IMiddlewareFactory では、ミドルウェアを作成するメソッドが提供されます。 ミドルウェア ファクトリの実装は、スコープ化されたサービスとして、コンテナーに登録されます。

既定の IMiddlewareFactory の実装である MiddlewareFactory は、Microsoft.AspNetCore.Http パッケージにあります。

その他の技術情報

IMiddlewareFactory/IMiddleware は、ミドルウェアのアクティブ化の拡張ポイントです。

UseMiddleware 拡張メソッドでは、ミドルウェアの登録済みの型で IMiddleware が実装されているかが確認されます。 実装されている場合、規則に基づくミドルウェアのライセンス認証ロジックを使用する代わりに、コンテナーに登録されている IMiddlewareFactory インスタンスが IMiddleware の実装の解決に使用されます。 ミドルウェアは、アプリのサービス コンテナーで、スコープ サービスまたは一時的サービスとして登録されています。

利点:

  • クライアント要求ごとにアクティブ化 (スコープ サービスの挿入)
  • ミドルウェアの厳密な型指定

IMiddleware はクライアント要求 (接続) ごとにアクティブ化されているので、スコープ サービスをミドルウェアのコンストラクターに挿入することができます。

サンプル コードを表示またはダウンロードします (ダウンロード方法)。

IMiddleware

IMiddleware では、アプリの要求パイプライン用にミドルウェアが定義されます。 要求は、InvokeAsync (HttpContext, RequestDelegate) メソッドによって処理され、ミドルウェアの実行を表す Task が返されます。

規則でアクティブ化されるミドルウェア:

public class ConventionalMiddleware
{
    private readonly RequestDelegate _next;

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

    public async Task InvokeAsync(HttpContext context, AppDbContext db)
    {
        var keyValue = context.Request.Query["key"];

        if (!string.IsNullOrWhiteSpace(keyValue))
        {
            db.Add(new Request()
                {
                    DT = DateTime.UtcNow, 
                    MiddlewareActivation = "ConventionalMiddleware", 
                    Value = keyValue
                });

            await db.SaveChangesAsync();
        }

        await _next(context);
    }
}

MiddlewareFactory でアクティブ化されるミドルウェア:

public class FactoryActivatedMiddleware : IMiddleware
{
    private readonly AppDbContext _db;

    public FactoryActivatedMiddleware(AppDbContext db)
    {
        _db = db;
    }

    public async Task InvokeAsync(HttpContext context, RequestDelegate next)
    {
        var keyValue = context.Request.Query["key"];

        if (!string.IsNullOrWhiteSpace(keyValue))
        {
            _db.Add(new Request()
                {
                    DT = DateTime.UtcNow, 
                    MiddlewareActivation = "FactoryActivatedMiddleware", 
                    Value = keyValue
                });

            await _db.SaveChangesAsync();
        }

        await next(context);
    }
}

ミドルウェア用に拡張機能が作成されます。

public static class MiddlewareExtensions
{
    public static IApplicationBuilder UseConventionalMiddleware(
        this IApplicationBuilder builder)
    {
        return builder.UseMiddleware<ConventionalMiddleware>();
    }

    public static IApplicationBuilder UseFactoryActivatedMiddleware(
        this IApplicationBuilder builder)
    {
        return builder.UseMiddleware<FactoryActivatedMiddleware>();
    }
}

UseMiddleware では、ファクトリでアクティブ化されたミドルウェアにオブジェクトを渡すことはできません。

public static IApplicationBuilder UseFactoryActivatedMiddleware(
    this IApplicationBuilder builder, bool option)
{
    // Passing 'option' as an argument throws a NotSupportedException at runtime.
    return builder.UseMiddleware<FactoryActivatedMiddleware>(option);
}

ファクトリでアクティブ化されたミドルウェアは、Startup.ConfigureServices の組み込みのコンテナーに追加されます。

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<AppDbContext>(options =>
        options.UseInMemoryDatabase("InMemoryDb"));

    services.AddTransient<FactoryActivatedMiddleware>();

    services.AddRazorPages();
}

この 2 つのミドルウェアは、Startup.Configure の要求処理パイプラインに登録されます。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Error");
    }

    app.UseConventionalMiddleware();
    app.UseFactoryActivatedMiddleware();

    app.UseStaticFiles();
    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapRazorPages();
    });
}

IMiddlewareFactory

IMiddlewareFactory では、ミドルウェアを作成するメソッドが提供されます。 ミドルウェア ファクトリの実装は、スコープ化されたサービスとして、コンテナーに登録されます。

既定の IMiddlewareFactory の実装である MiddlewareFactory は、Microsoft.AspNetCore.Http パッケージにあります。

その他の技術情報

IMiddlewareFactory/IMiddleware は、ミドルウェアのアクティブ化の拡張ポイントです。

UseMiddleware 拡張メソッドでは、ミドルウェアの登録済みの型で IMiddleware が実装されているかが確認されます。 実装されている場合、規則に基づくミドルウェアのライセンス認証ロジックを使用する代わりに、コンテナーに登録されている IMiddlewareFactory インスタンスが IMiddleware の実装の解決に使用されます。 ミドルウェアは、アプリのサービス コンテナーで、スコープ サービスまたは一時的サービスとして登録されています。

利点:

  • クライアント要求ごとにアクティブ化 (スコープ サービスの挿入)
  • ミドルウェアの厳密な型指定

IMiddleware はクライアント要求 (接続) ごとにアクティブ化されているので、スコープ サービスをミドルウェアのコンストラクターに挿入することができます。

サンプル コードを表示またはダウンロードします (ダウンロード方法)。

IMiddleware

IMiddleware では、アプリの要求パイプライン用にミドルウェアが定義されます。 要求は、InvokeAsync (HttpContext, RequestDelegate) メソッドによって処理され、ミドルウェアの実行を表す Task が返されます。

規則でアクティブ化されるミドルウェア:

public class ConventionalMiddleware
{
    private readonly RequestDelegate _next;

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

    public async Task InvokeAsync(HttpContext context, AppDbContext db)
    {
        var keyValue = context.Request.Query["key"];

        if (!string.IsNullOrWhiteSpace(keyValue))
        {
            db.Add(new Request()
                {
                    DT = DateTime.UtcNow, 
                    MiddlewareActivation = "ConventionalMiddleware", 
                    Value = keyValue
                });

            await db.SaveChangesAsync();
        }

        await _next(context);
    }
}

MiddlewareFactory でアクティブ化されるミドルウェア:

public class FactoryActivatedMiddleware : IMiddleware
{
    private readonly AppDbContext _db;

    public FactoryActivatedMiddleware(AppDbContext db)
    {
        _db = db;
    }

    public async Task InvokeAsync(HttpContext context, RequestDelegate next)
    {
        var keyValue = context.Request.Query["key"];

        if (!string.IsNullOrWhiteSpace(keyValue))
        {
            _db.Add(new Request()
                {
                    DT = DateTime.UtcNow, 
                    MiddlewareActivation = "FactoryActivatedMiddleware", 
                    Value = keyValue
                });

            await _db.SaveChangesAsync();
        }

        await next(context);
    }
}

ミドルウェア用に拡張機能が作成されます。

public static class MiddlewareExtensions
{
    public static IApplicationBuilder UseConventionalMiddleware(
        this IApplicationBuilder builder)
    {
        return builder.UseMiddleware<ConventionalMiddleware>();
    }

    public static IApplicationBuilder UseFactoryActivatedMiddleware(
        this IApplicationBuilder builder)
    {
        return builder.UseMiddleware<FactoryActivatedMiddleware>();
    }
}

UseMiddleware では、ファクトリでアクティブ化されたミドルウェアにオブジェクトを渡すことはできません。

public static IApplicationBuilder UseFactoryActivatedMiddleware(
    this IApplicationBuilder builder, bool option)
{
    // Passing 'option' as an argument throws a NotSupportedException at runtime.
    return builder.UseMiddleware<FactoryActivatedMiddleware>(option);
}

ファクトリでアクティブ化されたミドルウェアは、Startup.ConfigureServices の組み込みのコンテナーに追加されます。

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<AppDbContext>(options =>
        options.UseInMemoryDatabase("InMemoryDb"));

    services.AddTransient<FactoryActivatedMiddleware>();

    services.AddMvc()
        .SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

この 2 つのミドルウェアは、Startup.Configure の要求処理パイプラインに登録されます。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
        app.UseDatabaseErrorPage();
    }
    else
    {
        app.UseExceptionHandler("/Error");
    }

    app.UseConventionalMiddleware();
    app.UseFactoryActivatedMiddleware();

    app.UseStaticFiles();
    app.UseMvc();
}

IMiddlewareFactory

IMiddlewareFactory では、ミドルウェアを作成するメソッドが提供されます。 ミドルウェア ファクトリの実装は、スコープ化されたサービスとして、コンテナーに登録されます。

既定の IMiddlewareFactory の実装である MiddlewareFactory は、Microsoft.AspNetCore.Http パッケージにあります。

その他の技術情報