Skip to content

Latest commit

 

History

History
246 lines (197 loc) · 10.9 KB

README_zh-CN.md

File metadata and controls

246 lines (197 loc) · 10.9 KB
Raw

gorm

English ∙ 简体中文

Github License Go Doc Go Report Github Latest Release Github Latest Tag Github Stars

Grom 是一个可以将 mysql 的表字段转换为 golang 的模型结构的命令行工具。它的全称是 golang relational object mapping（GROM，Golang 关系对象映射）。

安装

使用如下命令下载并安装包：

# 如果 go 版本在 1.16 以前，使用如下命令安装：
$ GO111MODULE=on go get -u github.com/sliveryou/grom@latest

# 如果 go 版本在 1.16 及以后，使用如下命令安装：
$ GO111MODULE=on go install github.com/sliveryou/grom@latest

如果要从源码开始构建的话，需要有 Go 环境（1.16 及以上版本），并使用如下命令：

$ git clone https://github.com/sliveryou/grom.git
$ cd grom
$ sh scripts/install.sh

或者从 github 的 release 页面下载预编译好的二进制文件。

Grom 命令行接口

$ grom -h
利用 mysql 的信息模式获取 golang 的模型结构

用法:
  grom [command]

例子:
  grom generate -n ./grom.json
  grom convert -n ./grom.json

可用命令:
  convert     将 mysql 的表字段转换为 golang 的模型结构
  generate    生成 grom 的配置文件
  help        获取有关任何命令的帮助
  version     显示 grom 的版本信息

标记:
  -h, --help   获取有关 grom 命令的帮助

使用 "grom [command] --help" 获取有关命令的详细信息。

$ grom generate -h
将会生成如下的 grom 配置文件：
{
    "host": "localhost",            // 将要连接的 mysql 主机
    "port": 3306,                   // 将要连接的 mysql 端口
    "user": "user",                 // 将要连接的 mysql 用户
    "password": "password",         // 将要连接的 mysql 密码 
    "database": "database",         // 将要连接的 mysql 数据库
    "table": "table",               // 将要连接的 mysql 数据表
    "package_name": "package_name", // 转换后的模型结构的包名称
    "struct_name": "struct_name",   // 转换后的模型结构的结构体名称
    "enable_initialism": true,      // 是否开启常用缩写词映射
    "enable_field_comment": true,   // 是否启用字段注释
    "enable_sql_null": false,       // 是否启用 sql.Null 类型
    "enable_guregu_null": false,    // 是否启用 null.Null 类型
    "enable_json_tag": true,        // 是否启用 json 标签
    "enable_xml_tag": false,        // 是否启用 xml 标签
    "enable_gorm_tag": false,       // 是否启用 gorm v1 标签
    "enable_xorm_tag": false,       // 是否启用 xorm 标签
    "enable_beego_tag": false,      // 是否启用 beego orm 标签
    "enable_gorose_tag": false,     // 是否启用 gorose 标签
    "enable_gorm_v2_tag": true,     // 是否启用 gorm v2 标签
    "disable_unsigned": false       // 是否禁用无符号整数类型
}

用法:
  grom generate [flags]

例子:
  grom generate -n ./grom.json

标记:
  -h, --help          获取有关 generate 命令的帮助
  -n, --name string   生成的 grom 配置文件的名称（默认为 "grom.json"）

$ grom convert -h
通过 information_schema.columns 表和 information_schema.statistics 表，将 mysql 的表字段转换为 golang 的模型结构

用法:
  grom convert [flags]

例子:
  grom convert -n ./grom.json
  grom convert -H localhost -P 3306 -u user -p password -d database -t table -e INITIALISM,FIELD_COMMENT,JSON_TAG,GORM_V2_TAG --package PACKAGE_NAME --struct STRUCT_NAME

标记:
  -d, --database string   将要连接的 mysql 数据库
  -e, --enable strings    启用的服务（必须包含在 [INITIALISM,FIELD_COMMENT,SQL_NULL,GUREGU_NULL,JSON_TAG,XML_TAG,GORM_TAG,XORM_TAG,BEEGO_TAG,GOROSE_TAG,GORM_V2_TAG,DISABLE_UNSIGNED] 之中）
  -h, --help              获取有关 convert 命令的帮助
  -H, --host string       将要连接的 mysql 主机
  -n, --name string       指定的 grom 配置文件的名称
  -o, --output string     指定的存放 grom 输出的文件的名称
      --package string    转换后的模型结构的包名称
  -p, --password string   将要连接的 mysql 密码
  -P, --port int          将要连接的 mysql 端口
      --struct string     转换后的模型结构的结构体名称
  -t, --table string      将要连接的 mysql 数据表
  -u, --user string       将要连接的 mysql 用户

