go-transaction-manager 使用指南

go-transaction-manager 是一个用于 Golang 的多适配器事务管理库，它提供了统一的事务管理接口，支持多种数据库和存储引擎。

核心特性

• 支持多种适配器：PostgreSQL、MySQL、MongoDB、Redis 等
• 统一的事务管理接口
• 支持嵌套事务
• 上下文感知的事务管理

安装

go get github.com/avito-tech/go-transaction-manager

基本使用

1. 初始化事务管理器

import (
    "context"
    "database/sql"
    "github.com/avito-tech/go-transaction-manager/trm"
    "github.com/avito-tech/go-transaction-manager/trm/sqlx"
    _ "github.com/lib/pq"
)

func main() {
    // 初始化数据库连接
    db, err := sql.Open("postgres", "postgres://user:password@localhost/dbname?sslmode=disable")
    if err != nil {
        panic(err)
    }
    
    // 创建事务管理器
    trManager := sqlx.NewDefaultFactory(db)
    
    // 使用事务管理器
    ctx := context.Background()
    err = trManager.Do(ctx, func(ctx context.Context) error {
        // 业务逻辑代码
        return nil
    })
    
    if err != nil {
        // 处理错误
    }
}

2. 嵌套事务示例

func processOrder(ctx context.Context, trManager trm.Manager) error {
    return trManager.Do(ctx, func(ctx context.Context) error {
        // 主事务逻辑
        
        // 嵌套事务1
        err := trManager.Do(ctx, func(ctx context.Context) error {
            // 更新库存
            return nil
        })
        if err != nil {
            return err
        }
        
        // 嵌套事务2
        err = trManager.Do(ctx, func(ctx context.Context) error {
            // 创建订单
            return nil
        })
        
        return err
    })
}

3. 获取事务对象

func updateUser(ctx context.Context, trManager trm.Manager, userID int, name string) error {
    return trManager.Do(ctx, func(ctx context.Context) error {
        // 从上下文中获取事务对象
        tr, ok := trm.FromContext(ctx)
        if !ok {
            return errors.New("transaction not found")
        }
        
        // 类型断言为具体的事务类型
        sqlTr, ok := tr.(*sql.Tx)
        if !ok {
            return errors.New("invalid transaction type")
        }
        
        // 使用事务执行SQL
        _, err := sqlTr.ExecContext(ctx, "UPDATE users SET name = $1 WHERE id = $2", name, userID)
        return err
    })
}

多适配器支持

1. MongoDB 适配器示例

import (
    "go.mongodb.org/mongo-driver/mongo"
    "github.com/avito-tech/go-transaction-manager/trm/mongo"
)

func main() {
    client, err := mongo.Connect(context.Background(), options.Client().ApplyURI("mongodb://localhost:27017"))
    if err != nil {
        panic(err)
    }
    
    trManager := mongo.NewDefaultFactory(client)
    
    err = trManager.Do(context.Background(), func(ctx context.Context) error {
        collection := client.Database("test").Collection("users")
        _, err := collection.InsertOne(ctx, bson.M{"name": "John"})
        return err
    })
}

2. Redis 适配器示例

import (
    "github.com/redis/go-redis/v9"
    "github.com/avito-tech/go-transaction-manager/trm/redis"
)

func main() {
    rdb := redis.NewClient(&redis.Options{
        Addr:     "localhost:6379",
        Password: "",
        DB:       0,
    })
    
    trManager := redis.NewDefaultFactory(rdb)
    
    err := trManager.Do(context.Background(), func(ctx context.Context) error {
        err := rdb.Set(ctx, "key", "value", 0).Err()
        return err
    })
}

高级配置

1. 自定义事务设置

func main() {
    db, _ := sql.Open("postgres", "postgres://...")
    
    // 自定义事务设置
    settings := sqlx.NewSettings(
        sqlx.WithIsolationLevel(sql.LevelSerializable),
        sqlx.WithReadOnly(false),
    )
    
    trManager := sqlx.New(db, settings)
    
    // 使用事务管理器...
}

2. 事务传播行为

func main() {
    db, _ := sql.Open("postgres", "postgres://...")
    trManager := sqlx.NewDefaultFactory(db)
    
    ctx := context.Background()
    
    // REQUIRED (默认): 如果存在事务则加入，否则新建
    err := trManager.Do(ctx, func(ctx context.Context) error {
        // 业务逻辑
        
        // REQUIRES_NEW: 总是新建事务
        return trManager.Do(trm.NewPropagation(ctx, trm.PropagationRequiresNew), func(ctx context.Context) error {
            // 独立事务逻辑
            return nil
        }
    })
}

最佳实践

1. 事务边界：合理划分事务边界，避免过长事务
2. 错误处理：正确处理事务中的错误，确保事务能够正确回滚
3. 上下文传递：始终传递上下文，确保事务能够正确传播
4. 隔离级别：根据业务需求选择合适的隔离级别

总结

go-transaction-manager 提供了统一的事务管理接口，简化了多数据源环境下的事务管理。通过适配器模式，它可以轻松集成到现有项目中，并提供灵活的事务控制能力。