C#+SQL Server如何获取事务Commit前的SQL语句？

我正在用C#开发基于SQL Server的项目，想要在查询满足特定条件时保存相关信息，计划通过通用方法触发事务提交，并且希望在提交前拿到这个事务对应的SQL语句。我的示例代码大概是这样的：

public void insertInfo(object obj) 
{ 
    using (Context context = new Context()) 
    { 
        // 执行插入操作
        // 执行第二个插入操作
        // 执行更新操作
        context.Save(); 
    } 
} 

// 在Context类中
public void Save() 
{ 
    // 我想在这里获取即将由transaction.Commit()执行的SQL语句
    transaction.Commit(); 
}

请问有没有办法实现这个需求？

当然可以实现！从你的代码结构来看，大概率是用了Entity Framework（EF），下面分场景给你几种靠谱的实现方式：

1. 如果使用Entity Framework（EF Core或EF6） #

方法一：启用EF自带的日志功能 #

EF本身就支持记录生成的SQL语句，你可以在Save方法里提前捕获这些SQL：

• EF Core：在DbContext的配置中添加日志拦截，把SQL收集到列表里：

public class Context : DbContext
{
    private readonly List<string> _pendingSql = new List<string>();
    public List<string> PendingSql => _pendingSql;

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer("你的数据库连接字符串")
                      .LogTo(sql => _pendingSql.Add(sql), LogLevel.Information);
    }

    public void Save()
    {
        // 提交前，_pendingSql里已经存好了所有即将执行的SQL
        foreach (var sql in PendingSql)
        {
            // 这里可以把SQL保存到日志、文件或数据库里
            Console.WriteLine($"待执行SQL：{sql}");
        }
        this.SaveChanges(); // 或者执行你的transaction.Commit()逻辑
    }
}

• EF6：利用Database.Log属性捕获SQL，同样在提交前拿到内容：

public class Context : DbContext
{
    private List<string> _pendingSql = new List<string>();
    public List<string> PendingSql => _pendingSql;

    public void Save()
    {
        Database.Log = sql => _pendingSql.Add(sql);
        // 先调用SaveChanges生成SQL（此时还未提交事务）
        SaveChanges();
        // 现在_pendingSql里就是所有要执行的SQL，按需处理
        transaction.Commit();
    }
}

方法二：用EF Core拦截器做精细化控制 #

如果需要只捕获事务相关的SQL，可以自定义DbCommandInterceptor，拦截所有即将执行的数据库命令：

public class SqlCaptureInterceptor : DbCommandInterceptor
{
    public List<string> CapturedSql { get; } = new List<string>();

    public override InterceptionResult<int> NonQueryExecuting(
        DbCommand command, 
        CommandEventData eventData, 
        InterceptionResult<int> result)
    {
        // 捕获增删改类的SQL语句
        CapturedSql.Add(command.CommandText);
        return base.NonQueryExecuting(command, eventData, result);
    }

    public override InterceptionResult<DbDataReader> ReaderExecuting(
        DbCommand command, 
        CommandEventData eventData, 
        InterceptionResult<DbDataReader> result)
    {
        // 捕获查询类的SQL语句（如果需要的话）
        CapturedSql.Add(command.CommandText);
        return base.ReaderExecuting(command, eventData, result);
    }
}

然后在Context里注册这个拦截器，就能在Save方法里拿到捕获的SQL：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    var sqlInterceptor = new SqlCaptureInterceptor();
    optionsBuilder.UseSqlServer("你的连接字符串")
                  .AddInterceptors(sqlInterceptor);
    // 把拦截器实例保存到Context的字段中，方便在Save方法里访问CapturedSql
}

2. 如果使用原生ADO.NET封装Context #

要是你的Context是基于原生ADO.NET自己写的，那可以在创建SqlCommand的时候直接记录SQL：

public class Context : IDisposable
{
    private SqlConnection _dbConnection;
    private SqlTransaction _dbTransaction;
    private List<string> _pendingSqlCommands = new List<string>();

    public void ExecuteNonQuery(string sql, SqlParameter[] parameters = null)
    {
        using (var cmd = _dbConnection.CreateCommand())
        {
            cmd.Transaction = _dbTransaction;
            cmd.CommandText = sql;
            if (parameters != null)
                cmd.Parameters.AddRange(parameters);
            // 记录当前要执行的SQL
            _pendingSqlCommands.Add(sql);
            cmd.ExecuteNonQuery();
        }
    }

    public void Save()
    {
        // 提交前遍历处理所有记录的SQL
        foreach (var sql in _pendingSqlCommands)
        {
            // 比如保存到日志表
            // SaveSqlToLog(sql);
        }
        _dbTransaction.Commit();
    }

    // IDisposable接口实现代码省略
}

3. 数据库层面的方案（无需改代码） #

如果不想动代码，也可以用SQL Server自带的工具捕获SQL：

• Extended Events：创建一个会话，跟踪sql_statement_completed事件，能轻量高效地捕获所有执行的SQL，适合生产环境使用。
• SQL Server Profiler：虽然新版本SQL Server推荐用Extended Events替代，但你也可以创建跟踪，筛选SQL:BatchCompleted或RPC:Completed事件来查看提交的SQL。

需要注意的是，EF生成的大多是参数化SQL，如果需要带参数值的完整SQL，可能需要额外处理参数的替换逻辑。

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