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

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

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

先把 go generate 的边界划清

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

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

type Status int

这里的注释只是“命令声明”，不会因为写进文件就自动运行。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，再执行包测试。生成命令的参数、输入文件和输出文件也要保持稳定，避免同一份源定义在不同机器上得到不同目录结构。

把执行、提交和失败处理纳入手册

值班或 CI 环境里可以按下面的顺序处理，但不要把它误解成 go generate 内部的执行流程：

1. 在包目录或模块根目录执行 go generate ./...，先观察生成器的错误输出。
2. 查看 git diff，确认变更只落在预期的生成文件和必要的格式调整上。
3. 执行 go test ./...；如果生成文件缺包、类型不一致或输出不稳定，在这里尽早暴露。
4. 生成结果通过检查后再提交；生成器本身也应随项目版本一起管理，避免依赖某个开发者的全局命令。

如果生成失败，先保留错误和输入版本，不要手动编辑生成文件“修到能过”。修复源定义或生成器后重新执行，仍失败就回滚本次生成产物。对公共库来说，已生成且通过测试的源码通常应提交，因为使用者未必安装了你的生成器。

复盘时重点看三项：指令是否被放进会被扫描的普通源文件；生成器路径在干净环境中是否可用；生成产物是否包含稳定标记并能被单独审查。把这三项写进项目贡献指南，比只在 README 里放一条命令更不容易漏。

常见问题

为什么写了 go:generate 却没有任何变化？

先检查标记是否从行首开始、是否写成了 //go:generate，再确认执行目录覆盖了目标包。也要确认命令行工具在当前 PATH 中，或改用项目内的 go run 形式。

生成文件要不要提交到 Git？

如果构建或测试依赖它，通常应提交。提交后使用者和 CI 不必拥有同一套生成器；每次修改源定义时重新生成并检查差异即可。

能不能只执行某一条生成指令？

可以使用 go generate -run 以正则筛选指令，也可以直接运行生成器命令。无论采用哪种方式，都要保留生成后的格式化、差异检查和测试。

命令的完整边界可参阅 Go 官方的 go generate 文档；需要了解设计背景时，再看 Go 官方博客的生成代码示例。