Searching...

[TOC]

基本函数

变量可以使用符号 | 在函数间传递

{{.value | Func1 | Func2}}

使用括号

{{printf "nums is %s %d" (printf "%d %d" 1 2) 3}}

and

{{and .X .Y .Z}}

and会逐一判断每个参数,将返回第一个为空的参数,否则就返回最后一个非空参数

call

{{call .Field.Func .Arg1 .Arg2}}

call可以调用函数,并传入参数

调用的函数需要返回 1 个值 或者 2 个值,返回两个值时,第二个值用于返回error类型的错误。返回的错误不等于nil时,执行将终止。

index

index支持map, slice, array, string,读取指定类型对应下标的值。

{{index .Maps "name"}}

len

{{printf "The content length is %d" (.Content|len)}}

返回对应类型的长度,支持类型:map, slice, array, string, chan

not

not返回输入参数的否定值。

例如,判断是否变量是否为空:

{{if not .Var}}
// 执行为空操作(.Var为空, 如: nil, 0, "", 长度为0的slice/map)
{{else}}
// 执行非空操作(.Var不为空)
{{end}}

or

{{or .X .Y .Z}}

or会逐一判断每个参数,将返回第一个非空的参数,否则就返回最后一个参数。

print

fmt.Sprint

printf

fmt.Sprintf

println

fmt.Sprintln

urlquery

{{urlquery "http://johng.cn"}}

将返回

http%3A%2F%2Fjohng.cn

eq / ne / lt / le / gt / ge

这类函数一般配合在if中使用

`eq`: arg1 == arg2
`ne`: arg1 != arg2
`lt`: arg1 < arg2
`le`: arg1 <= arg2
`gt`: arg1 > arg2
`ge`: arg1 >= arg2

eq和其他函数不一样的地方是,支持多个参数。

{{eq arg1 arg2 arg3 arg4}}

和下面的逻辑判断相同:

arg1==arg2 || arg1==arg3 || arg1==arg4 ...

if一起使用

{{if eq true .Var1 .Var2 .Var3}}...{{end}}
{{if lt 100 200}}...{{end}}

例如,判断变量不为空时执行:

{{if .Var}}
// 执行非空操作(.Var不为空)
{{else}}
// 执行为空操作(.Var为空, 如: nil, 0, "", 长度为0的slice/map)
{{end}}

对比函数改进

GF框架模板引擎对标准库自带的对比模板函数eq/ne/lt/le/gt/ge做了必要的改进,以便支持任意数据类型的比较。例如,在标准库模板中的以下比较:

{{eq 1 "1"}}

将会引发错误:

panic: template: at <eq 1 "1">: error calling eq: incompatible types for comparison

由于比较的两个参数不是同一数据类型,因此引发了panic错误。

GF框架的模板引擎中,将会自动将两个参数进行数据转换,转换为同一类型后再进行比较,这样的开发体验更好、灵活性更高。如果两个参数均为整型变量(或者整型字符串),那么将会转换为整型进行比较,否则转换为字符串变量进行比较(区分大小写)。

改进运行示例

我们来看一个GF框架的模板引擎中的对比模板函数运行示例。

package main

import (
	"fmt"
	"github.com/gogf/gf/frame/g"
)

func main() {
	tplContent := `
eq:
eq "a" "a": {{eq "a" "a"}}
eq "1" "1": {{eq "1" "1"}}
eq  1  "1": {{eq  1  "1"}}

ne:
ne  1  "1": {{ne  1  "1"}}
ne "a" "a": {{ne "a" "a"}}
ne "a" "b": {{ne "a" "b"}}

lt:
lt  1  "2": {{lt  1  "2"}}
lt  2   2 : {{lt  2   2 }}
lt "a" "b": {{lt "a" "b"}}

le:
le  1  "2": {{le  1  "2"}}
le  2   1 : {{le  2   1 }}
le "a" "a": {{le "a" "a"}}

gt:
gt  1  "2": {{gt  1  "2"}}
gt  2   1 : {{gt  2   1 }}
gt "a" "a": {{gt "a" "a"}}

ge:
ge  1  "2": {{ge  1  "2"}}
ge  2   1 : {{ge  2   1 }}
ge "a" "a": {{ge "a" "a"}}
`
	content, err := g.View().ParseContent(tplContent, nil)
	if err != nil {
		panic(err)
	}
	fmt.Println(content)
}

运行后,输出结果为:

eq:
eq "a" "a": true
eq "1" "1": true
eq  1  "1": true

ne:
ne  1  "1": false
ne "a" "a": false
ne "a" "b": true

lt:
lt  1  "2": true
lt  2   2 : false
lt "a" "b": true

le:
le  1  "2": true
le  2   1 : false
le "a" "a": true

gt:
gt  1  "2": false
gt  2   1 : true
gt "a" "a": false

