Golang中MongoDB全局客户端仍断开问题排查及结构咨询

1. 当前项目目录结构是否合理？ #

这个目录结构合理且符合Go项目的常见分层设计规范，各模块职责清晰：

• database/：负责数据库连接管理与数据模型定义，connect.go处理连接逻辑，models/存放数据结构，职责单一。
• handlers/：处理HTTP请求的路由与响应，作为请求入口，专注于解析请求、调用业务逻辑并返回响应，符合分层设计中控制器的角色。
• services/：封装核心业务逻辑，将请求处理与数据操作解耦，避免业务代码混杂在请求处理层，便于维护和复用。
• 根目录的main.go作为程序入口，负责服务启动、初始化（如数据库连接、HTTP服务配置）和优雅 shutdown，结构清晰。

如果要进一步优化，可以考虑将models/移到根目录（部分团队习惯将模型作为公共模块），但当前结构已经满足生产项目的基本要求，无需强制调整。

2. MongoDB客户端持续断开连接的原因及修复方案 #

核心问题 #

导致客户端断开的关键原因是connect.go中的defer DBClient.Disconnect(CtxDB)：

• 该defer语句会在ConnectToDatabase函数执行完成后立即触发，也就是main函数调用完数据库连接初始化后，客户端就被主动断开了。因此后续其他包调用数据库操作时，会提示"Client disconnected"错误。
• 另外，全局的CtxDB是通过context.WithTimeout创建的10秒超时上下文，10秒后该上下文会过期，后续用它执行数据库操作也会因上下文超时失败。

修复步骤 #

步骤1：移除不当的defer断开逻辑，将断开操作移到程序退出阶段

修改connect.go中的ConnectToDatabase函数，删除defer DBClient.Disconnect(CtxDB)：

// ConnectToDatabase function handle the connection to the database
func ConnectToDatabase() error {
    err := DBClient.Connect(CtxDB)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println("Database's client connected")

    err = DBClient.Ping(CtxDB, readpref.Primary())
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println("Client pinged")

    return err
}

然后在main.go的优雅shutdown逻辑中添加数据库断开操作：

// ... 原有shutdown代码
sig := <-sigChan
l.Println("Recieved terminated, gracefully shutdown", sig)

ctxTimeOut, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()

// 先关闭HTTP服务
err := s.Shutdown(ctxTimeOut)
if err != nil {
    l.Fatal(err)
}

// 再断开数据库客户端
err = database.DBClient.Disconnect(ctxTimeOut)
if err != nil {
    l.Fatal(err)
}

步骤2：避免使用全局超时上下文，改用请求上下文或独立上下文

全局的CtxDB超时时间仅10秒，会导致后续操作失败。修改get-users.go中的代码，使用请求上下文：

// GetUsers function return a list of user
func GetUsers(resWriter http.ResponseWriter, req *http.Request) (u users) {
    // 使用请求上下文，而非全局超时上下文
    ctx := req.Context()
    cursor, err := database.UserCollection.Find(ctx, bson.M{})
    if err != nil {
        log.Fatal(err)
    }
    defer cursor.Close(ctx) // 记得关闭cursor

    if err = cursor.All(ctx, &u); err != nil {
        log.Fatal(err)
    }

    return u
}

如果是无请求场景的数据库操作，可以创建独立的上下文：

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
// 执行数据库操作

步骤3：优化全局变量的初始化（可选）

全局变量DBClient和err的初始化方式可能导致初始化错误未被及时捕获，建议将客户端初始化移到ConnectToDatabase函数中：

// connect.go
var DBClient *mongo.Client
var DB *mongo.Database
var UserCollection *mongo.Collection

const (
    dbURI = "mongodb://localhost:27017"
)

func ConnectToDatabase() error {
    var err error
    DBClient, err = mongo.NewClient(options.Client().ApplyURI(dbURI))
    if err != nil {
        return err
    }

    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()

    err = DBClient.Connect(ctx)
    if err != nil {
        return err
    }

    err = DBClient.Ping(ctx, readpref.Primary())
    if err != nil {
        return err
    }

    DB = DBClient.Database("service-users-data")
    UserCollection = DB.Collection("users")

    fmt.Println("Database connected and pinged successfully")
    return nil
}

这样可以避免全局变量初始化时的错误被隐藏，同时让连接逻辑更集中。

内容的提问来源于stack exchange，提问作者Corentin TRUFFAUT