当前位置: 首页 > news >正文

Go text/template详解:使用指南与最佳实践

I. 简介

A. 什么是 Go text/template

Go text/template 是 Go 语言标准库中的一个模板引擎,用于生成文本输出。它使用类似于 HTML 的模板语言,可以将数据和模板结合起来,生成最终的文本输出。

B. Go text/template 的优点

Go text/template 具有以下优点:

  • 简单易用:使用类似于 HTML 的模板语言,易于学习和使用。
  • 安全可靠:支持自动转义,避免了 XSS 攻击等安全问题。
  • 高效性能:使用模板缓存和预编译技术,提高了渲染效率。
  • 灵活可扩展:支持自定义函数和控制结构,可以满足各种需求。

C. Go text/template 的应用场景

Go text/template 可以用于生成各种类型的文本输出,例如 HTML、XML、JSON、Markdown、Golang 等。它适用于以下场景:

  • Web 应用程序:可以用于生成动态网页、邮件模板、报表等。
  • 命令行工具:可以用于生成文本报告、配置文件等。
  • 数据处理:可以用于生成数据文件、日志文件等。
  • 代码生成:用于动态生成代码等。

II. 模板语法

A. 变量

在 Go text/template 中,变量由双大括号 {{ 和 }} 包围,例如 {{.Name}} 表示一个名为 Name 的变量。变量可以是结构体、数组、切片、映射等类型,也可以是自定义类型。

  1. 变量定义

在模板中,可以使用{{$}}语句定义一个变量,如下所示:

{{$name :="qqxhb"}}

这个语句定义了一个名为"name"的变量,其值为"qqxhb"。在模板中,可以使用{{$变量名}}语句来引用这个变量,如下所示:

{{$name}}

这个语句会输出"qqxhb"。

  1. 变量赋值

在模板中,可以使用{{$}}语句给变量赋值,和定义的区别是没有冒号如下所示:

{{$name ="qqxhb"}}

这个语句将字符串"qqxhb"赋值给变量,然后使用{{$name}}输出变量的值,即"qqxhb"。

  1. 变量操作

在模板中,可以使用{{range}}语句遍历一个变量的值,如下所示:

{{range .Names}}{{.}}{{end}}

这个语句表示遍历"Names"变量的值,并输出每个值。

  1. 变量函数

在模板中,可以使用内置函数来操作变量,如下所示:

{{len .Names}}

这个语句表示获取"Names"变量的长度,并输出它的值。
Go text/template提供了丰富的变量操作功能,可以用于生成各种文本格式的输出。通过上述示例,可以更好地理解和掌握Go text/template中变量的使用方法。

B. 控制结构

Go text/template 支持多种控制结构,例如 if、range、with 等。这些控制结构可以用于条件判断、循环迭代、变量作用域等。if和range是两个非常常用的控制结构,下面是关于Go text/template中if和range的详细用法:

  1. if语句

if语句用于根据条件判断是否输出某个内容。if语句的语法如下:

{{if .Condition}}...{{end}}

其中,“.Condition"表示一个条件表达式,如果该表达式的值为true,则输出”…"中的内容。

示例:

{{if .Name}}Hello, {{.Name}}{{end}}

这个语句表示如果"Name"变量的值不为空,则输出"Hello, "和"Name"变量的值。
除了判断空这种场景,我们更多的可能是判断等和不等。在Go text/template 中用于等式与不等式判断的函数主要有以下六种(均接受两个,分别名为 arg1 和 arg2 的参数):

eq:当等式 arg1 == arg2 成立时,返回 true,否则返回 false
ne:当不等式 arg1 != arg2 成立时,返回 true,否则返回 false
lt:当不等式 arg1 < arg2 成立时,返回 true,否则返回 false
le:当不等式 arg1 <= arg2 成立时,返回 true,否则返回 false
gt:当不等式 arg1 > arg2 成立时,返回 true,否则返回 false
ge:当不等式 arg1 >= arg2 成立时,返回 true,否则返回 false

示例:

{{if eq $age1 $age2}}年龄相同
{{else}}年龄不相同
{{end}}

或者是组合条件,如:

{{if and (eq $status 1) (ne $title "")}}上架
{{else}}下架
{{end}}
  1. range语句

