Go 語言操作 MySQL 之 SQLX 包

Meng小羽發表於2020-07-07

友情提示:此篇文章大約需要閱讀 14分鐘5秒,不足之處請多指教,感謝你的閱讀。 訂閱本站

SQLX 庫

sqlx是 Go 的軟體包,它在出色的內建database/sql軟體包的基礎上提供了一組擴充套件。

該庫相容sql原生包,同時又提供了更為強大的、優雅的查詢、插入函式。

該庫提供四個處理型別,分別是:

  • sqlx.DB – 類似原生的 sql.DB
  • sqlx.Tx – 類似原生的 sql.Tx
  • sqlx.Stmt – 類似原生的 sql.Stmt, 準備 SQL 語句操作;
  • sqlx.NamedStmt – 對特定引數命名並繫結生成 SQL 語句操作。

提供兩個遊標型別,分別是:

  • sqlx.Rows – 類似原生的 sql.Rows, 從 Queryx 返回;
  • sqlx.Row – 類似原生的 sql.Row, 從 QueryRowx 返回。

安裝 SQLX 庫

go get github.com/jmoiron/sqlx

使用操作

連線資料庫

// 初始化資料庫
func initMySQL() (err error) {
    dsn := "root:password@tcp(127.0.0.1:3306)/database"
    db, err = sqlx.Open("mysql", dsn)
    if err != nil {
        fmt.Printf("connect server failed, err:%v\n", err)
        return
    }
    db.SetMaxOpenConns(200)
    db.SetMaxIdleConns(10)
    return
}

SetMaxOpenConnsSetMaxIdleConns 分別為設定最大連線數和最大空閒數。

資料表達及引用

在這裡提前宣告一個使用者結構體 user,將 *sqlx.DB 作為一個全域性變數使用,當然也要提前引用 MySQL 的驅動包,如下設計:

import (
    "fmt"
    _ "github.com/go-sql-driver/mysql"
    "github.com/jmoiron/sqlx"
)

var db *sqlx.DB

type user struct {
    Id   int    `db:"id"`
    Age  int    `db:"age"`
    Name string `db:"name"`
}

查詢操作

查詢一行資料

查詢一行資料使用sqlx庫中的Get函式實現:

func (db *DB) Get(dest interface{}, query string, args ...interface{}) error

dest是使用者宣告變數接收查詢結果,query為查詢 SQL 語句,args為繫結引數的賦值。

// 查詢一行資料
func queryRow() {
    sqlStr := "SELECT id, name, age FROM user WHERE id = ?"

    var u user
    if err := db.Get(&u, sqlStr, 1); err != nil {
        fmt.Printf("get data failed, err:%v\n", err)
        return
    }
    fmt.Printf("id:%d, name:%s, age:%d\n", u.Id, u.Name, u.Age)
}

查詢多行資料

而查詢多行資料則使用的是Select 函式:

func (db *DB) Select(dest interface{}, query string, args ...interface{}) error

使用Select函式進行查詢的時候,需要先宣告一個結構體陣列接收對映過來的資料:

// 查詢多行資料
func queryMultiRow() {
    sqlStr := "SELECT id, name, age FROM user WHERE id > ?"
    var users []user
    if err := db.Select(&users, sqlStr, 0); err != nil {
        fmt.Printf("get data failed, err:%v\n", err)
        return
    }

    for i := 0; i < len(users); i++ {
        fmt.Printf("id:%d, name:%s, age:%d\n", users[i].Id, users[i].Name, users[i].Age)
    }
}

插入、更新、刪除操作

sqlx庫中,使用插入、更新、刪除操作是和原生sql庫實現是一致的,都是採用Exec函式來實現的:

插入操作

// 插入資料
func insertRow() {
    sqlStr := "INSERT INTO user(name, age) VALUES(?, ?)"
    result, err := db.Exec(sqlStr, "Meng小羽", 22)
    if err != nil {
        fmt.Printf("exec failed, err:%v\n", err)
        return
    }
    insertID, err := result.LastInsertId()
    if err != nil {
        fmt.Printf("get insert id failed, err:%v\n", err)
        return
    }
    fmt.Printf("insert data success, id:%d\n", insertID)
}

更新操作

