什么是查询拦截器？在EF Core中如何使用它？-C#.Net教程-PHP中文网

什么是查询拦截器？在EF Core中如何使用它？

月夜之吻

发布： 2025-10-12 10:58:01

原创

693人浏览过

查询拦截器是EF Core中用于捕获和处理数据库操作的功能，通过继承DbCommandInterceptor并重写方法实现，可用于日志记录、性能监控、多租户过滤等场景，在DbContext配置时使用AddInterceptors注册，能提升系统可观测性与安全性，但应避免在拦截器中执行耗时操作以免影响性能。

什么是查询拦截器？在ef core中如何使用它？

查询拦截器是一种允许你在EF Core中拦截数据库操作的功能，主要用于修改或记录查询执行过程中的行为。它属于EF Core的拦截机制（Interception）的一部分，能够让你在不改变业务代码的前提下，对查询进行审计、日志记录、数据过滤或性能监控等操作。

查询拦截器的作用

查询拦截器可以捕获与数据库相关的操作，比如：

SQL 查询语句的生成和执行
命令的执行时间
连接的打开与关闭

通过实现自定义逻辑，你可以在查询发送到数据库之前或之后进行处理，例如添加默认过滤条件、记录慢查询或实现多租户数据隔离。

如何在EF Core中使用查询拦截器

要在EF Core中使用查询拦截器，需要创建一个类继承 DbCommandInterceptor，并重写相关方法。然后在 DbContext 配置时注册该拦截器。

1. 创建自定义拦截器

下面是一个简单的例子，用于记录所有执行时间超过一定阈值的查询：

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

193

查看详情

using Microsoft.EntityFrameworkCore.Diagnostics;
using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;

public class QueryLoggingInterceptor : DbCommandInterceptor
{
    private readonly Stopwatch _stopwatch = new Stopwatch();

    public override InterceptionResult<DbDataReader> ReaderExecuting(
        DbCommand command,
        CommandEventData eventData,
        InterceptionResult<DbDataReader> result)
    {
        _stopwatch.Restart();
        return result;
    }

    public override async ValueTask<InterceptionResult<DbDataReader>> ReaderExecutingAsync(
        DbCommand command,
        CommandEventData eventData,
        InterceptionResult<DbDataReader> result,
        CancellationToken cancellationToken = default)
    {
        _stopwatch.Restart();
        return result;
    }

    public override DbDataReader ReaderExecuted(DbCommand command, CommandEventData eventData, DbDataReader result)
    {
        _stopwatch.Stop();
        if (_stopwatch.ElapsedMilliseconds > 1000)
        {
            Console.WriteLine($"慢查询警告：{command.CommandText}");
            Console.WriteLine($"耗时：{_stopwatch.ElapsedMilliseconds} 毫秒");
        }
        return result;
    }

    public override async Task<DbDataReader> ReaderExecutedAsync(DbCommand command, CommandEventData eventData, DbDataReader result, CancellationToken cancellationToken = default)
    {
        _stopwatch.Stop();
        if (_stopwatch.ElapsedMilliseconds > 1000)
        {
            Console.WriteLine($"异步慢查询警告：{command.CommandText}");
            Console.WriteLine($"耗时：{_stopwatch.ElapsedMilliseconds} 毫秒");
        }
        return result;
    }
}

登录后复制

2. 在 DbContext 中注册拦截器

在 Program.cs 或 Startup.cs 中配置 EF Core 服务时，使用 AddInterceptors 方法注册拦截器：

services.AddDbContext<AppDbContext>(options =>
    options.UseSqlServer(connectionString)
           .AddInterceptors(new QueryLoggingInterceptor()));

登录后复制