当前位置：首页 > 文章列表 > Golang > Go教程 > Go go generate把生成结果纳入构建前检查的实践示例

Go go generate把生成结果纳入构建前检查的实践示例

来源：17golang原创 2026-09-20 06:28:15 0浏览收藏

项目里只要有代码生成，就会遇到一个很具体的风险：源定义已经改了，生成文件却还停在上一次结果。此时本地可能因为缓存或旧文件仍能编译，换一台机器或进入 CI 才暴露问题。比较稳妥的做法是把 go generate 放在构建前，先刷新生成结果，再检查工作区是否出现未提交差异，最后才执行 go build 或 go test。

要点速览

go generate 是显式的生成阶段，不会被 go build 自动调用。
生成命令要写进普通 Go 源文件，并固定输入、输出和工具依赖。
构建前检查应以“生成后无意外差异”为通过条件。

一、先把 go generate 和 go build 分成两个阶段

Go 官方对这两个命令的边界很清楚：go generate 会扫描源文件里的特殊注释并执行命令，但它没有依赖分析，也不是 go build 的隐式前置步骤。也就是说，构建成功只说明当前目录里的文件能编译，不能证明这些文件已经由最新输入生成。

因此，构建前检查的顺序应固定成：

阶段	检查内容	失败时的判断
生成	执行所有 go:generate 指令	工具缺失、输入错误或命令退出非零
差异	检查生成后工作区	生成文件未同步或存在意外改动
构建	运行 go build / go test	源码或生成代码自身无法通过编译

Go go generate与go build分阶段衔接的静态结构图 — 图1：Go go generate、差异检查和 go build 的阶段边界说明图，不是运行截图。

二、为生成命令建立可重复入口

生成入口应放在普通的、不会被生成器覆盖的 Go 文件里。指令必须从行首开始写成 //go:generate，后面接要执行的命令。下面用一个本地脚本模拟生成器，重点是展示输入文件、输出文件和退出码如何固定下来。

package schema

//go:generate go run ./cmd/schema-gen -input schema.yaml -output zz_schema_gen.go

// SchemaMarker 让这个文件保持为稳定的生成入口，不承载生成结果。
type SchemaMarker struct{}

生成器本身也要明确失败边界：输入不存在时返回非零状态，成功时只写入约定的输出文件。不要让命令依赖开发者当前目录下偶然存在的临时文件。进入模块目录后可以先单独运行：

# 先刷新本模块声明的全部生成文件
go generate ./...

# 再确认生成结果能够被构建工具读取
go build ./...

三、把生成结果变成构建前的硬检查

仅仅执行 go generate 还不够，因为生成器可能已经成功运行，但结果没有被提交。一个简单而有效的检查是：在干净工作树中先生成，再查看差异；如果发现变化，就让检查失败，把差异交给提交者处理。

#!/usr/bin/env bash
set -euo pipefail

# 生成命令失败时立即停止，避免拿半成品继续构建。
go generate ./...

# 只允许生成阶段不留下差异；其他手工改动也应在 CI 中单独管理。
if ! git diff --exit-code -- '*.go' '*.gen' '*.yaml'; then
  echo '生成结果与仓库内容不一致，请提交更新后的生成文件' >&2
  exit 1
fi

# 差异检查通过后，才进入真正的编译和测试阶段。
go build ./...
go test ./...

如果仓库允许本地未提交的业务改动，可以把检查范围收窄到生成文件，例如 zz_*.go 或工具约定的目录。关键不在于复制这段脚本，而在于先定义“哪些输出由生成器负责”，再用差异检查表达这条规则。