ge:
ge  1  "2": false
ge  2   1 : true
ge "a" "a": true

内置函数

text

{{.value | text}}

value变量值去掉HTML标签,仅显示文字内容(并且去掉script标签)。 示例:

{{"<div>测试</div>"|text}}
// 输出: 测试

html

别名htmlencode

{{.value | html}}

value变量值进行html转义。 示例:

{{"<div>测试</div>"|html}}
// 输出: &lt;div&gt;测试&lt;/div&gt;

htmldecode

{{.value | htmldecode}}

value变量值进行html反转义。 示例:

{{"&lt;div&gt;测试&lt;/div&gt;" | htmldecode}}
// 输出: <div>测试</div>

url

urlquery,别名urlencode

{{.url | url}}

url变量值进行url转义。 示例:

{{"https://goframe.org" | url}}
// 输出: https%3A%2F%2Fgoframe.org

urldecode

{{.url | urldecode}}

url变量值进行url反转义。 示例:

{{"https%3A%2F%2Fgoframe.org"|urldecode}}
// 输出: https://goframe.org

date

{{.timestamp | date .format}}
{{date .format .timestamp}}
{{date .format}}

timestamp时间戳变量进行时间日期格式化,类似PHP的date方法,format参数支持PHP date方法格式,亦可参考【gtime模块】。

timestamp变量为(或者0)时,表示以当前时间作为时间戳参数执行打印。

示例:

{{1540822968 | date "Y-m-d"}}
{{"1540822968" | date "Y-m-d H:i:s"}}
{{date "Y-m-d H:i:s"}}
// 输出: 
// 2018-10-29
// 2018-10-29 22:22:48
// 2018-12-05 10:22:00

compare

{{compare .str1 .str2}}
{{.str2 | compare .str1}}

str1str2进行字符串比较,返回值: - 0 : str1 == str2 - 1 : str1 > str2 - -1 : str1 < str2

示例:

{{compare "A" "B"}}
{{compare "1" "2"}}
{{compare 2 1}}
{{compare 1 1}}
// 输出: 
// -1
// -1
// 1
// 0

replace

{{.str | replace .search .replace}}
{{replace .search .replace .str}}

str中的search替换为replace。 示例:

{{"I'm中国人" | replace "I'm" "我是"}}
// 输出:
// 我是中国人

substr

{{.str | substr .start .length}}
{{substr .start .length .str}}

strstart索引位置(索引从0开始)进行字符串截取length,支持中文,类似PHP的substr函数。 示例:

{{"我是中国人" | substr 2 -1}}
{{"我是中国人" | substr 2  2}}
// 输出:
// 中国人
// 中国

strlimit

{{.str | strlimit .length .suffix}}

str字符串截取length长度,支持中文,超过长度则追加suffix字符串到末尾。 示例:

{{"我是中国人" | strlimit 2  "..."}}
// 输出:
// 我是...

hidestr

{{.str | hidestr .percent .hide}}

str字符串按照percent百分比从字符串中间向两边隐藏字符(主要用于姓名、手机号、邮箱地址、身份证号等的隐藏),隐藏字符由hide变量定义。 支持中文,支持email格式。 示例:

{{"热爱GF热爱生活" | hidestr 20  "*"}}
{{"热爱GF热爱生活" | hidestr 50  "*"}}
// 输出:
// 热爱GF*爱生活
// 热爱****生活

highlight

{{.str | highlight .key .color}}

str字符串中的关键字key按照定义的颜色color进行前置颜色高亮。 示例:

{{"热爱GF热爱生活" | highlight "GF" "red"}}
// 输出:
// 热爱<span style="color:red;">GF</span>热爱生活

toupper/tolower

{{.str | toupper}}
{{.str | tolower}}

str字符串进行大小写转换。 示例:

{{"gf" | toupper}}
{{"GF" | tolower}}
// 输出:
// GF
// gf

nl2br

{{.str | nl2br}}

str字符串中的\n/\r替换为html中的<br />标签。 示例:

{{"Go\nFrame" | nl2br}}
// 输出:
// Go<br />Frame

自定义模板函数

开发者可以自定义模板函数,全局绑定模板函数到指定的视图对象中。

使用示例:

package main

import (
	"fmt"
	"github.com/gogf/gf/frame/g"
)

// 用于测试的带参数的内置函数
func funcHello(name string) string {
	return fmt.Sprintf(`Hello %s`, name)
}

func main() {
	// 绑定全局的模板函数
	g.View().BindFunc("hello", funcHello)

	// 普通方式传参
	parsed1, err := g.View().ParseContent(`{{hello "GoFrame"}}`, nil)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(parsed1))

	// 通过管道传参
	parsed2, err := g.View().ParseContent(`{{"GoFrame" | hello}}`, nil)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(parsed2))
}

执行后,输出结果为:

Hello GoFrame
Hello GoFrame