gobatis是一个golang的ORM框架,类似Java的Mybatis。支持直接执行sql语句以及动态sql。
建议配合gobatis-cmd自动代码、sql生成工具使用。
支持的动态sql标签:
标签 | 说明 |
---|---|
if | 动态 SQL 通常要做的事情是根据条件包含 where 子句的一部分。 |
where | where 元素只会在至少有一个子元素的条件返回 SQL 子句的情况下才去插入“WHERE”子句。而且,若语句的开头为“AND”或“OR”,where 元素也会将它们去除。 |
set | set 元素会动态前置 SET 关键字,同时也会删掉无关的逗号。 |
include | 使用sql标签定义的语句替换。 |
choose when otherwise |
有时我们不想应用到所有的条件语句,而只想从中择其一项。针对这种情况,gobatis 提供了 choose 元素,它有点像switch 语句。 |
foreach | foreach 允许指定一个集合,声明可以在元素体内使用的集合项(item)和索引(index)变量。 |
除了xml之外,gobatis也支持使用go template的mapper格式。
- 继续完善动态sql支持(trim)
性能优化:增加动态sql缓存(已经实现,但测试发现性能提升很小,目前该功能被关闭)
func InitDB() *gobatis.SessionManager {
fac := gobatis.NewFactory(
gobatis.SetMaxConn(100),
gobatis.SetMaxIdleConn(50),
gobatis.SetDataSource(&datasource.MysqlDataSource{
Host: "localhost",
Port: 3306,
DBName: "test",
Username: "root",
Password: "123",
Charset: "utf8",
}))
return gobatis.NewSessionManager(&fac)
}
注意:
gobatis.NewFactory当连接数据库失败时会返回nil,如果需要知道具体的失败原因请使用:
fac, err := gobatis.CreateFactory(
gobatis.SetMaxConn(100),
gobatis.SetMaxIdleConn(50),
gobatis.SetDataSource(&datasource.MysqlDataSource{
Host: "localhost",
Port: 3306,
DBName: "test",
Username: "root",
Password: "123",
Charset: "utf8",
}))
if err != nil {
t.Log(err)
}
使用tag("yfield")定义struct,tag指定数据库表中的column name。
type TestTable struct {
//指定table name
TestTable gobatis.ModelName "test_table"
//指定表字段id
Id int64 `yfield:"id"`
//指定表字段username
Username string `yfield:"username"`
//指定表字段password
Password string `yfield:"password"`
}
作用是提高执行速度,已变为非必要步骤,现在gobatis会自动缓存。
func init() {
var model TestTable
gobatis.RegisterModel(&model)
}
func Run() {
//初始化db并获得Session Manager
mgr := InitDB()
//获得session
session := mgr.NewSession()
ret := TestTable{}
//使用session查询
session.Select("select * from test_table where id = ${0}").Param(100).Result(&ret)
fmt.printf("%v\n", ret)
}
内置动态解析是gobatis类Mybatis的解析方案(目前是xml mapper文件和直接执行sql的默认解析方式):
- ${}表示直接替换,#{}防止sql注入
- 与Mybatis类似,语句中${0}、${1}、${2}...${n} 对应的是Param方法中对应的不定参数,最终替换和调用底层Driver
- Param方法接受简单类型的不定参数(string、int、time、float等)、struct、map,底层自动解析获得参数,用法为:
param := TestTable{Username:"test_user"}
ret := TestTable{}
session.Select("select * from test_table where username = #{TestTable.username}").Param(param).Result(&ret)
- Param解析的参数规则(请务必按此规则对应SQL语句的占位参数):
-
简单类型
对应sql参数中的#{0}、#{1}...
-
map类型
对应sql参数中的#{key1}、#{key2}...
-
struct类型
对应sql参数中的#{StructName.Field1}、#{StructName.Field2}...
使用go template解析,遵循template解析规则,是template mapper文件的解析方式。
如要要修改直接执行sql的默认解析方式,可通过:
sessionManager.SetParserFactory(gobatis.TemplateParserFactory)
或者
session.SetParserFactory(gobatis.TemplateParserFactory)
调用后可使用template的方式直接解析执行sql:
session.Select("SELECT * FROM test_table WHERE id = {{.}}").Param(2).Result(&ret)
gobatis内置where、set、arg自定义函数,用于智能生成动态sql
arg用于将对象动态转换为占位符,并保存为sql参数,如:
SELECT * FROM TABLE_NAME WHERE name = {{arg .Name}}
以mysql为例,将解析为:
SELECT * FROM TABLE_NAME WHERE name = ?
同时Name的值将自动保存为SQL参数,自动传入,起到类似内置动态解析中#{MODEL.Name}的效果。
使用
mgr.NewSession().Tx(func(session *gobatis.Session) error {
ret := 0
session.Insert("insert_id").Param(testV).Result(&ret)
t.Logf("ret %d\n", ret)
session.Select("select_id").Param().Result(&testList)
for _, v := range testList {
t.Logf("data: %v", v)
}
//commit
return nil
})
- 当参数的func返回nil,则提交
- 当参数的func返回非nil的错误,则回滚
- 当参数的func内抛出panic,则回滚
err := gobatis.ScanMapperFile(${MAPPER_FILE_DIR})
if err != nil {
t.Fatal(err)
}
gobatis支持xml的sql解析及动态sql
- 直接注册xml
gobatis.RegisterMapperData([]byte(main_xml))
或
gobatis.RegisterMapperFile(filePath)
- xml示例
<mapper namespace="test">
<sql id="columns_id">id,username,password,createtime</sql>
<select id="selectTestTable">
SELECT <include refid="columns_id"> </include> FROM test_table
<where>
<if test="{TestTable.id} != nil and {TestTable.id} != 0">AND id = #{TestTable.id} </if>
<if test="{TestTable.username} != nil">AND username = #{TestTable.username} </if>
<if test="{TestTable.password} != nil">AND password = #{TestTable.password} </if>
<if test="{TestTable.createtime} != nil">AND createtime = #{TestTable.createtime} </if>
</where>
</select>
<select id="selectTestTableCount">
SELECT COUNT(*) FROM test_table
<where>
<if test="{TestTable.id} != nil and {TestTable.id} != 0">AND id = #{TestTable.id} </if>
<if test="{TestTable.username} != nil">AND username = #{TestTable.username} </if>
<if test="{TestTable.password} != nil">AND password = #{TestTable.password} </if>
<if test="{TestTable.createtime} != nil">AND createtime = #{TestTable.createtime} </if>
</where>
</select>
<insert id="insertTestTable">
INSERT INTO test_table (id,username,password,createtime)
VALUES(
#{TestTable.id},
#{TestTable.username},
#{TestTable.password},
#{TestTable.createtime}
)
</insert>
<insert id="insertBatchTestTable">
INSERT INTO test_table (id,username,password,createtime)
VALUES
<foreach item="item" index="index" collection="{0}" open="" separator="," close="">
(#{item.TestTable.id},#{item.TestTable.username},#{item.TestTable.password},#{item.TestTable.createtime})
</foreach>
</insert>
<update id="updateTestTable">
UPDATE test_table
<set>
<if test="{TestTable.username} != nil"> username = #{TestTable.username} </if>
<if test="{TestTable.password} != nil"> password = #{TestTable.password} </if>
<if test="{TestTable.createtime} != nil"> createtime = #{TestTable.createtime} </if>
</set>
WHERE id = #{TestTable.id}
</update>
<delete id="deleteTestTable">
DELETE FROM test_table
<where>
<if test="{TestTable.id} != nil and {TestTable.id} != 0">AND id = #{TestTable.id} </if>
<if test="{TestTable.username} != nil">AND username = #{TestTable.username} </if>
<if test="{TestTable.password} != nil">AND password = #{TestTable.password} </if>
<if test="{TestTable.createtime} != nil">AND createtime = #{TestTable.createtime} </if>
</where>
</delete>
</mapper>
- namespace
xml数据或文件注册之后,session参数sqlid与xml action对应关系为:${NAMESPACE}+"."+${ACTION_ID}
以2中的xml为例,调用select的方式为:
sess.Select("test.selectTestTable").Param(model).Result(&dataList)
gobatis也支持go template的sql解析及动态sql
- 直接注册template
gobatis.RegisterTemplateData([]byte(main_xml))
或
gobatis.RegisterTemplateFile(filePath)
- template示例
{{define "namespace"}}test{{end}}
{{define "selectTestTable"}}
SELECT id,username,password,createtime FROM test_table
{{where .Id "AND" "id = " (arg .Id) "" | where .Username "AND" "username = " (arg .Username) | where .Password "AND" "password = " (arg .Password) | where .Createtime "AND" "createtime = " (arg .Createtime)}}
{{end}}
{{define "selectTestTableCount"}}
SELECT COUNT(*) FROM test_table
{{where .Id "AND" "id = " (arg .Id) "" | where .Username "AND" "username = " (arg .Username) | where .Password "AND" "password = " (arg .Password) | where .Createtime "AND" "createtime = " (arg .Createtime)}}
{{end}}
{{define "insertTestTable"}}
INSERT INTO test_table(id,username,password,createtime)
VALUES(
{{arg .Id}}, {{arg .Username}}, {{arg .Password}}, {{arg .Createtime}})
{{end}}
{{define "insertBatchTestTable"}}
{{$size := len . | add -1}}
INSERT INTO test_table(id,username,password,createtime)
VALUES {{range $i, $v := .}}
({{arg $v.Id}}, {{arg $v.Username}}, {{arg $v.Password}}, {{arg $v.Createtime}}){{if lt $i $size}},{{end}}
{{end}}
{{end}}
{{define "updateTestTable"}}
UPDATE test_table
{{set .Id "id = " (arg .Id) "" | set .Username "username = " (arg .Username) | set .Password "password = " (arg .Password) | set .Createtime "createtime = " (arg .Createtime)}}
{{where .Id "AND" "id = " (arg .Id) ""}}
{{end}}
{{define "deleteTestTable"}}
DELETE FROM test_table
{{where .Id "AND" "id = " (arg .Id) "" | where .Username "AND" "username = " (arg .Username) | where .Password "AND" "password = " (arg .Password) | where .Createtime "AND" "createtime = " (arg .Createtime)}}
{{end}}
- namespace
template数据或文件可定义一个名称为namespace的子模版,用以定义namespace。
template数据或文件注册之后,session参数sql id与模板对应关系为:${NAMESPACE}+"."+${ACTION_ID}
以2中的template为例,调用select的方式为:
sess.Select("test.selectTestTable").Param(model).Result(&dataList)
参考cmd_test
gobatis xml特性有非常强大的动态SQL生成方案,当需要在代码中嵌入SQL语句时,也可使用SQL语句构建器:
import "github.com/xfali/gobatis/builder"
str := builder.Select("A.test1", "B.test2").
Select("B.test3").
From("test_a AS A").
From("test_b AS B").
Where("id = 1").
And().
Where("name=2").
GroupBy("name").
OrderBy("name").
Desc().
Limit(5, 10).
String()
t.Log(str)
使用pagehelper: gobatis的配套分页工具
go get github.com/xfali/pagehelper
使用xml mapper文件会出现大于号“ > ”、小于号“ < ”号解析的问题,gobatis使用CDATA规避此问题。
<![CDATA[ > ]]>
<![CDATA[ < ]]>
使用LIKE CONCAT('%',#{field},'%')
举例:
SELECT <include refid="columns_id"> </include> FROM `TEST_TABLE`
<where>
<if test="{TestTable.username} != nil">AND `username` LIKE CONCAT('%',#{TestTable.username},'%') </if>
</where>