使用sqldb-logger记录Golang SQL查询日志

sqldb-logger是一个无需修改标准库即可记录SQL查询日志的Golang库，它通过包装标准库的database/sql接口实现日志记录功能。

基本用法

首先安装sqldb-logger：

go get github.com/simukti/sqldb-logger

简单示例

package main

import (
	"database/sql"
	"log"
	"os"

	"github.com/simukti/sqldb-logger"
	"github.com/simukti/sqldb-logger/logadapter/zapadapter"
	"go.uber.org/zap"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	// 创建zap日志记录器
	zapLogger, err := zap.NewDevelopment()
	if err != nil {
		log.Fatalf("failed to create zap logger: %v", err)
	}
	defer zapLogger.Sync()

	// 打开数据库连接
	db, err := sql.Open("mysql", "user:password@/dbname")
	if err != nil {
		zapLogger.Fatal("failed to open db", zap.Error(err))
	}
	defer db.Close()

	// 包装原始db连接以添加日志记录
	loggedDB := sqldb_logger.New(
		db,
		zapadapter.New(zapLogger),
		sqldb_logger.WithLogArguments(true),
		sqldb_logger.WithLogDriverErrorSkip(true),
	)

	// 使用loggedDB执行查询
	var id int
	err = loggedDB.QueryRow("SELECT id FROM users WHERE email = ?", "test@example.com").Scan(&id)
	if err != nil {
		zapLogger.Error("query failed", zap.Error(err))
	}
}

配置选项

sqldb-logger提供了多个配置选项：

loggedDB := sqldb_logger.New(
    db,
    zapadapter.New(zapLogger),
    // 记录SQL参数
    sqldb_logger.WithLogArguments(true),
    // 记录执行时间
    sqldb_logger.WithTimeFormat(sqldb_logger.TimeFormatRFC3339Nano),
    // 记录错误跳过
    sqldb_logger.WithLogDriverErrorSkip(true),
    // 最小日志级别
    sqldb_logger.WithMinimumLevel(sqldb_logger.LevelDebug),
    // 查询执行前记录
    sqldb_logger.WithLogQuery(true),
    // 查询执行后记录
    sqldb_logger.WithLogResult(true),
    // 记录影响的行数
    sqldb_logger.WithLogRowsAffected(true),
    // 记录最后插入ID
    sqldb_logger.WithLogLastInsertID(true),
    // 记录错误
    sqldb_logger.WithLogError(true),
)

支持的日志适配器

sqldb-logger支持多种日志库适配器：

1. Zap适配器 (推荐)

   import "github.com/simukti/sqldb-logger/logadapter/zapadapter"
   
   logger := zapadapter.New(zapLogger)
   

2. Logrus适配器

   import "github.com/simukti/sqldb-logger/logadapter/logrusadapter"
   
   logger := logrusadapter.New(logrusLogger)
   

3. 标准库log适配器

   import "github.com/simukti/sqldb-logger/logadapter/stdlogadapter"
   
   logger := stdlogadapter.New(stdLogger)
   

4. ZeroLog适配器

   import "github.com/simukti/sqldb-logger/logadapter/zerologadapter"
   
   logger := zerologadapter.New(zerologLogger)
   

自定义日志格式

你可以实现自己的日志适配器：

type MyLogger struct{}

func (l *MyLogger) Log(ctx context.Context, level sqldb_logger.LogLevel, msg string, data map[string]interface{}) {
    // 自定义日志处理逻辑
    fmt.Printf("[%s] %s: %+v\n", level, msg, data)
}

// 使用自定义日志器
loggedDB := sqldb_logger.New(db, &MyLogger{})

性能考虑

sqldb-logger对性能的影响很小，因为它只是在标准库的database/sql接口上添加了一个薄薄的包装层。但在生产环境中，你可能需要考虑：

1. 只在调试时启用详细的SQL日志记录
2. 使用异步日志记录减少I/O阻塞
3. 避免在生产环境中记录敏感数据

完整示例

package main

import (
	"context"
	"database/sql"
	"fmt"
	"time"

	"github.com/simukti/sqldb-logger"
	"github.com/simukti/sqldb-logger/logadapter/zapadapter"
	"go.uber.org/zap"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	// 初始化zap日志
	logger, _ := zap.NewProduction()
	defer logger.Sync()

	// 打开数据库连接
	db, err := sql.Open("mysql", "user:password@tcp(localhost:3306)/dbname")
	if err != nil {
		logger.Fatal("failed to open db", zap.Error(err))
	}
	defer db.Close()

	// 配置日志记录
	loggedDB := sqldb_logger.New(
		db,
		zapadapter.New(logger),
		sqldb_logger.WithLogArguments(true),
		sqldb_logger.WithTimeFormat(sqldb_logger.TimeFormatUnix),
		sqldb_logger.WithMinimumLevel(sqldb_logger.LevelDebug),
	)

	// 创建表
	_, err = loggedDB.Exec(`CREATE TABLE IF NOT EXISTS users (
		id INT AUTO_INCREMENT PRIMARY KEY,
		name VARCHAR(255),
		email VARCHAR(255)
	)`)
	if err != nil {
		logger.Error("create table failed", zap.Error(err))
	}

	// 插入数据
	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	result, err := loggedDB.ExecContext(ctx, 
		"INSERT INTO users (name, email) VALUES (?, ?)", 
		"John Doe", "john@example.com")
	if err != nil {
		logger.Error("insert failed", zap.Error(err))
	}

	id, _ := result.LastInsertId()
	logger.Info("inserted user", zap.Int64("id", id))

	// 查询数据
	var name string
	err = loggedDB.QueryRow("SELECT name FROM users WHERE id = ?", id).Scan(&name)
	if err != nil {
		logger.Error("query failed", zap.Error(err))
	}
	fmt.Printf("User name: %s\n", name)
}

sqldb-logger是一个简单而强大的工具，可以帮助你轻松地记录SQL查询日志，而无需修改现有的数据库代码或标准库。