在Go语言的多包项目架构中，合理实现SQL数据库连接的跨包共享，既能避免重复创建连接带来的资源浪费，也能统一数据库访问逻辑，降低维护成本。但共享过程需要兼顾连接池管理、并发安全和包职责划分，否则容易出现各类运行时问题。
核心原则：利用database/sql包的内置连接池
Go标准库的database/sql包已经内置了连接池机制，sql.DB对象本身是并发安全的，不需要开发者额外加锁。跨包共享的核心就是让多个包共用同一个sql.DB实例，而不是各自创建独立的连接对象。
惯用实现步骤
- 单独创建一个数据库工具包，比如
db包，专门负责初始化和管理sql.DB实例 - 在工具包中导出获取连接的方法，其他业务包通过该方法获取同一个连接实例
- 全局只调用一次初始化方法，避免重复打开数据库连接
示例代码实现
db包的实现
首先创建db包，封装连接的初始化和获取逻辑：
package db
import (
"database/sql"
"fmt"
_ "github.com/go-sql-driver/mysql" // 导入MySQL驱动
"sync"
)
var (
// 全局唯一的sql.DB实例
dbInstance *sql.DB
// 确保初始化只执行一次
once sync.Once
// 数据库连接错误
initErr error
)
// InitDB 初始化数据库连接，建议在程序启动时调用一次
func InitDB(dsn string) error {
once.Do(func() {
// 打开数据库连接，这里使用MySQL作为示例
dbInstance, initErr = sql.Open("mysql", dsn)
if initErr != nil {
return
}
// 配置连接池参数，避免连接数过多或过少
// 设置最大打开连接数
dbInstance.SetMaxOpenConns(20)
// 设置最大空闲连接数
dbInstance.SetMaxIdleConns(10)
// 设置连接最大存活时间，避免长期占用过期连接
dbInstance.SetConnMaxLifetime(time.Hour)
// 验证连接是否正常
initErr = dbInstance.Ping()
})
return initErr
}
// GetDB 获取共享的数据库连接实例
func GetDB() (*sql.DB, error) {
if dbInstance == nil {
return nil, fmt.Errorf("数据库连接未初始化，请先调用InitDB")
}
return dbInstance, nil
}
业务包的使用方式
其他业务包只需要导入db包，调用GetDB方法即可获取共享的连接：
package user
import (
"fmt"
"your_project/db" // 替换为实际的项目路径
)
// GetUserByID 根据用户ID查询用户信息
func GetUserByID(userID int) error {
// 获取共享的数据库连接
dbConn, err := db.GetDB()
if err != nil {
return err
}
// 执行查询操作
var username string
err = dbConn.QueryRow("SELECT username FROM user WHERE id = ?", userID).Scan(&username)
if err != nil {
return err
}
fmt.Printf("用户ID %d 的用户名是 %sn", userID, username)
return nil
}
安全实践注意事项
避免重复初始化
使用sync.Once确保InitDB只执行一次，防止多个包同时调用初始化方法导致重复打开连接，造成资源浪费甚至连接冲突。如果没有使用sync.Once，也可以在程序入口处统一调用一次初始化，业务包不再调用初始化方法。
合理设置连接池参数
sql.DB的连接池参数需要根据实际业务场景调整：
SetMaxOpenConns：设置最大打开连接数，不能超过数据库服务端的最大连接限制，避免被数据库拒绝连接SetMaxIdleConns：设置最大空闲连接数，空闲连接过多会占用额外资源，过少会导致频繁创建新连接SetConnMaxLifetime：设置连接的最大存活时间，避免连接长时间占用后失效，引发查询错误
不要跨包传递sql.DB的关闭操作
sql.DB的Close方法应该在程序退出时统一调用，不要放在某个业务包中单独调用，否则其他包还在使用连接时连接被关闭，会导致运行时错误。可以在程序入口处使用defer调用关闭方法：
package main
import (
"your_project/db"
"log"
)
func main() {
// 初始化数据库连接
err := db.InitDB("root:password@tcp(127.0.0.1:3306)/test")
if err != nil {
log.Fatalf("初始化数据库失败: %v", err)
}
// 程序退出时关闭数据库连接
defer func() {
conn, _ := db.GetDB()
if conn != nil {
conn.Close()
}
}()
// 执行业务逻辑
}
避免连接泄漏
所有从连接池获取的sql.Rows或者sql.Stmt对象，使用完毕后必须调用对应的Close方法，否则会导致连接无法归还到连接池，最终引发连接耗尽的问题。可以使用defer确保关闭操作执行：
func QueryAllUsers() error {
dbConn, err := db.GetDB()
if err != nil {
return err
}
rows, err := dbConn.Query("SELECT id, username FROM user")
if err != nil {
return err
}
// 确保rows被关闭
defer rows.Close()
for rows.Next() {
var id int
var username string
if err := rows.Scan(&id, &username); err != nil {
return err
}
fmt.Printf("id: %d, username: %sn", id, username)
}
return rows.Err()
}
常见错误实践与规避
- 错误：每个业务包各自调用
sql.Open创建连接。规避：统一使用工具包管理连接实例，所有包通过工具包获取连接。 - 错误：不设置连接池参数，使用默认值。规避：根据业务并发量和数据库配置调整连接池参数，避免连接数不合理。
- 错误：在业务包中随意调用
db.Close()。规避：统一在程序入口处管理连接的关闭，业务包只获取和使用连接。