range语句用于遍历一个数组、切片、映射或通道,并输出其中的每个元素。range语句的语法如下:

{{range .Array}}...{{end}}
{{range .Slice}}...{{end}}
{{range .Map}}...{{end}}
{{range .Channel}}...{{end}}

其中,“.Array”、“.Slice”、“.Map"和”.Channel"分别表示一个数组、切片、映射和通道。"…"中的内容表示遍历到的每个元素。

示例:

{{range .Names}}Hello, {{.}}!{{end}}

这个语句表示遍历"Names"变量的值,并输出"Hello, "和每个值。
遍历也支持两个参数,和go一样有索引遍历,如:

{{range $i, $name := .Names}}{{$i}}. {{$name}}
{{end}}
  1. with语句

在模板中,with语句用于设置当前上下文中的变量,下面是关于Go text/template中with的详细用法:

  • with语句

with语句用于设置当前上下文中的变量,使得在该语句块中可以直接使用该变量。with语句的语法如下:

{{with .Variable}}...{{end}}

其中,“.Variable"表示一个变量,”…"中的内容表示在该语句块中可以直接使用该变量。

示例:

{{with .Person}}
Name: {{.Name}}
Age: {{.Age}}
{{end}}

这个语句表示设置当前上下文中的变量为"Person",并在该语句块中可以直接使用"Person"变量中的"Name"、"Age"等字段。

  • with-else语句

with-else语句用于根据条件判断是否设置当前上下文中的变量。with-else语句的语法如下:

{{with .Variable}}...{{else}}...{{end}}

其中,“.Variable"表示一个变量,如果该变量的值不为空,则设置当前上下文中的变量为该变量,”…“中的内容表示在该语句块中可以直接使用该变量;否则输出"else"后面的”…"中的内容。

示例:

{{with .Person}}{{.Name}}{{else}}Unknown{{end}}

这个语句表示如果"Person"变量的值不为空,则设置当前上下文中的变量为"Person",并输出"Person"变量中的"Name"字段;否则输出"Unknown"。

C. 函数

Go text/template 内置了一些常用的函数,例如 len、range、printf 等。同时,也支持自定义函数,可以通过 Funcs() 方法注册自定义函数,或者是某个结构的方法。在模板中,函数是一种非常重要的元素,可以用于操作变量、格式化输出等。下面是关于Go text/template中函数的详细用法,包括自定义函数和结构体方法:

  1. 内置函数

Go text/template中内置了一些常用的函数,如下所示:

  • len:返回一个字符串、数组、切片、映射或通道的长度。
  • index:返回一个字符串、数组或切片中指定位置的元素。
  • printf:根据格式字符串输出格式化的字符串。
  • range:遍历一个数组、切片、映射或通道,并输出其中的每个元素。
  • with:设置当前上下文中的变量。

示例:

{{len .Names}}
{{index .Names 0}}
{{printf "%d" .Age}}
{{range .Names}}{{.}}{{end}}
{{with .Person}}{{.Name}}{{end}}

这些语句分别表示获取"Names"变量的长度、获取"Names"变量中的第一个元素、格式化输出"Age"变量的值、遍历"Names"变量的值并输出每个值、设置当前上下文中的变量为"Person"并输出"Person"变量中的"Name"字段。

  1. 自定义函数

除了内置函数外,还可以自定义函数来操作变量、格式化输出等。自定义函数的语法如下:

{{funcName arg1 arg2 ...}}

其中,"funcName"表示函数名,“arg1”、"arg2"等表示函数的参数。

示例:

{{upper .Name}}

这个语句表示调用名为"upper"的自定义函数,将"Name"变量的值转换为大写字母并输出。

自定义函数需要在模板执行之前注册,可以使用text/template包中的Funcs方法来注册自定义函数,示例代码如下:

func upper(s string) string {return strings.ToUpper(s)
}t := template.New("test").Funcs(template.FuncMap{"upper": upper,
})

这个代码片段定义了一个名为"upper"的自定义函数,并将其注册到名为"test"的模板中。

  1. 结构体方法

除了自定义函数外,还可以使用结构体方法来操作变量、格式化输出等。结构体方法的语法如下:

{{.Variable.Method arg1 arg2 ...}}

