当前位置：首页 > 文章列表 > Golang > Go教程 > Go 怎么用 go generate 自动生成重复代码

Go 怎么用 go generate 自动生成重复代码

来源：17golang原创 2026-09-06 10:32:53 0浏览收藏

项目里只要有一组“从源定义可以稳定推导出来”的代码，就不值得长期手写维护。Go 的 go generate 可以把生成器命令写进源码，但它不是隐藏在构建过程里的魔法：你必须显式执行它，再检查生成文件，最后决定是否提交产物。

最小可靠做法是：在普通 Go 源文件中写好 //go:generate，让生成器输出带有 Code generated ... DO NOT EDIT. 标记的文件；把 go generate 放进开发或 CI 检查清单，而不是误以为 go build 会替你触发。

要点速览

go generate 读取源码中的生成指令，命令本身需要显式运行。
生成器可以是本地可执行文件，也可以用 go run 调用项目内工具。
生成文件应可重复产生、带清晰标记，并在生成后经过格式化和测试。

先把 go generate 的边界划清

go generate 只处理源码里的特殊注释。指令必须从行首开始，标记中不能在 // 与 go:generate 之间插入空格：

//go:generate go run ./internal/genstatus -output status_string.go
// 生成器从当前包的状态定义产生可提交的字符串方法。

type Status int

这里的注释只是“命令声明”，不会因为写进文件就自动运行。go build 和 go test 也不会替你生成文件；生成器失败时，当前包后面的生成指令不会继续执行。因此，生成应当是可观察、可重跑的准备动作。

Go go generate 从源 Go 文件、生成指令到生成文件和构建检查的静态边界框图 — 图1：看清源码声明、生成产物和构建检查三个边界，理解 go generate 为什么必须显式执行。

几个容易混淆的对象可以这样区分：

对象	负责什么	不负责什么
`//go:generate`	声明要执行的生成器命令	不保证命令已安装，也不触发执行
`go generate`	扫描指令并运行命令	不替你编译、测试或提交产物
`go build` / `go test`	检查当前源码是否能构建、测试	不自动补齐缺失的生成文件

用生成器维护重复代码的最小目录

以状态常量为例，手写每个 String() 方法很容易漏掉新增状态。可以把生成器放在 internal/genstatus，把业务定义和生成结果留在同一个包：

// status.go：业务源定义，修改这里后再重新生成。
package order

//go:generate go run ./internal/genstatus -output status_string.go

type Status int

const (
	StatusPending Status = iota // 待处理
	StatusPaid                  // 已支付
	StatusClosed                // 已关闭
)

生成器只需要接受明确输入并写出确定结果。无论你使用自研工具还是成熟的字符串方法生成器，都建议让产物开头出现标准标记：

// Code generated by genstatus; DO NOT EDIT.

package order

import "fmt"

// String 返回状态的稳定文本，未知值保留数字便于排查。
func (s Status) String() string {
	switch s {
	case StatusPending:
		return "pending"
	case StatusPaid:
		return "paid"
	case StatusClosed:
		return "closed"
	default:
		return fmt.Sprintf("status(%d)", s)
	}
}

产物不是临时缓存。它要能被普通编译器看到，因此生成后运行 gofmt -w status_string.go，再执行包测试。生成命令的参数、输入文件和输出文件也要保持稳定，避免同一份源定义在不同机器上得到不同目录结构。