视图组件是GoFrame框架核心的组件之一,当然也支持非常方便的配置管理功能。

配置对象

配置对象定义: https://pkg.go.dev/github.com/gogf/gf/v2/os/gview#Config

配置文件

视图组件支持配置文件,当使用g.View(单例名称)获取View单例对象时,将会自动通过默认的配置管理对象获取对应的View配置。默认情况下会读取viewer.单例名称配置项,当该配置项不存在时,将会读取viewer配置项。

完整配置文件配置项及说明如下,其中配置项名称不区分大小写:

  1. [viewer]
  2. Paths = ["/var/www/template"] # 模板文件搜索目录路径,建议使用绝对路径。默认为当前程序工作路径
  3. DefaultFile = "index.html" # 默认解析的模板引擎文件。默认为"index.html"
  4. Delimiters = ["${", "}"] # 模板引擎变量分隔符号。默认为 ["{{", "}}"]
  5. AutoEncode = false # 是否默认对变量内容进行XSS编码。默认为false
  6. [viewer.Data] # 自定义的全局Key-Value键值对,将在模板解析中可被直接使用到
  7. Key1 = "Value1"
  8. Key2 = "Value2"

示例1,默认配置项

  1. [viewer]
  2. paths = ["template", "/var/www/template"]
  3. defaultFile = "index.html"
  4. delimiters = ["${", "}"]
  5. [viewer.data]
  6. name = "gf"
  7. version = "1.10.0"

随后可以使用g.View()获取默认的单例对象时自动获取并设置该配置。

示例2,多个配置项

多个View对象的配置示例:

  1. [viewer]
  2. paths = ["template", "/var/www/template"]
  3. defaultFile = "index.html"
  4. delimiters = ["${", "}"]
  5. [viewer.data]
  6. name = "gf"
  7. version = "1.10.0"
  8. [viewer.view1]
  9. defaultFile = "layout.html"
  10. delimiters = ["${", "}"]
  11. [viewer.view2]
  12. defaultFile = "main.html"
  13. delimiters = ["#{", "}"]

我们可以通过单例对象名称获取对应配置的View单例对象:

  1. // 对应 viewer.view1 配置项
  2. v1 := g.View("view1")
  3. // 对应 viewer.view2 配置项
  4. v2 := g.View("view2")
  5. // 对应默认配置项 viewer
  6. v3 := g.View("none")
  7. // 对应默认配置项 viewer
  8. v4 := g.View()

配置方法

方法列表: https://pkg.go.dev/github.com/gogf/gf/v2/os/gview

简要说明:

  1. 可以通过SetConfigSetConfigWithMap来设置。
  2. 也可以使用View对象的Set*方法进行特定配置的设置。
  3. 主要注意的是,配置项在View对象执行视图解析之前设置,避免并发安全问题。

SetConfigWithMap方法

我们可以使用SetConfigWithMap方法通过Key-Value键值对来设置/修改View的特定配置,其余的配置使用默认配置即可。其中Key的名称即是Config这个struct中的属性名称,并且不区分大小写,单词间也支持使用-/_/空格符号连接,具体可参考 类型转换-Struct转换 章节转换规则。

简单示例:

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "github.com/gogf/gf/v2/frame/g"
  6. "github.com/gogf/gf/v2/os/gview"
  7. )
  8. func main() {
  9. view := gview.New()
  10. view.SetConfigWithMap(g.Map{
  11. "Paths": []string{"template"},
  12. "DefaultFile": "index.html",
  13. "Delimiters": []string{"${", "}"},
  14. "Data": g.Map{
  15. "name": "gf",
  16. "version": "1.10.0",
  17. },
  18. })
  19. result, err := view.ParseContent(context.TODO(), "hello ${.name}, version: ${.version}")
  20. if err != nil {
  21. panic(err)
  22. }
  23. fmt.Println(result)
  24. }

其中DefaultFile表示默认解析的模板文件,键名也可以使用defaultFile, default-File, default_file, default file,其他配置属性以此类推。

注意事项

经常有小伙伴问,为神马我的模板解析没有生效?为神马页面上直接将我写的标签原木原样显示出来了?

这个时候请检查你的配置文件中是否有设置模板标签,常见的是delimiters设置为了["${", "}"],但是模板中使用的是["{{", "}}"]