江苏龙网

  1. 主页 > 生活百科 > >

Go工具之generate

generate

Go语言提供了一系列强大的工具 ， 灵活使用这些工具 ， 能够让我们的项目开发更加容易 ， 工具集包含如下 。
bug         start a bug reportbuild       compile packages and dependenciesclean       remove object files and cached filesdoc         show documentation for package or symbolenv         print Go environment informationfix         update packages to use new APIsfmt         gofmt (reformat) package sourcesgenerate    generate Go files by processing sourceget         add dependencies to current module and install theminstall     compile and install packages and dependencieslist        list packages or modulesmod         module maintenancerun         compile and run Go programtest        test packagestool        run specified go toolversion     print Go versionvet         report likely mistakes in packages工具的源码位于$GOPATH/src/cmd/internal ， 本篇文章主要讨论Go工具generate 。
Go语言的自动化工具
go generate常用于自动生成代码 ， 它可以在代码编译之前根据源代码生成代码 。当运行go generate时 ， 它将扫描与当前包相关的源代码文件 ， 找出所有包含"// go:generate"的注释语句 ， 提取并执行该注释后的命令 ， 命令为可执行程序 。该过程类似于调用执行shell脚本 。
使用方法

  • 添加特殊注释
//go:generate command argument...
  • 执行generate命令
【Go工具之generate】$ go generate [-run regexp] [-n] [-v] [-x] [build flags] [file.go... | packages]注意事项
  • 该特殊注释必须包含在.go源码文件中 。
  • 每个源码文件可以包含多个generate特殊注释 。
  • go generate不会被类似go build ， go get ， go test等命令触发执行 ， 必须由开发者显式使用 。
  • 命令执行是串行的 ， 如果出错 ， 后续命令不再执行 。
  • 特殊注释必须以“//go:generate”开头 ， 双斜线之后没有空格 。
  • 执行命令必须是系统PATH（echo $PATH）下的可执行程序 。
使用示例
package mainimport "fmt"//go:generate echo GoGoGo!//go:generate go run main.go//go:generate echo $GOARCH $GOOS $GOFILE $GOLINE $GOPACKAGEfunc main() { fmt.Println("go rum main.go!")}执行go generate命令
$ go generateGoGoGo!go rum main.go!amd64 darwin main.go 7 main为枚举常量实现String方法
看完上述generate的简单介绍 ， 可能读者并没有感受到该工具的强大之处 ， 小菜刀提供一个该工具的经典应用场景：为枚举常量实现String方法 。
这里需要提及官方的另外一个工具stringer ， 它可以自动为整数常量集编写String()方法 。由于stringer并不在Go官方发行版的工具集里 ， 我们需要自行安装 ， 执行如下命令 。
go get golang.org/x/tools/cmd/stringer这里引用stringer文档中的一个示例 。代码如下 ， 其定义了一组不同Pill类型的整数常量 。
package painkillertype Pill intconst (    Placebo Pill = iota    Aspirin    Ibuprofen    Paracetamol    Acetaminophen = Paracetamol)为了进行调试或者其他原因 ， 我们希望这些常量能够打印出来 ， 这意味着Pill要有一个带有签名的方法 。
func (p Pill) String() string


推荐阅读


上一篇：立式钢琴中间的踏板叫什么？

下一篇：新一代BDD框架Gauge+Taiko