本文介绍了 golang orm 库 xorm 的使用和项目结构。
xorm
- 官方介绍:xorm是一个简单而强大的Go语言ORM库。
- 通过它可以使数据库操作非常简便。xorm的目标并不是让你完全不去学习SQL,
- 我们认为SQL并不会为ORM所替代,但是ORM将可以解决绝大部分的简单SQL需求。
- xorm支持两种风格的混用。
xorm 还提供了工具,通过 reverse 命令根据数据库的表结构生成对应的 struct,省去了人工组织代码的工作,十分方便。官方地址:https://xorm.io/
安装
浏览 xorm 的 github 地址,我们要下载 2 个包,https://github.com/go-xorm
1、xorm 驱动包,我们使用 xorm 的核心包
2、cmd 工具包,用于使用 reverse 命令生成数据表对应的 struct
通过 go get 命令分别下载 2 个包go get github.com/go-xorm/xormgo get github.com/go-xorm/cmd/xorm下载完成后 github.com 文件夹下会出现 go-xorm 包
生成数据结构 struct
本地数据库 test 有 2 张数据表,doctor_tb 和 user_tb, 数据结构如下:
我们现在就来生成这 2 张数据表的结构模型。
1、在任意项目下新建一个文件夹 xorm_models,文件名没有规定,为了存放生成的代码文件。
2、拷贝 cmd 工具包中的摸板目录到 xorm_models 下,在文件目录github.com\go-xorm\cmd\xorm\templates\goxorm下
config 是生成的配置信息,struct.go.tpl 是数据摸板,允许自定义,可以根据自己的项目需求,修改摸板。一般不需要修改。
3、打开 cmd 命令行窗口,进入 xorm_models 目录下,执行 reverse 命令:xorm reverse [数据库类型] [数据库连接串] [模板目录]
- xormreversemysqlroot:112233@tcp(127.0.0.1:3305)/test?charset=utf8templates/goxorm
4、数据结构代码会自动生成在 xorm_models/models 目录下。
我们能看到生成了和表名同名的 2 个数据结构文件 doctor_tb.go 和 user_tb.go
- packagemodels
- import(
- "time"
- )
- typeDoctorTbstruct{
- Idint`xorm:"notnullpkautoincrINT(11)"`
- Namestring`xorm:"default''comment('姓名')VARCHAR(50)"`
- Ageint`xorm:"default0comment('年龄')INT(11)"`
- Sexint`xorm:"default0comment('性别')INT(11)"`
- Addtimetime.Time`xorm:"DATETIME"`
- }
使用 xorm
xorm 支持链式的写法engine.Where("age > ?", 40).Or("name like ?", "林%").OrderBy("Id desc").Find(&docList2)也支持直接执行 sql 语句engine.SQL("select * from doctor_tb where age > ?", 40).Find(&docList4)
附上增删改查事务的 demo 例子,代码里都有注释,很容易看懂。xorm 的封装比较友好,只要熟悉 sql 语句,即便不看文档,也能顺利的使用各种关键字。
- packagemain
- import(
- "fmt"
- _"github.com/go-sql-driver/mysql"
- "github.com/go-xorm/xorm"
- "goShare/xorm_models/models"
- "time"
- )
- funcmain(){
- varengine*xorm.Engine
- //连接数据库
- engine,err:=xorm.NewEngine("mysql","root:112233@tcp(127.0.0.1:3305)/test?charset=utf8")
- iferr!=nil{
- fmt.Println(err)
- return
- }
- //连接测试
- iferr:=engine.Ping();err!=nil{
- fmt.Println(err)
- return
- }
- deferengine.Close()//延迟关闭数据库
- fmt.Println("数据库链接成功")
- //查询单条数据
- vardocmodels.DoctorTb
- b,_:=engine.Where("name=?","钟南山").Get(&doc)
- ifb{
- fmt.Println(doc)
- }else{
- fmt.Println("数据不存在")
- }
- //查询单条数据方式2会根据结构体的
- doc2:=models.DoctorTb{Name:"钟南山"}
- b,_=engine.Get(&doc2)
- fmt.Println(doc2)
- //新增数据
- doc3:=models.DoctorTb{0,"王医生",48,1,time.Now()}
- i3,_:=engine.InsertOne(doc3)
- fmt.Println("新增结果:",i3)
- //查询列表
- docList:=make([]models.DoctorTb,0)
- engine.Where("age>?ornamelike?",40,"林%").Find(&docList)
- fmt.Println("docList:",docList)
- //查询列表方式2
- docList2:=make([]models.DoctorTb,0)
- engine.Where("age>?",40).Or("namelike?","林%").OrderBy("Iddesc").Find(&docList2)
- fmt.Println("docList2:",docList2)
- //查询分页
- docList3:=make([]models.DoctorTb,0)
- page:=0//页索引
- pageSize:=2//每页数据
- limit:=pageSize
- start:=page*pageSize
- totalCount,err:=engine.Where("age>?ornamelike?",40,"林%").Limit(limit,start).FindAndCount(&docList3)
- fmt.Println("总记录数:",totalCount,"docList3:",docList3)
- //直接用语句查询
- docList4:=make([]models.DoctorTb,0)
- engine.SQL("select*fromdoctor_tbwhereage>?",40).Find(&docList4)
- fmt.Println("docList4:",docList4)
- //删除
- docDel:=models.DoctorTb{Name:"王医生"}
- iDel,_:=engine.Delete(&docDel)
- fmt.Println("删除结果:",iDel)
- //删除方式2
- engine.Exec("deletefromdoctor_tbwhereId=?",3)
- //更新数据
- doc5:=models.DoctorTb{Name:"钟医生"}
- //更新数据ID为2的记录名字更改为“钟医生”
- iUpdate,_:=engine.Id(2).Update(&doc5)
- fmt.Println("更新结果:",iUpdate)
- //指定表名查询。Table()
- user:=models.UserTb{Id:2}
- b,_=engine.Table("user_tb").Get(&user)
- fmt.Println(user)
- //事务
- session:=engine.NewSession()
- defersession.Close()
- err=session.Begin()
- _,err=session.Exec("deletefromdoctor_tbwhereId=?",6)
- iferr!=nil{
- session.Rollback()
- return
- }
- _,err=session.Exec("deletefromuser_tbwhereId=?",10)
- iferr!=nil{
- session.Rollback()
- return
- }
- err=session.Commit()
- iferr!=nil{
- return
- }
- fmt.Println("事务执行成功")
- }
总结
归纳下使用流程:
1、下载 xorm 包和 cmd 工具包
2、复制 cmd 工具包里的模板代码文件夹至生成目录底下
3、使用 reverse 生成数据结构代码,省去苦力活
4、实例引擎xorm.NewEngine()
5、痛快的调用
demo 里提供了我们开发业务上常用的增,删,改,查单条数据,查列表,查分页,事务等内容。如果文章对你有用,请点个赞。
原文链接:https://mp.weixin.qq.com/s/Zz_x9j18-l1dcqRvxuJWww