Gone框架介绍16 - 自动生成Priest

我从头到尾实现了一个Golang的依赖注入框架，并且集成了gin、xorm、redis、cron、消息中间件等功能；自己觉得还挺好用的，并且打算长期维护！
github地址：https://github.com/gone-io/gone
文档原地址：https://goner.fun/zh/guide/auto-gen-priest.html
请帮忙在github上点个 ⭐️吧，这对我很重要；万分感谢！！

文章目录

自动生成Priest
- 小试牛刀
- - 1. 安装gone辅助工具
  - 2. 编写Goner
  - 3. 生成代码
- 最佳实践

自动生成Priest

什么是Priest?

小试牛刀

gone priest命令可以扫描代码中的特殊注释//go:gone生成Priest函数；//go:gone暂时只能用于标记func () gone.Goner 和 func () (gone.Goner, gone.GonerId)这两种形式的函数，函数必须是公开（以大写字母开头）。

1. 安装gone辅助工具

执行如下命令：

go install github.com/gone-io/gone/tools/gone@latest

gone更多内容参考文档 gone辅助工具

2. 编写Goner

创建项目，创建文件：

mkdir demo
cd demo
go mod init demo
touch demo.go

编辑demo.go文件代码如下：

package demoimport "github.com/gone-io/gone"//go:gone
func NewDemo() gone.Goner {return &Demo{}
}type Demo struct {gone.Flag
}

3. 生成代码

执行

gone priest -s ./ -f Priest -o priest.go -p demo

将生成文件：priest.go
内容如下：

// Code generated by gone; DO NOT EDIT.
package demo
import ("github.com/gone-io/gone"
)func Priest(cemetery gone.Cemetery) error {cemetery.Bury(NewDemo())return nil
}

最佳实践

创建一个MasterPriest函数，用于Gone框架的启动；
在MasterPriest函数中，调用项目依赖包的Priest函数；
将“gone priest”命令放到MasterPriest函数的//go:generate注释后，例如：

package internalimport ("github.com/gone-io/gone""github.com/gone-io/gone/goner"
)//go:generate gone priest -s . -p $GOPACKAGE -f Priest -o priest.go
func MasterPriest(cemetery gone.Cemetery) error {//调用项目依赖包的Priest函数_ = goner.GinPriest(cemetery)//调用生成的Priest函数_ = Priest(cemetery)return nil
}