Go - 代码生成工具

简介: Go - 代码生成工具

分享两个常用的代码生成工具:

  • gormgen
  • handlergen

gormgen

基于 MySQL 数据表结构进行生成 3 个文件:

  1. 生成表的 struct 结构体
  2. 生成表的 Markdown 文档
  3. 生成表的 CURD 方法

场景

在进行业务需求开发时,创建完数据表后,执行代码生成工具,常用的 CURD 操作全部生成完毕,使用的时候只需要 . 后面的方法即可,这样大大提高了业务开发效率。

示例

表结构:

CREATE TABLE `user_demo` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
  `user_name` varchar(32) NOT NULL DEFAULT '' COMMENT '用户名',
  `nick_name` varchar(100) NOT NULL DEFAULT '' COMMENT '昵称',
  `mobile` varchar(20) NOT NULL DEFAULT '' COMMENT '手机号',
  `is_deleted` tinyint(1) NOT NULL DEFAULT '-1' COMMENT '是否删除 1:是  -1:否',
  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='用户Demo表';

1、在 config 中设置需要自动生成的表,参数为 cmd.genTables,如果设置为空,表示生成当前数据库中的所有的表,如果设置多张表还可以用 “,” 分割。

[cmd]
genTables = 'user_demo'

2、在根目录下执行脚本

./scripts/gormgen.sh

执行完毕后,会在 /internal/api/repository/db_repo 中生成 user_demo_repo 目录,同时也会生成 3 个文件:

  • gen_model.go
  • gen_table.md
  • gen_user_demo.go

gen_model.go 内容如下:

package user_demo_repo
import "time"
// 用户Demo表
//go:generate gormgen -structs UserDemo -input .
type UserDemo struct {
    Id        int32     // 主键
    UserName  string    // 用户名
    NickName  string    // 昵称
    Mobile    string    // 手机号
    IsDeleted int32     // 是否删除 1:是  -1:否
    CreatedAt time.Time `gorm:"time"` // 创建时间
    UpdatedAt time.Time `gorm:"time"` // 更新时间
}

gen_table.md Markdown 内容如下:

e7832d8ffcfcc5c28f952806ea04098e.png

gen_user_demo.go 内容如下:

func NewModel() *UserDemo {...}
func NewQueryBuilder() *userDemoRepoQueryBuilder {...}
func (t *UserDemo) Create(db *gorm.DB) (id int32, err error) {...}
func (t *UserDemo) Delete(db *gorm.DB) (err error) {...}
func (t *UserDemo) Updates(db *gorm.DB, m map[string]interface{}) (err error) {...}
type userDemoRepoQueryBuilder struct {...}
func (qb *userDemoRepoQueryBuilder) buildQuery(db *gorm.DB) *gorm.DB {...}
func (qb *userDemoRepoQueryBuilder) Count(db *gorm.DB) (int64, error) {...}
func (qb *userDemoRepoQueryBuilder) First(db *gorm.DB) (*UserDemo, error) {...}
func (qb *userDemoRepoQueryBuilder) QueryOne(db *gorm.DB) (*UserDemo, error) {...}
func (qb *userDemoRepoQueryBuilder) QueryAll(db *gorm.DB) ([]*UserDemo, error) {...}
func (qb *userDemoRepoQueryBuilder) Limit(limit int) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) Offset(offset int) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) WhereId(p db_repo.Predicate, value int32) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) OrderById(asc bool) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) WhereUserName(p db_repo.Predicate, value string) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) OrderByUserName(asc bool) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) WhereNickName(p db_repo.Predicate, value string) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) OrderByNickName(asc bool) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) WhereMobile(p db_repo.Predicate, value string) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) OrderByMobile(asc bool) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) WhereIsDeleted(p db_repo.Predicate, value int32) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) OrderByIsDeleted(asc bool) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) WhereCreatedAt(p db_repo.Predicate, value time.Time) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) OrderByCreatedAt(asc bool) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) WhereUpdatedAt(p db_repo.Predicate, value time.Time) *userDemoRepoQueryBuilder {...}
func (qb *userDemoRepoQueryBuilder) OrderByUpdatedAt(asc bool) *userDemoRepoQueryBuilder {...}

使用

这样使用生成后的方法:

