Gorm + Gen自动生成数据库结构体

使用gORM操作数据库的时候，需要自己来创建用于映射数据表的结构体，比较繁琐。现在Gorm官方提供了一个可以自动生成数据库结构体的工具：Gen。

这个工具不仅仅可以用来生成数据表对应的模型文件，还提供了更加安全以及方便的api。

安装

# 安装Gorm和Mysql驱动go get -u gorm.io/gormgo get -u gorm.io/driver/mysql# 安装Gengo get -u gorm.io/gen

创建数据表

我们在mysql中创建两个数据表来试试效果：

user表：

score表：

生成model

使用Gen提供的gen.NewGenerator函数就可以生成对应的model，当然不仅仅会生成结构体，还可以生成一些用于查询的API，如果不需要，删除即可。

import ("fmt""gorm.io/driver/mysql""gorm.io/gen""gorm.io/gorm""strings""testing")const MysqlConfig = "root:123456@(localhost:3306)/gen_test?charset=utf8mb4&parseTime=True&loc=Local"func TestGEN(t *testing.T) {// 连接数据库db, err := gorm.Open(mysql.Open(MysqlConfig))if err != nil {panic(fmt.Errorf("cannot establish db connection: %w", err))}// 生成实例g := gen.NewGenerator(gen.Config{// 相对执行`go run`时的路径, 会自动创建目录OutPath: "./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})// 设置目标 dbg.UseDB(db)// 自定义字段的数据类型// 统一数字类型为int64,兼容protobufdataMap := 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`, 表字段数据类型为: DATETIMEautoUpdateTimeField := 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`类型对象用于后面的模型关联操作中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()}

运行效果

运行上面的测试文件之后，生成了两个文件夹，其中model文件夹下面是数据表对应的结构体，query文件夹下面则是生成的查询函数。

user结构体：

// Code generated by gorm.io/gen. DO NOT EDIT.// Code generated by gorm.io/gen. DO NOT EDIT.// Code generated by gorm.io/gen. DO NOT EDIT.package modelimport ("time""gorm.io/gorm")const TableNameUser = "user"// User mapped from table type User struct {ID        int64          `gorm:"column:id;type:int;primaryKey;autoIncrement:true" json:"id"`Name      string         `gorm:"column:name;type:varchar(255);not null" json:"name"`Age       int64          `gorm:"column:age;type:tinyint;not null" json:"age"`CreatedAt time.Time      `gorm:"column:created_at;type:datetime;not null" json:"created_at"`UpdatedAt time.Time      `gorm:"column:updated_at;type:datetime;not null" json:"updated_at"`DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;type:datetime;not null" json:"deleted_at"`}// TableName User's table namefunc (*User) TableName() string {return TableNameUser}

score结构体：

// Code generated by gorm.io/gen. DO NOT EDIT.// Code generated by gorm.io/gen. DO NOT EDIT.// Code generated by gorm.io/gen. DO NOT EDIT.package modelimport ("time""gorm.io/gorm")const TableNameScore = "score"// Score mapped from table type Score struct {Sno       int64          `gorm:"column:sno;type:int;primaryKey" json:"sno"`Score     float32        `gorm:"column:score;type:float;not null" json:"score"`Cname     string         `gorm:"column:cname;type:varchar(255);not null" json:"cname"`CreatedAt time.Time      `gorm:"column:created_at;type:datetime;not null" json:"created_at"`UpdatedAt time.Time      `gorm:"column:updated_at;type:datetime;not null" json:"updated_at"`DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;type:datetime;not null" json:"deleted_at"`}// TableName Score's table namefunc (*Score) TableName() string {return TableNameScore}

参考文章：https://blog.csdn.net/Jeffid/article/details/126898000

来源地址：https://blog.csdn.net/qq_49723651/article/details/127813262