$ grom version -h
显示 grom 版本信息，如项目名称、项目版本、go 版本、git 提交 id 和构建时间等

用法:
  grom version [flags]

标记:
  -h, --help   获取有关 version 命令的帮助

目前支持生成的类型和标签

类型：

标签：

支持的标签生成规则

标签 主键 自增 列名 类型 是否为 null normal 索引 unique 索引 默认值 注释 外键
json × × √ × × × × × × ×
xml × × √ × × × × × × ×
gorm v1 √ √ √ √ √ √ √ √ √ ×
xorm √ √ √ √ √ √ √ √ √ ×
beego orm √ √ √ √ √ × × √ √ ×
gorose × × √ × × × × × × ×
gorm v2 √ √ √ √ √ √ √ √ √ ×

支持的函数生成规则

标签 表名函数（TableName） 表 normal 索引函数（TableIndex） 表 unique 索引函数（TableUnique）
json × × ×
xml × × ×
gorm v1 √ × ×
xorm √ × ×
beego orm √ √ √
gorose √ × ×
gorm v2 √ × ×

用法举例

  1. 通过以下 sql 语句创建名为 api 的表：
CREATE TABLE `api` (
    `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '接口id',
    `path` varchar(255) NULL DEFAULT NULL COMMENT '接口路径',
    `description` varchar(255) NULL DEFAULT NULL COMMENT '接口描述',
    `group` varchar(255) NULL DEFAULT NULL COMMENT '接口属组',
    `method` varchar(255) NULL DEFAULT 'POST' COMMENT '接口方法',
    `create_time` bigint(20) NULL DEFAULT NULL COMMENT '创建时间',
    `update_time` bigint(20) NULL DEFAULT NULL COMMENT '更新时间',
    PRIMARY KEY (`id`),
    UNIQUE INDEX `path_method`(`path`, `method`),
    INDEX `group`(`group`)
) ENGINE = InnoDB AUTO_INCREMENT = 1;
  1. 生成并编辑 grom 的配置文件：
$ grom generate -n grom.json 
$ vim grom.json
{
    "host": "localhost",
    "port": 3306,
    "user": "user",
    "password": "password",
    "database": "database",
    "table": "api",
    "package_name": "model",
    "struct_name": "API",
    "enable_initialism": true,
    "enable_field_comment": true,
    "enable_sql_null": false,
    "enable_guregu_null": false,
    "enable_json_tag": true,
    "enable_xml_tag": false,
    "enable_gorm_tag": false,
    "enable_xorm_tag": false,
    "enable_beego_tag": false,
    "enable_gorose_tag": false,
    "enable_gorm_v2_tag": true,
    "disable_unsigned": false
}
$ grom convert -n grom.json -o output.go

你也可以在命令行中填写参数，而不生成配置文件：

$ grom convert -H localhost -P 3306 -u user -p password -d database -t api -e INITIALISM,FIELD_COMMENT,JSON_TAG,GORM_V2_TAG -o output.go

然后你将会得到生成的代码：

package model

type API struct {
    ID          int    `json:"id" gorm:"primaryKey;column:id;type:int(11) auto_increment;comment:接口id"`                           // 接口id
    Path        string `json:"path" gorm:"column:path;type:varchar(255);uniqueIndex:path_method;comment:接口路径"`                  // 接口路径
    Description string `json:"description" gorm:"column:description;type:varchar(255);comment:接口描述"`                            // 接口描述
    Group       string `json:"group" gorm:"column:group;type:varchar(255);index:group;comment:接口属组"`                            // 接口属组
    Method      string `json:"method" gorm:"column:method;type:varchar(255);uniqueIndex:path_method;default:POST;comment:接口方法"` // 接口方法
    CreateTime  int64  `json:"create_time" gorm:"column:create_time;type:bigint(20);comment:创建时间"`                              // 创建时间
    UpdateTime  int64  `json:"update_time" gorm:"column:update_time;type:bigint(20);comment:更新时间"`                              // 更新时间
}

// TableName returns the table name of the API model
func (a *API) TableName() string {
    return "api"
}
  1. 尽情享受吧。