解锁Golang模板的力量：动态文本生成的初学者指南

开发运维 2023-08-30 张二河手机阅读

Golang Template

Go语言中的Go Template是一种用于生成文本输出的简单而强大的模板引擎。它提供了一种灵活的方式来生成各种格式的文本，例如HTML、XML、JSON等。

Go Template具有以下主要特性：

简洁易用：Go Template语法简洁而易于理解。它使用一对双大括号“{{}}”来标记模板的占位符和控制结构。这种简单的语法使得模板的编写和维护变得非常方便。

数据驱动：Go Template支持数据驱动的模板生成。你可以将数据结构传递给模板，并在模板中使用点号“.”来引用数据的字段和方法。这种数据驱动的方式使得模板可以根据不同的数据动态生成输出。

条件和循环：Go Template提供了条件语句和循环语句，使得你可以根据条件和迭代来控制模板的输出。你可以使用“if”、“else”、“range”等关键字来实现条件判断和循环迭代，从而生成灵活的输出。

过滤器和函数：Go Template支持过滤器和函数，用于对数据进行转换和处理。你可以使用内置的过滤器来格式化数据，例如日期格式化、字符串截断等。此外，你还可以定义自己的函数，并在模板中调用这些函数来实现更复杂的逻辑和操作。

嵌套模板：Go Template支持模板的嵌套，允许你在一个模板中包含其他模板。这种模板的组合和嵌套机制可以帮助你构建更大型、更复杂的模板结构，提高代码的可重用性和可维护性。

在很多Go开发的工具、项目都大量使用了template模板。例如: Helm,K8s,Prometheus,以及一些code-gen代码生成器等等。Go template提供了一种模板机制，通过预声明模板，传入自定义数据来灵活定制各种文本。

1.示例

我们通过一个示例来了解一下template的基本使用。

首先声明一段模板

var md = `Hello,{{ . }}`

解析模板并执行

func main() {
 tpl := template.Must(template.New("first").Parse(md))
 if err := tpl.Execute(os.Stdout, "Jack"); err != nil {
  log.Fatal(err)
 }
}

// 输出
// Hello Jack

在上述例子中, {{ . }}前后花括号属于分界符,template会对分界符内的数据进行解析填充。其中 .代表当前对象，这种概念在很多语言中都存在。

在main函数中，我们通过template.New创建一个名为"first"的template，并用此template进行Parse解析模板。随后，再进行执行：传入io.Writer,data，template会将数据填充至解析的模板中，再输出到传入的io.Writer上。

我们再来看一个例子

// {{ .xxoo -}} 删除右侧的空白
var md = `个人信息:
姓名: {{ .Name }}
年龄: {{ .Age }}
爱好: {{ .Hobby -}}
`

type People struct {
 Name string
 Age  int
}

func (p People) Hobby() string {
 return "唱,跳,rap,篮球"
}

func main() {

 tpl := template.Must(template.New("first").Parse(md))
 p := People{
  Name: "Jackson",
  Age:  20,
 }
 if err := tpl.Execute(os.Stdout, p); err != nil {
  log.Fatal(err)
 }
}

// 输出
//个人信息:
//姓名: Jackson       
//年龄: 20            
//爱好: 唱,跳,rap,篮球

Hobby属于People的方法，所以在模板中也可以通过.进行调用。需要注意: 不管是字段还是方法，由于template实际解析的包与当前包不同，无论是字段还是方法必须是导出的。

在template中解析时，它移除了 {{ 和 }} 里面的内容，但是留下的空白完全保持原样。所以解析出来的时候，我们需要对空白进行控制。YAML认为空白是有意义的，因此管理空白变得很重要。我们可以通过-进行控制空白。

{{- (包括添加的横杠和空格)表示向左删除空白，而 -}}表示右边的空格应该被去掉。