go第三方庫(kù)sqlx操作MySQL及ORM原理
sqlx是Golang中的一個(gè)知名三方庫(kù)，其為Go標(biāo)準(zhǔn)庫(kù)database/sql提供了一組擴(kuò)展支持。使用它可以方便的在數(shù)據(jù)行與Golang的結(jié)構(gòu)體、映射和切片之間進(jìn)行轉(zhuǎn)換，從這個(gè)角度可以說(shuō)它是一個(gè)ORM框架；它還封裝了一系列地常用SQL操作方法，讓我們用起來(lái)更爽。
sqlx實(shí)戰(zhàn)
這里以操作MySQL的增刪改查為例。
準(zhǔn)備工作
先要準(zhǔn)備一個(gè)MySQL，這里通過(guò)docker快速啟動(dòng)一個(gè)MySQL 5.7。
docker run -d --name mysql1 -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7
在MySQL中創(chuàng)建一個(gè)名為test的數(shù)據(jù)庫(kù)：
CREATE DATABASE `test` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
數(shù)據(jù)庫(kù)中創(chuàng)建一個(gè)名為Person的數(shù)據(jù)庫(kù)表：
CREATE TABLE test.Person ( Id integer auto_increment NOT NULL, Name VARCHAR(30) NULL, City VARCHAR(50) NULL, AddTime DATETIME NOT NULL, UpdateTime DATETIME NOT NULL, CONSTRAINT Person_PK PRIMARY KEY (Id) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
然后創(chuàng)建一個(gè)Go項(xiàng)目，安裝sqlx：
go get github.com/jmoiron/sqlx
因?yàn)椴僮鞯氖荕ySQL，還需要安裝MySQL的驅(qū)動(dòng)：
go get github.com/go-sql-driver/mysql
編寫代碼
添加引用
添加sqlx和mysql驅(qū)動(dòng)的引用：
import ( "log" _ "github.com/go-sql-driver/mysql" "github.com/jmoiron/sqlx" )
MySQL的驅(qū)動(dòng)是隱式注冊(cè)的，并不會(huì)在接下來(lái)的程序中直接調(diào)用，所以這里加了下劃線。
創(chuàng)建連接
操作數(shù)據(jù)庫(kù)前需要先創(chuàng)建一個(gè)連接:
db, err := sqlx.Connect("mysql", "root:123456@tcp(127.0.0.1:3306)/test?charset=utf8mb4&parseTime=true&loc=Local")
if err != nil {
log.Println("數(shù)據(jù)庫(kù)連接失敗")
}
這個(gè)連接中指定了程序要用MySQL驅(qū)動(dòng)，以及MySQL的連接地址、用戶名和密碼、數(shù)據(jù)庫(kù)名稱、字符編碼方式；這里還有兩個(gè)參數(shù)parseTime和loc，parseTime的作用是讓MySQL中時(shí)間類型的值可以映射到Golang中的time.Time類型，loc的作用是設(shè)置time.Time的值的時(shí)區(qū)為當(dāng)前系統(tǒng)時(shí)區(qū)，不使用這個(gè)參數(shù)的話保存到的數(shù)據(jù)庫(kù)的就是UTC時(shí)間，會(huì)和北京時(shí)間差8個(gè)小時(shí)。
增刪改查
sqlx擴(kuò)展了DB和Tx，繼承了它們?cè)械姆椒?，并擴(kuò)展了一些方法，這里主要看下這些擴(kuò)展的方法。
增加
通用占位符的方式：
insertResult := db.MustExec("INSERT INTO Person (Name, City, AddTime, UpdateTime) VALUES (?, ?, ?, ?)", "Zhang San", "Beijing", time.Now(), time.Now())
lastInsertId, _ := insertResult.LastInsertId()
log.Println("Insert Id is ", lastInsertId)
這個(gè)表的主鍵使用了自增的方式，可以通過(guò)返回值的LastInsertId方法獲取。
命名參數(shù)的方式：
insertPerson := &Person{
Name: "Li Si",
City: "Shanghai",
AddTime: time.Now(),
UpdateTime: time.Now(),
}
insertPersonResult, err := db.NamedExec("INSERT INTO Person (Name, City, AddTime, UpdateTime) VALUES(:Name, :City, :AddTime, :UpdateTime)", insertPerson)
命名參數(shù)的方式是sqlx擴(kuò)展的，這個(gè)方式就是常說(shuō)的ORM。這里需要注意給struct字段添加上db標(biāo)簽：
type Person struct {
Id int `db:"Id"`
Name string `db:"Name"`
City string `db:"City"`
AddTime time.Time `db:"AddTime"`
UpdateTime time.Time `db:"UpdateTime"`
}
struct中的字段名稱不必和數(shù)據(jù)庫(kù)字段相同，只需要通過(guò)db標(biāo)簽映射正確就行。注意SQL語(yǔ)句中使用的命名參數(shù)需要是db標(biāo)簽中的名字。
除了可以映射struct，sqlx還支持map，請(qǐng)看下面這個(gè)示例：
insertMap := map[string]interface{}{
"n": "Wang Wu",
"c": "HongKong",
"a": time.Now(),
"u": time.Now(),
}
insertMapResult, err := db.NamedExec("INSERT INTO Person (Name, City, AddTime, UpdateTime) VALUES(:n, :c, :a, :u)", insertMap)
再來(lái)看看批增加的方式：
insertPersonArray := []Person{
{Name: "BOSIMA", City: "Wu Han", AddTime: time.Now(), UpdateTime: time.Now()},
{Name: "BOSSMA", City: "Xi An", AddTime: time.Now(), UpdateTime: time.Now()},
{Name: "BOMA", City: "Cheng Du", AddTime: time.Now(), UpdateTime: time.Now()},
}
insertPersonArrayResult, err := db.NamedExec("INSERT INTO Person (Name, City, AddTime, UpdateTime) VALUES(:Name, :City, :AddTime, :UpdateTime)", insertPersonArray)
if err != nil {
log.Println(err)
return
}
insertPersonArrayId, _ := insertPersonArrayResult.LastInsertId()
log.Println("InsertPersonArray Id is ", insertPersonArrayId)
這里還是采用命名參數(shù)的方式，參數(shù)傳遞一個(gè)struct數(shù)組或者切片就可以了。這個(gè)執(zhí)行結(jié)果中也可以獲取到最后插入數(shù)據(jù)的自增Id，不過(guò)實(shí)測(cè)返回的是本次插入的第一條的Id，這個(gè)有點(diǎn)別扭，但是考慮到增加多條只獲取一個(gè)Id的場(chǎng)景似乎沒有，所以也不用多慮。
除了使用struct數(shù)組或切片，也可以使用map數(shù)組或切片，這里就不貼出來(lái)了，有興趣的可以去看文末給出的Demo鏈接。
刪除
刪除也可以使用通用占位符和命名參數(shù)的方式，并且會(huì)返回本次執(zhí)行受影響的行數(shù)，某些情況下可以使用這個(gè)數(shù)字判斷SQL實(shí)際有沒有執(zhí)行成功。
deleteResult := db.MustExec("Delete from Person where Id=?", 1)
log.Println(deleteResult.RowsAffected())
deleteMapResult, err := db.NamedExec("Delete from Person where Id=:Id",
map[string]interface{}{"Id": 1})
if err != nil {
log.Println(err)
return
}
log.Println(deleteMapResult.RowsAffected())
修改
Sqlx對(duì)修改的支持和刪除差不多：
updateResult := db.MustExec("Update Person set City=?, UpdateTime=? where Id=?", "Shanghai", time.Now(), 1)
log.Println(updateResult.RowsAffected())
updateMapResult, err := db.NamedExec("Update Person set City=:City, UpdateTime=:UpdateTime where Id=:Id",
map[string]interface{}{"City": "Chong Qing", "UpdateTime": time.Now(), "Id": 1})
if err != nil {
log.Println(err)
}
log.Println(updateMapResult.RowsAffected())
查詢
Sqlx對(duì)查詢的支持比較多。
使用Get方法查詢一條：
getPerson := &Person{}
db.Get(getPerson, "select * from Person where Name=?", "Zhang San")
使用Select方法查詢多條：
selectPersons := []Person{}
db.Select(&selectPersons, "select * from Person where Name=?", "Zhang San")
只查詢部分字段：
getId := new(int64)
db.Get(getId, "select Id from Person where Name=?", "Zhang San")
selectTowFieldSlice := []Person{}
db.Select(&selectTowFieldSlice, "select Id,Name from Person where Name=?", "Zhang San")
selectNameSlice := []string{}
db.Select(&selectNameSlice, "select Name from Person where Name=?", "Zhang San")
從上可以看出如果只查詢部分字段，還可以繼續(xù)使用struct；特別的只查詢一個(gè)字段時(shí)，使用基本數(shù)據(jù)類型就可以了。
除了這些高層次的抽象方法，Sqlx也對(duì)更低層次的查詢方法進(jìn)行了擴(kuò)展：
查詢單行：
row = db.QueryRowx("select * from Person where Name=?", "Zhang San")
if row.Err() == sql.ErrNoRows {
log.Println("Not found Zhang San")
} else {
queryPerson := &Person{}
err = row.StructScan(queryPerson)
if err != nil {
log.Println(err)
return
}
log.Println("QueryRowx-StructScan:", queryPerson.City)
}
查詢多行：
rows, err := db.Queryx("select * from Person where Name=?", "Zhang San")
if err != nil {
log.Println(err)
return
}
for rows.Next() {
rowSlice, err := rows.SliceScan()
if err != nil {
log.Println(err)
return
}
log.Println("Queryx-SliceScan:", string(rowSlice[2].([]byte)))
}
命名參數(shù)Query：
rows, err = db.NamedQuery("select * from Person where Name=:n", map[string]interface{}{"n": "Zhang San"})
查詢出數(shù)據(jù)行后，這里有多種映射方法：StructScan、SliceScan和MapScan，分別對(duì)應(yīng)映射后的不同數(shù)據(jù)結(jié)構(gòu)。
預(yù)處理語(yǔ)句
對(duì)于重復(fù)使用的SQL語(yǔ)句，可以采用預(yù)處理的方式，減少SQL解析的次數(shù)，減少網(wǎng)絡(luò)通信量，從而提高SQL操作的吞吐量。
下面的代碼展示了sqlx中如何使用stmt查詢數(shù)據(jù)，分別采用了命名參數(shù)和通用占位符兩種傳參方式。
bosima := Person{}
bossma := Person{}
nstmt, err := db.PrepareNamed("SELECT * FROM Person WHERE Name = :n")
if err != nil {
log.Println(err)
return
}
err = nstmt.Get(&bossma, map[string]interface{}{"n": "BOSSMA"})
if err != nil {
log.Println(err)
return
}
log.Println("NamedStmt-Get1:", bossma.City)
err = nstmt.Get(&bosima, map[string]interface{}{"n": "BOSIMA"})
if err != nil {
log.Println(err)
return
}
log.Println("NamedStmt-Get2:", bosima.City)
stmt, err := db.Preparex("SELECT * FROM Person WHERE Name=?")
if err != nil {
log.Println(err)
return
}
err = stmt.Get(&bosima, "BOSIMA")
if err != nil {
log.Println(err)
return
}
log.Println("Stmt-Get1:", bosima.City)
err = stmt.Get(&bossma, "BOSSMA")
if err != nil {
log.Println(err)
return
}
log.Println("Stmt-Get2:", bossma.City)
對(duì)于上文增刪改查的方法，sqlx都有相應(yīng)的擴(kuò)展方法。與上文不同的是，需要先使用SQL模版創(chuàng)建一個(gè)stmt實(shí)例，然后執(zhí)行相關(guān)SQL操作時(shí)，不再需要傳遞SQL語(yǔ)句。
數(shù)據(jù)庫(kù)事務(wù)
為了在事務(wù)中執(zhí)行sqlx擴(kuò)展的增刪改查方法，sqlx必然也對(duì)數(shù)據(jù)庫(kù)事務(wù)做一些必要的擴(kuò)展支持。
tx, err = db.Beginx()
if err != nil {
log.Println(err)
return
}
tx.MustExec("INSERT INTO Person (Name, City, AddTime, UpdateTime) VALUES (?, ?, ?, ?)", "Zhang San", "Beijing", time.Now(), time.Now())
tx.MustExec("INSERT INTO Person (Name, City, AddTime, UpdateTime) VALUES (?, ?, ?, ?)", "Li Si Hai", "Dong Bei", time.Now(), time.Now())
err = tx.Commit()
if err != nil {
log.Println(err)
return
}
log.Println("tx-Beginx is successful")
上面這段代碼就是一個(gè)簡(jiǎn)單的sqlx數(shù)據(jù)庫(kù)事務(wù)示例，先通過(guò)db.Beginx開啟事務(wù)，然后執(zhí)行SQL語(yǔ)句，最后提交事務(wù)。
如果想要更改默認(rèn)的數(shù)據(jù)庫(kù)隔離級(jí)別，可以使用另一個(gè)擴(kuò)展方法：
tx, err = db.BeginTxx(context.Background(), &sql.TxOptions{Isolation: sql.LevelRepeatableRead})
sqlx干了什么
通過(guò)上邊的實(shí)戰(zhàn)，基本上就可以使用sqlx進(jìn)行開發(fā)了。為了更好的使用sqlx，我們可以再了解下sqlx是怎么做到上邊這些擴(kuò)展的。
Go的標(biāo)準(zhǔn)庫(kù)中沒有提供任何具體數(shù)據(jù)庫(kù)的驅(qū)動(dòng)，只是通過(guò)database/sql庫(kù)定義了操作數(shù)據(jù)庫(kù)的通用接口。sqlx中也沒有包含具體數(shù)據(jù)庫(kù)的驅(qū)動(dòng)，它只是封裝了常用SQL的操作方法，讓我們的SQL寫起來(lái)更爽。
MustXXX
sqlx提供兩個(gè)幾個(gè)MustXXX方法。
Must方法是為了簡(jiǎn)化錯(cuò)誤處理而出現(xiàn)的，當(dāng)開發(fā)者確定SQL操作不會(huì)返回錯(cuò)誤的時(shí)候就可以使用Must方法，但是如果真的出現(xiàn)了未知錯(cuò)誤的時(shí)候，這個(gè)方法內(nèi)部會(huì)觸發(fā)panic，開發(fā)者需要有一個(gè)兜底的方案來(lái)處理這個(gè)panic，比如使用recover。
這里是MustExec的源碼：
func MustExec(e Execer, query string, args ...interface{}) sql.Result {
res, err := e.Exec(query, args...)
if err != nil {
panic(err)
}
return res
}
NamedXXX
對(duì)于需要傳遞SQL參數(shù)的方法， sqlx都擴(kuò)展了命名參數(shù)的傳參方式。這讓我們可以在更高的抽象層次處理數(shù)據(jù)庫(kù)操作，而不必關(guān)心數(shù)據(jù)庫(kù)操作的細(xì)節(jié)。
這種方法的內(nèi)部會(huì)解析我們的SQL語(yǔ)句，然后從傳遞的struct、map或者slice中提取命名參數(shù)對(duì)應(yīng)的值，然后形成新的SQL語(yǔ)句和參數(shù)集合，再交給底層database/sql的方法去執(zhí)行。
這里摘抄一些代碼：
func NamedExec(e Ext, query string, arg interface{}) (sql.Result, error) {
q, args, err := bindNamedMapper(BindType(e.DriverName()), query, arg, mapperFor(e))
if err != nil {
return nil, err
}
return e.Exec(q, args...)
}
NamedExec 內(nèi)部調(diào)用了 bindNamedMapper，這個(gè)方法就是用于提取參數(shù)值的。其內(nèi)部分別對(duì)Map、Slice和Struct有不同的處理。
func bindNamedMapper(bindType int, query string, arg interface{}, m *reflectx.Mapper) (string, []interface{}, error) {
...
switch {
case k == reflect.Map && t.Key().Kind() == reflect.String:
...
return bindMap(bindType, query, m)
case k == reflect.Array || k == reflect.Slice:
return bindArray(bindType, query, arg, m)
default:
return bindStruct(bindType, query, arg, m)
}
}
以批量插入為例，我們的代碼是這樣寫的：
insertPersonArray := []Person{
{Name: "BOSIMA", City: "Wu Han", AddTime: time.Now(), UpdateTime: time.Now()},
{Name: "BOSSMA", City: "Xi An", AddTime: time.Now(), UpdateTime: time.Now()},
{Name: "BOMA", City: "Cheng Du", AddTime: time.Now(), UpdateTime: time.Now()},
}
insertPersonArrayResult, err := db.NamedExec("INSERT INTO Person (Name, City, AddTime, UpdateTime) VALUES(:Name, :City, :AddTime, :UpdateTime)", insertPersonArray)
經(jīng)過(guò)bindNamedMapper處理后SQL語(yǔ)句和參數(shù)是這樣的：
這里使用了反射，有些人可能會(huì)擔(dān)心性能的問(wèn)題，對(duì)于這個(gè)問(wèn)題的常見處理方式就是緩存起來(lái)，sqlx也是這樣做的。
XXXScan
這些Scan方法讓數(shù)據(jù)行到對(duì)象的映射更為方便，sqlx提供了StructScan、SliceScan和MapScan，看名字就可以知道它們映射的數(shù)據(jù)結(jié)構(gòu)。而且在這些映射能力的基礎(chǔ)上，sqlx提供了更為抽象的Get和Select方法。
這些Scan內(nèi)部還是調(diào)用了database/sql的Row.Scan方法。
以StructScan為例，其使用方法為：
queryPerson := &Person{}
err = row.StructScan(queryPerson)
經(jīng)過(guò)sqlx處理后，調(diào)用Row.Scan的參數(shù)是：
以上就是go第三方庫(kù)sqlx操作MySQL及ORM原理的詳細(xì)內(nèi)容，更多關(guān)于go sqlx操作MySQLORM的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
GO中?分組聲明與array,?slice,?map函數(shù)
這篇文章主要介紹了GO中?分組聲明與array,slice,map函數(shù)，Go語(yǔ)言中，同時(shí)聲明多個(gè)常量、變量，或者導(dǎo)入多個(gè)包時(shí)，可采用分組的方式進(jìn)行聲明，下面詳細(xì)介紹需要的小伙伴可以參考一下2022-03-03
這篇文章主要介紹了go mod 使用私有g(shù)itlab群組的解決方案，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-05-05
這篇文章主要為大家介紹了Go逃逸分析示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-08-08
這篇文章主要介紹了gin安裝及初始化，修改啟動(dòng)端口，get/post?請(qǐng)求參數(shù)，模型綁定shouldbind,自定義驗(yàn)證器/表單驗(yàn)證，等操作步驟，有需要的朋友可以借鑒參考下2022-04-04
這篇文章主要為大家詳細(xì)介紹的是 Go 語(yǔ)言中的 Slice 的常見陷阱以及如何避免這些錯(cuò)誤，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以學(xué)習(xí)一下2023-02-02
Golang動(dòng)態(tài)數(shù)組的實(shí)現(xiàn)示例
動(dòng)態(tài)數(shù)組能自動(dòng)調(diào)整大小,與靜態(tài)數(shù)組不同,其大小不固定,可根據(jù)需求變化,實(shí)現(xiàn)通常依賴于數(shù)據(jù)結(jié)構(gòu)如鏈表或數(shù)組加額外信息,本文就來(lái)介紹一下Golang動(dòng)態(tài)數(shù)組的實(shí)現(xiàn)示例,感興趣的可以了解一下2024-10-10
go允許定義多個(gè)init(),多個(gè)init()會(huì)涉及到執(zhí)行先后的問(wèn)題,本文將詳細(xì)講解Go中init()執(zhí)行順序，感興趣的朋友一起看看吧2022-09-09
go語(yǔ)言實(shí)現(xiàn)簡(jiǎn)易比特幣系統(tǒng)錢包的原理解析
這篇文章主要介紹了go語(yǔ)言實(shí)現(xiàn)簡(jiǎn)易比特幣系統(tǒng)錢包的原理解析,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-04-04
Golang?Gin解析JSON請(qǐng)求數(shù)據(jù)避免出現(xiàn)EOF錯(cuò)誤
這篇文章主要為大家介紹了Golang?Gin?優(yōu)雅地解析JSON請(qǐng)求數(shù)據(jù)，避免ShouldBindBodyWith出現(xiàn)EOF錯(cuò)誤的源碼分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-04-04
golang API開發(fā)過(guò)程的中的自動(dòng)重啟方式(基于gin框架)
這篇文章主要介紹了golang API開發(fā)過(guò)程的中的自動(dòng)重啟方式(基于gin框架),本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-12-12