ASP.NET Core 6.0 での新しい最小ホスティングモデルに移行されたコードサンプル

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

この記事では、ASP.NET Core 6.0 へ移行されたコードのサンプルについて説明します。 ASP.NET Core 6.0 では、新しい最小ホスティングモデルが使用されています。詳細については、「新しいホスティングモデル」を参照してください。

ミドルウェア

次のコードでは、静的ファイルミドルウェアを ASP.NET Core 5 アプリに追加します。

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.UseStaticFiles();
    }
}

次のコードでは、静的ファイルミドルウェアを ASP.NET Core 6 アプリに追加します。

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.UseStaticFiles();

app.Run();

WebApplication.CreateBuilder は、事前に構成された既定値を使用して WebApplicationBuilder クラスの新しいインスタンスを初期化します。詳細については、「ASP.NET Core のミドルウェア」を参照してください

ルート指定

次のコードでは、ASP.NET Core 5 アプリにエンドポイントを追加します。

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.UseRouting();
        app.UseEndpoints(endpoints =>
        {
            endpoints.MapGet("/", () => "Hello World");
        });
    }
}

.NET 6 では、UseEndpoints または UseRouting への明示的な呼び出しを行うことなく、WebApplication にルートを直接追加できます。次のコードでは、ASP.NET Core 6 アプリにエンドポイントを追加します。

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

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

app.Run();

注: ルートは、パイプラインの "最後" で、WebApplication execute に直接追加されます。

コンテンツルート、アプリ名、環境の変更

ASP.NET Core 5

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .UseContentRoot(Directory.GetCurrentDirectory())
        .UseEnvironment(Environments.Staging)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>()
                      .UseSetting(WebHostDefaults.ApplicationKey,
                                  typeof(Program).Assembly.FullName);
        });

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(new WebApplicationOptions
{
    Args = args,
    ApplicationName = typeof(Program).Assembly.FullName,
    ContentRootPath = Directory.GetCurrentDirectory(),
    EnvironmentName = Environments.Staging,
    WebRootPath = "customwwwroot"
});

Console.WriteLine($"Application Name: {builder.Environment.ApplicationName}");
Console.WriteLine($"Environment Name: {builder.Environment.EnvironmentName}");
Console.WriteLine($"ContentRoot Path: {builder.Environment.ContentRootPath}");
Console.WriteLine($"WebRootPath: {builder.Environment.WebRootPath}");

var app = builder.Build();

詳細については、「ASP.NET Core の基礎の概要」を参照してください

環境変数またはコマンドラインを使用したコンテンツルート、アプリ名、環境の変更

次の表は、コンテンツルート、アプリ名、環境を変更するために使用される環境変数とコマンドライン引数を示しています。

の機能	環境変数	コマンドライン引数
アプリケーション名	ASPNETCORE_APPLICATIONNAME	--applicationName
環境名	ASPNETCORE_ENVIRONMENT	--environment
コンテンツルート	ASPNETCORE_CONTENTROOT	--contentRoot

構成プロバイダーの追加

ASP.NET Core 5

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration(config =>
        {
            config.AddIniFile("appsettings.ini");
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(args);

builder.Configuration.AddIniFile("appsettings.ini");

var app = builder.Build();

詳細については、「ASP.NET Core の構成」の「ファイル構成プロバイダー」を参照してください。

ログプロバイダーを追加する

ASP.NET Core 5

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureLogging(logging =>
        {
            logging.AddJsonConsole();
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(args);

// Configure JSON logging to the console.
builder.Logging.AddJsonConsole();

var app = builder.Build();

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

サービスの追加

ASP.NET Core 5

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // Add the memory cache services
        services.AddMemoryCache();

        // Add a custom scoped service
        services.AddScoped<ITodoRepository, TodoRepository>();
    }
}

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(args);

// Add the memory cache services.
builder.Services.AddMemoryCache();

// Add a custom scoped service.
builder.Services.AddScoped<ITodoRepository, TodoRepository>();
var app = builder.Build();

詳細については、「ASP.NET Core での依存関係の挿入」を参照してください。

IHostBuilder または IWebHostBuilder のカスタマイズ

IHostBuilder のカスタマイズ

ASP.NET Core 5

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureHostOptions(o => o.ShutdownTimeout = TimeSpan.FromSeconds(30));
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(args);

// Wait 30 seconds for graceful shutdown.
builder.Host.ConfigureHostOptions(o => o.ShutdownTimeout = TimeSpan.FromSeconds(30));

var app = builder.Build();

IWebHostBuilder のカスタマイズ

ASP.NET Core 5

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            // Change the HTTP server implementation to be HTTP.sys based.
            webBuilder.UseHttpSys()
                      .UseStartup<Startup>();
        });

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(args);

