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表';

一、在 config 中設置須要自動生成的表，參數爲 cmd.genTables，若是設置爲空，表示生成當前數據庫中的全部的表，若是設置多張表還能夠用 「,」 分割。

[cmd]
genTables = 'user_demo'

二、在根目錄下執行腳本

./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 內容以下：

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