從此篇文章開始,我們來陸續介紹
go-zero
開發一個專案所需要的元件和開發實踐。
首先我們從 model
層開始,來說說go-zero
的API以及封裝細節。首先 model
層連線的API集中在core/stores
。我們先來看看操作 mysql
這類資料庫,API方法我們來到 core/stores/sqlx
,所以接下來用幾篇的文章總體介紹一下 sqlx
的使用和設計思想。
快速使用
func main() {
// 1
const datasource = "user:password@/dbname"
mysqlDB := sqlx.NewMysql(datasource)
// 2
um := model.NewUserModel(mysqlDB,"User")
// 3
ul := logic.NewUserLogic(um)
// 4
engine.AddRoutes(nginxApi(ul))
engine.Start()
}
// NewUserModel,NewUserLogic 類似
func NewUserModel(conn sqlx.SqlConn, table string) *UserModel {
return &UserModel{conn: conn, table: table}
}
// nginxApi將logic注入到handle,同時繫結路由和handler
func nginxApi(ul *logic.UserLogic) []rest.Route {
return []rest.Route{
{
Method: http.MethodGet,
Path: "/user/:id", // /user/54er6;
Handler: handler.NewUserHandler(ul).GetUserById,
}
}
總結一下:
NewMysql
建立資料庫連線- 建立相應的
model
,並將連線傳入「相應的NewModel
需要開發者編寫」 model
是為上一層logic
提供服務- 將
logic
注入到handler
中,同時handler
與路由繫結,開啟Server
這樣 model-logic-handler
最簡單的結構就出來了。然後來看看在 model
層如何進行資料操作:
var userBuilderQueryRows = strings.Join(builderx.FieldNames(&User{}), ",")
type User struct {
Avatar string `db:"avatar"` // 頭像
UserName string `db:"user_name"` // 姓名
Sex int `db:"sex"` // 1男,2女
MobilePhone string `db:"mobile_phone"` // 手機號
}
func (um *UserModel) Insert(user *User) (int64, error) {
const insertsql = `insert into `+um.table+` (`+userBuilderQueryRows+`) values(?, ?, ?)`
// insert「delete使用方式一致」
res, err := um.conn.Exec(insertsql, user.Avatar, user.UserName, user.Sex, user.MobilePhone)
if err != nil {
logx.Errorf("insert User Position Model Model err, err=%v", err)
return -1, err
}
id, err := res.LastInsertId()
if err != nil {
logx.Errorf("insert User Model to Id parse id err,err=%v", err)
return -1, err
}
return id, nil
}
func (um *UserModel) FindOne(uid int64) (*User, error) {
var user User
// query
const querysql = `select `+userBuilderQueryRows+` from `+um.table+` where id=? limit 1`
err := um.conn.QueryRow(&user, querysql, uid)
if err != nil {
logx.Errorf("userModile.findOne error ,id=%d,err=%s", uid, err.Error())
if err == sqlx.ErrNotFound {
return nil, ErrNotFound
}
return nil, err
}
return &user, nil
}
insert/update/delete
:conn.Exec(insertsql/updatesql/deletesql, args...)
query
:conn.QueryRow(&model, querysql, args...)
上述就是最簡單的 crud
的結構:首先是構建 model
,然後操作 model
進行操作。
程式碼結構
檔名 | 作用 |
---|---|
bulkinserter.go | 批量插入 |
mysql.go | NewMysql |
orm.go | 解析,序列化model 的操作 |
sqlconn.go | 抽象crud 操作的介面 |
tx.go | 事務操作 |
從 sqlconn.go
的相互介面關係:
可以看出:commonSqlConn
和 txSession
是真正實現的地方。先從 API
的功能整體介紹一下:
API | 引數 | 作用 |
---|---|---|
Exec(query, args...) | sql, sql引數 | insert/update/delete |
Prepare(query) | sql | 預編譯sql |
QueryRow(&model, query, args...) | model, sql, sql引數 | 查詢一行資料同時賦值給「model」 |
QueryRowPartial(&model, query, args...) | model, sql, sql引數 | 功能同上,但是select sql可以只選取model的部分column「映襯Partial」 |
QueryRows/QueryRowsPartial | 同上 | 查詢多行API |
Transact(func(session Session) error) | 事務操作 | 將引數中的操作用事務包裹,開發者只需專注引數中的函式編寫 |
總結
go-zero
的 sqlx
遮蔽了go原生的sql操作,開發者只需關注sql編寫和業務封裝的資料物件,不需要像原生開發中需要手動prepare,賦值資料時Scan。
本節只是簡略介紹了介面的相互關係以及開發者平時關注的API,下節將著重分析go-zero是怎麼幫你賦值資料,同時在併發大的情況下,如何不讓流量直接把你的資料庫打死。
參考
歡迎大家使用 go-zero
專案地址:https://github.com/tal-tech/go-zero
如果覺得文章不錯,歡迎 github 點個 star ?