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

什么是Priest?

小试牛刀

gone priest命令可以扫描代码中的特殊注释//go:gone生成Priest函数;//go:gone暂时只能用于标记func () gone.Gonerfunc () (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,已经放到github上,快点击打开吧;另外也可以运行gone create web-app生成一个空白项目,参考快速开始

上一篇:Gone框架介绍15 - 使用traceId追踪日志

相关推荐

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

    2024-05-13 08:04:03       14 阅读
  2. Gone框架介绍27 - 再讲 Goner 和 依赖注入

    2024-05-13 08:04:03       7 阅读
  3. Gone框架介绍15 - 使用traceId追踪日志

    2024-05-13 08:04:03       12 阅读
  4. Gone框架介绍19 -如何进行单元测试?

    2024-05-13 08:04:03       12 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-05-13 08:04:03       18 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-05-13 08:04:03       19 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-05-13 08:04:03       18 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-05-13 08:04:03       20 阅读

热门阅读

  1. 39-1 Web应用防火墙 - WAF应用程序层绕过

    2024-05-13 08:04:03       9 阅读
  2. PHP笔记

    PHP笔记

    2024-05-13 08:04:03      13 阅读
  3. 什么事防抖和节流,有什么区别,如何实现

    2024-05-13 08:04:03       8 阅读
  4. 02.01移除重复点

    2024-05-13 08:04:03       14 阅读
  5. 富格林:正规经验加持交易安全

    2024-05-13 08:04:03       8 阅读
  6. Lua 基础 01 入门

    2024-05-13 08:04:03       13 阅读