// Change the HTTP server implementation to be HTTP.sys based.
// Windows only.
builder.WebHost.UseHttpSys();

var app = builder.Build();

Web ルートを変更する

既定では、Web ルートは、wwwroot フォルダーのコンテンツルートに対して相対的です。静的ファイルミドルウェアは、Web ルートで静的ファイルを探します。 Web ルートは、WebApplicationOptions の WebRootPath プロパティを設定することにより変更できます。

ASP.NET Core 5

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            // Look for static files in webroot.
            webBuilder.UseWebRoot("webroot")
                      .UseStartup<Startup>();
        });

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(new WebApplicationOptions
{
    Args = args,
    // Look for static files in webroot
    WebRootPath = "webroot"
});

var app = builder.Build();

カスタムの依存関係の挿入 (DI) コンテナー

次の .NET 5 および .NET 6 サンプルには、Autofac が使用されています

ASP.NET Core 5

Program クラス

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .UseServiceProviderFactory(new AutofacServiceProviderFactory())
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

Startup

public class Startup
{
    public void ConfigureContainer(ContainerBuilder containerBuilder)
    {
    }
}

ASP.NET Core 6

var builder = WebApplication.CreateBuilder(args);

builder.Host.UseServiceProviderFactory(new AutofacServiceProviderFactory());

// Register services directly with Autofac here. Don't
// call builder.Populate(), that happens in AutofacServiceProviderFactory.
builder.Host.ConfigureContainer<ContainerBuilder>(builder => builder.RegisterModule(new MyApplicationModule()));

var app = builder.Build();

その他のサービスへのアクセス

Startup.Configure を使用すると、IServiceCollection 経由で追加された任意のサービスを挿入できます。

ASP.NET Core 5

public class Startup
{
    // This method gets called by the runtime. Use this method to add services
    // to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddSingleton<IService, Service>();
    }

    // Anything added to the service collection can be injected into Configure.
    public void Configure(IApplicationBuilder app,
                          IWebHostEnvironment env,
                          IHostApplicationLifetime lifetime,
                          IService service,
                          ILogger<Startup> logger)
    {
        lifetime.ApplicationStarted.Register(() =>
            logger.LogInformation(
                "The application {Name} started in the injected {Service}",
                env.ApplicationName, service));
    }
}

ASP.NET Core 6

ASP.NET Core 6 の内容は、次のとおりです。

WebApplication の最上位レベルのプロパティとして使用できる一般的なサービスがいくつかあります。
追加のサービスは、IServiceProvider から、WebApplication.Services 経由で、手動で解決する必要があります。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddSingleton<IService, Service>();

var app = builder.Build();

IService service = app.Services.GetRequiredService<IService>();
ILogger logger = app.Logger;
IHostApplicationLifetime lifetime = app.Lifetime;
IWebHostEnvironment env = app.Environment;

lifetime.ApplicationStarted.Register(() =>
    logger.LogInformation(
        $"The application {env.ApplicationName} started" +
        $" with injected {service}"));

WebApplicationFactory または TestServer を使用したテスト

ASP.NET Core 5

次のサンプルでは、テストプロジェクトで TestServer と WebApplicationFactory<TEntryPoint> が使用されます。これらは、明示的な参照を必要とする個別のパッケージとして出荷されます。

WebApplicationFactory

<ItemGroup>
  <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="{Version}" />
</ItemGroup>

TestServer

<ItemGroup>
  <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="{Version}" />
</ItemGroup>

ASP.NET Core 5 コード

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddSingleton<IHelloService, HelloService>();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IHelloService helloService)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapGet("/", async context =>
            {
                await context.Response.WriteAsync(helloService.HelloMessage);
            });
        });
    }
}

TestServer を使用する場合

