Golang Template实现自定义函数的操作指南

郝瑞芝

目录

• 1. 基础用法
  
  
  
  • 1.1 创建简单模板函数
    
  • 1.2 带参数的模板函数
    
  
  
• 2. 高级用法
  
  
  
  • 2.1 条件判断函数
    
  • 2.2 格式化函数
    
  • 2.3 切片操作函数
    
  
  
• 3. 实用示例
  
  
  
  • 3.1 HTML 安全转义
    
  • 3.2 数据过滤和转换
    
  
  
• 4. 最佳实践
  
  
  
  • 4.1 模板函数组织
    
  • 4.2 错误处理
    
  
  
• 总结
  

1. 基础用法


1.1 创建简单模板函数

1. package main
   
2. 
   
3. import (
   
4.     "html/template"
   
5.     "os"
   
6. )
   
7. 
   
8. func main() {
   
9.     // 创建自定义函数映射
   
10.     funcMap := template.FuncMap{
    
11.         "upper": strings.ToUpper,
    
12.         "lower": strings.ToLower,
    
13.     }
    
14.    
    
15.     // 创建模板并添加函数
    
16.     tmpl := template.New("test").Funcs(funcMap)
    
17.    
    
18.     // 解析模板内容
    
19.     tmpl, err := tmpl.Parse(`
    
20.         原始字符串: {{.}}
    
21.         大写: {{upper .}}
    
22.         小写: {{lower .}}
    
23.     `)
    
24.    
    
25.     if err != nil {
    
26.         panic(err)
    
27.     }
    
28.    
    
29.     // 执行模板
    
30.     err = tmpl.Execute(os.Stdout, "Hello, World!")
    
31. }

复制代码

1.2 带参数的模板函数

1. package main
   
2. 
   
3. import (
   
4.     "html/template"
   
5.     "os"
   
6. )
   
7. 
   
8. func main() {
   
9.     funcMap := template.FuncMap{
   
10.         "add": func(a, b int) int {
    
11.             return a + b
    
12.         },
    
13.         "multiply": func(a, b int) int {
    
14.             return a * b
    
15.         },
    
16.     }
    
17.    
    
18.     tmpl := template.New("calc").Funcs(funcMap)
    
19.     tmpl, err := tmpl.Parse(`
    
20.         {{add 5 3}} = 8
    
21.         {{multiply 4 6}} = 24
    
22.     `)
    
23.    
    
24.     if err != nil {
    
25.         panic(err)
    
26.     }
    
27.    
    
28.     err = tmpl.Execute(os.Stdout, nil)
    
29. }

复制代码

2. 高级用法


2.1 条件判断函数

1. package main
   
2. 
   
3. import (
   
4.     "html/template"
   
5.     "os"
   
6. )
   
7. 
   
8. func main() {
   
9.     funcMap := template.FuncMap{
   
10.         "isEven": func(n int) bool {
    
11.             return n%2 == 0
    
12.         },
    
13.         "ifThenElse": func(condition bool, a, b interface{}) interface{} {
    
14.             if condition {
    
15.                 return a
    
16.             }
    
17.             return b
    
18.         },
    
19.     }
    
20.    
    
21.     tmpl := template.New("conditions").Funcs(funcMap)
    
22.     tmpl, err := tmpl.Parse(`
    
23.         {{range $i := .}}
    
24.             数字 {{$i}} 是: {{if isEven $i}}偶数{{else}}奇数{{end}}
    
25.             另一种写法: {{ifThenElse (isEven $i) "偶数" "奇数"}}
    
26.         {{end}}
    
27.     `)
    
28.    
    
29.     if err != nil {
    
30.         panic(err)
    
31.     }
    
32.    
    
33.     numbers := []int{1, 2, 3, 4, 5}
    
34.     err = tmpl.Execute(os.Stdout, numbers)
    
35. }

复制代码

2.2 格式化函数

1. package main
   
2. 
   
3. import (
   
4.     "fmt"
   
5.     "html/template"
   
6.     "os"
   
7.     "time"
   
8. )
   
9. 
   
