【开源软件推荐】gorm 数据库反向生成status结构工具 gormt

一、前言

Gorm是比较经常使用的orm基础库，也是从2017年到现在5年时间从beego、sqlx、xorm、gorm等数据库操作框架中跑出来的一个比较好用的orm库，但随着go-zero、Kratos等框架的逐渐流行，所谓是在数据库操作上百花齐放，go-zero通过生成的方式非常好的集成了数据库和cache之间的打通，Kratos则Facebook 开源的Ent定义数据操作。但他们都是可选项如果你熟悉传统的orm的方式gorm将会是你的不二之选。如果你的工作方式是先创建好数据结构在创建编写status实体，如果你和笔者一样嫌麻烦，今天笔者给大家带来一个开源软件是专门为这个场景打造的那就是gormt。

资料如下：

• gormt Github：https://github.com/xxjwxc/gormt
• gormt 官方文档：https://xxjwxc.github.io/post/gormt/
• Gorm 官方文档：https://gorm.io/zh_CN/

二、工具安装

安装其实非常简单：

> go version
go version go1.17.11 darwin/amd64
> go install github.com/xxjwxc/gormt@master
1
2
3

也可以通过下载二进制包的方式：

之后就可以通过命令行开始使用了：

./gormt -h

-------------------------------------------------------
base on gorm tools for mysql database to golang struct

Usage:
  main [flags]

Flags:
  -d, --database string   数据库名
  -f, --foreign           是否导出外键关联
  -F, --fun               是否导出函数
  -g, --gui               是否ui显示模式
  -h, --help              help for main
  -H, --host string       数据库地址.(注意-H为大写)
  -o, --outdir string     输出目录
  -p, --password string   密码.
      --port int          端口号 (default 3306)
  -s, --singular          是否禁用表名复数
  -l, --url string        url标签(json,url)
  -u, --user string       用户名.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

使用 gormt -g=true 就可以打开终端ui界面：

点击“设置"就可以编辑配置，填入数据库链接信息：

点击执行就可以开始链接数据库读取表结构，最后会列举出对应的表面，点击表面就可以获得对应的结构体了。

结果如下：

//	用户信息
type UserAccountTbl struct {
	ID          int       `gorm:"primary_key;column:id;type:int(11);not null" json:"-"`                                                   //
	Account     string    `gorm:"unique;column:account;type:varchar(64);not null" json:"account"`                                         //
	Password    string    `gorm:"column:password;type:varchar(64);not null" json:"password"`                                              //
	AccountType int       `gorm:"column:account_type;type:int(11);not null" json:"account_type"`                                          //	帐号类型:0手机号，1邮件
	AppKey      string    `json:"app_key" gorm:"unique_index:UNIQ_5696AD037D3656A4;column:app_key;type:varchar(255);not null"`            //	authbucket_oauth2_client表的id
	UserInfoID  int       `gorm:"unique_index:UNIQ_5696AD037D3656A4;index;column:user_info_id;type:int(11);not null" json:"user_info_id"` //
	RegTime     time.Time `gorm:"column:reg_time;type:datetime" json:"reg_time"`                                                          //
	RegIP       string    `gorm:"column:reg_ip;type:varchar(15)" json:"reg_ip"`                                                           //
	BundleID    string    `json:"bundle_id" gorm:"column:bundle_id;type:varchar(255)"`                                                    //
	Describ     string    `gorm:"column:describ;type:varchar(255)" json:"describ"`                                                        //
}
1
2
3
4
5
6
7
8
9
10
11
12
13

PS1: 非常推荐关闭简单输出，关闭简单输出后的字段注解中会显示出索引、默认值、值范围等一系列的内容，在编写orm方法的时候能够非常直观的看到使用的字段是否存在索引，强烈建议对每个字段子啊数据库中的配置描述清楚。
PS2：如果你对float64精度有要求，建议替换为 decimal.Decimal

三、扩展使用

除了使用图形化界面也可以使用命令进行一键生成，比较推荐每张表首次实用工具生成，后续的字段增加通过手动方式进行。

配置文件config.toml默认配置项：

base:
    is_dev : false
out_dir : ./model  # 输出目录
url_tag : json # web url tag(json,db(https://github.com/google/go-querystring))
language :  # 语言(English,中 文)
db_tag : gorm # 数据库标签(gorm,db)
singular_table : false  # 单表模式:true:禁用表名复数,false:采用表明复数 参考:gorm.SingularTable
simple : false # 简单输出(默认gorm标签不输出)
is_out_sql : false # 是否输出 sql 原信息
is_out_func : true # 是否输出 快捷函数
is_web_tag : true # 是否打web标记
is_foreign_key : true # 是否导出外键关联
is_gui : false # 是否ui模式显示
mysql_info:
    host : 127.0.0.1
    port : 3306
    username : root
    password : qwer
    database : oauth_db
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19