Velocity:页面模型与空值约定

模板输出了变量名或空白,可能是模型缺字段,也可能是模板把空值与有效值混在一起。

edyang · 2014-08-05

模板输出了变量名或空白,可能是模型缺字段,也可能是模板把空值与有效值混在一起。

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

1. 从现象推到机制

模板引用的属性来自上下文对象及其访问方法。静默引用可以减少未解析文本,却也会隐藏字段拼错。零、空字符串和不存在的对象不应靠同一个判断随意混为一谈,页面含义应由模型约定。

Velocity:页面模型与空值约定的处理、反馈与观察关系

图中的四个节点分别表示业务模型、上下文键、模板判断、页面输出。顺着实线检查输入如何变成输出,再沿虚线核对反馈条件。图示表达的是本文讨论的关系,不是实测曲线或现场截图。

2. 最小实现与输入条件

服务端先组装订单展示模型,对可选字段给出明确状态;模板只负责按状态呈现。开发阶段对必需字段缺失应尽早暴露。

1
2
3
4
5
#if($order.hasRemark)
  <p>$order.remark</p>
#else
  <p>暂无备注</p>
#end

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

3. 用对照区分原因

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

改变的条件 需要验证的行为
必需对象没有放入上下文 应定位模型准备问题
备注合法为空 页面可按约定显示空状态
金额恰好为零 不能误当成字段缺失

对照 1:必需对象没有放入上下文

应定位模型准备问题。观察时记录模型键名与模板引用。把这个条件与基准情形分开,有助于判断变化来自哪一层;若得到相反结果,应先核对前提,再修改实现。

对照 2:备注合法为空

页面可按约定显示空状态。观察时记录字段存在与有无内容。把这个条件与基准情形分开,有助于判断变化来自哪一层;若得到相反结果,应先核对前提,再修改实现。

对照 3:金额恰好为零

不能误当成字段缺失。观察时记录数据类型与显式判断。把这个条件与基准情形分开,有助于判断变化来自哪一层;若得到相反结果,应先核对前提,再修改实现。

4. 适用条件与取舍

不要通过全局静默所有变量来掩盖模型错误。页面越复杂,越应收敛展示对象,避免模板直接导航很深的实体关系。

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

同月延伸

参考资料

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