gormx

gormx

基于 gorm 的工程化封装，提供：

• MySQL/Postgres 初始化（TLS、连接池、命名策略、可选 AutoMigrate）
• 全量可观测性集成（OpenTelemetry Logs + Traces）
• 常用模型基类（自增主键、UUIDv7 主键、软删除）
• 常用 scope（分页）

安装

go get github.com/fireflycore/gormx

快速开始

MySQL

package main

import (
	"github.com/fireflycore/gormx"
)

func main() {
	conf := &gormx.MysqlConf{
		Conf: gormx.Conf{
			Type:            gormx.Mysql,
			Address:         "127.0.0.1:3306",
			Database:        "demo",
			Username:        "root",
			Password:        "root",
			MaxOpenConnects: 100,
			MaxIdleConnects: 10,
			ConnMaxLifeTime: 600,
			SingularTable:   true,
			PrepareStmt:     true,
			Logger:          true, // 开启后自动启用 OTel Logs
		},
	}

	conf.WithLoggerConsole(true)
	conf.WithAutoMigrate(true)

	db, err := gormx.NewMysql(conf, []interface{}{})
	if err != nil {
		panic(err)
	}

	_ = db.DB
}

Postgres

package main

import (
	"github.com/fireflycore/gormx"
)

func main() {
	conf := &gormx.PostgresConf{
		Conf: gormx.Conf{
			Type:            gormx.Postgres,
			Address:         "127.0.0.1:5432",
			Database:        "demo",
			Username:        "postgres",
			Password:        "postgres",
			MaxOpenConnects: 100,
			MaxIdleConnects: 10,
			ConnMaxLifeTime: 600,
			SingularTable:   true,
			PrepareStmt:     true,
			Logger:          true, // 开启后自动启用 OTel Logs
		},
	}

	conf.WithLoggerConsole(true)
	conf.WithAutoMigrate(true)

	db, err := gormx.NewPostgres(conf, []interface{}{})
	if err != nil {
		panic(err)
	}

	_ = db.DB
}

配置说明

初始化配置为 gormx.Conf，MySQL/Postgres 的配置结构分别为 gormx.MysqlConf / gormx.PostgresConf（匿名嵌入 Conf）。

常用字段：

• Address：MySQL 为 host:port；Postgres 可为 host 或 host:port（未带端口默认 5432）
• Database/Username/Password：连接信息
• MaxOpenConnects/MaxIdleConnects/ConnMaxLifeTime：连接池（ConnMaxLifeTime 单位为秒，<=0 表示不限制）
• TablePrefix/SingularTable：命名策略
• DisableForeignKeyConstraintWhenMigrating：AutoMigrate 时不创建物理外键
• SkipDefaultTransaction：跳过 gorm 默认事务
• PrepareStmt：启用预处理语句缓存
• Logger：启用 SQL 日志（自动上报 OpenTelemetry Logs，配合 WithLoggerConsole 可同时输出到控制台）

TLS

当 Conf.Tls 同时配置了 CaCert / ClientCert / ClientCertKey 三个文件路径时启用 TLS，否则视为不启用：

conf := &gormx.PostgresConf{
	Conf: gormx.Conf{
		Type:     gormx.Postgres,
		Address:  "127.0.0.1",
		Database: "demo",
		Username: "postgres",
		Password: "postgres",
		Tls: &gormx.TLS{
			CaCert:        "/path/to/ca.pem",
			ClientCert:    "/path/to/client.pem",
			ClientCertKey: "/path/to/client.key",
		},
	},
}

可观测性 (Observability)

gormx 已全量集成 OpenTelemetry，无需手动配置插件，只需确保你的应用已初始化全局 OTel Tracer/Logger Provider（例如使用 go-micro 框架）。

1. Logs (日志审计)

开启 Conf.Logger = true 后，gormx 会自动通过 OTel Logs SDK 上报每条 SQL 执行记录（OperationLog）。

• Log Type: operation
• Fields: database, statement, result, duration, rows, trace_id, user_id, app_id, tenant_id 等。
• Destination: 通常发往 OTel Collector -> Loki。

注意：

• 必须使用 db.WithContext(ctx) 执行 SQL，否则无法提取 TraceID 和 UserID。
• UserID/TenantID 等字段会自动从 gRPC metadata 中提取（如果存在）。

2. Traces (链路追踪)

初始化数据库时，gormx 会自动挂载 otelgorm 插件。

• 自动为每个 SQL 操作创建 Span。
• Span 名称格式：SELECT demo.users。
• Destination: 通常发往 OTel Collector -> Tempo/Jaeger。

注意：

• 如果未初始化全局 TracerProvider，插件会自动静默，不会报错。
• 同样需要 db.WithContext(ctx) 才能将 SQL Span 正确关联到父 Trace。

模型基类

gormx 提供了一组可直接嵌入的模型基类：

• gormx.Table：uint64 主键 + 软删除
• gormx.TableUnique：uint64 主键 + 软删除（DeletedAt 上 uniqueIndex:idx_unique）
• gormx.TableUUID：string 主键（UUIDv7）+ 软删除
• gormx.TableUUIDUnique：string 主键（UUIDv7）+ 软删除（DeletedAt 上 uniqueIndex:idx_unique）

分页 Scope

import "github.com/fireflycore/gormx/scope"

db = db.Scopes(scope.WithPagination(1, 20))

分页规则：

• page 从 1 开始（0 会被修正为 1）
• size 范围为 [5, 100]（小于 5 修正为 5，大于 100 修正为 100）