
text/template 生成代码时变量未被替换?检查模板语法和数据传入方式
go 的 text/template 默认不会执行任何逻辑,变量不渲染几乎全是「数据没传对」或「语法写错」导致的。最常见的是用 {{.FieldName}} 访问结构体字段,但传入的是 map 或基础类型;或者结构体字段没导出(首字母小写),模板根本访问不到。
- 确保传给
Execute的数据是导出类型:结构体字段必须大写开头,如type GenConfig Struct { Name String } - 别直接传
string或int给模板——除非你用{{.}},否则字段访问会静默失败 - 调试时先加
{{printf "%#v" .}}看实际传入结构,比猜快得多 - 注意
template.New和Parse后必须用同一个*template.Template实例调用Execute,跨实例会导致「模板未定义」错误
生成 Go 源码时缩进混乱、换行丢失?用 {{- }} 和 {{- $var -}} 控制空白
模板默认保留所有换行和空格,生成的 Go 代码容易缩进错乱、多出空行,甚至因换行符位置不对导致编译失败。这不是 bug,是设计行为——text/template 把空白当普通文本处理。
-
{{- }}去掉前面的空白(含换行),{{- .Name}}不会在变量前加换行 -
{{.Name -}}去掉后面的空白,{{- .Name -}}前后都去,适合写在 if/else 块里保持缩进干净 - 避免在模板中手动拼接
n或空格,靠-控制更可靠 - 如果生成的是多行结构(如 struct 定义),建议把每行写成独立模板语句,用
{{- if .Fields}}...{{end -}}包裹,而不是塞进一行
模板里需要条件判断或循环生成字段?用 {{if}} 和 {{range}},但注意作用域变化
生成代码常要根据输入动态决定是否加字段、加方法或加 import。Go 模板支持 {{if}} 和 {{range}},但它们会改变 . 的含义,容易误读上下文。
-
{{range .Methods}}会让.变成当前遍历项,原结构体字段就不可见了;需用{{$root := .}}{{range .Methods}}...{{$root.Name}}{{end}}保存根对象 -
{{if .HasError}}判布尔值没问题,但判非空切片要用{{if len .Imports}}或提前在数据层转成布尔字段,模板里不支持函数链式调用 - 避免在
{{range}}里嵌套太多层级,可提前在 Go 层组装好扁平数据,比在模板里反复$parent引用更清晰 - import 列表生成常用
{{range .Imports}}{{printf " "%s"" .}}{{end}},注意引号和空格位置,否则生成的 import 语句非法
生成的代码编译失败?检查模板输出是否含不可见字符或非法符号
模板输出肉眼看着正常,但 Go 编译器报 syntax error: unexpected newline 或 invalid character U+00A0,大概率是模板混入了全角空格、bom、或 windows 换行符(rn)。Go 源码只认 n,且严禁 UTF-8 BOM。
立即学习“go语言免费学习笔记(深入)”;
- 用
file -i template.tmpl检查模板文件编码,确保是 UTF-8 无 BOM - 生成后用
hexdump -C output.go | head看开头是否有ef bb bf(BOM) - 不要在模板里写
func {{.Name}}() {这种裸大括号,Go 要求{必须和 func 在同一行,用func {{.Name}}() {并配合{{- }}控制换行 - 如果生成带注释的代码,确保
//后有空格,{{"// "}}{{.Desc}}比//{{.Desc}}更安全
真正麻烦的不是语法写不对,而是生成逻辑和 Go 编译约束之间的隐性冲突——比如字段名含数字、模板意外输出空行导致函数签名断开、或 range 遍历时漏了 - 导致缩进塌陷。这些细节不报错,但生成的代码跑不起来。