GoFrame通过gf pack命令将resource/template和resource/public目录打包进二进制,生成internal/resource/resource.go;模板引擎需配置g.View().SetConfig({Paths: ["resource/template"]})以从嵌入资源读取,且Paths必须与-pack参数-p值完全一致;生产环境必须启用SetAutoEncode(true)防御XSS。

将模板与静态资源嵌入可执行文件
避免部署时因路径错误导致模板找不到、CSS/JS加载失败,必须把资源打包进二进制文件中。
在项目根目录下执行命令,将resource/template和resource/public两个目录打包为Go源码:
【必须确保 resource 目录结构存在且路径准确】
gf pack -s resource/template,resource/public -t internal/resource/resource.go -p resource
该命令生成 internal/resource/resource.go 文件,其中包含所有资源的字节数据和注册逻辑。运行时 gres 模块会自动调用 init 函数完成资源加载,无需手动触发。
若提示“no such file or directory”,请先检查 resource 目录是否真实存在,而不是仅在 .gitignore 中声明了但未创建。
配置模板引擎读取嵌入式资源
模板引擎默认从磁盘路径加载文件,必须显式切换为从 gres 资源管理器读取。
在服务初始化位置(如 main.go 的 init 或 main 函数开头),添加以下配置:
g.View().SetConfig(gview.Config{Paths: []string{"resource/template"}})
这一步让 g.View() 实例知道:所有模板文件都应从名为 “resource/template” 的嵌入式资源路径中查找,而非物理磁盘。
注意:Paths 中的字符串必须与 gf pack 命令中 -p 参数指定的资源前缀完全一致,大小写敏感,多一个斜杠都会失败。
启用自动HTML编码防御XSS攻击
用户提交的内容直接插入模板易引发XSS漏洞,GoFrame 默认不开启自动编码,必须手动打开。
方法一:全局配置启用
g.View().SetAutoEncode(true)
方法二:单次渲染时临时启用
content, _ := g.View().ParseContent("{{.UserInput}}", data).ToString()
g.View().SetAutoEncode(true) → result, _ := g.View().Render("index", data)
【生产环境必须使用方法一,否则每次渲染都要重复设置,极易遗漏】
开启后,所有变量插值(如 {{.Name}})输出前会自动转义 " ' & 字符,防止脚本注入。若某处需原始 HTML,改用 {{.RawContent|safe}} 语法。
设置多环境模板路径与分隔符
开发时用双大括号 {{ }},测试环境想快速验证变量名拼写,可临时改用 ${ } 分隔符降低视觉干扰。
第一步:定义 viewer.viewdev 配置项
在 configs/config.yaml 中添加:
[viewer.viewdev]
paths = ["resource/template"]
delimiters = ["${", "}"]
autoEncode = true
第二步:获取专用 View 实例
vDev := g.View("viewdev")
第三步:用该实例渲染
html, _ := vDev.Render("admin/dashboard", data)
这样 dev 环境走独立配置,不影响默认 viewer 行为,上线前删掉 viewer.viewdev 配置即可。
调试时导出嵌入资源查看内容
打包后无法直接查看 template/index.html 是否正确嵌入,需要导出到本地验证。
在任意 handler 或 init 函数中加入:
gres.Export("resource/template/index.html", "./debug/index.html")
运行程序后,当前目录下会生成 debug/index.html 文件,打开即可确认内容。
导出操作只应在开发机执行,切勿保留在生产代码中,否则可能意外暴露敏感模板结构。

