10. func main() {
    
11.     funcMap := template.FuncMap{
    
12.         "formatDate": func(t time.Time) string {
    
13.             return t.Format("2006-01-02 15:04:05")
    
14.         },
    
15.         "formatPrice": func(price float64) string {
    
16.             return fmt.Sprintf("￥%.2f", price)
    
17.         },
    
18.     }
    
19.    
    
20.     tmpl := template.New("format").Funcs(funcMap)
    
21.     tmpl, err := tmpl.Parse(`
    
22.         当前时间: {{formatDate .Time}}
    
23.         商品价格: {{formatPrice .Price}}
    
24.     `)
    
25.    
    
26.     if err != nil {
    
27.         panic(err)
    
28.     }
    
29.    
    
30.     data := struct {
    
31.         Time  time.Time
    
32.         Price float64
    
33.     }{
    
34.         Time:  time.Now(),
    
35.         Price: 99.99,
    
36.     }
    
37.    
    
38.     err = tmpl.Execute(os.Stdout, data)
    
39. }

复制代码

2.3 切片操作函数

1. package main
   
2. 
   
3. import (
   
4.     "html/template"
   
5.     "os"
   
6. )
   
7. 
   
8. func main() {
   
9.     funcMap := template.FuncMap{
   
10.         "first": func(x []interface{}) interface{} {
    
11.             if len(x) > 0 {
    
12.                 return x[0]
    
13.             }
    
14.             return nil
    
15.         },
    
16.         "last": func(x []interface{}) interface{} {
    
17.             if len(x) > 0 {
    
18.                 return x[len(x)-1]
    
19.             }
    
20.             return nil
    
21.         },
    
22.         "slice": func(x []interface{}, start, end int) []interface{} {
    
23.             if start < 0 {
    
24.                 start = 0
    
25.             }
    
26.             if end > len(x) {
    
27.                 end = len(x)
    
28.             }
    
29.             return x[start:end]
    
30.         },
    
31.     }
    
32.    
    
33.     tmpl := template.New("slice").Funcs(funcMap)
    
34.     tmpl, err := tmpl.Parse(`
    
35.         完整切片: {{.}}
    
36.         第一个元素: {{first .}}
    
37.         最后一个元素: {{last .}}
    
38.         切片[1:3]: {{slice . 1 3}}
    
39.     `)
    
40.    
    
41.     if err != nil {
    
42.         panic(err)
    
43.     }
    
44.    
    
45.     data := []interface{}{1, 2, 3, 4, 5}
    
46.     err = tmpl.Execute(os.Stdout, data)
    
47. }

复制代码

3. 实用示例


3.1 HTML 安全转义

1. package main
   
2. 
   
3. import (
   
4.     "html/template"
   
5.     "os"
   
6. )
   
7. 
   
8. func main() {
   
9.     funcMap := template.FuncMap{
   
10.         "safe": func(s string) template.HTML {
    
11.             return template.HTML(s)
    
12.         },
    
13.         "safeAttr": func(s string) template.HTMLAttr {
    
14.             return template.HTMLAttr(s)
    
15.         },
    
16.     }
    
17.    
    
18.     tmpl := template.New("safe").Funcs(funcMap)
    
19.     tmpl, err := tmpl.Parse(`
    
20.         普通文本: {{.Text}}
    
21.         HTML内容: {{safe .HTML}}
    
22.         属性值: <div {{safeAttr .Attr}}></div>
    
23.     `)
    
24.    
    
25.     if err != nil {
    
26.         panic(err)
    
27.     }
    
28.    
    
29.     data := struct {
    
30.         Text string
    
31.         HTML string
    
32.         Attr string
    
33.     }{
    
34.         Text: "<b>文本</b>",
    
35.         HTML: "<b>HTML</b>",
    
36.         Attr: `style="color: red"`,
    
37.     }
    
38.    
    
39.     err = tmpl.Execute(os.Stdout, data)
    
40. }

复制代码

3.2 数据过滤和转换

1. package main
   
2. 
   
3. import (
   
4.     "html/template"
   
5.     "os"
   
6.     "strings"
   
7. )
   
8. 
   