其中,".Variable"表示一个变量,"Method"表示该变量的一个方法,“arg1”、"arg2"等表示方法的参数。

示例:

{{.Person.GetName}}

这个语句表示调用"Person"变量的"GetName"方法,并输出该方法的返回值。

结构体方法不需要在模板执行之前注册,只需要在结构体定义即可,然后用结构体作为模版参数,代码如下:

type Person struct {Name string
}func (p Person) GetName() string {return p.Name
}t := template.New("test")
t.Parse(&buf,&Person{})

这个代码片段定义了一个名为"Person"的结构体,并在该结构体中定义了一个名为"GetName"的方法。

D. 注释

在模板中,注释是一种非常重要的元素,可以用于注释模板中的代码,方便代码的维护和阅读。下面是关于Go text/template中注释的详细用法:

  1. 单行注释

单行注释用于注释一行代码,其语法如下:

{{/* This is a comment */}}

其中,"/“和”/"表示注释的开始和结束,"This is a comment"表示注释的内容。

示例:

{{/* This is a comment */}}Hello, {{.Name}}!

这个语句表示注释"Hello, {{.Name}}!"这一行代码。

  1. 多行注释

多行注释用于注释多行代码,其语法如下:

{{- /* This is a comment
on multiple lines */ -}}

其中,"{{- “和” -}}"表示注释的开始和结束,“This is a comment on multiple lines"表示注释的内容。需要注意的是,注释内容前后的空格会被保留,如果不想保留空格,可以在注释开始和结束标记中使用”-"符号。

示例:

{{- /* This is a comment
on multiple lines */ -}}
Hello, {{.Name}}!

这个语句表示注释"Hello, {{.Name}}!"这一行代码,并且注释内容跨越了多行。

III. 模板解析和渲染

A. 解析模板

使用 template.New() 函数创建一个新的模板对象,然后使用 Parse() 方法解析模板字符串。如果模板字符串中包含多个模板,可以使用 ParseFiles() 或 ParseGlob() 方法解析多个模板文件。
在Go语言中,使用text/template包创建和解析模板非常简单。下面是关于Go text/template模板创建和解析注释的详细用法:

在Go text/template中,可以使用New函数创建一个新的模板对象,示例代码如下:

t := template.New("test")

其中,"test"表示模板的名称,可以根据实际情况进行修改。

B. 渲染模板

使用 Execute() 方法渲染模板,并将结果输出到指定的 io.Writer 中。如果模板需要接收参数,可以将参数传递给 Execute() 方法。

err := t.Execute(os.Stdout, map[string]string{"Name": "World"})

其中,"os.Stdout"表示输出流,"map[string]string{“Name”: “World”}"表示模板中的变量。

C. 模板缓存

text/template 支持模板缓存,可以提高模板渲染的效率。使用 template.Must() 函数可以创建一个带有模板缓存的模板对象,如果解析模板失败,会直接 panic。

IV. 最佳实践

A. 模板设计原则

在设计模板时,应该遵循以下原则:

  • 简洁明了:模板应该尽量简洁明了,避免过多的嵌套和复杂的控制结构。
  • 可维护性:模板应该易于维护和修改,避免出现重复的代码和逻辑。
  • 可扩展性:模板应该具有一定的扩展性,可以通过自定义函数和控制结构满足各种需求。

B. 模板性能优化

在优化模板性能时,应该注意以下几点:

  • 使用模板缓存:使用 template.Must() 函数创建一个带有模板缓存的模板对象,可以提高模板渲染的效率。
  • 避免重复解析:避免在每次渲染模板时都重新解析模板,可以将模板解析放在初始化阶段。
  • 减少模板变量:减少模板中的变量数量,可以提高模板渲染的效率。

C. 模板安全性

在使用模板时,应该注意以下安全问题:

  • 避免 XSS 攻击:使用自动转义功能,避免输出恶意脚本和标签。
  • 避免注入攻击:避免将用户输入作为模板变量,可以使用模板函数进行转义和过滤。

V. 总结

Go text/template 是一个简单易用、安全可靠、高效性能、灵活可扩展的模板引擎,适用于生成各种类型的文本输出。在使用模板时,应该遵循最佳实践,注意模板设计原则、模板性能优化和模板安全性。