// 更新資料
func updateRow() {
    sqlStr := "UPDATE user SET age = ? WHERE id = ?"
    result, err := db.Exec(sqlStr, 22, 6)
    if err != nil {
        fmt.Printf("exec failed, err:%v\n", err)
        return
    }
    affectedRows, err := result.RowsAffected()
    if err != nil {
        fmt.Printf("get affected failed, err:%v\n", err)
        return
    }
    fmt.Printf("update data success, affected rows:%d\n", affectedRows)
}

刪除操作

// 刪除一行
func deleteRow() {
    sqlStr := "DELETE FROM user WHERE id = ?"
    result, err := db.Exec(sqlStr, 4)
    if err != nil {
        fmt.Printf("exec failed, err:%v\n", err)
        return
    }
    affectedRows, err := result.RowsAffected()
    if err != nil {
        fmt.Printf("get affected failed, err:%v\n", err)
        return
    }
    fmt.Printf("delete data success, affected rows:%d\n", affectedRows)
}

引數繫結

在庫中提供最常用的就是NamedQueryNamedExec函式,一個是執行對查詢引數命名並繫結,另一個則是對 CUD 操作的查詢引數名的繫結:

NamedQuery

// 繫結查詢
func selectNamedQuery() {
    sqlStr := "SELECT id, name, age FROM user WHERE age = :age"
    rows, err := db.NamedQuery(sqlStr, map[string]interface{}{
        "age": 22,
    })
    if err != nil {
        fmt.Printf("named query failed failed, err:%v\n", err)
        return
    }
    defer rows.Close()
    for rows.Next() {
        var u user
        if err := rows.StructScan(&u); err != nil {
            fmt.Printf("struct sacn failed, err:%v\n", err)
            continue
        }
        fmt.Printf("%#v\n", u)
    }
}

NamedExec

// 使用 named 方法插入資料
func insertNamedExec() {
    sqlStr := "INSERT INTO user(name, age) VALUES(:name, :age)"
    result, err := db.NamedExec(sqlStr, map[string]interface{}{
        "name": "里斯",
        "age":  18,
    })
    if err != nil {
        fmt.Printf("named exec failed, err:%v\n", err)
        return
    }
    insertId, err := result.LastInsertId()
    if err != nil {
        fmt.Printf("get last insert id failed, err:%v\n", err)
        return
    }
    fmt.Printf("insert data success, id:%d\n", insertId)
}

事務操作

使用Begin函式、Rollback函式及Commit函式實現事務操作:

// 開啟事務
func (db *DB) Begin() (*Tx, error) 
// 回滾事務
func (tx *Tx) Rollback() error 
// 提交事務
func (tx *Tx) Commit() error

示例程式碼:

// 事務操作
func updateTransaction() (err error) {
    tx, err := db.Begin()
    if err != nil {
        fmt.Printf("transaction begin failed, err:%v\n", err)
        return err
    }

    defer func() {
        if p := recover(); p != nil {
            _ = tx.Rollback()
            panic(p)
        } else if err != nil {
            fmt.Printf("transaction rollback")
            _ = tx.Rollback()
        } else {
            err = tx.Commit()
            fmt.Printf("transaction commit")
            return
        }
    }()

    sqlStr1 := "UPDATE user SET age = ? WHERE id = ? "
    reuslt1, err := tx.Exec(sqlStr1, 18, 1)
    if err != nil {
        fmt.Printf("sql exec failed, err:%v\n", err)
        return err
    }
    rows1, err := reuslt1.RowsAffected()
    if err != nil {
        fmt.Printf("affected rows is 0")
        return
    }
    sqlStr2 := "UPDATE user SET age = ? WHERE id = ? "
    reuslt2, err := tx.Exec(sqlStr2, 19, 5)
    if err != nil {
        fmt.Printf("sql exec failed, err:%v\n", err)
        return err
    }
    rows2, err := reuslt2.RowsAffected()
    if err != nil {
        fmt.Printf("affected rows is 0\n")
        return
    }

    if rows1 > 0 && rows2 > 0 {
        fmt.Printf("update data success\n")
    }
    return
}

開源支援

最後將此開源專案放在此處,大家要是感興趣可以給這個開源專案一個 Star,感謝。

GitHub jmoiron/sqlx

參考文章

本作品採用《CC 協議》,轉載必須註明作者和本文連結
Meng小羽

相關文章