// 查询示例:
user_demo_repo.NewQueryBuilder().
 WhereUserName(db_repo.EqualPredicate, "tom").
 OrderById(true).
 QueryOne(u.db.GetDbR().WithContext(ctx.RequestContext()))

handlergen

基于定义的 Handler 文件中 type interface 中接口方法,进行生成文件。

场景

本次需求的研发负责人通过定义 type interface 的方式,定义出需要开发的方法,执行代码生成工具,每个方法的空实现都会生成在一个单独的文件中,开发人员只需去实现各自方法即可,便于进行分工和代码管理。

示例

比如 test_handler 中定义的 type interface 如下:

var _ Handler = (*handler)(nil)
type Handler interface {
 // i 为了避免被其他包实现
 i()
 // Create 创建用户
 Create() core.HandlerFunc
 // Update 编辑用户
 Update() core.HandlerFunc
 // Delete 删除用户
 Delete() core.HandlerFunc
 // Detail 用户详情
 Detail() core.HandlerFunc
}
type handler struct {
 logger      *zap.Logger
 cache       cache.Repo
 userService user_service.UserService
}
func New(logger *zap.Logger, db db.Repo, cache cache.Repo) Handler {
 return &handler{
  logger:      logger,
  cache:       cache,
  userService: user_service.NewUserService(db, cache),
 }
}
func (h *handler) i() {}

在根目录下执行脚本:

./scripts/handlergen.sh test_handler
// test_handler 为需要生成 handler 的包名

执行完毕后,会在 /internal/api/controller/test_handler 中生成 4 个文件:

  • func_create.go
  • func_update.go
  • func_detail.go
  • func_delete.go

func_create.go 内容如下:

type createRequest struct{}
type createResponse struct{}
func (h *handler) Create() core.HandlerFunc {
 return func(c core.Context) {
 }
}

其中 createRequest 为入参结构体,createResponse 为出参结构体。

func_update.go 内容如下:

type updateRequest struct{}
type updateResponse struct{}
func (h *handler) Update() core.HandlerFunc {
 return func(c core.Context) {
 }
}

func_detail.go 内容如下:

type detailRequest struct{}
type detailResponse struct{}
func (h *handler) Detail() core.HandlerFunc {
 return func(c core.Context) {
 }
}

func_delete.go 内容如下:

type deleteRequest struct{}
type deleteResponse struct{}
func (h *handler) Delete() core.HandlerFunc {
 return func(c core.Context) {
 }
}


以上代码都在 go-gin-api 项目中,地址:https://github.com/xinliangnote/go-gin-api

目录
相关文章
|
20天前
|
JSON 监控 安全
go语言选择合适的工具和库
【10月更文挑战第17天】
12 2
|
3月前
|
Shell Go
Go 语言Air 工具使用入门
在Go开发中,频繁的手动重启应用以加载新代码既耗时又低效。为此,我们引入了Air——一款专为Go项目设计的自动重载工具。Air通过监听文件变化,实现代码更改后的自动编译与运行,极大提升了开发效率。本文将指导你完成Air的安装与配置,包括如何启动Air、忽略临时文件以及理解其工作原理,让Go项目开发更加流畅高效。
|
3月前
|
Kubernetes 数据可视化 Java
|
3月前
|
算法 测试技术 Go
|
3月前
|
JSON Go 数据格式
Go - 使用工具生成易读的 Protocol 文档
Go - 使用工具生成易读的 Protocol 文档
23 1
|
3月前
|
JSON 编解码 中间件
go-zero代码生成器助你高效开发
go-zero代码生成器助你高效开发
|
3月前
|
编译器 Go
Go语言中的闭包:封装数据与功能的强大工具
Go语言中的闭包:封装数据与功能的强大工具
|
3月前
|
Java Go PHP
Go - 关于 protoc 工具的小疑惑
Go - 关于 protoc 工具的小疑惑
26 0
|
4月前
|
Oracle 关系型数据库 MySQL
|
8天前
|
存储 JSON 监控
Viper,一个Go语言配置管理神器!
Viper 是一个功能强大的 Go 语言配置管理库,支持从多种来源读取配置,包括文件、环境变量、远程配置中心等。本文详细介绍了 Viper 的核心特性和使用方法,包括从本地 YAML 文件和 Consul 远程配置中心读取配置的示例。Viper 的多来源配置、动态配置和轻松集成特性使其成为管理复杂应用配置的理想选择。
26 2