目录

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

  • gormgen
  • handlergen

gormgen

 

MySQL
structMarkdownCURD

场景

CURD

示例

表结构：

CREATETABLE`user_demo` (  `id` int(11) unsigned NOTNULLAUTO_INCREMENT COMMENT '主键',  `user_name` varchar(32) NOTNULLDEFAULT''COMMENT '用户名',  `nick_name` varchar(100) NOTNULLDEFAULT''COMMENT '昵称',  `mobile` varchar(20) NOTNULLDEFAULT''COMMENT '手机号',  `is_deleted` tinyint(1) NOTNULLDEFAULT'-1'COMMENT '是否删除 1:是  -1:否',  `created_at` timestampNOTNULLDEFAULTCURRENT_TIMESTAMPCOMMENT '创建时间',  `updated_at` timestampNOTNULLDEFAULTCURRENT_TIMESTAMPONUPDATECURRENT_TIMESTAMPCOMMENT '更新时间',  PRIMARYKEY(`id`)) ENGINE=InnoDB DEFAULTCHARSET=utf8mb4 COMMENT='用户Demo表';
configcmd.genTables
[cmd]genTables = 'user_demo'

2、在根目录下执行脚本

./scripts/gormgen.sh
/internal/api/repository/db_repouser_demo_repo
  • 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

Go 代码生成工具详解

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

 

Handlertype interface

场景

type interface

示例

test_handlertype 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
  • 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) {  }}
createRequestcreateResponse
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

 

原文链接：https://blog.csdn.net/XinLiangTalk/article/details/114314118