[Fact]
public async Task HelloWorld()
{
    using var host = Host.CreateDefaultBuilder()
        .ConfigureWebHostDefaults(builder =>
        {
            // Use the test server and point to the application's startup
            builder.UseTestServer()
                    .UseStartup<WebApplication1.Startup>();
        })
        .ConfigureServices(services =>
        {
            // Replace the service
            services.AddSingleton<IHelloService, MockHelloService>();
        })
        .Build();

    await host.StartAsync();

    var client = host.GetTestClient();

    var response = await client.GetStringAsync("/");

    Assert.Equal("Test Hello", response);
}

class MockHelloService : IHelloService
{
    public string HelloMessage => "Test Hello";
}

WebApplicationFactory を使用する場合

[Fact]
public async Task HelloWorld()
{
    var application = new WebApplicationFactory<Program>()
        .WithWebHostBuilder(builder =>
        {
            builder.ConfigureServices(services =>
            {
                services.AddSingleton<IHelloService, MockHelloService>();
            });
        });

    var client = application.CreateClient();

    var response = await client.GetStringAsync("/");

    Assert.Equal("Test Hello", response);
}

class MockHelloService : IHelloService
{
    public string HelloMessage => "Test Hello";
}

ASP.NET Core 6


var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton<IHelloService, HelloService>();

var app = builder.Build();

var helloService = app.Services.GetRequiredService<IHelloService>();

app.MapGet("/", async context =>
{
    await context.Response.WriteAsync(helloService.HelloMessage);
});

app.Run();

プロジェクトファイル (.csproj)

プロジェクトファイルには、次のいずれかを含めることができます。

<ItemGroup>
    <InternalsVisibleTo Include="MyTestProject" />
</ItemGroup>

または

[assembly: InternalsVisibleTo("MyTestProject")]

別の方法として、Program クラスをパブリックにすることもできます。 Program は、プロジェクトまたは Program.cs で public partial Program クラスを定義することで、最上位レベルのステートメントを使用して、パブリックにすることができます。

var builder = WebApplication.CreateBuilder(args);

// ... Configure services, routes, etc.

app.Run();

public partial class Program { }

[Fact]
public async Task HelloWorld()
{
    var application = new WebApplicationFactory<Program>()
        .WithWebHostBuilder(builder =>
        {
            builder.ConfigureServices(services =>
            {
                services.AddSingleton<IHelloService, MockHelloService>();
            });
        });

    var client = application.CreateClient();

    var response = await client.GetStringAsync("/");

    Assert.Equal("Test Hello", response);
}

class MockHelloService : IHelloService
{
    public string HelloMessage => "Test Hello";
}

.NET 5 バージョンと .NET 6 バージョンは、WebApplicationFactory の設計上同一です。

次の方法で共有

ASP.NET Core 6.0 での新しい最小ホスティング モデルに移行されたコード サンプル

ミドルウェア

ルート指定

コンテンツ ルート、アプリ名、環境の変更

ASP.NET Core 5

ASP.NET Core 6

環境変数またはコマンド ラインを使用したコンテンツ ルート、アプリ名、環境の変更

構成プロバイダーの追加

ASP.NET Core 5

ASP.NET Core 6

ログ プロバイダーを追加する

ASP.NET Core 5

ASP.NET Core 6

サービスの追加

ASP.NET Core 5

ASP.NET Core 6

IHostBuilder または IWebHostBuilder のカスタマイズ

IHostBuilder のカスタマイズ

ASP.NET Core 5

ASP.NET Core 6

IWebHostBuilder のカスタマイズ

ASP.NET Core 5

ASP.NET Core 6

Web ルートを変更する

ASP.NET Core 5

ASP.NET Core 6

カスタムの依存関係の挿入 (DI) コンテナー

ASP.NET Core 5

ASP.NET Core 6

その他のサービスへのアクセス

ASP.NET Core 5

ASP.NET Core 6

WebApplicationFactory または TestServer を使用したテスト

ASP.NET Core 5

WebApplicationFactory

TestServer

ASP.NET Core 5 コード

TestServer を使用する場合

WebApplicationFactory を使用する場合

ASP.NET Core 6

プロジェクト ファイル (.csproj)

その他のリソース

ASP.NET Core 6.0 での新しい最小ホスティングモデルに移行されたコードサンプル

コンテンツルート、アプリ名、環境の変更

環境変数またはコマンドラインを使用したコンテンツルート、アプリ名、環境の変更

ログプロバイダーを追加する

プロジェクトファイル (.csproj)