最轻量可控的Go代码生成器应使用text/template+os.WriteFile,避免字符串拼接;模板需独立文件、参数预处理、校验覆盖风险,并添加生成标记。

Go 代码生成器不是非得用 go:generate 或依赖 golang.org/x/tools 才能写;最轻量、最可控的方式,是直接用 Go 自身的 text/template + os.WriteFile 拼出你需要的代码文件——只要结构清晰、模板分层合理,几小时就能跑通第一条生成流水线。
用 text/template 而不是字符串拼接
硬拼字符串写生成器,初期快,但字段一多、嵌套一深,就变成不可维护的 quote 嵌套地狱。比如生成一个带方法的 struct,用 fmt.Sprintf 很容易漏掉转义或换行,而 text/template 天然支持条件、循环、嵌套和自动转义控制(用 {{.Foo}} 和 {{.Foo|printf "%q"}} 分开处理)。
实操建议:
- 把模板文件单独存为
templates/model.go.tmpl,而非内联字符串,方便 IDE 语法高亮和团队协作 - 在模板里用
{{- if .HasMethods}}...{{end}}控制区块,避免空行堆积(-去除前后空白) - 传入的数据结构用小写字段(如
struct{ Name string; Fields []Field }),模板里用.Name访问,避免大小写混淆 - 不要在模板里做业务逻辑判断,比如“如果字段类型是 time.Time 就加 tag”,这类逻辑应提前在 Go 代码中计算好,再传入布尔标记(如
IsTime bool)
模板参数必须预处理,不能靠运行时反射硬推
很多新手想让生成器“自动扫描 struct 定义并生成 CRUD”,结果卡在反射获取字段 tag、嵌套类型解析、泛型约束上——这本质是把生成器写成了编译器前端。真实项目里,90% 的代码生成需求都基于明确的输入描述(YAML/JSON 配置),而不是源码分析。
实操建议:
- 定义一个简单的
Schema结构体,包含Name、Fields(每个字段含Name、Type、Tag)、Methods等字段 - 用
yaml.Unmarshal从schema.yaml加载数据,再传给模板执行,这样改模型只需改 YAML,不碰 Go 逻辑 - 如果真要读 Go 源码,优先用
go/parser+go/ast解析 AST,而不是反射——反射看不到 struct tag 的原始字符串,也拿不到注释和嵌套结构 - 别试图在生成阶段兼容所有 Go 类型;先支持
string、int64、time.Time、[]string和自定义类型名,其余报错退出,比静默生成错误代码强得多
生成前校验路径与覆盖风险,别让 os.WriteFile 覆盖掉手写的逻辑
os.WriteFile("user.go", data, 0644) 这一行,既是核心,也是事故高发点。没人希望早上运行一次生成器,下午发现 user.go 里手写的 Validate() 方法没了。
实操建议:
- 默认不覆盖已有文件,而是写到临时路径(如
user.go.gen),用diff -u user.go user.go.gen提示用户检查 - 加一个
--force标志才允许覆盖,且覆盖前先备份原文件为user.go.bak - 生成目标路径必须显式声明,禁止相对路径模糊匹配(比如
./models/**/*.go),防止误删 - 在模板顶部加一行生成标记:
// Code generated by go-generate-tool v0.2.1; DO NOT EDIT.,配合go:generate注释一起用,后续可用脚本过滤掉这些文件做 lint
最难的不是写出第一个 template.Execute,而是设计出能随业务演进的 schema 描述方式——比如要不要支持字段级钩子(pre-create / post-update)、是否预留扩展字段(Extra map[string]any)、生成的文件要不要按 domain 分包。这些决策一旦定下,改起来比重写模板还费劲。


















