分享两个常用的代码生成工具：
- 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
到此这篇关于go 代码生成工具的文章就介绍到这了,更多相关go 代码生成工具内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com！
黄山市民网：https://www.huangshanshimin.com/
