页面模板的重构

最近在工作中重构一个老系统，烂的地方有很多，但是对于后台的页面模板（我指的是JSP、FreeMarker、Velocity这样的后台模板，JavaScript前端模板不在此讨论范围内），却是我要说的部分，这似乎是一个被人遗忘的小角落。你可以很轻易地找到怎样重构Java类和方法的材料，你的Java代码可以写得很优雅；去搜搜“重构”，到处是怎样重构你的Java代码、C++代码，我们也能找到许多前端设计师对于页面结构的重构，但是重构的范围远非至此。

后台业务逻辑写得再好，一个jsp、ftl模板页面还是可能写上几千行，业务逻辑耦合在呈现代码里面，看起来一团糟，对这部分的重构，既不属于传统的Java代码的重构，也不属于前端工程师的范畴，就这样姥姥不疼、舅舅不爱地被忽略了。但是对一个网站来说，模板数量大得惊人，这是一个不可避开的话题。微博上@zhh-2009说道：

阿里集团有成千上万的系统，一大堆的Java码农，有个更好笑的说法是: 阿里Java码农其实就是velocity模板码农。

把业务逻辑从模板中剥离出去

模板是用来做什么的？就是用来做页面生成和展现的，以分离业务逻辑代码和用户界面代码。理想情况下，模板代码中不应该包含任何业务逻辑的代码在里面。我见过通过向模板传递service对象的方式，再在模板里面通过service获取数据，这是糟糕的做法。模板要做的事情需要保持清晰，不要耦合那些模型层的业务逻辑。

剥离数据处理的重复劳动

Model的数据，距离展现需要的数据，表现形式上会有诸多差异，所以往往在模板拿到以后，还需要经过加工处理才能展示。比如日期型数据，一个java.util.Date对象被送到了模板上，有时需要转换成“2012-11-18”这样的形式，有时需要转换成“09:47:10”这样的形式，于是我见到了大块的页面模板上数据处理的逻辑代码。

当然，这也是可以优化的：

1、使用标签。标签可以封装好一些通用的展示逻辑，这里指的标签就是纯粹为了展示的需要而封装的标签，并非封装了业务逻辑的功能标签。每一个标签都可以变成一个小的MVC组件，一样可以使用模板的方式来输出（而不是再标签实现类里面生写HTML代码）。

2、使用模板宏。比如FreeMarker的模板宏：

<#macro repeat count>

    <#local name = "default">

    <#list 1..count as iter>

        ${name} ${count}/${iter}: <#nested>

    </#list>

</#macro>

然后就可以使用了：

<@repeat count=3>abc</@repeat>

3、使用数据处理的工具方法。可以写辅助类，在模板中引入，也可以利用模板的“静态引入”能力，后文会提到。

4、在数据传递到模板前，增加一层数据预处理的逻辑。这个实现方式有很多，比较常见的是利用Interceptor，将一种数据处理成多种展现形式，在模板中就可以直接拿来使用，后文也会提到。

管理好模板数据的上下文

说到模板数据的上下文，就要提到模板变成页面的方式，最基本的方式其实就是占位符（表达式）的替换，也就是将指定模板内容（字符串）中的特定标记（子字符串）替换一下便生成了最终需要的业务数据。在此基础上，才有编译型或者解释型的其它方式。

在占位符替换的过程中，需要根据表达式字符串，去特定的上下文中寻找相应的数据，以JSTL为例，所有通过request.setAttribute(“key”, value)方法放置的数据全部都能直接获取：

<div><c:out value="key" /></div>

或者也可以利用JSP对EL表达式原生的支持：

<div>${key}</div>

如果你使用的是OGNL表达式语言，为了更好用，它在Struts 2中做了进一步扩展，这时这个上下文就是总接触到的“value stack”。

展示数据预处理层

这一层就是为了填补Model和模板展示需要的数据或者数据形式之沟壑而增加的，可以使用Interceptor实现，比如我在所有页面展示里面都需要用到当前用户user这个对象，那我就可以在Interceptor中，把user对象准备好，放置到模板数据的上下文中，这样在模板里面就可以拿来即用了。这是数据的沟壑，还有数据形式的沟壑，前面那个时间格式的例子已经提到过了。

静态引入也是一种常用的准备数据的方式，在JSP里就是：

<%@import page="userData.jsp" %>

用这种方式引入的页面在编译时就会引入进来，里面的数据、包、类拿来即用。

子页面划分

在页面模板重构上，这大概是我们最常用和最基础的办法。我们经常根据最终呈现页面的特点，把页面划分成展示功能独立的几个子页面，然后在需要的位置引入进来，比如JSP的动态引入：

<jsp:import page="detail.jsp" />

还有一种方式对页面模板开发的程序员更加透明，开发人员在自己关心的页面模板中可以看不到这些import的代码，转而把这个引入的规则配置放到页面模板之外去，有的根据URL规则来聚合子页面，有的根据自定义的页面特点来聚合那些子页面，比如Tiles 2的聚合规则配置：

<definition name="index" template="/siteLayout.jsp"> 

    <put-attribute name="header" value="/header.jsp"></put-attribute> 

    <put-attribute name="content" value="/content.jsp"/>  

    <put-attribute name="footer" value="/footer.jsp"/> 

</definition>

更多的例子，在这个我曾经已经谈到过的这个页面聚合的话题。

文章系本人原创，转载请注明作者和出处（ http://www.raychase.net ）

注：本博客已经迁移到个人站点  http://www.raychase.net/  ，欢迎大家访问收藏，本ITEye博客在数日后将不再更新。