从此篇文章开始,我们来陆续介绍
go-zero开发一个项目所需要的组件和开发实践。
首先我们从 model 层开始,来说说go-zero 的API以及封装细节。首先 model 层连接的API集中在core/stores。我们先来看看操作 mysql 这类数据库,API方法我们来到 core/stores/sqlx,所以接下来用几篇的文章总体介绍一下 sqlx 的使用和设计思想。
快速使用
1func main() { 2 // 1 3 const datasource = "user:password@/dbname" 4 mysqlDB := sqlx.NewMysql(datasource) 5 // 2 6 um := model.NewUserModel(mysqlDB,"User") 7 // 3 8 ul := logic.NewUserLogic(um) 9 // 4 10 engine.AddRoutes(nginxApi(ul)) 11 engine.Start() 12} 13 14// NewUserModel,NewUserLogic 类似 15func NewUserModel(conn sqlx.SqlConn, table string) *UserModel { 16 return &UserModel{conn: conn, table: table} 17} 18 19// nginxApi将logic注入到handle,同时绑定路由和handler 20func nginxApi(ul *logic.UserLogic) []rest.Route { 21 return []rest.Route{ 22 { 23 Method: http.MethodGet, 24 Path: "/user/:id", // /user/54er6; 25 Handler: handler.NewUserHandler(ul).GetUserById, 26 } 27}
总结一下:
NewMysql创建数据库连接- 创建相应的
model,并将连接传入「相应的NewModel需要开发者编写」 model是为上一层logic提供服务- 将
logic注入到handler中,同时handler与路由绑定,开启Server
这样 model-logic-handler 最简单的结构就出来了。然后来看看在 model 层如何进行数据操作:
1var userBuilderQueryRows = strings.Join(builderx.FieldNames(&User{}), ",") 2 3type User struct { 4 Avatar string `db:"avatar"` // 头像 5 UserName string `db:"user_name"` // 姓名 6 Sex int `db:"sex"` // 1男,2女 7 MobilePhone string `db:"mobile_phone"` // 手机号 8} 9 10func (um *UserModel) Insert(user *User) (int64, error) { 11 const insertsql = `insert into `+um.table+` (`+userBuilderQueryRows+`) values(?, ?, ?)` 12 // insert「delete使用方式一致」 13 res, err := um.conn.Exec(insertsql, user.Avatar, user.UserName, user.Sex, user.MobilePhone) 14 if err != nil { 15 logx.Errorf("insert User Position Model Model err, err=%v", err) 16 return -1, err 17 } 18 id, err := res.LastInsertId() 19 if err != nil { 20 logx.Errorf("insert User Model to Id parse id err,err=%v", err) 21 return -1, err 22 } 23 return id, nil 24} 25 26func (um *UserModel) FindOne(uid int64) (*User, error) { 27 var user User 28 // query 29 const querysql = `select `+userBuilderQueryRows+` from `+um.table+` where id=? limit 1` 30 err := um.conn.QueryRow(&user, querysql, uid) 31 if err != nil { 32 logx.Errorf("userModile.findOne error ,id=%d,err=%s", uid, err.Error()) 33 if err == sqlx.ErrNotFound { 34 return nil, ErrNotFound 35 } 36 return nil, err 37 } 38 return &user, nil 39}
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
https://gitee.com/kevwan/go-zero
如果觉得文章不错,欢迎 github 点个 star 🤝