Go 代碼生成工具詳解
更新時間：2021年03月10日 10:36:10 作者：新亮筆記
這篇文章主要介紹了Go 代碼生成工具詳解,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下
分享兩個常用的代碼生成工具：
- gormgen
- handlergen
gormgen
基于 MySQL 數(shù)據(jù)表結(jié)構(gòu)進(jìn)行生成 3 個文件：
- 生成表的
struct結(jié)構(gòu)體 - 生成表的
Markdown文檔 - 生成表的
CURD方法
場景
在進(jìn)行業(yè)務(wù)需求開發(fā)時，創(chuàng)建完數(shù)據(jù)表后，執(zhí)行代碼生成工具，常用的 CURD 操作全部生成完畢，使用的時候只需要 . 后面的方法即可，這樣大大提高了業(yè)務(wù)開發(fā)效率。
示例
表結(jié)構(gòu)：
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 '手機(jī)號', `is_deleted` tinyint(1) NOT NULL DEFAULT '-1' COMMENT '是否刪除 1:是 -1:否', `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時間', `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 中設(shè)置需要自動生成的表，參數(shù)為 cmd.genTables，如果設(shè)置為空，表示生成當(dāng)前數(shù)據(jù)庫中的所有的表，如果設(shè)置多張表還可以用 “,” 分割。
[cmd] genTables = 'user_demo'
2、在根目錄下執(zhí)行腳本
./scripts/gormgen.sh
執(zhí)行完畢后，會在 /internal/api/repository/db_repo 中生成 user_demo_repo 目錄，同時也會生成 3 個文件：
- gen_model.go
- gen_table.md
- gen_user_demo.go
gen_model.go 內(nèi)容如下：
package user_demo_repo
import "time"
// 用戶Demo表
//go:generate gormgen -structs UserDemo -input .
type UserDemo struct {
Id int32 // 主鍵
UserName string // 用戶名
NickName string // 昵稱
Mobile string // 手機(jī)號
IsDeleted int32 // 是否刪除 1:是 -1:否
CreatedAt time.Time `gorm:"time"` // 創(chuàng)建時間
UpdatedAt time.Time `gorm:"time"` // 更新時間
}
gen_table.md Markdown 內(nèi)容如下：
gen_user_demo.go 內(nèi)容如下：
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 中接口方法，進(jìn)行生成文件。
場景
本次需求的研發(fā)負(fù)責(zé)人通過定義 type interface 的方式，定義出需要開發(fā)的方法，執(zhí)行代碼生成工具，每個方法的空實現(xiàn)都會生成在一個單獨的文件中，開發(fā)人員只需去實現(xiàn)各自方法即可，便于進(jìn)行分工和代碼管理。
示例
比如 test_handler 中定義的 type interface 如下：
var _ Handler = (*handler)(nil)
type Handler interface {
// i 為了避免被其他包實現(xiàn)
i()
// Create 創(chuàng)建用戶
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() {}
在根目錄下執(zhí)行腳本：
./scripts/handlergen.sh test_handler // test_handler 為需要生成 handler 的包名
執(zhí)行完畢后，會在 /internal/api/controller/test_handler 中生成 4 個文件：
- func_create.go
- func_update.go
- func_detail.go
- func_delete.go
func_create.go 內(nèi)容如下：
type createRequest struct{}
type createResponse struct{}
func (h *handler) Create() core.HandlerFunc {
return func(c core.Context) {
}
}
其中 createRequest 為入?yún)⒔Y(jié)構(gòu)體，createResponse 為出參結(jié)構(gòu)體。
func_update.go 內(nèi)容如下：
type updateRequest struct{}
type updateResponse struct{}
func (h *handler) Update() core.HandlerFunc {
return func(c core.Context) {
}
}
func_detail.go 內(nèi)容如下：
type detailRequest struct{}
type detailResponse struct{}
func (h *handler) Detail() core.HandlerFunc {
return func(c core.Context) {
}
}
func_delete.go 內(nèi)容如下：
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
到此這篇關(guān)于Go 代碼生成工具的文章就介紹到這了,更多相關(guān)Go 代碼生成工具內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了golang 如何獲取pem格式RSA公私鑰長度操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
Golang制定了統(tǒng)一的官方代碼風(fēng)格,并推出gofmt工具(go fmt)來幫助開發(fā)人員格式化代碼到統(tǒng)一的風(fēng)格,下面這篇文章主要給大家介紹了關(guān)于Go代碼格式化gofmt的使用方法,需要的朋友可以參考下2023-04-04
本文主要介紹了Golang切片連接成字符串的實現(xiàn)示例,可以使用Go語言中的內(nèi)置函數(shù)"String()"可以將字節(jié)切片轉(zhuǎn)換為字符串,具有一定的參考價值,感興趣的可以了解一下2023-11-11
這篇文章主要為大家介紹了Go語言基礎(chǔ)變量的聲明及初始化示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助祝大家多多進(jìn)步，早日升職加薪2021-11-11
本文主要介紹了gORM操作MySQL的實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-07-07
Go?開發(fā)過程中有時我們需要集合（set）這種容器,但?Go?本身未內(nèi)置這種數(shù)據(jù)容器,故常常我們需要自己實現(xiàn),下面我們就來看看具體有哪些實現(xiàn)方法吧2024-01-01
本文將深入探討 Go 語言數(shù)組和切片的區(qū)別，包括它們的定義、內(nèi)存布局、長度和容量、初始化和操作等方面。從而更好地在實際開發(fā)中選擇和使用合適的數(shù)據(jù)結(jié)構(gòu)，提高代碼的效率和可維護(hù)性，需要的可以參考一下2023-05-05
這篇文章主要介紹了淺談golang并發(fā)操作變量安全的問題，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
這篇文章主要為大家介紹了gRPC的發(fā)布訂閱模式及REST接口和超時控制，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-06-06
這篇文章主要為大家介紹了go語言LeetCode題解1030距離順序排列矩陣單元格，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-12-12