Freemarker自定义方法

在项目中有一个需求，每个物品有一个guid，存在数据库中，而在页面上需要显示一个对应的业务数据值，暂且叫做serverId，serverId是通过guid移位计算得来。serverId只需要显示，后台并不需要使用。

因为serverId在后台用不到，所以就没有使用VO字段来存储，项目使用了Freemarker作为view层的模板引擎。了解到Freemarker的一个特点是具有很多内置的功能强大的方法，例如substring、upper_case等。最重要的是Freemarker支持自定义方法。所以就考虑到了通过自定义Freemarker方法来解决。具体步骤如下：

Freemarker实现自定义方法很简单，只需要实现freemarker.template.TemplateMethodModel接口就行了。具体代码如下所示：

import java.util.List;

import freemarker.template.TemplateMethodModel;
import freemarker.template.TemplateModelException;

/**
* ClassName:GuidToServerIdUtil <br/>
* Function: Freemarker自定义方法，通过guid位移48位计算serverId. <br/>
* Date:     2012-12-26 下午09:09:35 <br/>
* @author   chenzhou
* @version
* @since    JDK 1.6
*/
public class GuidToServerIdUtil implements TemplateMethodModel {

@Override
public Object exec(List args) throws TemplateModelException{
//参数列表的第一位为guid
long guid = Long.parseLong(args.get(0).toString());
//通过guid位移48位计算serverId
int serverId = (int) (guid >>> 48);
return serverId;
}

}

如上面代码所示 ，GuidToServerIdUtil类定义了一个exec方法，此方法内的逻辑就是自定义Freemarker方法的执行逻辑。代码很简单，把guid当做第1个参数传递进来，然后执行移位计算后返回计算后的结果。

定义了GuidToServerIdUtil类之后我们如果需要在ftl页面中使用还需要在项目的xxx-servlet.xml中进行配置，具体配置如下：

<!--配置视图解析器，使用FreeMarker视图 -->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
<property name="viewClass"
value="org.springframework.web.servlet.view.freemarker.FreeMarkerView"></property>
<property name="exposeSessionAttributes" value="true"></property>
<property name="exposeRequestAttributes" value="true"></property>
<property name="suffix" value=".ftl"></property>
<property name="contentType" value="text/html;charset=utf-8"></property>
<property name="attributesMap">
<map>
<!-- 定义Freemarker方法的名称 -->
<entry key="guid2sid">
<!-- 关联到我们之前定义的工具类 -->
<bean class="com.chenzhou.examples.erm.util.GuidToServerIdUtil" />
</entry>
</map>
</property>
</bean>

上面配置文件中，我们定义了方法的名称为guid2sid，然后关联到了GuidToServerIdUtil类。配置完后，我们就可以在ftl页面中使用了：



页面显示结果如下：



说明guid2sid方法已经生效了。
除了在配置文件中定义后使用之外，我们也可以直接把方法对象放入到Freemarker的数据模型中，然后在ftl文件中使用。具体示例如下（注意我把方法命名为guid2serverId）：

//在Controller方法中把方法对象存入数据模型中
model.put("guid2serverId", new GuidToServerIdUtil());

然后在ftl使用方法还是一样：



结果如下：