自动生成Priest

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

什么是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 demo
import "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 internal
import (
	"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
}

tips: 运行go generate ./... 会执行 所有//go:generate注释后的命令；

• 在MasterPriest函数中，调用调用生成的Priest函数；
• git忽略掉生成文件，将生成的文件加入到.gitignore文件中。

按照上面逻辑，我们编写了一个可供参考的Web空白项目Demo (opens new window)，已经放到github上，快点击打开吧；另外也可以运行gone create web-app生成一个空白项目，参考快速开始 (opens new window)。