Go generate 如何把生成步骤和源码目录绑定

我更愿意把 go generate 当成“写在源码旁边的构建说明”，而不是一条只在项目根目录里记住的命令。要让生成结果稳定，核心做法是：把 //go:generate 放进拥有输入源码的包，生成器路径和输出文件都按这个包目录解释；从根目录执行时只传包路径，不要依赖当前 shell 恰好停在哪个目录。

先把生成指令放在真正拥有源码的包里

假设项目的生成器在 cmd/schema-gen，输入和结果属于 internal/schema。指令文件可以放在后者，而不是根目录的脚本目录：

project/
├── cmd/schema-gen/       # 生成器程序
├── internal/schema/      # 输入源码和生成结果所属的包
│   ├── generate.go       # 保存 go:generate 指令
│   └── zz_schema_gen.go  # 生成器写出的文件
└── go.mod                # 模块根目录

在 internal/schema/generate.go 中，路径从 internal/schema 出发向上两级即可回到模块根目录：

package schema

// 用文件级别别名固定多词生成器，避免调用入口各自拼命令。
//go:generate -command schemagen go run ../../cmd/schema-gen

// 输出文件落在当前源码包，便于审查、格式化和提交。
//go:generate schemagen -out zz_schema_gen.go

这里的“当前目录”不是运行者的心理预期，而是 go generate 为该包设置的源码目录。官方实现会在包的源目录运行生成器，所以 ../../cmd/schema-gen 和 zz_schema_gen.go 都有明确落点。生成文件的头部还应标记为不可手改：

// Code generated by schema-gen; DO NOT EDIT.

package schema

// GeneratedSchema 返回生成器整理出的字段名。
var GeneratedSchema = []string{"id", "created_at"}

从根目录运行，但让包目录负责解析相对路径

团队协作时我会把入口写成包路径，而不是要求每个人先 cd internal/schema：

# 在模块根目录只生成 schema 包，路径解析仍由包源码目录负责。
go generate ./internal/schema

# 先打印将要执行的指令，不真正写入生成文件。
go generate -n ./internal/schema

# 需要排查实际执行参数时再显示命令。
go generate -x ./internal/schema

-n 适合确认相对路径是否合理，-x 适合确认实际执行顺序。不要把 go generate ./... 当成默认修复手段：它会扫描多个包，包之间的生成器可能有先后关系，出错后当前包的后续处理也会停止。

用环境变量确认命中了哪一个源码文件

生成器需要区分多个输入文件时，可以读取 GOFILE、GOLINE 和 GOPACKAGE。这些值由 go generate 注入，适合写进生成器日志或错误信息；不要把机器绝对路径写入输出文件，否则换工作区后容易出现无意义差异。

package main

import (
    "fmt"
    "os"
)

func main() {
    // 把指令来源写入诊断信息，不把本机绝对路径写进生成结果。
    fmt.Printf("generate source=%s line=%s package=%s\\n",
        os.Getenv("GOFILE"), os.Getenv("GOLINE"), os.Getenv("GOPACKAGE"))
}

如果日志显示的 GOFILE 不是预期文件，先检查指令是否被误放在另一个包；如果输出目录不对，再检查生成器是否自行改变了工作目录。生成器内部可以使用绝对路径完成临时文件操作，但最终输出位置最好由参数显式指定。

重复执行前，先检查顺序和失败边界

同一个包内，文件按文件名顺序处理，单个文件里的指令按出现顺序执行。于是可以把“先准备输入、后写结果”放在同一个文件的两条指令中，但更稳妥的做法是让第二步读取第一步的明确产物，并在命令失败时返回非零退出码。

提交前可以按这张清单快速判断：

生成结果出现差异时，先执行 go generate -n ./internal/schema 比较命令，再执行 go generate -x ./internal/schema 留下可读日志。确认目录和参数一致后，才去排查生成器本身的排序、时间戳或本地环境变量。

相关问题

go generate 会被 go build 自动执行吗？

不会。它必须被显式调用，go build 和 go test 不会替你运行生成指令。

为什么在根目录执行时相对路径找不到生成器？

通常是生成器把路径当成了 shell 当前目录，而不是指令所在包的源码目录。先用 go generate -n 包路径 看实际命令，再把路径按目标包重新计算。

生成文件应该提交到仓库吗？

如果项目需要不装生成器也能构建，通常应提交并保留 Code generated ... DO NOT EDIT. 标记；关键是让重新生成后的结果可重复，而不是盲目忽略所有生成文件。