gin | 青训营笔记
gorm-gen
概述
什么是gorm-gen
gorm-gen是基于 GORM, 更安全更友好的ORM工具，可生成model和curd代码
相比gorm有何优势
- 连接数据库的表生成相应的结构体model，再也不用手敲了，如果以后数据库有表的字段发生改动，只需重新生成即可
- 提供crud的API类似于mybatisplus，做crud更方便
- 有条件查询或更新时，表的列名不用写进字符串里，有列名改动不用手动去查找替换了
- 完全兼容GORM
- 对于零基础更容易上手
安装
arduino
复制代码
go get -u gorm.io/gen
使用
构建数据库测试表
sql
复制代码
CREATE TABLE `user`
(
`id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
`username` varchar(32) DEFAULT '' COMMENT '用户名',
`age` int unsigned NOT NULL COMMENT '年龄',
`password` varchar(128) DEFAULT '' COMMENT '密码',
`create_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
`phone` varchar(11) NOT NULL COMMENT '手机号码',
PRIMARY KEY (`id`),
UNIQUE KEY `uniqe_key_phone` (`phone`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4
COLLATE = utf8mb4_0900_ai_ci
insert into user (username, age, phone, password)
VALUES ('张无忌', 25 ,'13888888888', '123456'),
('周芷若', 18 ,'13999999999', '654321'),
('赵敏', 23 ,'15666666666', 'abcabc');
复制代码
构建生成代码
go
复制代码
const dsn = "root:123456@(localhost:3306)/test_gen?charset=utf8mb4&parseTime=True&loc=Local"
func main() {
// 连接数据库
db, err := gorm.Open(mysql.Open(dsn))
if err != nil {
panic(fmt.Errorf("cannot establish db connection: %w", err))
}
// 构造生成器实例
g := gen.NewGenerator(gen.Config{
// 相对执行`go run`时的路径, 会自动创建目录
OutPath: "./dao", //curd代码的输出路径
ModelPkgPath: "./model", //model代码的输出路径
// WithDefaultQuery 生成默认查询结构体(作为全局变量使用), 即`Q`结构体和其字段(各表模型)
// WithoutContext 生成没有context调用限制的代码供查询
// WithQueryInterface 生成interface形式的查询代码(可导出), 如`Where()`方法返回的就是一个可导出的接口类型
Mode: gen.WithDefaultQuery | gen.WithoutContext | gen.WithQueryInterface,
// 表字段可为 null 值时, 对应结体字段使用指针类型
FieldNullable: false, // generate pointer when field is nullable
// 表字段默认值与模型结构体字段零值不一致的字段, 在插入数据时需要赋值该字段值为零值的, 结构体字段须是指针类型才能成功, 即`FieldCoverable:true`配置下生成的结构体字段.
// 因为在插入时遇到字段为零值的会被GORM赋予默认值. 如字段`age`表默认值为10, 即使你显式设置为0最后也会被GORM设为10提交.
// 如果该字段没有上面提到的插入时赋零值的特殊需要, 则字段为非指针类型使用起来会比较方便.
FieldCoverable: false, // generate pointer when field has default value, to fix problem zero value cannot be assign: https://gorm.io/docs/create.html#Default-Values
// 模型结构体字段的数字类型的符号表示是否与表字段的一致, `false`指示都用有符号类型
FieldSignable: false, // detect integer field's unsigned type, adjust generated data type
// 生成 gorm 标签的字段索引属性
FieldWithIndexTag: false, // generate with gorm index tag
// 生成 gorm 标签的字段类型属性
FieldWithTypeTag: true, // generate with gorm column type tag
})
// 设置目标 db
g.UseDB(db)
// 自定义字段的数据类型
// 统一数字类型为int64,兼容protobuf和thrift
dataMap := map[string]func(detailType string) (dataType string){
"tinyint": func(detailType string) (dataType string) { return "int64" },
"smallint": func(detailType string) (dataType string) { return "int64" },
"mediumint": func(detailType string) (dataType string) { return "int64" },
"bigint": func(detailType string) (dataType string) { return "int64" },
"int": func(detailType string) (dataType string) { return "int64" },
}
// 要先于`ApplyBasic`执行
g.WithDataTypeMap(dataMap)
// 自定义模型结体字段的标签
// 将特定字段名的 json 标签加上`string`属性,即 MarshalJSON 时该字段由数字类型转成字符串类型
jsonField := gen.FieldJSONTagWithNS(func(columnName string) (tagContent string) {
toStringField := `id, `
if strings.Contains(toStringField, columnName) {
return columnName + ",string"
}
return columnName
})
// 将非默认字段名的字段定义为自动时间戳和软删除字段;
// 自动时间戳默认字段名为:`updated_at`、`created_at, 表字段数据类型为: INT 或 DATETIME
// 软删除默认字段名为:`deleted_at`, 表字段数据类型为: DATETIME
//autoUpdateTimeField := gen.FieldGORMTag("update_time", "column:update_time;type:int unsigned;autoUpdateTime")
//autoCreateTimeField := gen.FieldGORMTag("create_time", "column:create_time;type:int unsigned;autoCreateTime")
softDeleteField := gen.FieldType("delete_time", "gorm.DeletedAt")
// 模型自定义选项组
//fieldOpts := []gen.ModelOpt{jsonField, autoCreateTimeField, autoUpdateTimeField, softDeleteField}
fieldOpts := []gen.ModelOpt{jsonField, softDeleteField}
// 创建模型的结构体,生成文件在 model 目录; 先创建的结果会被后面创建的覆盖
// 这里创建个别模型仅仅是为了拿到`*generate.QueryStructMeta`类型对象用于后面的模型关联操作中
//User := g.GenerateModel("user")
// 创建全部模型文件, 并覆盖前面创建的同名模型
allModel := g.GenerateAllTable(fieldOpts...)
// 创建有关联关系的模型文件
// 可以用于指定外键
//Score := g.GenerateModel("score",
// append(
// fieldOpts,
// // user 一对多 address 关联, 外键`uid`在 address 表中
// gen.FieldRelate(field.HasMany, "user", User, &field.RelateConfig{GORMTag: "foreignKey:UID"}),
// )...,
//)
// 创建模型的方法,生成文件在 query 目录; 先创建结果不会被后创建的覆盖
//g.ApplyBasic(User)
g.ApplyBasic(allModel...)
g.Execute()
}
复制代码
运行，生成完代码结构是这样
连接初始化
最后一行是使用gen
go
复制代码
const dsn = "root:123456@(localhost:3306)/test_gen?charset=utf8mb4&parseTime=True&loc=Local"
func InitDB() {
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
// 配置日志
Logger: newLogger,
})
if err != nil {
panic(err)
}
dao.SetDefault(db)
}
复制代码
创建
创建记录
Create的形参为user的可变参数，可以传入一个或多个
go
复制代码
u := &model.User{
Username: "谢逊",
Age: 30,
Password: "qwer1234",
Phone: "12345678901",
}
err := dao.User.Create(u)
if err != nil {
fmt.Println(err)
}
复制代码
批量创建
css
复制代码
// 批量插入
users := []*model.User{
{
Username: "小昭",
Age: 16,
Password: "zzz369",
Phone: "14789632541",
},
{
Username: "韦一笑",
Age: 18,
Password: "wyx369",
Phone: "14789632542",
},
{
Username: "灭绝师太",
Age: 50,
Password: "mjs369",
Phone: "14789632543",
},
}
err := dao.User.CreateInBatches(users, 10)
if err != nil {
fmt.Println(err)
}
复制代码
更新
更新单字段
go
复制代码
u := dao.User
// Update with conditions
u.Where(u.ID.Eq(2)).Update(u.Age, 13))
// Update with conditions
u.Where(u.ID.Eq(2)).Update(u.Age, u.Age.Add(1))
// or
u.Where(u.ID.Eq(2)).UpdateSimple(u.Age.Add(1))
u.Where(u.ID.Eq(2))..UpdateSimple(u.Age.Zero())
复制代码
更新多字段
Updates 支持 struct 和 map[string]interface{}类型，更新多个字段，但是struct会忽略其中的零值属性
用法和上面一样
删除
go
复制代码
u := dao.User
u.Where(u.ID.Eq(10)).Delete()
复制代码
查询
根据id查询
go
复制代码
users, err := u.Where(u.ID.In(1,2,3)).Find()
复制代码
分页查询
会执行两条sql，一条查询分页数据，一条查询满足条件的总数
go
复制代码
u := dao.User
userList, count, err := u.Where(u.ID.Gt(2)).Order(u.Age.Desc()).FindByPage(2, 2)
if err != nil {
fmt.Println(err)
}
fmt.Println(userList, count)
复制代码
事物
函数里有err会自动回滚
go
复制代码
err := dao.Q.Transaction(func(tx *dao.Query) error {
return nil
})
复制代码
还有更多内容，以及更有意思的注解请看官方文档
——>Gen Guides
