Go — инструмент для генерации кода

Поделитесь двумя часто используемыми инструментами генерации кода:

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_handler4 файла создаются в:

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 по адресу:GitHub.com/Бессердечный не…