Go 的 text/template 是生成 YAML 等配置的首选,需精确使用 {{- }} 控制空白、预处理环境变量为结构体、按环境分离配置数据、禁用 html/template 以防转义破坏格式。

Go 的 text/template 和 html/template 足够轻量、安全且可控,是生成部署配置(如 YAML、JSON、Docker Compose、K8s manifests)最稳妥的选择——不依赖外部模板引擎,编译期检查变量引用,还能通过自定义函数注入环境逻辑。
用 text/template 渲染 YAML 配置时,缩进和换行容易错乱
YAML 对空格敏感,而 Go 模板默认会保留所有空白符,导致渲染出的 YAML 缩进错位、解析失败。关键不是“怎么写模板”,而是“怎么控制空白”。{{- }} 和 {{- }}{{- }} 这类裁剪语法必须精确到每个分隔符位置。
- 模板中每行开头/结尾的空白(包括换行符)默认原样输出,需手动用
{{- }}去掉左侧空白,{{- }}去掉右侧空白 - 对多行结构(如 YAML 的 list 或 map),推荐把整个块写在单个
{{ range }}或{{ with }}内,避免模板指令穿插破坏缩进 - 不要用
strings.ReplaceAll后处理 YAML 字符串——会破坏字面量引号、转义和注释
func renderYAML() {
tmpl := `apiVersion: v1
kind: ConfigMap
metadata:
name: {{.Name | quote}}
data:
{{- range $k, $v := .Data }}
{{ $k | quote }}: {{ $v | quote }}
{{- end }}
`
t := template.Must(template.New("cm").Funcs(template.FuncMap{
"quote": func(s string) string { return fmt.Sprintf("%q", s) },
}).Parse(tmpl))
data := map[string]interface{}{
"Name": "app-config",
"Data": map[string]string{"LOG_LEVEL": "debug", "TIMEOUT": "30s"},
}
t.Execute(os.Stdout, data)}
如何安全注入环境变量或运行时值,又不破坏模板隔离性
直接在 Execute 时传入 os.Getenv 结果是危险的:无法做类型校验、缺失值不报错、测试难 mock。正确做法是预处理数据结构,把环境变量作为输入参数的一部分,而非在模板里调用 .Env.FOO。
立即学习“go语言免费学习笔记(深入)”;
- 定义明确的配置结构体(如
type Config struct { Name, Region, Replicas int }),用mapstructure或encoding/json解析环境变量或 JSON 文件填充它 - 禁止在模板中使用
index .Env "FOO"—— 这会让模板承担配置校验职责,且.Env是 map[string]string,无法表达嵌套或数字类型 - 若需动态计算(如
service-name-{{.Replicas}}),应在 Go 层完成拼接后传入,而不是让模板做字符串操作
生成 K8s manifest 时,如何复用同一套模板支持多环境(dev/staging/prod)
靠 if 判断环境名({{if eq .Env "prod"}})会导致模板臃肿、难以维护。更可持续的方式是:模板只负责结构,环境差异收口到输入数据中。
- 为每个环境准备独立的配置源(如
config.dev.yaml,config.prod.yaml),用yaml.Unmarshal解析为统一结构体 - 模板内只访问字段(如
{{.Resources.Limits.Memory}}),不出现环境名判断逻辑 - 如果某些字段仅在特定环境存在,结构体中设为指针(
*string)或使用omitempty标签,模板中用{{with .SomeField}}安全展开
为什么不用 html/template 渲染非 HTML 配置
html/template 默认启用自动转义(如把 变成 zuojiankuohaophpcn),对 YAML/JSON 是灾难性的。即使调用 {{.Raw | safeHTML}},也仅限 HTML 场景,且 safeHTML 不适用于 YAML 中的 key: value 这类合法符号。
- 始终优先选
text/template;只有生成 HTML 页面才用html/template -
text/template不做任何转义,完全由你控制输出内容,适合配置生成场景 - 若需防注入(比如用户输入作为模板变量),应在 Go 层过滤/校验输入值,而非依赖模板转义
真正难的不是写模板,而是设计可扩展的数据结构和清晰的配置加载流程——模板只是最后一步;一旦把环境差异、类型约束、缺失字段处理都推给模板,后续加一个新环境就会变成改一堆 {{if}} 嵌套。










