在C#项目中实现单元测试与Web API的上下文共享方案问询

核心思路 #

将DbContext的配置逻辑抽离为可复用代码，让Web API和测试项目共用同一套配置规则，仅在测试时动态替换连接字符串中的数据库名称——既保证两者的Context配置完全一致，又满足测试用独立数据库的需求。

具体实现方案 #

方案1：抽离DbContext配置为扩展方法（依赖注入场景） #

适合Web API和测试项目都基于依赖注入的场景，统一配置逻辑。

1. 创建配置扩展方法
   在共享类库或Web API项目中添加静态扩展类，封装DbContext的配置逻辑：

public static class ServiceCollectionExtensions
{
    public static IServiceCollection AddAppDbContext(this IServiceCollection services, string connectionString)
    {
        services.AddDbContext<Context>(options =>
        {
            options.UseSqlServer(connectionString);
            // 可添加其他统一配置，比如：
            // options.EnableSensitiveDataLogging();
            // options.UseQueryTrackingBehavior(QueryTrackingBehavior.NoTracking);
        });
        return services;
    }
}

2. 修改Web API的Program.cs
   替换原有的DbContext注册代码，调用扩展方法：

var connectionString = Environment.GetEnvironmentVariable("ConnectionString");
builder.Services.AddAppDbContext(connectionString);

3. 修改测试项目的TestBase
   通过构建服务提供者复用扩展方法，确保配置一致：

public TestBase()
{
    var connectionString = Environment.GetEnvironmentVariable("ConnectionString");
    // 替换数据库名称为带Guid的独立名称
    connectionString = connectionString.Replace("dbName", $"dbName{Guid.NewGuid()}");

    // 构建服务容器并注册Context
    var services = new ServiceCollection();
    services.AddAppDbContext(connectionString);
    
    var serviceProvider = services.BuildServiceProvider();
    context = serviceProvider.GetRequiredService<Context>();
    context.Database.Migrate();
}

方案2：抽离配置逻辑为静态方法（直接实例化Context场景） #

如果测试项目习惯直接new Context，可将配置逻辑抽为静态方法：

1. 创建配置静态类

public static class ContextConfiguration
{
    public static void Configure(DbContextOptionsBuilder<Context> builder, string connectionString)
    {
        builder.UseSqlServer(connectionString);
        // 统一配置项和Web API保持一致
    }
}

2. 修改Web API的Program.cs

var connectionString = Environment.GetEnvironmentVariable("ConnectionString");
builder.Services.AddDbContext<Context>(options =>
    ContextConfiguration.Configure(options, connectionString));

3. 修改测试项目的TestBase

public TestBase()
{
    var connectionString = Environment.GetEnvironmentVariable("ConnectionString");
    connectionString = connectionString.Replace("dbName", $"dbName{Guid.NewGuid()}");

    var optionsBuilder = new DbContextOptionsBuilder<Context>();
    ContextConfiguration.Configure(optionsBuilder, connectionString);
    
    context = new Context(optionsBuilder.Options);
    context.Database.Migrate();
}

方案3：使用WebApplicationFactory做集成测试（推荐） #

如果是集成测试，使用WebApplicationFactory可以完全复用Web API的启动配置，仅替换连接字符串：

1. 自定义WebApplicationFactory

public class TestWebApplicationFactory : WebApplicationFactory<Program>
{
    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureServices(services =>
        {
            // 移除原有Context的配置
            var contextDescriptor = services.SingleOrDefault(
                d => d.ServiceType == typeof(DbContextOptions<Context>));
            if (contextDescriptor != null)
            {
                services.Remove(contextDescriptor);
            }

            // 生成独立测试数据库的连接字符串
            var connectionString = Environment.GetEnvironmentVariable("ConnectionString");
            connectionString = connectionString.Replace("dbName", $"dbName{Guid.NewGuid()}");

            // 重新注册Context，复用Web API的配置逻辑
            services.AddAppDbContext(connectionString);

            // 迁移数据库
            using var scope = services.BuildServiceProvider().CreateScope();
            var context = scope.ServiceProvider.GetRequiredService<Context>();
            context.Database.Migrate();
        });
    }
}

2. 在测试类中使用

public class ApiTests : IClassFixture<TestWebApplicationFactory>
{
    private readonly HttpClient _httpClient;
    private readonly Context _dbContext;

    public ApiTests(TestWebApplicationFactory factory)
    {
        _httpClient = factory.CreateClient();
        _dbContext = factory.Services.CreateScope().ServiceProvider.GetRequiredService<Context>();
    }

    // 测试方法示例
    [Fact]
    public async Task Get_Items_ReturnsSuccess()
    {
        // 使用_dbContext操作测试数据库
        // 使用_httpClient调用API接口
    }
}

关键优势 #

• 确保Web API和测试项目的DbContext配置完全一致，避免因配置差异导致的测试无效
• 测试用独立数据库，支持并行测试，不会互相干扰
• 配置逻辑集中维护，后续修改只需调整一处代码

内容的提问来源于stack exchange，提问作者Jaczura Zoltán