如何正确封装 sql.DB 并调用其导出方法-Golang-PHP中文网

如何正确封装 sql.DB 并调用其导出方法

本文讲解 go 语言中封装 *sql.db 时的常见错误，重点解决因大小写不匹配导致的“undefined (cannot refer to unexported field or method)”编译错误，并提供可复用、符合 go 惯例的数据库连接封装方案。

本文讲解 go 语言中封装 *sql.db 时的常见错误，重点解决因大小写不匹配导致的“undefined (cannot refer to unexported field or method)”编译错误，并提供可复用、符合 go 惯例的数据库连接封装方案。

在 Go 中，首字母大写的标识符才是导出（public）的，小写字母开头的方法或字段属于包内私有，外部无法访问。sql.DB 提供的 Prepare 方法首字母为大写 P，而你在代码中误写为小写的 prepare（如 dbConn.db.prepare），Go 编译器因此报错：

dbConn.db.prepare undefined (cannot refer to unexported field or method sql.(*DB)."".prepare)

这并非结构体嵌套或指针接收器的问题，而是最基础的导出规则误用——sql.DB 根本没有名为 prepare 的方法，只有 Prepare。

✅ 正确写法如下（注意 Prepare 首字母大写）：

getNodeRecord, err := dbConn.db.Prepare(dbQuery)
if err != nil {
    log.Fatal("Failed to prepare query:", err)
}
defer getNodeRecord.Close()

但当前 DatabaseConn 结构体还存在多个关键问题，需一并修正以保证健壮性与可用性：

? 1. Open() 方法未保存初始化的 *sql.DB

你调用了 sql.Open(...)，却未将返回的 *sql.DB 赋值给 d.db 字段，导致后续 dbConn.db 始终为 nil，调用 Prepare 会 panic（空指针）。应改为：

func (d *DatabaseConn) Open() error {
    d.driverName = DB_DRNAME
    d.userName = DB_UNAME
    d.password = DB_PWD
    d.databaseName = DB_DBNAME
    d.dataSourceName = fmt.Sprintf("%s:%s@/%s?charset=utf8", d.userName, d.password, d.databaseName)

    db, err := sql.Open(d.driverName, d.dataSourceName)
    if err != nil {
        return err
    }
    // ✅ 关键：保存 db 实例到结构体字段
    d.db = db

    // ✅ 推荐：验证连接有效性（sql.Open 不立即建连）
    if err = db.Ping(); err != nil {
        return fmt.Errorf("failed to ping database: %w", err)
    }
    return nil
}

? 注意：sql.Open 只是初始化连接池配置，不建立真实连接；db.Ping() 才真正触发一次连接测试。

? 2. Close() 中的 recover() 是反模式

*sql.DB.Close() 是安全的幂等操作，不会 panic，无需 defer/recover 包裹。滥用 recover 会掩盖真实问题，且违背 Go 错误处理原则。直接简化为：

func (d *DatabaseConn) Close() error {
    if d.db == nil {
        return nil // 已关闭或未打开
    }
    return d.db.Close()
}

✅ 完整推荐实现（含初始化与使用示例）

type DatabaseConn struct {
    db *sql.DB
}

func (d *DatabaseConn) Open() error {
    dsn := fmt.Sprintf("%s:%s@/%s?charset=utf8", DB_UNAME, DB_PWD, DB_DBNAME)
    db, err := sql.Open(DB_DRNAME, dsn)
    if err != nil {
        return err
    }
    if err = db.Ping(); err != nil {
        db.Close() // 确保资源释放
        return fmt.Errorf("failed to connect to DB: %w", err)
    }
    d.db = db
    return nil
}

func (d *DatabaseConn) Close() error {
    if d.db != nil {
        return d.db.Close()
    }
    return nil
}

// ✅ 封装常用方法（提升可读性 & 复用性）
func (d *DatabaseConn) QueryRow(query string, args ...any) *sql.Row {
    return d.db.QueryRow(query, args...)
}

func (d *DatabaseConn) Prepare(query string) (*sql.Stmt, error) {
    return d.db.Prepare(query)
}

使用方式：

var dbConn DatabaseConn
if err := dbConn.Open(); err != nil {
    log.Fatal("DB open failed:", err)
}
defer dbConn.Close()

// ✅ 正确调用导出方法
stmt, err := dbConn.Prepare("SELECT * FROM ms_node WHERE node_id = ?")
if err != nil {
    log.Fatal("Prepare failed:", err)
}
defer stmt.Close()

var id int
err = stmt.QueryRow(123).Scan(&id)
// ...