GEN 主动生成 GORM 模型构造体文件及应用示例
背景
GEN 是一个基于 GORM 的平安 ORM 框架, 由字节跳动无恒实验室与 GORM 作者联结研发，次要性能说白了就是帮忙生成数据表对应的模型文件和更平安不便地执行 SQL。
间接应用 GORM 与 GEN 工具的比照：
间接应用 GORM 应用 GEN 需手动创立与数据表各列一一对应的构造体 指定表名后主动读取并生成对应构造体 需手动实现具体的 go 代码查问逻辑 形容 SQL 查问逻辑即可，工具主动转换成平安稳固的代码 查问接口非常灵便，但不能放弃查问的 SQL 不产生语法错误，
只能通过测试保障局部场景的失常运行查问接口应用类型平安，编译可通过，查问逻辑即是失常正当的 需人工评教训保障业务不存在平安问题，
一旦出错往往在上线前能力发现，影响上线流程提供的安全可靠的查问 API，开发时能用的就是平安的
本文指标
GEN 提供的性能是弱小而丰盛的，本文相当一个上手指引只挑些常见操作进行示例阐明：
- 表字段的整型类型无论大小和有无符号，构造体中对立应用 int64（为了简化后续应用时的操作）。
- 个别构造体字段 json 序列化时由数字类型转成字符串类型，如：余额字段
balance在表中是 DECIMAL 类型，构造体中是 int64，业务须要的 json 字段类型为字符串。 - 应用非默认字段名实现自动更新、创立工夫戳和软删除。
- 模型关联
示例环境：
- go 1.18
- gen v0.3.16 留神: 以后 GEN 的最新版主版本是 0, 也就是 API 在将来可能会有较大的变更, 应用时务必留神版本变更问题
- MySQL 8.0
指标表有 3 个, 别离是 user、address和 hobby，user与 address是一对多关系，如下所示:
CREATE TABLE IF NOT EXISTS `user` (
`id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'ID',
`name` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT ''COMMENT' 用户名 ',
`age` tinyint unsigned NOT NULL DEFAULT '0' COMMENT '年龄',
`balance` decimal(11,2) unsigned NOT NULL DEFAULT '0.00' COMMENT '余额',
`updated_at` datetime NOT NULL COMMENT '更新工夫',
`created_at` datetime NOT NULL COMMENT '创立工夫',
`deleted_at` datetime DEFAULT NULL COMMENT '删除工夫',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
CREATE TABLE IF NOT EXISTS `address` (
`id` int unsigned NOT NULL AUTO_INCREMENT,
`uid` int unsigned NOT NULL,
`province` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '',
`city` varchar(20) COLLATE utf8mb4_general_ci NOT NULL DEFAULT '',
`update_time` int unsigned NOT NULL,
`create_time` int unsigned NOT NULL,
`delete_time` int unsigned NOT NULL DEFAULT '0',
PRIMARY KEY (`id`) USING BTREE,
KEY `uid` (`uid`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci ROW_FORMAT=DYNAMIC;
CREATE TABLE IF NOT EXISTS `hobby` (
`id` int unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT '',
`updated_at` int unsigned NOT NULL,
`created_at` int unsigned NOT NULL,
`deleted_at` int unsigned NOT NULL DEFAULT '0',
PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci ROW_FORMAT=DYNAMIC;
配置 GEN 并生成模型构造体
创立并初始化我的项目, 再引入 GEN 包
mkdir gormgendemo && cd gormgendemo
go mod init
go get -u gorm.io/gen@v0.3.16持续创立用于生成模型文件的 ./cmd/generate/main.go文件和用于执行 SQL 示例的 ./main.go文件，目录如下所示：
├── cmd
│ └── generate
│ └── main.go
├── go.mod
├── go.sum
└── main.go./cmd/generate/main.go代码：
package main
import (
"fmt"
"strings"
"gorm.io/driver/mysql"
"gorm.io/gen"
"gorm.io/gen/field"
"gorm.io/gorm"
)
const MySQLDSN = "root:123456@(localhost:3306)/gormgendemo?charset=utf8mb4&parseTime=True&loc=Local"
func main() {
// 连贯数据库
db, err := gorm.Open(mysql.Open(MySQLDSN))
if err != nil {panic(fmt.Errorf("cannot establish db connection: %w", err))
}
// 生成实例
g := gen.NewGenerator(gen.Config{
// 绝对执行 `go run` 时的门路, 会主动创立目录
OutPath: "dal/query",
// WithDefaultQuery 生成默认查问构造体(作为全局变量应用), 即 `Q` 构造体和其字段(各表模型)
// WithoutContext 生成没有 context 调用限度的代码供查问
// WithQueryInterface 生成 interface 模式的查问代码(可导出), 如 `Where()` 办法返回的就是一个可导出的接口类型
Mode: gen.WithDefaultQuery | gen.WithQueryInterface,
// 表字段可为 null 值时, 对应结体字段应用指针类型
FieldNullable: true, // 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
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 := `balance, `
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", "soft_delete.DeletedAt")
// 模型自定义选项组
fieldOpts := []gen.ModelOpt{jsonField, autoCreateTimeField, autoUpdateTimeField, softDeleteField}
// 创立模型的构造体, 生成文件在 model 目录; 先创立的后果会被前面创立的笼罩
// 这里创立个别模型仅仅是为了拿到 `*generate.QueryStructMeta` 类型对象用于前面的模型关联操作中
Address := g.GenerateModel("address")
// 创立全副模型文件, 并笼罩后面创立的同名模型
allModel := g.GenerateAllTable(fieldOpts...)
// 创立有关联关系的模型文件
User := g.GenerateModel("user",
append(
fieldOpts,
// user 一对多 address 关联, 外键 `uid` 在 address 表中
gen.FieldRelate(field.HasMany, "Address", Address, &field.RelateConfig{GORMTag: "foreignKey:UID"}),
)...,
)
Address = g.GenerateModel("address",
append(
fieldOpts,
gen.FieldRelate(field.BelongsTo, "User", User, &field.RelateConfig{GORMTag: "foreignKey:UID"}),
)...,
)
// 创立模型的办法, 生成文件在 query 目录; 先创立后果不会被后创立的笼罩
g.ApplyBasic(User, Address)
g.ApplyBasic(allModel...)
g.Execute()}
执行生成程序:
go mod tidy
go run ./cmd/generate/main.go后果目录:
.
├── cmd
│ └── generate
│ └── main.go
├── dal
│ ├── model
│ │ ├── address.gen.go
│ │ ├── hobby.gen.go
│ │ └── user.gen.go
│ └── query
│ ├── address.gen.go
│ ├── gen.go
│ ├── hobby.gen.go
│ └── user.gen.go
├── go.mod
├── go.sum
└── main.go生成的模型构造体:
// User mapped from table <user>
type User struct {
ID int64 `gorm:"column:id;type:int unsigned;primaryKey;autoIncrement:true" json:"id"` // ID
Name string `gorm:"column:name;type:varchar(20);not null" json:"name"` // 用户名
Age int64 `gorm:"column:age;type:tinyint unsigned;not null" json:"age"` // 年龄
Balance float64 `gorm:"column:balance;type:decimal(11,2) unsigned;not null;default:0.00" json:"balance,string"` // 余额
UpdatedAt time.Time `gorm:"column:updated_at;type:datetime;not null" json:"updated_at"` // 更新工夫
CreatedAt time.Time `gorm:"column:created_at;type:datetime;not null" json:"created_at"` // 创立工夫
DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;type:datetime" json:"deleted_at"` // 删除工夫
Address []Address `gorm:"foreignKey:UID" json:"address"`}
// Address mapped from table <address>
type Address struct {
ID int64 `gorm:"column:id;type:int unsigned;primaryKey;autoIncrement:true" json:"id"`
UID int64 `gorm:"column:uid;type:int unsigned;not null" json:"uid"`
Province string `gorm:"column:province;type:varchar(20);not null" json:"province"`
City string `gorm:"column:city;type:varchar(20);not null" json:"city"`
UpdateTime int64 `gorm:"column:update_time;type:int unsigned;autoUpdateTime" json:"update_time"`
CreateTime int64 `gorm:"column:create_time;type:int unsigned;autoCreateTime" json:"create_time"`
DeleteTime soft_delete.DeletedAt `gorm:"column:delete_time;type:int unsigned;not null" json:"delete_time"`
User User `gorm:"foreignKey:UID" json:"user"`
}
// Hobby mapped from table <hobby>
type Hobby struct {
ID int64 `gorm:"column:id;type:int unsigned;primaryKey;autoIncrement:true" json:"id"`
Name string `gorm:"column:name;type:varchar(20);not null" json:"name"`
UpdatedAt int64 `gorm:"column:updated_at;type:int unsigned;not null" json:"updated_at"`
CreatedAt int64 `gorm:"column:created_at;type:int unsigned;not null" json:"created_at"`
DeletedAt int64 `gorm:"column:deleted_at;type:int unsigned;not null" json:"deleted_at"`
}下面 3 个模型都实现了更新、创立字段的主动工夫戳性能，后面 2 个实现了软删除性能，表字段的整型类型都以 int64 示意。
应用 GEN 进行数据库操作
./main.go代码：
package main
import (
"context"
"fmt"
"log"
"gormgendemo/dal/model"
"gormgendemo/dal/query"
"gorm.io/driver/mysql"
"gorm.io/gorm"
)
const MySQLDSN = "root:123456@(localhost:3306)/gormgendemo?charset=utf8mb4&parseTime=True&loc=Local"
func main() {
// 连贯数据库
db, err := gorm.Open(mysql.Open(MySQLDSN))
if err != nil {panic(fmt.Errorf("cannot establish db connection: %w", err))
}
query.SetDefault(db)
q := query.Q
ctx := context.Background()
//qc := q.WithContext(ctx)
// 增
insert(ctx, q)
// 删
del(ctx, q)
// 改
update(ctx, q)
// 查
find(ctx, q)
fmt.Println("Done!")
}
func insert(ctx context.Context, q *query.Query) {qc := q.WithContext(ctx)
// 插入数据
users := []*model.User{
{
Name: "张三",
Age: 30,
Address: []model.Address{{Province: "广东", City: "广州"},
{Province: "广东", City: "深圳"},
},
},
{
Name: "李四",
Age: 40,
Address: []model.Address{{Province: "广东", City: "广州"},
{Province: "广东", City: "深圳"},
},
},
{
Name: "王五",
Age: 50,
},
}
hobby := []*model.Hobby{{Name: "看电影"}, {Name: "看书"}, {Name: "跑步"},
}
err := qc.User.Create(users...)
if err != nil {log.Fatal(err)
}
err = qc.Hobby.Create(hobby...)
if err != nil {log.Fatal(err)
}
}
func del(ctx context.Context, q *query.Query) {qc := q.WithContext(ctx)
qc.User.Where(q.User.Name.Eq("张三")).Delete() // 软删
qc.Address.Where(q.Address.City.Eq("深圳")).Delete() // 软删
qc.Hobby.Where(q.Hobby.Name.Eq("看电影")).Delete() // 非软删}
func update(ctx context.Context, q *query.Query) {qc := q.WithContext(ctx)
qc.User.Where(q.User.Name.Eq("李四")).UpdateSimple(q.User.Age.Add(1))
}
func find(ctx context.Context, q *query.Query) {qc := q.WithContext(ctx)
// First、Take、Last 办法, 如果没有找到记录则返回谬误 ErrRecordNotFound。_, err := qc.User.Preload(q.User.Address).Where(q.User.Name.Eq("张三")).First()
if err != nil {fmt.Printf("%+v \n", err)
//record not found
}
user, err := qc.User.Preload(q.User.Address).Where(q.User.Name.Eq("李四")).First()
if err == nil {fmt.Printf("%+v \n", *user)
//{ID:2 Name: 李四 Age:41 Balance:0 UpdatedAt:2022-09-16 15:13:39 +0800 CST CreatedAt:2022-09-16 15:13:39 +0800 CST
//DeletedAt:{Time:0001-01-01 00:00:00 +0000 UTC Valid:false}
//Address:[{ID:3 UID:2rovince: 广东 City: 广州 UpdateTime:1663312418 CreateTime:1663312418 DeleteTime:0
//User:{ID:0 Name: Age:0 Balance:0 UpdatedAt:0001-01-01 00:00:00 +0000 UTC CreatedAt:0001-01-01 00:00:00 +0000 UTC
//CreatedAt:{Time:0001-01-01 00:00:00 +0000 UTC Valid:false} Address:[]}}]}
}
addr, err := qc.Address.Preload(q.Address.User).Offset(1).First()
if err == nil {fmt.Printf("%+v \n", *addr)
//{ID:3 UID:2 Province: 广东 City: 广州 UpdateTime:1663312418 CreateTime:1663312418 DeleteTime:0
//User:{ID:2 Name: 李四 Age:41 Balance:0 UpdatedAt:2022-09-16 15:13:39 +0800 CST CreatedAt:2022-09-16 39 +0800 CST
//DeletedAt:{Time:0001-01-01 00:00:00 +0000 UTC Valid:false} Address:[]}}
}
_, err = qc.Hobby.Where(q.Hobby.Name.Eq("看电影")).First()
if err != nil {fmt.Printf("%+v \n", err)
//record not found
}
hb, err := qc.Hobby.Where(q.Hobby.Name.Eq("看书")).First()
if err == nil {fmt.Printf("%+v \n", *hb)
//{ID:2 Name: 看书 UpdatedAt:1663312418 CreatedAt:1663312418 DeletedAt:0}
}
}
执行应用程序能够看到成果
go run main.go结语
示例的相干代码已上传 github 仓库，有须要的能够自取。如果文章中有什么错漏或改善的中央也欢送给我留言交换。
下面示例仅作抛砖引玉之用，更多应用办法还得参考官网文档和源码。
最初在这里对 GORM 和 GEN 的开发者们给咱们带来了这么好用的工具表示感谢！
参考
GORM/GEN 中文文档
无恒实验室联结 GORM 推出平安好用的 ORM 框架 -GEN