Entity Framework Core (EF Core) 是一个流行的对象关系映射（ORM）框架，它允许开发者使用C#对象来操作数据库。在开发过程中，经常需要查看或调试生成的SQL语句以确保查询的正确性。EF Core提供了拦截器（Interceptors）功能，使得我们可以在SQL命令发送到数据库之前捕获并打印它们。

下面，我们将通过配置一个自定义的拦截器来在EF Core中实现SQL的完整打印。

1. 创建一个自定义拦截器

首先，我们需要创建一个类来实现IDbCommandInterceptor接口。这个接口定义了一些方法，允许我们在SQL命令执行的不同阶段进行拦截。

using Microsoft.EntityFrameworkCore.Diagnostics;
using Microsoft.EntityFrameworkCore.Storage;
using System;
using System.Data;
using System.Data.Common;
using System.Diagnostics;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

public class SqlLoggingInterceptor : IDbCommandInterceptor
{
    public void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
    {
        LogCommand(command);
    }

    public void ReaderExecuted(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
    {
        // 可以在执行后添加额外的日志记录，如果需要的话
    }

    public void NonQueryExecuting(DbCommand command, DbCommandInterceptionContext<int> interceptionContext)
    {
        LogCommand(command);
    }

    public void NonQueryExecuted(DbCommand command, DbCommandInterceptionContext<int> interceptionContext)
    {
        // 可以在执行后添加额外的日志记录，如果需要的话
    }

    public void ScalarExecuting(DbCommand command, DbCommandInterceptionContext<object> interceptionContext)
    {
        LogCommand(command);
    }

    public void ScalarExecuted(DbCommand command, DbCommandInterceptionContext<object> interceptionContext)
    {
        // 可以在执行后添加额外的日志记录，如果需要的话
    }

    private void LogCommand(DbCommand command)
    {
        var output = new StringBuilder();
        output.AppendLine($"Command Text: {command.CommandText}");
        if (command.Parameters.Count > 0)
        {
            output.AppendLine("Parameters:");
            foreach (DbParameter param in command.Parameters)
            {
                output.AppendLine($"{param.ParameterName} = {param.Value} (DbType = {param.DbType})");
            }
        }
        Debug.WriteLine(output.ToString()); // 使用Debug输出，你也可以替换为其他日志记录方式，如NLog、Serilog等。
    }

    // 实现其他必要的方法，即使它们是空的...
    // ... (省略其他方法)
}

2. 在DbContext中注册拦截器

创建了自定义拦截器之后，我们需要在DbContext的OnConfiguring方法中注册它。这样，每当DbContext执行数据库操作时，都会触发我们的拦截器。

using Microsoft.EntityFrameworkCore;

public class MyDbContext : DbContext
{
    // ... DbSets and other members ...

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        if (!optionsBuilder.IsConfigured)
        {
            optionsBuilder.UseSqlServer("YourConnectionStringHere") // 替换为你的连接字符串
                          .AddInterceptors(new SqlLoggingInterceptor()); // 注册拦截器
        }
    }
}

3. 使用DbContext并执行查询

现在，每当你使用MyDbContext实例执行查询或其他数据库操作时，自定义的SqlLoggingInterceptor就会捕获并打印相应的SQL命令和参数。

using (var context = new MyDbContext())
{
    var users = context.Users.ToList(); // 示例查询，这会触发拦截器并记录SQL语句
}

结论

通过配置EF Core的拦截器，我们可以轻松地捕获和打印执行的SQL语句，这对于开发和调试过程中理解EF Core如何生成和执行SQL非常有帮助。上面的示例展示了如何创建一个简单的拦截器来记录SQL命令，但你可以根据需要扩展它，例如添加更详细的日志记录、性能监控等。