SQL 如何在我的程序中记录通过DbContext.SaveChanges()生成的SQL

在本文中，我们将介绍如何在程序中记录通过DbContext.SaveChanges()生成的SQL。在开发过程中，我们经常需要查看或记录程序与数据库之间的交互信息，这对于排查问题、性能优化以及审计追踪非常有用。

阅读更多：SQL 教程

开启EF Core的日志记录功能

要记录通过DbContext.SaveChanges()生成的SQL，我们需要开启Entity Framework Core (EF Core)的日志记录功能。EF Core通过Microsoft.Extensions.Logging框架提供的日志记录机制，可以将日志输出到多个目标，如控制台、文本文件或数据库。

首先，我们需要添加以下包依赖到项目中：

Microsoft.Extensions.Logging
Microsoft.Extensions.Logging.Console
Microsoft.Extensions.Logging.Debug

然后，在代码中添加以下引用：

using Microsoft.Extensions.Logging;

接下来，我们需要配置日志提供程序。在程序的入口处（例如Main方法）添加以下代码：

// 创建日志工厂
var loggerFactory = LoggerFactory.Create(builder => {
    builder
        .AddFilter(DbLoggerCategory.Database.Command.Name, LogLevel.Information)
        .AddConsole();
});

// 初始化DbContext并启用日志记录
using (var dbContext = new MyDbContext()) 
{
    dbContext .UseLoggerFactory(loggerFactory);
    // 其他操作
    // ...
}

上述代码创建了一个日志工厂，并配置了日志过滤器，只记录数据库相关的日志。然后，通过AddConsole()方法将日志输出到控制台。当然，我们也可以使用其他提供程序，如AddFile()将日志输出到文件。

记录生成的SQL语句

现在，我们已经配置好了EF Core的日志记录功能，下面我们来记录通过DbContext.SaveChanges()生成的SQL语句。为了实现这一点，我们需要定义一个自定义日志提供程序。

首先，创建一个名为SqlLoggerProvider的类，继承自ILoggerProvider接口，并实现对应的方法：

using Microsoft.Extensions.Logging;

public class SqlLoggerProvider : ILoggerProvider
{
    public ILogger CreateLogger(string categoryName)
    {
        if (categoryName == DbLoggerCategory.Database.Command.Name)
        {
            return new SqlLogger();
        }
        else
        {
            return NullLogger.Instance;
        }
    }

    public void Dispose()
    {
    }
}

上述代码中，我们根据日志的类别名称判断是否创建SqlLogger实例。

接下来，创建一个名为SqlLogger的类，继承自ILogger接口，并实现对应的方法：

using Microsoft.Extensions.Logging;

public class SqlLogger : ILogger
{
    public IDisposable BeginScope<TState>(TState state)
    {
        return null;
    }

    public bool IsEnabled(LogLevel logLevel)
    {
        return true;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state,
        Exception exception, Func<TState, Exception, string> formatter)
    {
        if (logLevel == LogLevel.Information)
        {
            // 将日志信息输出到自定义目标（例如日志文件）
            using (StreamWriter w = File.AppendText("log.txt"))
            {
                w.WriteLine(formatter(state, exception));
            }
        }
    }
}

上述代码中，我们将Log方法的参数中的日志信息输出到自定义目标（例如日志文件）中。

最后，我们将新创建的日志提供程序添加到日志工厂的配置中：

// 创建日志工厂
var loggerFactory = LoggerFactory.Create(builder => {
    builder
        .AddFilter(DbLoggerCategory.Database.Command.Name, LogLevel.Information)
        .AddProvider(new SqlLoggerProvider());
});

至此，我们已经完成了通过DbContext.SaveChanges()生成的SQL语句的记录。

示例

下面我们通过一个示例来演示如何使用上述方法记录生成的SQL语句。

假设我们有一个ASP.NET Core Web API项目，使用EF Core进行数据库访问。

首先，我们创建一个名为Product的实体类：

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

然后，创建一个名为MyDbContext的DbContext类，并添加对应的DbSet：

public class MyDbContext : DbContext
{
    public DbSet<Product> Products { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlServer("your_connection_string");
    }
}

在Controller中，我们可以使用如下代码来添加一条新的产品记录并保存到数据库：

[HttpPost]
public ActionResult AddProduct(Product product)
{
    using (var dbContext = new MyDbContext())
    {
        dbContext.Products.Add(product);
        dbContext.SaveChanges();
    }

    return Ok();
}

在以上代码中，我们通过DbContext的SaveChanges()方法将产品记录保存到数据库。

现在，我们已经完成了配置日志记录工具和代码示例，当我们调用AddProduct方法时，将会将生成的SQL语句记录到自定义目标中。

总结

在本文中，我们介绍了如何在程序中记录通过DbContext.SaveChanges()生成的SQL语句。首先，我们需要开启EF Core的日志记录功能，并配置日志提供程序。然后，我们定义了一个自定义的日志提供程序和日志记录器，将日志信息输出到自定义目标中。最后，我们通过一个示例演示了如何使用上述方法记录生成的SQL语句。通过记录生成的SQL，我们可以更好地调试、优化和审计我们的程序及数据库操作。