db

db

db 模块是对 gorm + mysql 驱动的轻量封装，提供统一的初始化入口、连接池配置、自动迁移和事务执行能力。

包名与导入

• 目录：db
• 包名：db
• 导入：

import "gitee.com/mstes/base-framework/db"

适用场景

• 需要快速连接 MySQL 并统一 GORM 初始化参数
• 希望在初始化时自动迁移某个模型
• 希望用统一入口执行事务

目录结构

• config.go：数据库配置、连接池配置、DSN 构造
• db.go：驱动初始化、GORM 选项、事务执行
• errors.go：错误定义
• test/main.go：最小可运行示例

核心类型

MysqlConfig 字段说明

ConnectionPoolConfig 字段说明

默认初始化行为

New[T] 内部会默认设置以下 GORM 选项：

• SkipDefaultTransaction = true
• DisableAutomaticPing = false
• DisableForeignKeyConstraintWhenMigrating = true
• DisableNestedTransaction = true

创建成功后还会自动执行：

• 连接数据库
• 配置连接池
• AutoMigrate(new(T))

快速示例

package main

import (
    "context"

    "gitee.com/mstes/base-framework/db"
    "gorm.io/gorm"
)

type User struct {
    gorm.Model
    Name string
}

func main() {
    driver, err := db.New(
        db.WithProductLogModel[User](),
        db.WithDriverWithDefaultMode[User](&db.MysqlConfig{
            Host:     "127.0.0.1",
            Port:     "3306",
            Username: "root",
            Password: "123456",
            Database: "demo",
            SSL:      false,
            ConnectionPool: &db.ConnectionPoolConfig{
                MaxOpenConns:    20,
                MaxIdleConns:    10,
                ConnMaxLifetime: 10,
                ConnMaxIdleTime: 5,
            },
        }),
    )
    if err != nil {
        panic(err)
    }

    err = driver.Execute(context.Background(), func(tx *gorm.DB) error {
        return tx.Create(&User{Name: "alice"}).Error
    })
    if err != nil {
        panic(err)
    }
}

常用 API

使用建议

• 如果你只想使用 GORM 原生能力，可以直接通过 driver.Controller 继续调用底层 API。
• 如果你不希望自动迁移，可以考虑在业务侧自行封装，而不是直接调用当前 New[T]。
• 事务回调签名是 func(db *gorm.DB) error，返回 nil 时提交，否则回滚。

注意事项

• ConnectionPool 不能为空，否则返回 ErrNotFoundConnectionPool。
• 当前实现只提供了 MySQL 配置结构，UniversalConfig 主要用于保留扩展入口。
• MysqlConfig.BuildDsn() 固定追加 charset=utf8mb4&parseTime=True&loc=Local。
• Charset 字段虽然存在，但当前版本不会覆盖默认 DSN 编码。

示例入口

• test/main.go
• 返回仓库根目录