Velocity:宏、公共布局与模板缓存

多个页面复制同一段导航,改动时容易漏一处。

edyang · 2014-08-25

多个页面复制同一段导航,改动时容易漏一处。模板复用可以减少重复,也需要控制隐藏依赖。

本文使用Velocity 1.7、Java 7 与 UTF-8 模板,代码为模板片段。模板引擎负责把模型渲染成文本,不应该直接承担下单、数据库查询或权限判断。模板上下文只放页面真正需要的数据,可以减少隐式依赖。

1. 从现象推到机制

宏适合封装小段展示结构,公共布局负责页面骨架。模板缓存减少重复加载和解析,但会影响文件修改何时被看到。宏依赖过多全局变量时,页面之间会产生看不见的耦合。

Velocity:宏、公共布局与模板缓存的处理、反馈与观察关系

图中的四个节点分别表示页面骨架、显式宏参数、资源加载、缓存策略。顺着实线检查输入如何变成输出,再沿虚线核对反馈条件。图示表达的是本文讨论的关系,不是实测曲线或现场截图。

2. 最小实现与输入条件

把分页宏的输入显式列出,使用固定模型测试首尾页。开发与部署环境分别设置资源加载和检查策略,不要依赖手工重启刷新所有问题。

1
2
3
4
#macro(pageLink $page $label)
  <a href="?page=$page">$label</a>
#end
#pageLink(1 "首页")

在固定输入下渲染到字符串或测试文件,保留模板名与最终输出。HTML(超文本标记语言)编码、字符集编码和业务权限是不同层面的约束,需要分别确认。

3. 用对照区分原因

下表列出需要主动改变的条件。预期行为来自机制分析,复现时还需记录运行环境和原始输出,不能将预期当作已经测得的结果。

改变的条件 需要验证的行为
修改公共宏 所有引用页面都需要回归查看
开发修改模板未生效 核对加载路径和缓存配置
宏依赖隐藏全局变量 在另一页面可能出现缺失

对照 1:修改公共宏

所有引用页面都需要回归查看。观察时记录最终渲染结构与传入参数。把这个条件与基准情形分开,有助于判断变化来自哪一层;若得到相反结果,应先核对前提,再修改实现。

对照 2:开发修改模板未生效

核对加载路径和缓存配置。观察时记录实际模板来源与检查间隔。把这个条件与基准情形分开,有助于判断变化来自哪一层;若得到相反结果,应先核对前提,再修改实现。

对照 3:宏依赖隐藏全局变量

在另一页面可能出现缺失。观察时记录调用参数能否完整描述输入。把这个条件与基准情形分开,有助于判断变化来自哪一层;若得到相反结果,应先核对前提,再修改实现。

4. 适用条件与取舍

模板缓存是解析层优化,不能替代整页缓存的权限隔离。不同用户页面若共享错误的缓存键,仍可能显示他人的数据。

一次正常运行只覆盖了这组输入。继续扩展前,应把上面的异常对照保留下来,尤其关注“宏依赖隐藏全局变量”这一分支。后续方案若改变了图中任意一处依赖,原来的判断就要重新验证,不能仅凭界面相似或返回值相同沿用结论。

同月延伸

参考资料

  1. Apache Velocity 1.7 用户指南
  2. OWASP XSS 防护说明