EF Core 中如何优雅地添加数据库上下文拦截器

在 EF Core 开发中，拦截器(Interceptor)是一个强大的功能，它允许开发者在数据库操作的关键点插入自定义逻辑。本文将探讨在 EF Core 9 中如何优雅地为 DbContext 添加拦截器，特别是在 Aspire 项目中的最佳实践。

拦截器的作用场景

EF Core 拦截器可以用于多种场景：

• 审计日志记录
• 数据验证
• 性能监控
• 查询重写
• 缓存实现

传统添加拦截器的方式

传统上，我们可以直接在 DbContext 配置中添加拦截器：

services.AddDbContext<ModelContext>((provider, options) =>
{
    options.UseLazyLoadingProxies()
        .ReplaceService<ILazyLoader, EnableDisableLazyLoader>()
        .AddInterceptors(
            provider.GetRequiredService<ValidateSaveChangesInterceptor>(),
            provider.GetRequiredService<ServiceLoggerSaveChangesInterceptor<ModelContext>>()
        );
});

这种方式在普通 ASP.NET Core 应用中工作良好，但在 Aspire 项目中会遇到限制。

Aspire 项目中的挑战

Aspire 框架提供的 AddSqlServerDbContext 方法没有直接暴露 IServiceProvider 参数，这使得从依赖注入容器解析拦截器变得困难。开发者可能会尝试在 DbContext 的 OnConfiguring 方法中添加拦截器：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    base.OnConfiguring(optionsBuilder);
    optionsBuilder.AddInterceptors(
        provider.GetRequiredService<ValidateSaveChangesInterceptor>(),
        provider.GetRequiredService<ServiceLoggerSaveChangesInterceptor<ModelContext>>()
    );
}

但这种方法有两个主要问题：

1. 配置被限制在 DbContext 内部，不够灵活
2. 当 DbContext 被健康检查等机制使用时，会尝试从根容器解析作用域服务，导致错误

推荐的解决方案

方案一：使用 ConfigureDbContext

Aspire 提供了 ConfigureDbContext 方法，可以更灵活地配置 DbContext：

builder.ConfigureDbContext<DbContext>(
    (provider, options) => options.AddInterceptors(provider.GetRequiredService<ValidateSaveChangesInterceptor>()));

方案二：分离注册与丰富

将 DbContext 注册与特定数据库提供者配置分离：

// 先注册 DbContext
builder.AddDbContext<ModelContext>();

// 然后丰富 SQL Server 特定配置
builder.EnrichSqlServerDbContext<ModelContext>();

方案三：自定义扩展方法

创建一个扩展方法来简化拦截器注册：

public static IServiceCollection AddDbContextInterceptor<TContext, TInterceptor>(
    this IServiceCollection services,
    ServiceLifetime optionsLifetime = ServiceLifetime.Scoped)
    where TContext : DbContext
    where TInterceptor : IInterceptor
{
    Action<IServiceProvider, DbContextOptionsBuilder> optionsAction = (sp, builder) =>
    {
        builder.AddInterceptors(sp.GetRequiredService<TInterceptor>());
    };
    
    services.Add(ServiceDescriptor.Describe(typeof(TInterceptor), typeof(TInterceptor), optionsLifetime));
    services.Add(ServiceDescriptor.Describe(typeof(IDbContextOptionsConfiguration<TContext>), _ => 
        new DbContextOptionsConfiguration<TContext>(optionsAction), optionsLifetime));
    
    return services;
}

最佳实践建议

1. 作用域管理：确保拦截器的生命周期与 DbContext 匹配，通常使用 Scoped 生命周期
2. 避免根容器解析：不要在应用程序启动时从根容器解析拦截器
3. 考虑拦截器顺序：多个拦截器的执行顺序可能很重要
4. 性能考量：拦截器会在每个数据库操作中执行，确保其中的逻辑高效
5. 异常处理：在拦截器中妥善处理异常，避免影响正常的数据库操作

通过以上方法，开发者可以在 EF Core 中灵活、优雅地添加和管理拦截器，特别是在 Aspire 项目中实现更干净的架构设计。