go第三方庫sqlx操作MySQL及ORM原理
sqlx是Golang中的一個知名三方庫,其為Go標準庫database/sql提供了一組擴展支持。使用它可以方便的在數(shù)據(jù)行與Golang的結(jié)構(gòu)體、映射和切片之間進行轉(zhuǎn)換,從這個角度可以說它是一個ORM框架;它還封裝了一系列地常用SQL操作方法,讓我們用起來更爽。
sqlx實戰(zhàn)
這里以操作MySQL的增刪改查為例。
準備工作
先要準備一個MySQL,這里通過docker快速啟動一個MySQL 5.7。
docker run -d --name mysql1 -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7
在MySQL中創(chuàng)建一個名為test的數(shù)據(jù)庫:
CREATE DATABASE `test` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
數(shù)據(jù)庫中創(chuàng)建一個名為Person的數(shù)據(jù)庫表:
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)建一個Go項目,安裝sqlx:
go get github.com/jmoiron/sqlx
因為操作的是MySQL,還需要安裝MySQL的驅(qū)動:
go get github.com/go-sql-driver/mysql
編寫代碼
添加引用
添加sqlx和mysql驅(qū)動的引用:
import ( "log" _ "github.com/go-sql-driver/mysql" "github.com/jmoiron/sqlx" )
MySQL的驅(qū)動是隱式注冊的,并不會在接下來的程序中直接調(diào)用,所以這里加了下劃線。
創(chuàng)建連接
操作數(shù)據(jù)庫前需要先創(chuàng)建一個連接:
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ù)庫連接失敗") }
這個連接中指定了程序要用MySQL驅(qū)動,以及MySQL的連接地址、用戶名和密碼、數(shù)據(jù)庫名稱、字符編碼方式;這里還有兩個參數(shù)parseTime和loc,parseTime的作用是讓MySQL中時間類型的值可以映射到Golang中的time.Time類型,loc的作用是設(shè)置time.Time的值的時區(qū)為當前系統(tǒng)時區(qū),不使用這個參數(shù)的話保存到的數(shù)據(jù)庫的就是UTC時間,會和北京時間差8個小時。
增刪改查
sqlx擴展了DB和Tx,繼承了它們原有的方法,并擴展了一些方法,這里主要看下這些擴展的方法。
增加
通用占位符的方式:
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)
這個表的主鍵使用了自增的方式,可以通過返回值的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擴展的,這個方式就是常說的ORM。這里需要注意給struct字段添加上db標簽:
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ù)庫字段相同,只需要通過db標簽映射正確就行。注意SQL語句中使用的命名參數(shù)需要是db標簽中的名字。
除了可以映射struct,sqlx還支持map,請看下面這個示例:
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)
再來看看批增加的方式:
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ù)傳遞一個struct數(shù)組或者切片就可以了。這個執(zhí)行結(jié)果中也可以獲取到最后插入數(shù)據(jù)的自增Id,不過實測返回的是本次插入的第一條的Id,這個有點別扭,但是考慮到增加多條只獲取一個Id的場景似乎沒有,所以也不用多慮。
除了使用struct數(shù)組或切片,也可以使用map數(shù)組或切片,這里就不貼出來了,有興趣的可以去看文末給出的Demo鏈接。
刪除
刪除也可以使用通用占位符和命名參數(shù)的方式,并且會返回本次執(zhí)行受影響的行數(shù),某些情況下可以使用這個數(shù)字判斷SQL實際有沒有執(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對修改的支持和刪除差不多:
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對查詢的支持比較多。
使用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;特別的只查詢一個字段時,使用基本數(shù)據(jù)類型就可以了。
除了這些高層次的抽象方法,Sqlx也對更低層次的查詢方法進行了擴展:
查詢單行:
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,分別對應(yīng)映射后的不同數(shù)據(jù)結(jié)構(gòu)。
預(yù)處理語句
對于重復(fù)使用的SQL語句,可以采用預(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)
對于上文增刪改查的方法,sqlx都有相應(yīng)的擴展方法。與上文不同的是,需要先使用SQL模版創(chuàng)建一個stmt實例,然后執(zhí)行相關(guān)SQL操作時,不再需要傳遞SQL語句。
數(shù)據(jù)庫事務(wù)
為了在事務(wù)中執(zhí)行sqlx擴展的增刪改查方法,sqlx必然也對數(shù)據(jù)庫事務(wù)做一些必要的擴展支持。
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")
上面這段代碼就是一個簡單的sqlx數(shù)據(jù)庫事務(wù)示例,先通過db.Beginx開啟事務(wù),然后執(zhí)行SQL語句,最后提交事務(wù)。
如果想要更改默認的數(shù)據(jù)庫隔離級別,可以使用另一個擴展方法:
tx, err = db.BeginTxx(context.Background(), &sql.TxOptions{Isolation: sql.LevelRepeatableRead})
sqlx干了什么
通過上邊的實戰(zhàn),基本上就可以使用sqlx進行開發(fā)了。為了更好的使用sqlx,我們可以再了解下sqlx是怎么做到上邊這些擴展的。
Go的標準庫中沒有提供任何具體數(shù)據(jù)庫的驅(qū)動,只是通過database/sql庫定義了操作數(shù)據(jù)庫的通用接口。sqlx中也沒有包含具體數(shù)據(jù)庫的驅(qū)動,它只是封裝了常用SQL的操作方法,讓我們的SQL寫起來更爽。
MustXXX
sqlx提供兩個幾個MustXXX方法。
Must方法是為了簡化錯誤處理而出現(xiàn)的,當開發(fā)者確定SQL操作不會返回錯誤的時候就可以使用Must方法,但是如果真的出現(xiàn)了未知錯誤的時候,這個方法內(nèi)部會觸發(fā)panic,開發(fā)者需要有一個兜底的方案來處理這個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
對于需要傳遞SQL參數(shù)的方法, sqlx都擴展了命名參數(shù)的傳參方式。這讓我們可以在更高的抽象層次處理數(shù)據(jù)庫操作,而不必關(guān)心數(shù)據(jù)庫操作的細節(jié)。
這種方法的內(nèi)部會解析我們的SQL語句,然后從傳遞的struct、map或者slice中提取命名參數(shù)對應(yīng)的值,然后形成新的SQL語句和參數(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,這個方法就是用于提取參數(shù)值的。其內(nèi)部分別對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)過bindNamedMapper處理后SQL語句和參數(shù)是這樣的:
這里使用了反射,有些人可能會擔心性能的問題,對于這個問題的常見處理方式就是緩存起來,sqlx也是這樣做的。
XXXScan
這些Scan方法讓數(shù)據(jù)行到對象的映射更為方便,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)過sqlx處理后,調(diào)用Row.Scan的參數(shù)是:
以上就是go第三方庫sqlx操作MySQL及ORM原理的詳細內(nèi)容,更多關(guān)于go sqlx操作MySQLORM的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
golang多次讀取http request body的問題分析
這篇文章主要給大家分析了golang多次讀取http request body的問題,文中通過代碼示例和圖文介紹的非常詳細,對大家的學習或工作有一定的幫助,需要的朋友可以參考下2024-01-01Go?CSV包實現(xiàn)結(jié)構(gòu)體和csv內(nèi)容互轉(zhuǎn)工具詳解
這篇文章主要介紹了Go?CSV包實現(xiàn)結(jié)構(gòu)體和csv內(nèi)容互轉(zhuǎn)工具詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-03-03