Tips: 欢迎评论区讨论,你想要的或者你知道的其他用法哦!!!

相关文章:

Go text/template详解:使用指南与最佳实践

I. 简介 A. 什么是 Go text/template Go text/template 是 Go 语言标准库中的一个模板引擎&#xff0c;用于生成文本输出。它使用类似于 HTML 的模板语言&#xff0c;可以将数据和模板结合起来&#xff0c;生成最终的文本输出。 B. Go text/template 的优点 Go text/templa…...

Stable Diffusion在各种显卡上的加速方式测试,最高可以提速211.2%

Stable Diffusion是一种基于扩散模型的图像生成技术&#xff0c;能够从文本生成高质量的图像&#xff0c;适用于CG&#xff0c;插图和高分辨率壁纸等领域。 但是它计算过程复杂&#xff0c;使得它的生成速度较慢。所以研究人员就创造了各种提高其速度的方式&#xff0c;比如Xf…...

Java读取外链图片忽略ssl验证转为base64

最近在对接外部接口时遇到返回的图片所在的服务器全都没有ssl证书&#xff0c;导致在前端直接用img标签展示时图片开裂。于是转为通过后端获取&#xff0c;绕过ssl验证之后转为base64返回。记录一下代码段。 package com.sy.ai.common.utils;import cn.hutool.core.codec.Base…...

系统架构设计师 10:软件架构的演化和维护

一、软件架构演化 如果软件架构的定义是 SA{components, connectors, constraints}&#xff0c;也就是说&#xff0c;软件架构包括组件、连接件和约束三大要素&#xff0c;这类软件架构演化主要关注的就是组件、连接件和约束的添加、修改与删除等。 二、面向对象软件架构演化…...

Windows 11 绕过 TPM 方法总结,通用免 TPM 镜像下载 (2023 年 7 月更新)

Windows 11 绕过 TPM 方法总结&#xff0c;通用免 TPM 镜像下载 (2023 年 7 月更新) 在虚拟机、Mac 电脑和 TPM 不符合要求的旧电脑上安装 Windows 11 的通用方法总结 请访问原文链接&#xff1a;https://sysin.org/blog/windows-11-no-tpm/&#xff0c;查看最新版。原创作品…...

EXCEL,如何比较2个表里的数据差异(使用数据透视表)

目录 1 问题: 需要比较如下2个表的内容差异 1.1 原始数据喝问题 1.2 提前总结 2 使用EXCEL公式方法 2.1 新增辅助列&#xff1a; 辅助index 2.2 具体公式 配合条件格式 使用 3 数据透视表方法 3.1 新增辅助列&#xff1a; 辅助index 3.2 需要先打开 数据透视表向导 …...

字节抖音小程序,使用 uniapp 调起内置支付

字节抖音小程序&#xff0c;使用 uniapp 调起内置支付 第一步&#xff1a;提交订单 后端通过抖音预下单接口&#xff0c;提交支付订单信息。 预下单接口_小程序_抖音开放平台预下单接口 提交支付订单信息。 ## 使用限制 无 ## 接口说明 预下单接口需要保证同一app_id下每笔订…...

django模板继承和组件了解

1、模板继承 什么时候需要用到模板呢&#xff0c;比如我们在开发的页面的导航栏&#xff0c;你点不同的功能页面这个导航栏都是一样的&#xff0c;如果每个页面都要加上这个导航条会写重复代码&#xff0c;而且如果导航条有变化&#xff0c;每个页面都要修改&#xff0c;这个是…...

首屏优化,给以图片为背景的元素增加相似背景,优化用户体验,background-image 绘制规则

每日鸡汤&#xff1a;每个你想要学习的瞬间都是未来的你向自己求救 假设你的项目首页有个大大的图片作为背景&#xff0c;那么这个图片肯定会在网络不好的时候加载出来很慢&#xff0c;导致用户回看到一大片白屏&#xff0c;这样很影响体验。这也是老生常谈的首屏优化的问题。例…...

【用户体验分析报告】 按需加载组件,导致组件渲染卡顿,影响交互体验?组件拆包预加载方案来了!