9. func main() {
   
10.     funcMap := template.FuncMap{
    
11.         "join": strings.Join,
    
12.         "split": strings.Split,
    
13.         "title": strings.Title,
    
14.         "filter": func(arr []string, f func(string) bool) []string {
    
15.             var result []string
    
16.             for _, v := range arr {
    
17.                 if f(v) {
    
18.                     result = append(result, v)
    
19.                 }
    
20.             }
    
21.             return result
    
22.         },
    
23.     }
    
24.    
    
25.     tmpl := template.New("filter").Funcs(funcMap)
    
26.     tmpl, err := tmpl.Parse(`
    
27.         原始数组: {{.}}
    
28.         Join结果: {{join . ","}}
    
29.         Split结果: {{split "a,b,c" ","}}
    
30.         Title结果: {{title "hello world"}}
    
31.         Filter结果: {{filter . (lambda "len" "gt" 3)}}
    
32.     `)
    
33.    
    
34.     if err != nil {
    
35.         panic(err)
    
36.     }
    
37.    
    
38.     data := []string{"apple", "banana", "orange", "pear"}
    
39.     err = tmpl.Execute(os.Stdout, data)
    
40. }

复制代码

4. 最佳实践


4.1 模板函数组织

1. // template_funcs.go
   
2. package template
   
3. 
   
4. import "html/template"
   
5. 
   
6. // 创建全局函数映射
   
7. var GlobalFuncMap = template.FuncMap{
   
8.     // 字符串操作
   
9.     "upper":      strings.ToUpper,
   
10.     "lower":      strings.ToLower,
    
11.     "title":      strings.Title,
    
12.    
    
13.     // 数值操作
    
14.     "add":        func(a, b int) int { return a + b },
    
15.     "subtract":   func(a, b int) int { return a - b },
    
16.     "multiply":   func(a, b int) int { return a * b },
    
17.     "divide":     func(a, b int) float64 { return float64(a) / float64(b) },
    
18.    
    
19.     // 日期操作
    
20.     "formatDate": func(t time.Time, layout string) string { return t.Format(layout) },
    
21.     "now":        time.Now,
    
22.    
    
23.     // 切片操作
    
24.     "first":      first,
    
25.     "last":       last,
    
26.     "slice":      slice,
    
27.    
    
28.     // 条件操作
    
29.     "isEven":     isEven,
    
30.     "ifThenElse": ifThenElse,
    
31. }
    
32. 
    
33. // 在应用中使用
    
34. func main() {
    
35.     tmpl := template.New("page").Funcs(GlobalFuncMap)
    
36.     // ... 其他操作
    
37. }

复制代码

4.2 错误处理

1. package main
   
2. 
   
3. import (
   
4.     "html/template"
   
5.     "os"
   
6. )
   
7. 
   
8. func main() {
   
9.     funcMap := template.FuncMap{
   
10.         "divide": func(a, b int) (string, error) {
    
11.             if b == 0 {
    
12.                 return "", fmt.Errorf("除数不能为零")
    
13.             }
    
14.             return fmt.Sprintf("%.2f", float64(a)/float64(b)), nil
    
15.         },
    
16.     }
    
17.    
    
18.     tmpl := template.New("error").Funcs(funcMap)
    
19.     tmpl, err := tmpl.Parse(`
    
20.         {{with $result := divide 10 2}}
    
21.             结果: {{$result}}
    
22.         {{else}}
    
23.             计算出错
    
24.         {{end}}
    
25.     `)
    
26.    
    
27.     if err != nil {
    
28.         panic(err)
    
29.     }
    
30.    
    
31.     err = tmpl.Execute(os.Stdout, nil)
    
32. }

复制代码

总结

1.基本原则

• 保持函数简单明确
  
• 注意类型安全
  
• 适当处理错误
  
• 避免过度复杂的逻辑
  

2.常见用途

• 文本格式化
  
• 数据转换
  
• 条件判断
  
• 集合操作
  
• HTML 安全处理
  

3.性能考虑

• 缓存模板
  
• 避免重复解析
  
• 合理使用内存
  

到此这篇关于Golang Template实现自定义函数的操作指南的文章就介绍到这了,更多相关Go Template自定义函数内容请搜索晓枫资讯以前的文章或继续浏览下面的相关文章希望大家以后多多支持晓枫资讯！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

蔺书萱

顶顶更健康！！！

悔过之人翘

路过，支持一下