分享兩個常用的程式碼生成工具：
- gormgen
- handlergen
gormgen
基於 MySQL 資料表結構進行生成 3 個檔案：
- 生成表的
struct結構體 - 生成表的
Markdown文件 - 生成表的
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 內容如下：
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