Golang零样板数据库操作插件库dbq使用指南

dbq是一个轻量级的Golang数据库操作库，旨在消除样板代码，提供简洁高效的数据库访问方式。下面我将详细介绍dbq的使用方法。

安装

go get github.com/rocketlaunchr/dbq/v2

基本用法

1. 初始化连接

import (
    "database/sql"
    "github.com/rocketlaunchr/dbq/v2"
    _ "github.com/go-sql-driver/mysql"
)

func main() {
    // 创建标准database/sql连接
    db, err := sql.Open("mysql", "user:password@tcp(localhost:3306)/dbname")
    if err != nil {
        panic(err)
    }
    defer db.Close()
    
    // 将连接传递给dbq
    dbq.SetDb(db)
}

2. 查询单条记录

type User struct {
    ID       int    `dbq:"id"`
    Username string `dbq:"username"`
    Email    string `dbq:"email"`
}

// 查询单条记录
func getUser(id int) (*User, error) {
    query := "SELECT id, username, email FROM users WHERE id = ?"
    opts := &dbq.Options{ConcreteStruct: User{}, SingleResult: true}
    
    result, err := dbq.Q(context.TODO(), dbq.DB(), query, opts, id)
    if err != nil {
        return nil, err
    }
    
    return result.(*User), nil
}

3. 查询多条记录

// 查询多条记录
func getAllUsers() ([]*User, error) {
    query := "SELECT id, username, email FROM users"
    opts := &dbq.Options{ConcreteStruct: User{}}
    
    result, err := dbq.Q(context.TODO(), dbq.DB(), query, opts)
    if err != nil {
        return nil, err
    }
    
    return result.([]*User), nil
}

4. 插入数据

// 插入数据
func createUser(user *User) (int64, error) {
    stmt := dbq.INSERTStmt("users", []string{"username", "email"}, 1, dbq.MySQL)
    
    res, err := dbq.E(context.TODO(), dbq.DB(), stmt, nil, user.Username, user.Email)
    if err != nil {
        return 0, err
    }
    
    return res.RowsAffected()
}

5. 批量插入

// 批量插入
func batchInsertUsers(users []*User) (int64, error) {
    // 准备数据
    data := make([]interface{}, len(users))
    for i, u := range users {
        data[i] = []interface{}{u.Username, u.Email}
    }
    
    stmt := dbq.INSERTStmt("users", []string{"username", "email"}, len(users), dbq.MySQL)
    
    res, err := dbq.E(context.TODO(), dbq.DB(), stmt, nil, data...)
    if err != nil {
        return 0, err
    }
    
    return res.RowsAffected()
}

6. 更新数据

// 更新数据
func updateUser(user *User) (int64, error) {
    stmt := "UPDATE users SET username = ?, email = ? WHERE id = ?"
    
    res, err := dbq.E(context.TODO(), dbq.DB(), stmt, nil, user.Username, user.Email, user.ID)
    if err != nil {
        return 0, err
    }
    
    return res.RowsAffected()
}

7. 事务处理

func transferMoney(fromID, toID int, amount float64) error {
    tx, err := dbq.DB().BeginTx(context.TODO(), nil)
    if err != nil {
        return err
    }
    
    defer func() {
        if err != nil {
            tx.Rollback()
        }
    }()
    
    // 扣款
    _, err = dbq.E(context.TODO(), tx, "UPDATE accounts SET balance = balance - ? WHERE id = ?", nil, amount, fromID)
    if err != nil {
        return err
    }
    
    // 存款
    _, err = dbq.E(context.TODO(), tx, "UPDATE accounts SET balance = balance + ? WHERE id = ?", nil, amount, toID)
    if err != nil {
        return err
    }
    
    return tx.Commit()
}

高级特性

1. 自定义映射

type CustomUser struct {
    UserID   int    `dbq:"id"`
    Name     string `dbq:"username"`
    Mail     string `dbq:"email"`
}

func getCustomUser(id int) (*CustomUser, error) {
    query := "SELECT id, username, email FROM users WHERE id = ?"
    opts := &dbq.Options{
        ConcreteStruct: CustomUser{},
        SingleResult:   true,
        DecoderConfig: dbq.StdTimeConversionConfig(),
    }
    
    result, err := dbq.Q(context.TODO(), dbq.DB(), query, opts, id)
    if err != nil {
        return nil, err
    }
    
    return result.(*CustomUser), nil
}

2. 使用原生SQL结果

func getRawResults() ([]map[string]interface{}, error) {
    query := "SELECT id, username, email FROM users"
    opts := &dbq.Options{
        RawResults: true,
    }
    
    result, err := dbq.Q(context.TODO(), dbq.DB(), query, opts)
    if err != nil {
        return nil, err
    }
    
    return result.([]map[string]interface{}), nil
}

3. 连接池配置

func initDB() {
    db, err := sql.Open("mysql", "user:password@tcp(localhost:3306)/dbname")
    if err != nil {
        panic(err)
    }
    
    // 配置连接池
    db.SetMaxOpenConns(25)
    db.SetMaxIdleConns(25)
    db.SetConnMaxLifetime(5 * time.Minute)
    
    dbq.SetDb(db)
}

总结

dbq库通过以下方式实现了零样板代码：

1. 自动映射查询结果到结构体
2. 简化CRUD操作
3. 提供便捷的事务支持
4. 支持批量操作
5. 灵活的查询选项配置

相比直接使用database/sql，dbq可以显著减少重复代码，同时保持足够的灵活性。它特别适合中小型项目，可以快速实现数据库操作而无需引入复杂的ORM框架。