GoFrame 模板引擎-基本介绍
模板引擎特点
- 简单、易用、强大；
- 支持多模板目录搜索；
- 支持
layout模板设计； - 支持模板视图对象单例模式；
- 与配置管理模块原生集成，使用方便；
- 底层采用了二级缓存设计，性能高效；
- 新增模板标签及大量的内置模板变量、模板函数；
- 支持模板文件修改后自动更新缓存机制，对开发过程更友好；
-
define/template标签支持跨模板调用（同一模板路径包括子目录下的模板文件）； -
include标签支持任意路径的模板文件引入；
通用视图管理
通用视图管理即使用原生的模板引擎gview模块来实现模板管理，包括模板读取展示，模板变量渲染等等。可以使用通过方法gview.Instance来获取视图单例对象，并可以按照单例对象名称进行获取。同时也可以通过对象管理器g.View()来获取默认的单例gview对象。
接口文档：
https://pkg.go.dev/github.com/gogf/gf/v2/os/gview
简要说明：
-
gview.Get用于根据给定的一个模板目录路径，获得对应的单例模板引擎对象； -
gview.New同样可以根据给定的模板目录路径创建模板引擎对象，但没有单例管理； -
SetPath/AddPath用于设置/添加当前模板引擎对象的模板目录路径，其中SetPath会覆盖所有的模板目录设置，推荐使用AddPath； -
Assign/Assigns用于设置模板变量，通过该模板引擎解析的所有模板均可以使用这些模板变量； -
BindFunc用于绑定模板函数，具体使用方法参考后续示例程序； -
Parse/ParseContent用于解析模板文件/内容，可以在解析时给定临时的模板变量及模板函数； -
SetDelimiters用于设置该模板引擎对象的模板解析分隔符号，默认为{{ }}（与vuejs前端框架有冲突）；
需要注意，从goframe v1.16版本开始，所有模板的解析方法都额外增加了第一个输入参数为Context上下文变量的传递。
示例1，解析模板文件
index.tpl
id:{{.id}}, name:{{.name}}main.go
package main
import (
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
)
func main() {
s := g.Server()
s.BindHandler("/template", func(r *ghttp.Request) {
r.Response.WriteTpl("index.tpl", g.Map{
"id": 123,
"name": "john",
})
})
s.SetPort(8199)
s.Run()
}执行后，访问 http://127.0.0.1:8199/template 可以看到解析后的内容为：id:123, name:john
示例2，解析模板内容
package main
import (
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
)
func main() {
s := g.Server()
s.BindHandler("/template", func(r *ghttp.Request){
tplContent := `id:{{.id}}, name:{{.name}}`
r.Response.WriteTplContent(tplContent, g.Map{
"id" : 123,
"name" : "john",
})
})
s.SetPort(8199)
s.Run()
}执行后，访问 http://127.0.0.1:8199/template 可以看到解析后的内容为：id:123, name:john
示例3，自定义模板分隔符
在项目中我们经常会遇到Golang默认模板变量分隔符号与Vue的变量分隔符号冲突的情况（都使用的是{{ }}），我们可以使用SetDelimiters方法来自定义全局的Golang模板变量分隔符号：
// main.go
package main
import (
"context"
"fmt"
"github.com/gogf/gf/v2/frame/g"
)
func main() {
v := g.View()
v.SetDelimiters("${", "}")
b, err := v.Parse(
context.TODO(),
"gview_delimiters.tpl",
map[string]interface{}{
"k": "v",
})
fmt.Println(err)
fmt.Println(b)
}<!-- gview_delimiters.tpl -->
test.tpl content, vars: ${.}执行后，输出结果为：
<nil>
test.tpl content, vars: map[k:v]目录配置方法
gf框架的模板引擎支持非常灵活的多目录自动搜索功能，通过SetPath可以修改模板目录为唯一的一个目录地址，同时，我们可以通过AddPath方法添加多个搜索目录，模板引擎底层将会按照添加目录的顺序作为优先级进行自动检索。直到检索到一个匹配的文件路径为止，如果在所有搜索目录下查找不到模板文件，那么会返回失败。
默认目录配置：
gview视图对象初始化时，默认会自动添加以下模板文件搜索目录：
- 当前工作目录及其下的
template目录：例如当前的工作目录为/home/www时，将会添加/home/www及/home/www/template； - 当前可执行文件所在目录及其下的
template目录：例如二进制文件所在目录为/tmp时，将会添加/tmp及/tmp/template； - 当前
main源代码包所在目录及其下的template目录（仅对源码开发环境有效）：例如main包所在目录为/home/john/workspace/gf-app时，将会添加/home/john/workspace/gf-app及/home/john/workspace/gf-app/template；
修改模板目录
我们可以通过以下方式修改视图对象的模板文件搜索目录，视图对象将会只在该指定目录执行配置文件检索：
- （推荐）单例模式获取全局
View对象，通过SetPath方法手动修改； - 修改命令行启动参数 -
gf.gview.path； - 修改指定的环境变量 -
GF_GVIEW_PATH；
例如，我们的执行程序文件为main，那么可以通过以下方式修改模板引擎的模板目录(Linux下)：
1、通过单例模式（推荐）
g.View().SetPath("/opt/template")2、通过命令行参数
./main --gf.gview.path=/opt/template/3、通过环境变量
- 启动时修改环境变量：
GF_GVIEW_PATH=/opt/config/; ./main- 使用
genv模块来修改环境变量：
genv.Set("GF_GVIEW_PATH", "/opt/template")自动检测更新
模板引擎使用了精心设计的缓存机制，当模板文件第一次被读取后会被缓存到内存，下一次读取时将会直接从缓存中获取，以提高执行效率。并且，模板引擎提供了对模板文件的自动检测更新机制，当模板文件在外部被修改后，模板引擎能够即时地监控到并刷新模板文件的缓存内容。
更多建议：