.NET 6最小Web API单元测试：如何注入对象或启用测试服务器？

背景 #

• 正在更新公司ASP.NET Web应用与Web API的初始化方式，原环境为.NET Core 3.1，仅能通过localhost套接字执行集成测试，要求代码贴合最新技术标准
• 切换到.NET 6最小API后，因隐式特性受阻，需实现：
  • 测试代码中直接创建对象并注入Program.cs的初始化逻辑
  • 指定测试专用命令行参数
  • 设置标记跳过部分初始化步骤
  • 直接注入Mock/Stub，而非先创建生产实例再替换
• 拒绝通过配置文件控制，要求在测试代码中直接操作

已尝试的无效方案 #

• 创建分部Program.cs，无法访问相关成员
• 最小API的Program.cs无可用this指针，推测导出到静态上下文或隐藏实例
• 自动生成的Program类无初始化插入点，builder.Build()前无法通过服务注入修改逻辑
• 调试时无法查看自动生成的Program类细节
• 静态变量方案：无法并行执行多测试；静态字典映射测试依赖：找不到传递密钥的方式，方案不合理

可行解决方案 #

方案1：显式化Program类，移除隐式顶层语句 #

将最小API的隐式顶层语句改为显式类结构，直接控制初始化逻辑，便于测试调用：

// Program.cs
namespace YourAppNamespace;

public class Program
{
    // 封装初始化逻辑，接收命令行参数和自定义配置委托
    public static WebApplication CreateWebApplication(string[] args, Action<WebApplicationBuilder>? configureBuilder = null)
    {
        var builder = WebApplication.CreateBuilder(args);

        // 执行测试传入的自定义配置逻辑
        configureBuilder?.Invoke(builder);

        // 原有服务注册逻辑
        builder.Services.AddControllers();
        // ...其他生产环境服务注册

        var app = builder.Build();

        // 原有中间件管道配置
        if (app.Environment.IsDevelopment())
        {
            app.UseSwagger();
            app.UseSwaggerUI();
        }

        app.UseHttpsRedirection();
        app.UseAuthorization();
        app.MapControllers();

        return app;
    }

    public static void Main(string[] args)
    {
        var app = CreateWebApplication(args);
        app.Run();
    }
}

测试代码中直接调用CreateWebApplication，传入测试参数和Mock逻辑：

// 测试类
using YourAppNamespace;
using Moq;

public class ApiIntegrationTests
{
    [Fact]
    public async Task TestApiWithMockedService()
    {
        // 测试用命令行参数
        var testArgs = new[] { "--Environment=Testing", "--SkipProductionInit=true" };

        // 创建Mock服务
        var mockedService = new Mock<IMyService>();
        mockedService.Setup(s => s.GetData()).ReturnsAsync("Test Data");

        // 初始化应用并注入Mock
        var app = Program.CreateWebApplication(testArgs, builder =>
        {
            // 移除原有服务注册
            builder.Services.RemoveAll<IMyService>();
            // 注入Mock实例
            builder.Services.AddSingleton(mockedService.Object);
            // 添加测试专用服务或跳过初始化步骤
            builder.Services.RemoveAll<IProductionOnlyService>();
        });

        // 创建测试服务器与客户端
        using var testServer = new TestServer(app.Services.GetRequiredService<IWebHostEnvironment>());
        var client = testServer.CreateClient();

        // 执行测试请求
        var response = await client.GetAsync("/api/data");
        response.EnsureSuccessStatusCode();

        var content = await response.Content.ReadAsStringAsync();
        Assert.Equal("Test Data", content);
    }
}

方案2：保留顶层语句，用自定义WebApplicationFactory扩展 #

若不想放弃最小API的顶层语句，可通过WebApplicationFactory自定义实现传递测试上下文：

首先在Program.cs末尾添加分部类，让测试项目能访问Program：

// Program.cs
var builder = WebApplication.CreateBuilder(args);

// 原有服务注册逻辑
builder.Services.AddScoped<IMyService, MyServiceImpl>();
// ...

var app = builder.Build();

// 原有中间件配置
// ...

app.Run();

// 添加分部类，开放访问权限
public partial class Program { }

测试项目中创建自定义工厂：

public class CustomWebApplicationFactory : WebApplicationFactory<Program>
{
    private readonly Action<WebApplicationBuilder> _configureBuilder;
    private readonly string[] _testArgs;

    public CustomWebApplicationFactory(string[] testArgs, Action<WebApplicationBuilder> configureBuilder)
    {
        _testArgs = testArgs;
        _configureBuilder = configureBuilder;
    }

    protected override IHost CreateHost(IHostBuilder builder)
    {
        // 覆盖命令行参数
        builder.ConfigureAppConfiguration((context, config) =>
        {
            config.AddCommandLine(_testArgs);
        });

        // 自定义服务配置
        builder.ConfigureServices((context, services) =>
        {
            _configureBuilder?.Invoke(builder.WebHost.GetApplicationBuilder());
        });

        return base.CreateHost(builder);
    }
}

测试时使用该工厂：

[Fact]
public async Task TestWithCustomFactory()
{
    var mockedService = new Mock<IMyService>();
    mockedService.Setup(s => s.GetData()).ReturnsAsync("Mocked Test Data");

    using var factory = new CustomWebApplicationFactory(
        new[] { "--Environment=Testing" },
        builder =>
        {
            builder.Services.RemoveAll<IMyService>();
            builder.Services.AddSingleton(mockedService.Object);
            // 跳过生产初始化步骤
            builder.Services.RemoveAll<ISomeProductionOnlyService>();
        });

    var client = factory.CreateClient();
    var response = await client.GetAsync("/api/data");
    var content = await response.Content.ReadAsStringAsync();

    Assert.Equal("Mocked Test Data", content);
}

关键注意事项 #

• 显式化Program类是最直接的方案，彻底消除隐式逻辑的测试限制，不影响生产环境执行
• 若保留顶层语句，必须添加public partial class Program { }开放访问权限
• 禁止使用静态变量传递测试上下文，确保测试可并行执行
• 可通过命令行参数或配置逻辑设置标记，跳过生产环境专属初始化步骤（如数据库迁移、外部服务连接）

内容的提问来源于stack exchange，提问作者Bjarne