首先&#xff0c;我们看一些针对《如何提升应用首屏加载体验》的文章&#xff0c;提到的必不可少的措施&#xff0c;便是减少首屏幕加载资源的大小&#xff0c;而减少资源大小必然会想到按需加载措施。本文提到的便是一个基于webpack 插件与 react 组件实现的一套研发高度自定义…...

idea 关闭页面右侧预览框/预览条

idea 关闭页面右侧预览框 如图&#xff0c;预览框存在想去除 找了好多方法&#xff0c;什么去掉“setting->appearance里的show editor preview tooltips”的对钩&#xff1b;又或者在该预览区的滚动条上右键&#xff0c;“取消勾选show code lens on scrollbar hover”。都…...

CSS3 Flexbox

Flex 是 Flexible Box 的缩写&#xff0c;意为弹性盒子布局。 CSS3中一种新的布局模式&#xff1a;W3C在2009年提出的一种布局方案&#xff0c;一种当页面需要适应不同的屏幕大小以及设备类型时确保元素拥有恰当的行为的布局方式。其目的是提供一种更加有效的方式来对一个容器…...

东南大学轴承故障诊断(Python代码,CNN模型,适合复合故障诊断研究)

运行代码要求&#xff1a; 代码运行环境要求&#xff1a;Keras版本>2.4.0&#xff0c;python版本>3.6.0 本次实验主要是在两种不同工况数据下&#xff0c;进行带有复合故障的诊断实验&#xff0c;没有复合故障的诊断实验。 实验结果证明&#xff0c;针对具有复合故障的…...

ubuntu--Motrix

Motrix官网 https://motrix.app/ 适用于windows和ubuntu 资源链接 链接: https://pan.baidu.com/s/16ka-w30BXJn066absXJXCA 密码: cds2 下载上面的资源&#xff0c;打开终端&#xff0c;安装Motrix sudo dpkg -i XXX.deb 在ubuntu安装好chrome&#xff0c;然后打开设置中…...

PHP 3des加解密新旧方法可对接加密

