dcfd24b624
v1.0.3 定位为 bug fix release,收口 v1.0.2 引入的破坏性清理并修复 4 个轻量 bug + 依赖复查 + 版本号治理 + 文档对齐。同时包含此前未提交 的 v1.0.2 全部工作。 v1.0.3 变更: Fixed: - generateJTI 忽略 rand.Read 错误(jwt)— 改为 (string, error) 并传播 - QueryBuilder.Page Count 受残留 Limit 截断(repository)— countDB 加 Limit(-1).Offset(-1) - OSS/本地存储文件名冲突(storage)— 新增 uniqueFilename 加 8 字节随机后缀 - 数据库重试策略对不可恢复错误无效(database)— 新增 isTransientDBError Dependencies: - go mod tidy 补全 postgres 方言传递依赖;安全补丁升级 x/crypto v0.49→v0.53、golang-jwt/jwt/v5 v5.2.1→v5.3.1、gorilla/websocket v1.5.1→v1.5.3 Removed: - Breaking: 清理 v1.0.2 兼容别名(InitMySQL* / driverName) - 死代码 database.DBResolver - 代码中 292 行"评分/理由"自夸注释(#26,23 个文件) Changed: - Breaking: 错误码体系重构 CodeSuccess 1→0、CodeFail 0→1,删除 CodeInvalidParams,加编译期防撞码 - database/mysql.go → manager.go;Logger 拆分三独立 core 修复 Tee 重复写入 - 版本号常量化:app.go 新增 const Version 作为唯一来源,CLI/脚手架模板引用之,不再散落字面量 Security: - CORS 中间件按 W3C 规范修复 Allow-Credentials / Vary: Origin / 非白名单不回显 Added: - console 包显式 level 控制(SetLevel/WithLevel/LevelSilent,atomic.Int32 并发安全) - 新增测试 jwt/repository/storage/database/router/middleware/app - 文档:新增 CHANGELOG.md、Version_v1.0.2_report.md;更新 README/GUIDE 顶部更新日志 - 文档对齐:删除对不存在的 config.DefaultManager() getter 的描述(保持 API 与文档一致) 详见 CHANGELOG.md 与 README.md 更新日志。 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
474 lines
12 KiB
Go
474 lines
12 KiB
Go
package database
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"math/rand"
|
|
"strings"
|
|
"sync"
|
|
"sync/atomic"
|
|
"time"
|
|
|
|
"github.com/EthanCodeCraft/xlgo-core/config"
|
|
"github.com/EthanCodeCraft/xlgo-core/logger"
|
|
|
|
"go.uber.org/zap"
|
|
"gorm.io/gorm"
|
|
gormlogger "gorm.io/gorm/logger"
|
|
)
|
|
|
|
type dbModeContextKey struct{}
|
|
|
|
const (
|
|
dbModeMaster = "master"
|
|
dbModeReplica = "replica"
|
|
)
|
|
|
|
// ReplicaPicker 从库选择策略
|
|
type ReplicaPicker interface {
|
|
Pick(replicas []*gorm.DB) *gorm.DB
|
|
}
|
|
|
|
// RoundRobinPicker 轮询选择从库
|
|
type RoundRobinPicker struct {
|
|
counter uint64
|
|
}
|
|
|
|
// Pick 轮询选择一个从库
|
|
func (p *RoundRobinPicker) Pick(replicas []*gorm.DB) *gorm.DB {
|
|
if len(replicas) == 0 {
|
|
return nil
|
|
}
|
|
n := atomic.AddUint64(&p.counter, 1)
|
|
return replicas[int(n-1)%len(replicas)]
|
|
}
|
|
|
|
// RandomPicker 随机选择从库
|
|
type RandomPicker struct{}
|
|
|
|
// Pick 随机选择一个从库
|
|
func (p *RandomPicker) Pick(replicas []*gorm.DB) *gorm.DB {
|
|
if len(replicas) == 0 {
|
|
return nil
|
|
}
|
|
return replicas[rand.Intn(len(replicas))]
|
|
}
|
|
|
|
// Manager 数据库管理器,持有主库与从库连接实例
|
|
type Manager struct {
|
|
cfg *config.Config
|
|
master *gorm.DB
|
|
replicas []*gorm.DB
|
|
picker ReplicaPicker
|
|
mu sync.Mutex
|
|
}
|
|
|
|
// NewManager 创建数据库管理器
|
|
func NewManager(cfg *config.Config) *Manager {
|
|
return &Manager{cfg: cfg, picker: &RandomPicker{}}
|
|
}
|
|
|
|
// SetPicker 设置从库选择策略
|
|
func (m *Manager) SetPicker(p ReplicaPicker) {
|
|
if p == nil {
|
|
return
|
|
}
|
|
m.mu.Lock()
|
|
m.picker = p
|
|
m.mu.Unlock()
|
|
}
|
|
|
|
// Picker 返回当前从库选择策略
|
|
func (m *Manager) Picker() ReplicaPicker {
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
return m.picker
|
|
}
|
|
|
|
// Master 返回主库实例
|
|
func (m *Manager) Master() *gorm.DB {
|
|
return m.master
|
|
}
|
|
|
|
// Replicas 返回所有从库实例
|
|
func (m *Manager) Replicas() []*gorm.DB {
|
|
return m.replicas
|
|
}
|
|
|
|
// Replica 按策略选择一个从库;无从库时返回主库
|
|
func (m *Manager) Replica() *gorm.DB {
|
|
if len(m.replicas) == 0 {
|
|
return m.master
|
|
}
|
|
m.mu.Lock()
|
|
defer m.mu.Unlock()
|
|
if m.picker != nil {
|
|
if db := m.picker.Pick(m.replicas); db != nil {
|
|
return db
|
|
}
|
|
}
|
|
return m.replicas[0]
|
|
}
|
|
|
|
// FromContext 根据上下文选择数据库
|
|
func (m *Manager) FromContext(ctx context.Context) *gorm.DB {
|
|
mode, ok := ctx.Value(dbModeContextKey{}).(string)
|
|
if !ok {
|
|
return m.Replica()
|
|
}
|
|
switch mode {
|
|
case dbModeMaster:
|
|
return m.master
|
|
case dbModeReplica:
|
|
return m.Replica()
|
|
default:
|
|
return m.Replica()
|
|
}
|
|
}
|
|
|
|
// Open 打开主库连接
|
|
func (m *Manager) Open(ctx context.Context) error {
|
|
if m.cfg == nil {
|
|
return errors.New("数据库配置未设置")
|
|
}
|
|
return m.InitDB(m.cfg)
|
|
}
|
|
|
|
// OpenWithReplicas 打开主库与从库连接
|
|
func (m *Manager) OpenWithReplicas(ctx context.Context, replicaDSNs []string) error {
|
|
if m.cfg == nil {
|
|
return errors.New("数据库配置未设置")
|
|
}
|
|
return m.InitDBWithReplicas(m.cfg, replicaDSNs)
|
|
}
|
|
|
|
// Close 关闭主库与全部从库连接
|
|
func (m *Manager) Close() error {
|
|
var errs []error
|
|
|
|
if m.master != nil {
|
|
sqlDB, err := m.master.DB()
|
|
if err != nil {
|
|
errs = append(errs, err)
|
|
} else if err := sqlDB.Close(); err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
}
|
|
|
|
for _, replica := range m.replicas {
|
|
if replica == nil {
|
|
continue
|
|
}
|
|
sqlDB, err := replica.DB()
|
|
if err != nil {
|
|
errs = append(errs, err)
|
|
continue
|
|
}
|
|
if err := sqlDB.Close(); err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
}
|
|
|
|
m.master = nil
|
|
m.replicas = nil
|
|
|
|
return errors.Join(errs...)
|
|
}
|
|
|
|
// HealthCheck 健康检查,主库不可达时返回错误
|
|
func (m *Manager) HealthCheck(ctx context.Context) error {
|
|
if m.master == nil {
|
|
return errors.New("database master not initialized")
|
|
}
|
|
sqlDB, err := m.master.DB()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return sqlDB.PingContext(ctx)
|
|
}
|
|
|
|
// DefaultManager 默认数据库管理器
|
|
var DefaultManager = &Manager{picker: &RandomPicker{}}
|
|
|
|
// InitDB 初始化数据库连接(带重试机制),驱动由配置决定
|
|
func (m *Manager) InitDB(cfg *config.Config) error {
|
|
var err error
|
|
m.cfg = cfg
|
|
|
|
// GORM 日志配置
|
|
var gormLogLevel gormlogger.LogLevel
|
|
if cfg.IsDevelopment() {
|
|
gormLogLevel = gormlogger.Info
|
|
} else {
|
|
gormLogLevel = gormlogger.Warn
|
|
}
|
|
|
|
gormConfig := &gorm.Config{
|
|
Logger: gormlogger.Default.LogMode(gormLogLevel),
|
|
}
|
|
|
|
// 重试配置
|
|
maxRetries := 5
|
|
retryDelay := time.Second
|
|
|
|
var lastErr error
|
|
for i := range maxRetries {
|
|
// 连接主库
|
|
m.master, err = gorm.Open(Dialector(cfg), gormConfig)
|
|
if err == nil {
|
|
sqlDB, err := m.master.DB()
|
|
if err == nil {
|
|
sqlDB.SetMaxIdleConns(cfg.Database.MaxIdleConns)
|
|
sqlDB.SetMaxOpenConns(cfg.Database.MaxOpenConns)
|
|
sqlDB.SetConnMaxLifetime(time.Hour)
|
|
|
|
if err := sqlDB.Ping(); err == nil {
|
|
logger.Info("数据库主库连接成功",
|
|
zap.String("driver", driverDescription(cfg.Database.Driver)),
|
|
zap.String("host", cfg.Database.Host),
|
|
zap.Int("port", cfg.Database.Port))
|
|
return nil
|
|
} else {
|
|
// Ping 失败(如服务端暂时不可达)视作可重试
|
|
lastErr = err
|
|
}
|
|
} else {
|
|
lastErr = err
|
|
}
|
|
} else {
|
|
lastErr = err
|
|
// 不可恢复的错误(认证失败、未知数据库、DSN 非法等)直接返回,不必重试
|
|
if !isTransientDBError(err) {
|
|
return fmt.Errorf("数据库连接失败(不可恢复): %w", err)
|
|
}
|
|
}
|
|
|
|
logger.Warnf("数据库连接失败,第 %d/%d 次重试: %v", i+1, maxRetries, lastErr)
|
|
time.Sleep(retryDelay)
|
|
retryDelay *= 2
|
|
if retryDelay > 30*time.Second {
|
|
retryDelay = 30 * time.Second
|
|
}
|
|
}
|
|
|
|
return fmt.Errorf("数据库连接失败(重试 %d 次): %w", maxRetries, lastErr)
|
|
}
|
|
|
|
// isTransientDBError 判断数据库连接错误是否值得重试。
|
|
// 认证失败、未知数据库、非法 DSN/驱动等属于配置类错误,重试无意义,直接返回更友好。
|
|
func isTransientDBError(err error) bool {
|
|
if err == nil {
|
|
return true
|
|
}
|
|
msg := err.Error()
|
|
nonTransient := []string{
|
|
"Access denied", // MySQL 认证失败(用户名/密码错误)
|
|
"authentication plugin", // MySQL 认证插件不支持
|
|
"Unknown database", // MySQL 目标库不存在
|
|
"invalid DSN", // DSN 语法错误
|
|
"unknown driver", // 驱动未注册
|
|
"unsupported driver", // 驱动不支持
|
|
}
|
|
for _, sub := range nonTransient {
|
|
if strings.Contains(msg, sub) {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// InitDBWithReplicas 初始化数据库主从连接,驱动由配置决定
|
|
// replicaDSNs: 从库连接字符串列表(需与主库驱动匹配)
|
|
func (m *Manager) InitDBWithReplicas(cfg *config.Config, replicaDSNs []string) error {
|
|
// 先初始化主库
|
|
if err := m.InitDB(cfg); err != nil {
|
|
return err
|
|
}
|
|
|
|
m.replicas = nil
|
|
|
|
// 初始化从库
|
|
if len(replicaDSNs) > 0 {
|
|
var gormLogLevel gormlogger.LogLevel
|
|
if cfg.IsDevelopment() {
|
|
gormLogLevel = gormlogger.Info
|
|
} else {
|
|
gormLogLevel = gormlogger.Warn
|
|
}
|
|
|
|
gormConfig := &gorm.Config{
|
|
Logger: gormlogger.Default.LogMode(gormLogLevel),
|
|
}
|
|
|
|
for i, dsn := range replicaDSNs {
|
|
replicaDB, err := gorm.Open(dialectorForDSN(cfg.Database.Driver, dsn), gormConfig)
|
|
if err != nil {
|
|
logger.Warnf("数据库从库 %d 连接失败: %v", i+1, err)
|
|
continue
|
|
}
|
|
|
|
sqlDB, err := replicaDB.DB()
|
|
if err != nil {
|
|
logger.Warnf("数据库从库 %d 获取连接池失败: %v", i+1, err)
|
|
continue
|
|
}
|
|
|
|
sqlDB.SetMaxIdleConns(cfg.Database.MaxIdleConns)
|
|
sqlDB.SetMaxOpenConns(cfg.Database.MaxOpenConns / 2) // 从库连接数可适当减少
|
|
sqlDB.SetConnMaxLifetime(time.Hour)
|
|
|
|
if err := sqlDB.Ping(); err != nil {
|
|
logger.Warnf("数据库从库 %d Ping 失败: %v", i+1, err)
|
|
continue
|
|
}
|
|
|
|
m.replicas = append(m.replicas, replicaDB)
|
|
logger.Info("数据库从库连接成功", zap.Int("index", i+1))
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// InitDB 初始化数据库连接(带重试机制),驱动由配置决定
|
|
func InitDB(cfg *config.Config) error {
|
|
return DefaultManager.InitDB(cfg)
|
|
}
|
|
|
|
// InitDBWithReplicas 初始化数据库主从连接,驱动由配置决定
|
|
func InitDBWithReplicas(cfg *config.Config, replicaDSNs []string) error {
|
|
return DefaultManager.InitDBWithReplicas(cfg, replicaDSNs)
|
|
}
|
|
|
|
// GetReadDB 获取读库实例(按策略选择从库)
|
|
func GetReadDB() *gorm.DB {
|
|
return DefaultManager.Replica()
|
|
}
|
|
|
|
// GetWriteDB 获取写库实例(主库)
|
|
func GetWriteDB() *gorm.DB {
|
|
return DefaultManager.Master()
|
|
}
|
|
|
|
// GetDB 获取数据库实例(默认主库,兼容旧代码)
|
|
func GetDB() *gorm.DB {
|
|
return DefaultManager.Master()
|
|
}
|
|
|
|
// GetReplicas 获取所有从库实例
|
|
func GetReplicas() []*gorm.DB {
|
|
return DefaultManager.Replicas()
|
|
}
|
|
|
|
// SetReplicaPicker 设置默认管理器的从库选择策略
|
|
func SetReplicaPicker(p ReplicaPicker) {
|
|
DefaultManager.SetPicker(p)
|
|
}
|
|
|
|
// UseMaster 强制使用主库(用于事务或需要实时数据的场景)
|
|
func UseMaster(ctx context.Context) context.Context {
|
|
return context.WithValue(ctx, dbModeContextKey{}, dbModeMaster)
|
|
}
|
|
|
|
// UseReplica 强制使用从库(用于报表查询等场景)
|
|
func UseReplica(ctx context.Context) context.Context {
|
|
return context.WithValue(ctx, dbModeContextKey{}, dbModeReplica)
|
|
}
|
|
|
|
// GetDBFromContext 根据上下文选择数据库
|
|
func GetDBFromContext(ctx context.Context) *gorm.DB {
|
|
return DefaultManager.FromContext(ctx)
|
|
}
|
|
|
|
// AutoMigrate 自动迁移数据库表结构(由应用通过 WithMigrator/WithModels 注册)
|
|
func AutoMigrate() error {
|
|
logger.Info("数据库表结构迁移完成")
|
|
return nil
|
|
}
|
|
|
|
// Close 关闭主库连接(兼容旧代码,从库连接请使用 CloseAll)
|
|
func Close() error {
|
|
if DefaultManager.master == nil {
|
|
return nil
|
|
}
|
|
sqlDB, err := DefaultManager.master.DB()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
err = sqlDB.Close()
|
|
DefaultManager.master = nil
|
|
return err
|
|
}
|
|
|
|
// CloseAll 关闭所有数据库连接(包括从库)
|
|
func CloseAll() error {
|
|
return DefaultManager.Close()
|
|
}
|
|
|
|
// Transaction 事务操作(自动使用主库)
|
|
func Transaction(fn func(tx *gorm.DB) error) error {
|
|
if DefaultManager.master == nil {
|
|
return errors.New("数据库未初始化")
|
|
}
|
|
return DefaultManager.master.Transaction(fn)
|
|
}
|
|
|
|
// TransactionWithContext 带上下文的事务操作
|
|
func TransactionWithContext(ctx context.Context, fn func(tx *gorm.DB) error) error {
|
|
if DefaultManager.master == nil {
|
|
return errors.New("数据库未初始化")
|
|
}
|
|
return DefaultManager.master.WithContext(ctx).Transaction(fn)
|
|
}
|
|
|
|
// ReadQuery 读查询(自动路由到从库)
|
|
func ReadQuery(ctx context.Context, model any, query string, args ...any) error {
|
|
db := GetDBFromContext(ctx)
|
|
if db == nil {
|
|
return errors.New("数据库未初始化")
|
|
}
|
|
return db.WithContext(ctx).Where(query, args...).Find(model).Error
|
|
}
|
|
|
|
// WriteQuery 写查询(强制使用主库)
|
|
func WriteQuery(ctx context.Context, model any, query string, args ...any) error {
|
|
if DefaultManager.master == nil {
|
|
return errors.New("数据库未初始化")
|
|
}
|
|
return DefaultManager.master.WithContext(ctx).Where(query, args...).Find(model).Error
|
|
}
|
|
|
|
// HealthCheck 健康检查
|
|
func HealthCheck() map[string]bool {
|
|
result := make(map[string]bool)
|
|
|
|
// 检查主库
|
|
if DefaultManager.master != nil {
|
|
sqlDB, err := DefaultManager.master.DB()
|
|
if err == nil && sqlDB.Ping() == nil {
|
|
result["master"] = true
|
|
} else {
|
|
result["master"] = false
|
|
}
|
|
} else {
|
|
result["master"] = false
|
|
}
|
|
|
|
// 检查从库
|
|
for i, replica := range DefaultManager.replicas {
|
|
if replica != nil {
|
|
sqlDB, err := replica.DB()
|
|
if err == nil && sqlDB.Ping() == nil {
|
|
result[fmt.Sprintf("replica_%d", i+1)] = true
|
|
} else {
|
|
result[fmt.Sprintf("replica_%d", i+1)] = false
|
|
}
|
|
} else {
|
|
result[fmt.Sprintf("replica_%d", i+1)] = false
|
|
}
|
|
}
|
|
|
|
return result
|
|
}
|