如何在ASP.NET Core集成测试中断言EF Core的SQL查询执行数量？

核心思路 #

通过EF Core的命令拦截器直接统计SQL查询的执行次数，无需解析日志，实现精准断言，快速检测N+1查询问题。

实现步骤 #

1. 编写查询计数拦截器 #

创建一个继承自DbCommandInterceptor的类，拦截同步和异步SQL命令执行并计数：

public class QueryCountInterceptor : DbCommandInterceptor
{
    public int ExecutedQueryCount { get; private set; }

    // 拦截同步查询执行
    public override InterceptionResult<DbDataReader> ReaderExecuting(
        DbCommand command,
        CommandEventData eventData,
        InterceptionResult<DbDataReader> result)
    {
        ExecutedQueryCount++;
        return result;
    }

    // 拦截异步查询执行
    public override Task<InterceptionResult<DbDataReader>> ReaderExecutingAsync(
        DbCommand command,
        CommandEventData eventData,
        InterceptionResult<DbDataReader> result,
        CancellationToken cancellationToken = default)
    {
        ExecutedQueryCount++;
        return Task.FromResult(result);
    }

    // 重置计数器，用于重复测试场景
    public void Reset() => ExecutedQueryCount = 0;
}

2. 在集成测试工厂中注册拦截器 #

自定义WebApplicationFactory，替换原有DbContext配置，将拦截器注入EF Core：

public class TestWebAppFactory<TStartup> : WebApplicationFactory<TStartup> where TStartup : class
{
    // 暴露拦截器实例，供测试用例访问计数
    public QueryCountInterceptor QueryCounter { get; } = new QueryCountInterceptor();

    protected override void ConfigureWebHost(IWebHostBuilder builder)
    {
        builder.ConfigureServices(services =>
        {
            // 移除原有DbContext的配置项
            var dbContextDescriptor = services.SingleOrDefault(
                d => d.ServiceType == typeof(DbContextOptions<YourDbContext>));
            if (dbContextDescriptor != null)
            {
                services.Remove(dbContextDescriptor);
            }

            // 注册带拦截器的DbContext，使用内存数据库（如SQLite）
            services.AddDbContext<YourDbContext>((sp, options) =>
            {
                options.UseSqlite("Data Source=:memory:");
                options.AddInterceptors(QueryCounter);
            });
        });
    }
}

3. 编写集成测试用例 #

在测试中重置计数器，发送HTTP请求后断言查询数量：

public class YourEndpointTests : IClassFixture<TestWebAppFactory<Startup>>
{
    private readonly HttpClient _client;
    private readonly QueryCountInterceptor _queryCounter;

    public YourEndpointTests(TestWebAppFactory<Startup> factory)
    {
        _client = factory.CreateClient();
        _queryCounter = factory.QueryCounter;
    }

    [Fact]
    public async Task Get_YourEndpoint_Should_Execute_Exactly_1_Query()
    {
        // 重置计数器
        _queryCounter.Reset();

        // 发送请求到目标端点
        var response = await _client.GetAsync("/api/your-resource");

        // 验证请求成功
        response.EnsureSuccessStatusCode();

        // 断言查询执行次数符合预期
        Assert.Equal(1, _queryCounter.ExecutedQueryCount);
    }
}

补充说明 #

• 如果需要统计所有SQL命令（包括INSERT/UPDATE/DELETE），可以覆盖DbCommandInterceptor的NonQueryExecuting和NonQueryExecutingAsync方法
• 测试时建议使用内存数据库（如SQLite），避免外部数据库依赖，提升测试速度和稳定性
• 拦截器会精准统计每个实际执行的SQL命令，能有效检测N+1查询问题（比如预期1次查询，实际执行10次时断言直接失败）

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