一、旧3des加解密方法 <?php class Encrypt_3DES {//加密秘钥&#xff0c;private $_key;private $_iv;public function __construct($key, $iv){$this->_key $key;$this->_iv $iv;}/*** 对字符串进行3DES加密* param string 要加密的字符串* return mixed 加密成…...

【朴素贝叶斯-新闻主题分类】

朴素贝叶斯对新闻进行分类 朴素贝叶斯算法是一种常用的文本分类方法&#xff0c;特别适用于自然语言处理任务&#xff0c;如新闻分类。在这篇博客中&#xff0c;我们将使用Python的scikit-learn库来实现朴素贝叶斯算法&#xff0c;并将其应用于新闻分类任务。 数据准备 首先…...

安卓面试问题记录

目录 1. JNI和NDK1.谈谈你对JNI和NDK的理解2.简要的JNI调用过程:2. 线程、同步、异步1.Java创建线程的方式有几种?start()方法和 run()方法的区别2.Handler 机制和原理3.为什么在子线程中创建Handler会抛异常?4.Android中的ANR的解决方法5.intentservice有什么优点?6.okhtt…...

php-golang-jsonrpc2.0 rpc-codec/jsonrpc2和tivoka/tivoka实践

golang代码&#xff1a; package main import ( "context" "net" "net/rpc" "github.com/powerman/rpc-codec/jsonrpc2" ) type App struct{} type Res struct { Code int json:"code" Msg string json:"msg&quo…...

听力词汇笔记(6级)

2022年9月六级 1.personality traits:人格特征 2.all of this notwithstanding:尽管如此 3.come under&#xff1a;受到 4.scrutiny&#xff1a;关注 5.highly responsive to:对....高度敏感 6.preteen year:青春期前 7.susceptible to:受....影响 8.take sharp preced…...

【JVM】详细解析java创建对象的具体流程

目录 一、java创建对象的几种方式 1.1、使用new关键字 1.2、反射创建对象 1.2.1、Class.newInstance创建对象 1.2.2、调用构造器再去创建对象Constructor.newInstance 1.3、clone实现 1.4、反序列化 二、创建对象的过程 2.1、分配空间的方式 1、指针碰撞 2、空闲列表 …...

浅谈 React Hooks

React Hooks 是 React 16.8 引入的一组 API&#xff0c;用于在函数组件中使用 state 和其他 React 特性&#xff08;例如生命周期方法、context 等&#xff09;。Hooks 通过简洁的函数接口&#xff0c;解决了状态与 UI 的高度解耦&#xff0c;通过函数式编程范式实现更灵活 Rea…...

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器的上位机配置操作说明

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器专为工业环境精心打造&#xff0c;完美适配AGV和无人叉车。同时&#xff0c;集成以太网与语音合成技术&#xff0c;为各类高级系统&#xff08;如MES、调度系统、库位管理、立库等&#xff09;提供高效便捷的语音交互体验。 L…...

Golang 面试经典题:map 的 key 可以是什么类型?哪些不可以?

Golang 面试经典题&#xff1a;map 的 key 可以是什么类型&#xff1f;哪些不可以&#xff1f; 在 Golang 的面试中&#xff0c;map 类型的使用是一个常见的考点&#xff0c;其中对 key 类型的合法性 是一道常被提及的基础却很容易被忽视的问题。本文将带你深入理解 Golang 中…...

电脑插入多块移动硬盘后经常出现卡顿和蓝屏

当电脑在插入多块移动硬盘后频繁出现卡顿和蓝屏问题时&#xff0c;可能涉及硬件资源冲突、驱动兼容性、供电不足或系统设置等多方面原因。以下是逐步排查和解决方案&#xff1a; 1. 检查电源供电问题 问题原因&#xff1a;多块移动硬盘同时运行可能导致USB接口供电不足&#x…...

c++ 面试题(1)-----深度优先搜索(DFS)实现

操作系统&#xff1a;ubuntu22.04 IDE:Visual Studio Code 编程语言&#xff1a;C11 题目描述 地上有一个 m 行 n 列的方格&#xff0c;从坐标 [0,0] 起始。一个机器人可以从某一格移动到上下左右四个格子&#xff0c;但不能进入行坐标和列坐标的数位之和大于 k 的格子。 例…...

2021-03-15 iview一些问题

1.iview 在使用tree组件时&#xff0c;发现没有set类的方法&#xff0c;只有get&#xff0c;那么要改变tree值&#xff0c;只能遍历treeData&#xff0c;递归修改treeData的checked&#xff0c;发现无法更改&#xff0c;原因在于check模式下&#xff0c;子元素的勾选状态跟父节…...

Qt Http Server模块功能及架构

Qt Http Server 是 Qt 6.0 中引入的一个新模块&#xff0c;它提供了一个轻量级的 HTTP 服务器实现&#xff0c;主要用于构建基于 HTTP 的应用程序和服务。 功能介绍&#xff1a; 主要功能 HTTP服务器功能&#xff1a; 支持 HTTP/1.1 协议 简单的请求/响应处理模型 支持 GET…...

高效线程安全的单例模式:Python 中的懒加载与自定义初始化参数

高效线程安全的单例模式:Python 中的懒加载与自定义初始化参数 在软件开发中,单例模式(Singleton Pattern)是一种常见的设计模式,确保一个类仅有一个实例,并提供一个全局访问点。在多线程环境下,实现单例模式时需要注意线程安全问题,以防止多个线程同时创建实例,导致…...

Aspose.PDF 限制绕过方案:Java 字节码技术实战分享(仅供学习)

Aspose.PDF 限制绕过方案&#xff1a;Java 字节码技术实战分享&#xff08;仅供学习&#xff09; 一、Aspose.PDF 简介二、说明&#xff08;⚠️仅供学习与研究使用&#xff09;三、技术流程总览四、准备工作1. 下载 Jar 包2. Maven 项目依赖配置 五、字节码修改实现代码&#…...

C++课设:简易日历程序(支持传统节假日 + 二十四节气 + 个人纪念日管理)

名人说:路漫漫其修远兮,吾将上下而求索。—— 屈原《离骚》 创作者:Code_流苏(CSDN)(一个喜欢古诗词和编程的Coder😊) 专栏介绍:《编程项目实战》 目录 一、为什么要开发一个日历程序?1. 深入理解时间算法2. 练习面向对象设计3. 学习数据结构应用二、核心算法深度解析…...