• 基本函数
    • and
    • call
    • index
    • len
    • not
    • or
    • print
    • printf
    • println
    • urlquery
    • eq / ne / lt / le / gt / ge
      • 对比函数改进
      • 改进运行示例
  • 内置函数
    • text
    • html
    • htmldecode
    • url
    • urldecode
    • date
    • compare
    • substr
    • strlimit
    • hidestr
    • highlight
    • toupper/tolower
    • nl2br
  • 自定义模板函数

    基本函数

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

    1. {{.value | Func1 | Func2}}

    使用括号

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

    and

    1. {{and .X .Y .Z}}

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

    call

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

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

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

    index

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

    1. {{index .Maps "name"}}

    len

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

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

    not

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

    例如，判断是否变量是否为空：

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

    or

    1. {{or .X .Y .Z}}

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

    print

    同fmt.Sprint。

    printf

    同fmt.Sprintf。

    println

    同fmt.Sprintln。

    urlquery

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

    将返回

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

    eq / ne / lt / le / gt / ge

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

    1. `eq`: arg1 == arg2
    2. `ne`: arg1 != arg2
    3. `lt`: arg1 < arg2
    4. `le`: arg1 <= arg2
    5. `gt`: arg1 > arg2
    6. `ge`: arg1 >= arg2

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

    1. {{eq arg1 arg2 arg3 arg4}}

    和下面的逻辑判断相同:

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

    与if一起使用

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

    例如，判断变量不为空时执行：

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

    对比函数改进

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

    1. {{eq 1 "1"}}

    将会引发错误：

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

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

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

    改进运行示例

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

    1. package main
    3. import (
    4.     "fmt"
    5.     "github.com/gogf/gf/g"
    6. )
    8. func main() {
    9.     tplContent := `
    10. eq:
    11. eq "a" "a": {{eq "a" "a"}}
    12. eq "1" "1": {{eq "1" "1"}}
    13. eq  1  "1": {{eq  1  "1"}}
    15. ne:
    16. ne  1  "1": {{ne  1  "1"}}
    17. ne "a" "a": {{ne "a" "a"}}
    18. ne "a" "b": {{ne "a" "b"}}
    20. lt:
    21. lt  1  "2": {{lt  1  "2"}}
    22. lt  2   2 : {{lt  2   2 }}
    23. lt "a" "b": {{lt "a" "b"}}
    25. le:
    26. le  1  "2": {{le  1  "2"}}
    27. le  2   1 : {{le  2   1 }}
    28. le "a" "a": {{le "a" "a"}}
    30. gt:
    31. gt  1  "2": {{gt  1  "2"}}
    32. gt  2   1 : {{gt  2   1 }}
    33. gt "a" "a": {{gt "a" "a"}}
    35. ge:
    36. ge  1  "2": {{ge  1  "2"}}
    37. ge  2   1 : {{ge  2   1 }}
    38. ge "a" "a": {{ge "a" "a"}}
    39. `
    40.     content, err := g.View().ParseContent(tplContent, nil)
    41.     if err != nil {
    42.         panic(err)
    43.     }
    44.     fmt.Println(content)
    45. }

    运行后，输出结果为：

    1. eq:
    2. eq "a" "a": true
    3. eq "1" "1": true
    4. eq  1  "1": true
    6. ne:
    7. ne  1  "1": false
    8. ne "a" "a": false
    9. ne "a" "b": true
    11. lt:
    12. lt  1  "2": true
    13. lt  2   2 : false
    14. lt "a" "b": true
    16. le:
    17. le  1  "2": true
    18. le  2   1 : false
    19. le "a" "a": true
    21. gt:
    22. gt  1  "2": false
    23. gt  2   1 : true
    24. gt "a" "a": false
    26. ge:
    27. ge  1  "2": false
    28. ge  2   1 : true
    29. ge "a" "a": true

    内置函数

    text

    1. {{.value | text}}

    将value变量值去掉HTML标签，仅显示文字内容（并且去掉script标签）。示例：

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

    html

    别名htmlencode。

    1. {{.value | html}}

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

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

    htmldecode

    1. {{.value | htmldecode}}

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

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

    url

    同urlquery，别名urlencode。

    1. {{.url | url}}

    将url变量值进行url转义。示例：

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

    urldecode

    1. {{.url | urldecode}}

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

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

    date

    1. {{.timestamp | date .format}}
    2. {{date .format .timestamp}}
    3. {{date .format}}

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

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

    示例：

    1. {{1540822968 | date "Y-m-d"}}
    2. {{"1540822968" | date "Y-m-d H:i:s"}}
    3. {{date "Y-m-d H:i:s"}}
    4. // 输出: 
    5. // 2018-10-29
    6. // 2018-10-29 22:22:48
    7. // 2018-12-05 10:22:00

    compare

    1. {{compare .str1 .str2}}
    2. {{.str2 | compare .str1}}

    将str1和str2进行字符串比较，返回值：

    • 0 : str1 == str2
    • 1 : str1 > str2
    • -1 : str1 < str2

    示例：

    1. {{compare "A" "B"}}
    2. {{compare "1" "2"}}
    3. {{compare 2 1}}
    4. {{compare 1 1}}
    5. // 输出: 
    6. // -1
    7. // -1
    8. // 1
    9. // 0

    substr

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

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

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

    strlimit

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

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

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

    hidestr

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

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

    1. {{"热爱GF热爱生活" | hidestr 20  "*"}}
    2. {{"热爱GF热爱生活" | hidestr 50  "*"}}
    3. // 输出:
    4. // 热爱GF*爱生活
    5. // 热爱****生活

    highlight

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

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

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

    toupper/tolower

    1. {{.str | toupper}}
    2. {{.str | tolower}}

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

    1. {{"gf" | toupper}}
    2. {{"GF" | tolower}}
    3. // 输出:
    4. // GF
    5. // gf

    nl2br

    1. {{.str | nl2br}}

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

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

    自定义模板函数

    开发者可以自定义模板函数，全局绑定模板函数到当前视图对象中。

    使用示例：

    1. package main
    3. import (
    4.     "fmt"
    5.     "github.com/gogf/gf/g"
    6. )
    8. // 用于测试的带参数的内置函数
    9. func funcHello(name string) string {
    10.     return fmt.Sprintf(`Hello %s`, name)
    11. }
    13. func main() {
    14.     // 绑定全局的模板函数
    15.     g.View().BindFunc("hello", funcHello)
    17.     // 普通方式传参
    18.     parsed1, err := g.View().ParseContent(`{{hello "GoFrame"}}`, nil)
    19.     if err != nil {
    20.         panic(err)
    21.     }
    22.     fmt.Println(string(parsed1))
    24.     // 通过管道传参
    25.     parsed2, err := g.View().ParseContent(`{{"GoFrame" | hello}}`, nil)
    26.     if err != nil {
    27.         panic(err)
    28.     }
    29.     fmt.Println(string(parsed2))
    30. }

    执行后，输出结果为：

    1. Hello GoFrame
    2. Hello GoFrame