分享两个罕用的代码生成工具：

  • 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_repoimport "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 内容如下：

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/xinliangno...