.net core实用技巧——将EF Core生成的SQL语句显示在控制台中

下面是详细讲解“.net core实用技巧——将EF Core生成的SQL语句显示在控制台中”的完整攻略。

什么是EF Core？

Entity Framework Core（EF Core）是一个跨平台开源ORM框架，可用于开发.NET平台上的应用程序。EF Core具有轻量级、可扩展性、高性能等优点，是.NET生态中最受欢迎的ORM框架之一。

为什么要显示EF Core生成的SQL语句？

在开发工作中，我们经常需要调试数据库操作，此时查看EF Core生成的SQL语句非常有用，可以帮助我们快速发现问题，并优化性能。因此，显示EF Core生成的SQL语句是一项非常实用的技巧。

如何在控制台中显示EF Core生成的SQL语句？

以下是显示EF Core生成的SQL语句的步骤：

1. 安装Microsoft.Extensions.Logging.Console

在项目中安装Microsoft.Extensions.Logging.Console包，可以使用以下NuGet命令进行安装：

Install-Package Microsoft.Extensions.Logging.Console

2. 配置DbContext

在DbContext构造函数中添加以下代码，开启EF Core生成的SQL语句输出：

using Microsoft.Extensions.Logging;

public class MyDbContext : DbContext
{
    public static readonly ILoggerFactory MyLoggerFactory
        = LoggerFactory.Create(builder => { builder.AddConsole(); });

    public MyDbContext(DbContextOptions<MyDbContext> options)
        : base(options)
    {
    }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        => optionsBuilder.UseLoggerFactory(MyLoggerFactory)
            .EnableSensitiveDataLogging();

    // ...
}

3. 测试输出EF Core生成的SQL语句

在对数据库进行操作时，EF Core将自动输出SQL语句到控制台。例如，以下代码查询所有的用户：

using (var db = new MyDbContext())
{
    var users = db.Users.ToList();
}

输出结果如下：

info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (0ms) [Parameters=[], CommandType='Text', CommandTimeout='30']

      SELECT [u].[Id], [u].[Name], [u].[Email]
      FROM [Users] AS [u]

示例说明

示例1 - 查询指定用户

以下代码查询指定用户，并输出对应的SQL语句：

using (var db = new MyDbContext())
{
    var user = db.Users.FirstOrDefault(u => u.Name == "Alice");
    Console.WriteLine("SQL: " + db.ToSql());
}

输出结果如下：

info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (0ms) [Parameters=[@__p_0='?' (DbType = String)], CommandType='Text', CommandTimeout='30']

      SELECT TOP(1) [u].[Id], [u].[Name], [u].[Email]
      FROM [Users] AS [u]
      WHERE [u].[Name] = @__p_0

示例2 - 更新用户信息

以下代码更新指定用户的电子邮件地址，并输出对应的SQL语句：

using (var db = new MyDbContext())
{
    var user = db.Users.FirstOrDefault(u => u.Name == "Alice");
    if (user != null)
    {
        user.Email = "alice@example.com";
        db.SaveChanges();
        Console.WriteLine("SQL: " + db.ToSql());
    }
}

输出结果如下：

info: Microsoft.EntityFrameworkCore.Database.Command[20101]
      Executed DbCommand (8ms) [Parameters=[@p0='alice@example.com' (Size = 4000), @p1='1' (Size = 4000)], CommandType='Text', CommandTimeout='30']

      UPDATE [Users] SET [Email] = @p0
      WHERE [Id] = @p1;
      SELECT @@ROWCOUNT;