zormGo 轻量 ORM
Go轻量ORM，零依赖，支持达梦(dm)、金仓(kingbase) 、神通(shentong) 、南通(gbase)、TDengine、mysql、postgresql、oracle、mssql、sqlite、db2 、clickhouse...
源码: https://gitee.com/chunanyong/zorm
官网: https://zorm.cn
测试用例: https://gitee.com/wuxiangege/zorm-examples/
- 基于原生sql语句编写,学习成本更低.
- 代码生成器
- 代码精简,主体3000行,零依赖5000行,注释详细,方便定制修改.
- 支持事务传播,这是zorm诞生的主要原因
- 支持mysql,postgresql,oracle,mssql,sqlite,db2,dm(达梦),kingbase(人大金仓),shentong(神通),gbase(南通),TDengine,clickhouse
- 支持多库和读写分离
- 不支持联合主键,变通认为无主键,业务控制实现(艰难取舍)
- 支持seata,hptx,dbpack分布式事务,支持全局事务托管,不修改业务代码,零侵入分布式事务
- 支持clickhouse,更新,删除语句使用SQL92标准语法
支持国产数据库
达梦(dm)
配置zorm.DataSourceConfig的 DriverName:dm ,Dialect:dm
达梦数据库驱动: gitee.com/chunanyong/dm
达梦的text类型会映射为dm.DmClob,string不能接收,需要实现zorm.CustomDriverValueConver接口,自定义扩展处理
import (
// 00.引入数据库驱动
"gitee.com/chunanyong/dm"
"io"
)
// CustomDMText 实现ICustomDriverValueConver接口,扩展自定义类型,例如 达梦数据库TEXT类型,映射出来的是dm.DmClob类型,无法使用string类型直接接收
type CustomDMText struct{}
// GetDriverValue 根据数据库列类型,返回driver.Value的实例,struct属性类型
// map接收或者字段不存在,无法获取到structFieldType,会传入nil
func (dmtext CustomDMText) GetDriverValue(ctx context.Context, columnType *sql.ColumnType, structFieldType *reflect.Type) (driver.Value, error) {
// 如果需要使用structFieldType,需要先判断是否为nil
// if structFieldType != nil {
// }
return &dm.DmClob{}, nil
}
// ConverDriverValue 数据库列类型,GetDriverValue返回的driver.Value的临时接收值,struct属性类型
// map接收或者字段不存在,无法获取到structFieldType,会传入nil
// 返回符合接收类型值的指针,指针,指针!!!!
func (dmtext CustomDMText) ConverDriverValue(ctx context.Context, columnType *sql.ColumnType, tempDriverValue driver.Value, structFieldType *reflect.Type) (interface{}, error) {
// 如果需要使用structFieldType,需要先判断是否为nil
// if structFieldType != nil {
// }
// 类型转换
dmClob, isok := tempDriverValue.(*dm.DmClob)
if !isok {
return tempDriverValue, errors.New("->ConverDriverValue-->转换至*dm.DmClob类型失败")
}
if dmClob == nil || !dmClob.Valid {
return new(string), nil
}
// 获取长度
dmlen, errLength := dmClob.GetLength()
if errLength != nil {
return dmClob, errLength
}
// int64转成int类型
strInt64 := strconv.FormatInt(dmlen, 10)
dmlenInt, errAtoi := strconv.Atoi(strInt64)
if errAtoi != nil {
return dmClob, errAtoi
}
// 读取字符串
str, errReadString := dmClob.ReadString(1, dmlenInt)
// 处理空字符串或NULL造成的EOF错误
if errReadString == io.EOF {
return new(string), nil
}
return &str, errReadString
}
// RegisterCustomDriverValueConver 注册自定义的字段处理逻辑,用于驱动无法直接转换的场景,例如达梦的 TEXT 无法直接转化成 string
// 一般是放到init方法里进行注册
func init() {
// dialectColumnType 值是 Dialect.字段类型 ,例如 dm.TEXT
zorm.RegisterCustomDriverValueConver("dm.TEXT", CustomDMText{})
}金仓(kingbase)
配置zorm.DataSourceConfig的 DriverName:kingbase ,Dialect:kingbase
金仓驱动说明: https://help.kingbase.com.cn/doc-view-8108.html
金仓kingbase 8核心是基于postgresql 9.6,可以使用 https://github.com/lib/pq 进行测试,生产环境建议使用官方驱动.
注意修改 data/kingbase.conf中 ora_input_emptystr_isnull = false,因为golang没有null值,一般数据库都是not null,golang的string默认是'',如果这个设置为true,数据库就会把值设置为null,和字段属性not null 冲突,因此报错.
神通(shentong)
建议使用官方驱动,配置zorm.DataSourceConfig的 DriverName:aci ,Dialect:shentong
南通(gbase)
暂时还未找到官方golang驱动,配置zorm.DataSourceConfig的 DriverName:gbase ,Dialect:gbase
暂时先使用odbc驱动,DriverName:odbc ,Dialect:gbase
TDengine
- 因TDengine驱动不支持事务,需要设置
DisableTransaction=true - 配置zorm.DataSourceConfig的
DriverName:taosSql或者taosRestful, Dialect:tdengine - zorm.DataSourceConfig的
TDengineInsertsColumnNameTDengine批量insert语句中是否有列名.默认false没有列名,插入值和数据库列顺序保持一致,减少语句长度 - 测试用例: https://www.yuque.com/u27016943/nrgi00/dnru3f
- TDengine已收录: https://github.com/taosdata/awesome-tdengine/#orm
数据库脚本和实体类
生成实体类或手动编写,建议使用代码生成器 https://gitee.com/zhou-a-xing/zorm-generate-struct
package testzorm
import (
"time"
"gitee.com/chunanyong/zorm"
)
// 建表语句
/*
DROP TABLE IF EXISTS `t_demo`;
CREATE TABLE `t_demo` (
`id` varchar(50) NOT NULL COMMENT '主键',
`userName` varchar(30) NOT NULL COMMENT '姓名',
`password` varchar(50) NOT NULL COMMENT '密码',
`createTime` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP(0),
`active` int COMMENT '是否有效(0否,1是)',
PRIMARY KEY (`id`)
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COMMENT = '例子' ;
*/
// demoStructTableName 表名常量,方便直接调用
const demoStructTableName = "t_demo"
// demoStruct 例子
type demoStruct struct {
// 引入默认的struct,隔离IEntityStruct的方法改动
zorm.EntityStruct
// Id 主键
Id string `column:"id"`
// UserName 姓名
UserName string `column:"userName"`
// Password 密码
Password string `column:"password"`
// CreateTime <no value>
CreateTime time.Time `column:"createTime"`
// Active 是否有效(0否,1是)
// Active int `column:"active"`
// ------------------数据库字段结束,自定义字段写在下面---------------//
// 如果查询的字段在column tag中没有找到,就会根据名称(不区分大小写,支持 _ 下划线转驼峰)映射到struct的属性上
// 模拟自定义的字段Active
Active int
}
// GetTableName 获取表名称
// IEntityStruct 接口的方法,实体类需要实现!!!
func (entity *demoStruct) GetTableName() string {
return demoStructTableName
}
// GetPKColumnName 获取数据库表的主键字段名称.因为要兼容Map,只能是数据库的字段名称
// 不支持联合主键,变通认为无主键,业务控制实现(艰难取舍)
// 如果没有主键,也需要实现这个方法, return "" 即可
// IEntityStruct 接口的方法,实体类需要实现!!!
func (entity *demoStruct) GetPKColumnName() string {
// 如果没有主键
// return ""
return "id"
}
// GetDefaultValue 获取列的默认值Map,用于Insert和Update Struct对象,返回map的key是Struct属性名,value是默认值,value可以是nil.不能是类型的默认值,比如int类型设置默认值为0
// BindContextDefaultValue 优先级高于 GetDefaultValue
//func (entity *EntityStruct) GetDefaultValue() map[string]interface{} {
// return map[string]interface{}{"CreateTime": time.Now(),"Active":nil}
//}
// newDemoStruct 创建一个默认对象
func newDemoStruct() demoStruct {
demo := demoStruct{
// 如果Id=="",保存时zorm会调用zorm.FuncGenerateStringID(ctx),默认时间戳+随机数,也可以自己定义实现方式,例如 zorm.FuncGenerateStringID=funcmyId
Id: zorm.FuncGenerateStringID(ctx),
UserName: "defaultUserName",
Password: "defaultPassword",
Active: 1,
CreateTime: time.Now(),
}
return demo
}
测试用例即文档
测试用例: https://gitee.com/wuxiangege/zorm-examples
// testzorm 使用原生的sql语句,没有对sql语法做限制.语句使用Finder作为载体
// 占位符统一使用?,zorm会根据数据库类型,自动替换占位符,例如postgresql数据库把?替换成$1,$2...
// zorm使用 ctx context.Context 参数实现事务传播,ctx从web层传递进来即可,例如gin的c.Request.Context()
// zorm的事务操作需要显式使用zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {})开启
package testzorm
import (
"context"
"fmt"
"testing"
"time"
"gitee.com/chunanyong/zorm"
// 00.引入数据库驱动
_ "github.com/go-sql-driver/mysql"
)
// dbDao 代表一个数据库,如果有多个数据库,就对应声明多个DBDao
var dbDao *zorm.DBDao
// 01.初始化DBDao
func init() {
// 自定义zorm日志输出
// zorm.LogCallDepth = 4 // 日志调用的层级
// zorm.FuncLogError = myFuncLogError // 记录异常日志的函数
// zorm.FuncLogPanic = myFuncLogPanic // 记录panic日志,默认使用defaultLogError实现
// zorm.FuncPrintSQL = myFuncPrintSQL // 打印sql的函数
// 自定义日志输出格式,把FuncPrintSQL函数重新赋值
// log.SetFlags(log.LstdFlags)
// zorm.FuncPrintSQL = zorm.FuncPrintSQL
// 自定义主键生成
// zorm.FuncGenerateStringID=funcmyId
// 自定义Tag列名
// zorm.FuncWrapFieldTagName=funcmyTagName
// 自定义decimal类型实现,例如github.com/shopspring/decimal
// zorm.FuncDecimalValue=funcmyDecimal
// Go数据库驱动列表:https://github.com/golang/go/wiki/SQLDrivers
// dbDaoConfig 数据库的配置.这里只是模拟,生产应该是读取配置配置文件,构造DataSourceConfig
dbDaoConfig := zorm.DataSourceConfig{
// DSN 数据库的连接字符串,parseTime=true会自动转换为time格式,默认查询出来的是[]byte数组.&loc=Local用于设置时区
DSN: "root:root@tcp(127.0.0.1:3306)/zorm?charset=utf8&parseTime=true&loc=Local",
// DriverName 数据库驱动名称:mysql,postgres,oracle(go-ora),sqlserver,sqlite3,go_ibm_db,clickhouse,dm,kingbase,aci,taosSql|taosRestful 和Dialect对应
// sql.Open(DriverName,DSN) DriverName就是驱动的sql.Open第一个字符串参数,根据驱动实际情况获取
DriverName: "mysql",
// Dialect 数据库方言:mysql,postgresql,oracle,mssql,sqlite,db2,clickhouse,dm,kingbase,shentong,tdengine 和 DriverName 对应
Dialect: "mysql",
// MaxOpenConns 数据库最大连接数 默认50
MaxOpenConns: 50,
// MaxIdleConns 数据库最大空闲连接数 默认50
MaxIdleConns: 50,
// ConnMaxLifetimeSecond 连接存活秒时间. 默认600(10分钟)后连接被销毁重建.避免数据库主动断开连接,造成死连接.MySQL默认wait_timeout 28800秒(8小时)
ConnMaxLifetimeSecond: 600,
// SlowSQLMillis 慢sql的时间阈值,单位毫秒.小于0是禁用SQL语句输出;等于0是只输出SQL语句,不计算执行时间;大于0是计算SQL执行时间,并且>=SlowSQLMillis值
SlowSQLMillis: 0,
// DefaultTxOptions 事务隔离级别的默认配置,默认为nil
// DefaultTxOptions: nil,
// 如果是使用分布式事务,建议使用默认配置
// DefaultTxOptions: &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false},
// FuncGlobalTransaction seata/hptx全局分布式事务的适配函数,返回IGlobalTransaction接口的实现
// 业务必须调用 ctx,_=zorm.BindContextEnableGlobalTransaction(ctx) 开启全局分布事务
// FuncGlobalTransaction : MyFuncGlobalTransaction,
// SQLDB 使用现有的数据库连接,优先级高于DSN
// SQLDB : nil,
// DisableTransaction 禁用事务,默认false,如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务,为了处理某些数据库不支持事务,比如TDengine
// 禁用事务应该有驱动伪造事务API,不应该有orm实现,clickhouse的驱动就是这样做的
// DisableTransaction :false,
// TDengineInsertsColumnName TDengine批量insert语句中是否有列名.默认false没有列名,插入值和数据库列顺序保持一致,减少语句长度
// TDengineInsertsColumnName :false,
}
// 根据dbDaoConfig创建dbDao, 一个数据库只执行一次,第一个执行的数据库为 defaultDao,后续zorm.xxx方法,默认使用的就是defaultDao
dbDao, _ = zorm.NewDBDao(&dbDaoConfig)
}
// TestInsert 02.测试保存Struct对象
func TestInsert(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
// 创建一个demo对象
demo := newDemoStruct()
// 保存对象,参数是对象指针.如果主键是自增,会赋值到对象的主键属性
_, err := zorm.Insert(ctx, &demo)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
// 标记测试失败
if err != nil {
t.Errorf("错误:%v", err)
}
}
// TestInsertSlice 03.测试批量保存Struct对象的Slice
// 如果是自增主键,无法对Struct对象里的主键属性赋值
func TestInsertSlice(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
// slice存放的类型是zorm.IEntityStruct!!!使用IEntityStruct接口,兼容Struct实体类
demoSlice := make([]zorm.IEntityStruct, 0)
// 创建对象1
demo1 := newDemoStruct()
demo1.UserName = "demo1"
// 创建对象2
demo2 := newDemoStruct()
demo2.UserName = "demo2"
demoSlice = append(demoSlice, &demo1, &demo2)
// 批量保存对象,如果主键是自增,无法保存自增的ID到对象里.
_, err := zorm.InsertSlice(ctx, demoSlice)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
// 标记测试失败
if err != nil {
t.Errorf("错误:%v", err)
}
}
// TestInsertEntityMap 04.测试保存EntityMap对象,用于不方便使用struct的场景,使用Map作为载体
func TestInsertEntityMap(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
// 创建一个EntityMap,需要传入表名
entityMap := zorm.NewEntityMap(demoStructTableName)
// 设置主键名称
entityMap.PkColumnName = "id"
// 如果是自增序列,设置序列的值
// entityMap.PkSequence = "mySequence"
// Set 设置数据库的字段值
// 如果主键是自增或者序列,不要entityMap.Set主键的值
entityMap.Set("id", zorm.FuncGenerateStringID(ctx))
entityMap.Set("userName", "entityMap-userName")
entityMap.Set("password", "entityMap-password")
entityMap.Set("createTime", time.Now())
entityMap.Set("active", 1)
// 执行
_, err := zorm.InsertEntityMap(ctx, entityMap)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
// 标记测试失败
if err != nil {
t.Errorf("错误:%v", err)
}
}
// TestInsertEntityMapSlice 05.测试批量保存[]IEntityMap,用于不方便使用struct的场景,使用Map作为载体
func TestInsertEntityMapSlice(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
_, err := Transaction(ctx, func(ctx context.Context) (interface{}, error) {
entityMapSlice := make([]IEntityMap, 0)
entityMap1 := NewEntityMap(demoStructTableName)
entityMap1.PkColumnName = "id"
entityMap1.Set("id", zorm.FuncGenerateStringID(ctx))
entityMap1.Set("userName", "entityMap-userName1")
entityMap1.Set("password", "entityMap-password1")
entityMap1.Set("createTime", time.Now())
entityMap1.Set("active", 1)
entityMap2 := NewEntityMap(demoStructTableName)
entityMap2.PkColumnName = "id"
entityMap2.Set("id", zorm.FuncGenerateStringID(ctx))
entityMap2.Set("userName", "entityMap-userName2")
entityMap2.Set("password", "entityMap-password2")
entityMap2.Set("createTime", time.Now())
entityMap2.Set("active", 2)
entityMapSlice = append(entityMapSlice, entityMap1 ,entityMap2)
// 执行
_, err := zorm.InsertEntityMapSlice(ctx, entityMapSlice)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
// 标记测试失败
if err != nil {
t.Errorf("错误:%v", err)
}
}
// TestQueryRow 06.测试查询一个struct对象
func TestQueryRow(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 声明一个对象的指针,用于承载返回的数据
demo := demoStruct{}
// 构造查询用的finder
// finder := zorm.NewSelectFinder(demoStructTableName) // select * from t_demo
// finder := zorm.NewSelectFinder(demoStructTableName, "id,userName") // select id,userName from t_demo
finder := zorm.NewFinder().Append("SELECT * FROM " + demoStructTableName) // select * from t_demo
// finder默认启用了sql注入检查,禁止语句中拼接 ' 单引号,可以设置 finder.InjectionCheck = false 解开限制
// finder.Append 第一个参数是语句,后面的参数是对应的值,值的顺序要正确.语句统一使用?,zorm会处理数据库的差异
// in (?) 参数必须有()括号,不能 in ?
finder.Append("WHERE id=? and active in(?)", "20210630163227149563000042432429", []int{0, 1})
// 如何使用like
// finder.Append("WHERE id like ? ", "20210630163227149563000042432429%")
// 执行查询,has为true表示数据库有数据
has, err := zorm.QueryRow(ctx, finder, &demo)
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
// 打印结果
fmt.Println(demo)
}
// TestQueryRowMap 07.测试查询map接收结果,用于不太适合struct的场景,比较灵活
func TestQueryRowMap(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 构造查询用的finder
// finder := zorm.NewSelectFinder(demoStructTableName) // select * from t_demo
finder := zorm.NewFinder().Append("SELECT * FROM " + demoStructTableName) // select * from t_demo
// finder.Append 第一个参数是语句,后面的参数是对应的值,值的顺序要正确.语句统一使用?,zorm会处理数据库的差异
// in (?) 参数必须有()括号,不能 in ?
finder.Append("WHERE id=? and active in(?)", "20210630163227149563000042432429", []int{0, 1})
// 执行查询
resultMap, err := zorm.QueryRowMap(ctx, finder)
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
// 打印结果
fmt.Println(resultMap)
}
// TestQuery 08.测试查询对象列表
func TestQuery(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 创建用于接收结果的slice
list := make([]demoStruct, 0)
// 构造查询用的finder
// finder := zorm.NewSelectFinder(demoStructTableName) // select * from t_demo
finder := zorm.NewFinder().Append("SELECT id FROM " + demoStructTableName) // select * from t_demo
// 创建分页对象,查询完成后,page对象可以直接给前端分页组件使用
page := zorm.NewPage()
page.PageNo = 1 // 查询第1页,默认是1
page.PageSize = 20 // 每页20条,默认是20
// 不查询总条数
// finder.SelectTotalCount = false
// 如果是特别复杂的语句,造成count语句构造失败,可以手动指定count语句
// countFinder := zorm.NewFinder().Append("select count(*) from (")
// countFinder.AppendFinder(finder)
// countFinder.Append(") tempcountfinder")
// finder.CountFinder = countFinder
// 执行查询
err := zorm.Query(ctx, finder, &list, page)
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
// 打印结果
fmt.Println("总条数:", page.TotalCount, " 列表:", list)
}
// TestQueryMap 09.测试查询map列表,用于不方便使用struct的场景,一条记录是一个map对象
func TestQueryMap(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 构造查询用的finder
// finder := zorm.NewSelectFinder(demoStructTableName) // select * from t_demo
finder := zorm.NewFinder().Append("SELECT * FROM " + demoStructTableName) // select * from t_demo
// 创建分页对象,查询完成后,page对象可以直接给前端分页组件使用
page := zorm.NewPage()
page.PageNo = 1 // 查询第1页,默认是1
page.PageSize = 20 // 每页20条,默认是20
// 不查询总条数
// finder.SelectTotalCount = false
// 如果是特别复杂的语句,造成count语句构造失败,可以手动指定count语句
// countFinder := zorm.NewFinder().Append("select count(*) from (")
// countFinder.AppendFinder(finder)
// countFinder.Append(") tempcountfinder")
// finder.CountFinder = countFinder
// 执行查询
listMap, err := zorm.QueryMap(ctx, finder, page)
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
// 打印结果
fmt.Println("总条数:", page.TotalCount, " 列表:", listMap)
}
// TestUpdateNotZeroValue 10.更新struct对象,只更新不为零值的字段.主键必须有值
func TestUpdateNotZeroValue(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
// 声明一个对象的指针,用于更新数据
demo := demoStruct{}
demo.Id = "20210630163227149563000042432429"
demo.UserName = "UpdateNotZeroValue"
// 指定必须更新的数据库字段,只对UpdateNotZeroValue方法有效.cols是数据库列名切片
// ctx里bind的值zorm不会清空,使用时不要覆盖原始的ctx或者不要传给多个UpdateNotZeroValue方法.
// newCtx, _ := zorm.BindContextMustUpdateCols(ctx, []string{"active"})
// _, err := zorm.UpdateNotZeroValue(newCtx, &demo)
// 更新 "sql":"UPDATE t_demo SET userName=? WHERE id=?","args":["UpdateNotZeroValue","20210630163227149563000042432429"]
_, err := zorm.UpdateNotZeroValue(ctx, &demo)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
}
// TestUpdate 11.更新struct对象,更新所有字段.主键必须有值
func TestUpdate(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// BindContextOnlyUpdateCols 指定仅更新的数据库字段,只对Update方法有效.cols是数据库列名切片
// ctx里bind的值zorm不会清空,使用时不要覆盖原始的ctx或者不要传给多个Update方法.
// ctx, _ = zorm.BindContextOnlyUpdateCols(ctx, []string{"userName", "active"})
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
// 声明一个对象的指针,用于更新数据
demo := demoStruct{}
demo.Id = "20210630163227149563000042432429"
demo.UserName = "TestUpdate"
_, err := zorm.Update(ctx, &demo)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
}
// TestUpdateFinder 12.通过finder更新,zorm最灵活的方式,可以编写任何更新语句,甚至手动编写insert语句
func TestUpdateFinder(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
// finder := zorm.NewUpdateFinder(demoStructTableName) // UPDATE t_demo SET
// finder := zorm.NewDeleteFinder(demoStructTableName) // DELETE FROM t_demo
finder := zorm.NewFinder().Append("UPDATE").Append(demoStructTableName).Append("SET") // UPDATE t_demo SET
finder.Append("userName=?,active=?", "TestUpdateFinder", 1).Append("WHERE id=?", "20210630163227149563000042432429")
// 更新 "sql":"UPDATE t_demo SET userName=?,active=? WHERE id=?","args":["TestUpdateFinder",1,"20210630163227149563000042432429"]
_, err := zorm.UpdateFinder(ctx, finder)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
}
// TestUpdateEntityMap 13.更新一个EntityMap,主键必须有值
func TestUpdateEntityMap(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
// 创建一个EntityMap,需要传入表名
entityMap := zorm.NewEntityMap(demoStructTableName)
// 设置主键名称
entityMap.PkColumnName = "id"
// Set 设置数据库的字段值,主键必须有值
entityMap.Set("id", "20210630163227149563000042432429")
entityMap.Set("userName", "TestUpdateEntityMap")
// 更新 "sql":"UPDATE t_demo SET userName=? WHERE id=?","args":["TestUpdateEntityMap","20210630163227149563000042432429"]
_, err := zorm.UpdateEntityMap(ctx, entityMap)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
}
// TestDelete 14.删除一个struct对象,主键必须有值
func TestDelete(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 需要手动开启事务,匿名函数返回的error如果不是nil,事务就会回滚.如果设置了DisableTransaction=true,Transaction方法失效,不再要求有事务
// 如果zorm.DataSourceConfig.DefaultTxOptions配置不满足需求,可以在zorm.Transaction事务方法前设置事务的隔离级别
// 例如 ctx, _ := dbDao.BindContextTxOptions(ctx, &sql.TxOptions{Isolation: sql.LevelDefault, ReadOnly: false}),如果txOptions为nil,使用zorm.DataSourceConfig.DefaultTxOptions
_, err := zorm.Transaction(ctx, func(ctx context.Context) (interface{}, error) {
demo := demoStruct{}
demo.Id = "20210630163227149563000042432429"
// 删除 "sql":"DELETE FROM t_demo WHERE id=?","args":["20210630163227149563000042432429"]
_, err := zorm.Delete(ctx, &demo)
// 如果返回的err不是nil,事务就会回滚
return nil, err
})
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
}
// TestProc 15.测试调用存储过程
func TestProc(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
demo := demoStruct{}
finder := zorm.NewFinder().Append("call testproc(?) ", "u_10001")
zorm.QueryRow(ctx, finder, &demo)
fmt.Println(demo)
}
// TestFunc 16.测试调用自定义函数
func TestFunc(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
userName := ""
finder := zorm.NewFinder().Append("select testfunc(?) ", "u_10001")
zorm.QueryRow(ctx, finder, &userName)
fmt.Println(userName)
}
// TestOther 17.其他的一些说明.非常感谢您能看到这一行
func TestOther(t *testing.T) {
// ctx 一般一个请求一个ctx,正常应该有web层传入,例如gin的c.Request.Context().这里只是模拟
var ctx = context.Background()
// 场景1.多个数据库.通过对应数据库的dbDao,调用BindContextDBConnection函数,把这个数据库的连接绑定到返回的ctx上,然后把ctx传递到zorm的函数即可
// 也可以重写FuncReadWriteStrategy函数,通过ctx设置不同的key,返回指定数据库的DBDao
newCtx, err := dbDao.BindContextDBConnection(ctx)
if err != nil { // 标记测试失败
t.Errorf("错误:%v", err)
}
finder := zorm.NewFinder().Append("SELECT * FROM " + demoStructTableName) // select * from t_demo
// 把新产生的newCtx传递到zorm的函数
list, _ := zorm.QueryMap(newCtx, finder, nil)
fmt.Println(list)
// 场景2.单个数据库的读写分离.设置读写分离的策略函数.
zorm.FuncReadWriteStrategy = myReadWriteStrategy
// 场景3.如果是多个数据库,每个数据库还读写分离,按照 场景1 处理.
// 也可以重写FuncReadWriteStrategy函数,通过ctx设置不同的key,返回指定数据库的DBDao
}
// myReadWriteStrategy 数据库的读写分离的策略 rwType=0 read,rwType=1 write
// 也可以通过ctx设置不同的key,返回指定数据库的DBDao
func myReadWriteStrategy(ctx context.Context, rwType int) (*zorm.DBDao, error) {
// 根据自己的业务场景,返回需要的读写dao,每次需要数据库的连接的时候,会调用这个函数
// if rwType == 0 {
// return dbReadDao
// }
// return dbWriteDao
return DbDao, nil
}
// --------------------------------------------
// ICustomDriverValueConver接口,参见达梦的例子
// --------------------------------------------
// OverrideFunc 重写ZORM的函数,当你使用这个函数时,你必须知道自己在做什么
//oldInsertFunc 默认的Insert实现
var oldInsertFunc func(ctx context.Context, entity IEntityStruct) (int, error)
//newInsertFunc 新的Insert实现
var newInsertFunc = func(ctx context.Context, entity IEntityStruct) (int, error) {
fmt.Println("Insert前")
i, err := oldInsertFunc(ctx, entity)
fmt.Println("Insert后")
return i, err
}
// 在init函数中注册覆盖老的函数
func init() {
ok, oldFunc, err := zorm.OverrideFunc("Insert", newInsertFunc)
if ok && err == nil {
oldInsertFunc = oldFunc.(func(ctx context.Context, entity IEntityStruct) (int, error))
}
}评论