使用 GORM 打印最终 SQL 语句

运维开发王义杰

发布于 2023-08-10 19:26:19

6.6K0

在开发过程中，了解实际执行的 SQL 语句有时候是非常必要的。不仅有助于调试问题，还可以用来优化数据库查询。这篇文章将详细解释如何使用 GORM 来打印实际执行的 SQL 语句。

1. 什么是 GORM？

GORM 是一个优雅的 ORM（对象关系映射）框架，用于 Go 语言。它支持主流的 SQL 数据库，如 MySQL、PostgreSQL 等，并提供了直观的 API 来操作数据库。通过 GORM，开发者可以以对象的方式操作数据库，不需要编写冗长的 SQL 语句。

2. 为什么要打印 SQL 语句？

打印 SQL 语句有助于：

调试问题：通过查看实际执行的 SQL，可以快速定位查询错误或效率问题。
性能优化：可以通过检查 SQL 来发现并修复慢查询。
理解 ORM 行为：有时 ORM 可能不按预期工作，查看 SQL 可以帮助理解 ORM 是如何转换查询的。

3. 如何使用 GORM 打印 SQL 语句？

下面的步骤将解释如何设置 GORM 以打印 SQL 语句：

3.1 导入 GORM 和 Logger

首先，确保导入了 GORM 和其 logger 包：

import (
  "gorm.io/gorm"
  "gorm.io/driver/mysql"
  "gorm.io/gorm/logger"
)

3.2 创建数据库连接

连接到你的数据库，并初始化 GORM：

dsn := "user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
if err != nil {
  panic("failed to connect database")
}

3.3 设置 Logger

创建一个新的 logger，并配置其选项：

newLogger := logger.New(
  log.New(os.Stdout, "\r\n", log.LstdFlags),
  logger.Config{
    SlowThreshold: time.Second,
    LogLevel:      logger.Info,
    Colorful:      true,
  },
)
db, err = db.WithContext(context.Background()).Set("gorm:logger", newLogger).Open(mysql.Open(dsn), &gorm.Config{})

3.4 示例查询

现在，我们可以执行查询，实际的 SQL 将打印到控制台：

var user User
db.Find(&user, 1)

4. 完整示例代码

以下是完整的示例代码：

package main

import (
  "gorm.io/gorm"
  "gorm.io/driver/mysql"
  "gorm.io/gorm/logger"
  "log"
  "os"
  "time"
)

func main() {
  dsn := "user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
  
  newLogger := logger.New(
    log.New(os.Stdout, "\r\n", log.LstdFlags),
    logger.Config{
      SlowThreshold: time.Second,
      LogLevel:      logger.Info,
      Colorful:      true,
    },
  )
  
  db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
    Logger: newLogger,
  })
  if err != nil {
    panic("failed to connect database")
  }

  var user User
  db.Find(&user, 1)
}