模板：velocity和freemarker的比较

/**
*作者：张荣华(ahuaxuan)
*2007-04-16
*转载请注明出处及作者
*/

模板技术在现代的软件开发中有着重要的地位，而目前最流行的两种模板技术恐怕要算freemarker和velocity 了，webwork2.2对两者都有不错的支持，也就是说在webwork2中你可以随意选择使用freemarker或velocity作为view， 模板技术作为view的好处是很多，尤其和jsp比较起来优点更大，众所周知jsp需要在第一次被执行的时候编译成servlet，那么这个过程是很慢 的，当然很多应用服务器都提供预编译的功能，但是在开发的时候仍然给我们程序员带来了很多痛苦，每次修改都要多几秒钟，那在一天的开发中就有很多时间浪费 在jsp的编译上了。用webwork in action的作者的话来说：“每次修改之后重新运行都要等等几秒是令人失望的，而频繁地修改jsp更是会令你的失望情绪变本加厉“。我们把模板技术引入 到view中去可以带来更好的开发效率，而且模板的速度要比jsp快（虽然编译过后的jsp在速度上已经满足我的需求了，呵呵）。 当然模板技术可以用在很多领域，可不只在view那里。我们可以通过模板技术来生成xml，生成jsp，生成java文件等等，说到这里，大家通常会使用 模板技术用在公司的框架里，这样就可以很快速的生成添删改查的代码，需要的只是模板，其他比如还有邮件模板等等。

以上是模板的作用，当然模板还有其他领域的应用，希望能和大家多讨论，提高我们的生产效率。

那么现在开源的模板技术有好几种，多了之后就有一个选择的问题了，如何选择一个满足自己需要的模板的呢，我大概了看了一下两种模板技术，写了一个 例子，我使用了几种设计模式来完成了这个例子，这个例子中，我同时使用了freemarker和velocity，这样同学们可以通过代码很直观的比较两 种模板技术，通过这个例子，我认识到freemarker在功能上要比velocity强大
1在view层的时候，它提供了format日期和数字的功能，我想大家都有在页面上format日期或数字的经验，用jsp的同学可能对 jstl的fmt标签很有感情，使用了freemarker之后也可以使用freemarker提供的功能来formmat日期和数据，这个功能我想是很 贴心的

2通过我的使用我发现freemaker的eclipseplugin要比velocity的eclipseplugin好，如果你是用idea 那很遗憾，我没有找到类似的插件。好在很多地方呢，我看到的是freemarker的插件除了支持freemarker语法也支持html语句，而 velocity的插件貌似只支持velocity的语法，html就只是用普通的文本来显示了，在这一点上freemarker占上风了（不要和我说高 手都是用windows记事本之类的话，这本来就违背了模板技术的初衷）

3freemarker对jsptag的支持很好，算了，不到迫不得已还是不要这样做吧。

还有就是两者的语法格式，这一点上不同的人有不同倾向

下面就介绍一下这个例子吧

/**
 *
 * @author 张荣华
 * 转载请注明出处
 */
public
 
class
 TemplateTest {

    /**
     * @param args
     */
    public
 
static
 
void
 main(String[] args) 
throws
 Exception{
        /* 准备数据 */
        Map latest = new
 HashMap();
        latest.put("url"
, 
"products/greenmouse.html"
);
        latest.put("name"
, 
"green mouse"
);

        Map root = new
 HashMap();
        root.put("user"
, 
"Big Joe"
);
        root.put("latestProduct"
, latest);
        root.put("number"
, 
new
 Long(
2222
));
        root.put("date"
,
new
 Date());

        List listTest = new
 ArrayList();
        listTest.add("1"
);
        listTest.add("2"
);

        root.put("list"
,listTest);

        TemplateEngine freemarkerEngine = (TemplateEngine)TemplateFactory.getInstance().getBean("freemarker"
);
        freemarkerEngine.run(root);//使用freemarker模板技术

        TemplateEngine velocityEngine = (TemplateEngine)TemplateFactory.getInstance().getBean("velocity"
);
        velocityEngine.run(root);//使用velocity模板技术
    }

}

工厂类，用来得到模板引擎

/**
 *
 * @author 张荣华
 * 转载请注明出处
 */
public
 
class
 TemplateFactory {
    private
 
static
 TemplateFactory instance;
    private
 Map objectMap;

    static
{
        instance = new
 TemplateFactory();
    }

    public
 TemplateFactory() {
        super
();
        this
.objectMap = 
new
 HashMap();
        synchronized
 (
this
) {
            objectMap.put("freemarker"
, 
new
 FreemarkerTemplateEngine(){
                public
 String getTemplatePath() {
                    return
 
"template"
;
                }
            });

            objectMap.put("velocity"
, 
new
 VelocityTemplateEngine());
        }
    }

    public
 
static
 TemplateFactory getInstance(){
        return
 instance;
    }

    /**
     * 模仿spring的工厂
     * @param beanName
     * @return
     */
    public
 Object getBean(String beanName){
        return
 objectMap.get(beanName);
    }

}

引擎接口

/**
 *
 * @author 张荣华
 * 转载请注明出处
 */
public
 
interface
 TemplateEngine {

    void
 run(Map context)
throws
 Exception;

}

模板引擎的实现使用method template模式，因为有两个实现，这两个实现又存在公共的逻辑，所以选择了这个模式

/**
 *
 * @author 张荣华
 * 转载请注明出处
 */
public
 
abstract
 
class
 AbstractTemplateEngine 
implements
 TemplateEngine{

    public
 
abstract
 String getTemplatePath();

    public
 
abstract
 String getTemplate();

    public
 
abstract
 String getEngineType();

    public
 
void
 run(Map context)
throws
 Exception{
        if
(Constants.ENGINE_TYPE_FREEMARKER.equals(getEngineType()))
            executeFreemarker(context);
        else
            executeVelocity(context);
    }

    private
 
void
 executeFreemarker(Map context)
throws
 Exception{
        Configuration cfg = new
 Configuration();
        cfg.setDirectoryForTemplateLoading(
                new
 File(getTemplatePath()));
        cfg.setObjectWrapper(new
 DefaultObjectWrapper());

        cfg.setCacheStorage(new
 freemarker.cache.MruCacheStorage(
20
, 
250
));

        Template temp = cfg.getTemplate(getTemplate());

        Writer out = new
 OutputStreamWriter(System.out);
        temp.process(context, out);
        out.flush();
    }

    private
 
void
 executeVelocity(Map root)
throws
 Exception{

        Velocity.init();
        VelocityContext context = new
 VelocityContext(root);
        org.apache.velocity.Template template = null
;

        template = Velocity.getTemplate(getTemplatePath()+getTemplate());

        StringWriter sw = new
 StringWriter();
        template.merge( context, sw );
        System.out.print(sw.toString());

    }

}

这个是freemarker实现

/**
 *
 * @author 张荣华
 * 转载请注明出处
 */
public
 
class
 FreemarkerTemplateEngine 
extends
 AbstractTemplateEngine{
    private
 
static
 
final
 String DEFAULT_TEMPLATE = 
"FreemarkerExample.ftl"
;

    /**
     * 这个方法应该实现的是读取配置文件
     */
    public
 String getTemplatePath() {
        return
 
null
;
    }

    public
 
void
 run(Map root) 
throws
 Exception{
        super
.run(root);
    }

    public
 String getTemplate() {
        // TODO Auto-generated method stub
        return
 DEFAULT_TEMPLATE;
    }

    public
 String getEngineType() {
        return
 Constants.ENGINE_TYPE_FREEMARKER;
    }
}

这个是velocity实现

/**
 *
 * @author 张荣华
 * 转载请注明出处
 */
public
 
class
 VelocityTemplateEngine 
extends
 AbstractTemplateEngine{

private
 
static
 
final
 String DEFAULT_TEMPLATE = 
"VelocityExample.vm"
;

    public
 String getTemplatePath() {
        return
 
"/template/"
;
    }

    public
 
void
 run(Map map) 
throws
 Exception{
        super
.run(map);
    }

    public
 String getTemplate() {
        // TODO Auto-generated method stub
        return
 DEFAULT_TEMPLATE;
    }

    public
 String getEngineType() {
        // TODO Auto-generated method stub
        return
 Constants.ENGINE_TYPE_VELOCITY;
    }
}

以下是模板
1，freemarker模板

freemarker template test:
string test-----------${user}-----------${number}-----------${latestProduct.url}-----------${latestProduct.name}
condition test-----------
<#if
 user == 
"Big Joe"
>
list iterator-----------
<#list list as aa>
${aa}
</#list>
</#if
>
date test-----------${date?string("MMM/dd/yyyy"
)}

2，velocity模板

******************************************************************************************************************
velocity template test:
string test-----------${user}-----------${number}-----------${latestProduct.url}-----------${latestProduct.name}
condition test-----------
#if
 ($user == 
"Big Joe"
)
list iterator-----------
#foreach( $aa in $list )
$aa
#end
#end
date test-----------${date}

至此整个例子就结束了，以上只是最简单的介绍，当然这两种技术还有待我们的深入研究。这个例子只不过是比较直观的表现两种技术的使用而已
而且如果想学习方法模板模式和工厂模式的同学可以下载代码看看

评论

9 楼 snoopy7713 2012-05-21  

但是JspServlet是分段写入流，用模板是把整个模板一次写入流，可能问题在这里，这一点我也没有测试过，只不过

“和jsp相比，velocity这样的模板语言有着类似的功能，脚本能力则有所欠缺－对于大多数开发者来说，也许脚本能力的欠缺反而是好事。如果选择jsp，则应该多考虑jstl和jsp表达式，避免使用杂乱的jsp脚本。

模板语言尽管它们是解释执行的，但常常比jsp更快。所以jsp并没有特别的性能优势。（实际上情况很可能正相反：模板技术的性能可能更高）
”
这段话是without ejb上的原话（详见without ejb第402页，倒数第7行），我只是照抄过来，没有加以验证

8 楼 snoopy7713 2012-05-21  

和jsp相比，velocity这样的模板语言有着类似的功能，脚本能力则有所欠缺－对于大多数开发者来说，也许脚本能力的欠缺反而是好事。如果选择jsp，则应该多考虑jstl和jsp表达式，避免使用杂乱的jsp脚本。

模板语言尽管它们是解释执行的，但常常比jsp更快。所以jsp并没有特别的性能优势。（实际上情况很可能正相反：模板技术的性能可能更高）

使用jstl和jsp表达式对大多数开发者来说应该是家常便饭，但是同样的功能，比如说c:foreach标签就比#foreach in来得更繁琐，而且每次修改jsp都需要编译，大得页面一编译就要好几秒钟，一个项目累计下来花在编译上就有很多时间了

7 楼 snoopy7713 2012-05-21  

velocity的好处是,ui可以完全独立出去设计页面,而我们的数据,可以很方便的嵌套在vm里.

6 楼 snoopy7713 2012-05-21  

昨天发现velocity在转义html的时候，会调用common-lang里的转义方法，如下

Java代码  收藏代码

    if (entityName == null) { 
                    if (c > 0x7F) { 
                        writer.write("&#"); 
                        writer.write(Integer.toString(c, 10)); 
                        writer.write(';'); 
                    } else { 
                        writer.write(c); 
                    } 
                } else { 
                    writer.write('&'); 
                    writer.write(entityName); 
                    writer.write(';'); 
                } 


0x7f是只单字节最大的一个，所以凡是是双字节以上的（比如说汉字是双字节）都会被转义成$#+数字，转义过后的$#+数字在浏览器里还是能够正常显示为汉字的。除了重写这个转义的方法，有没有其他方法可以不转义中文呢，抑或说转义双字节是w3c的规范？

5 楼 snoopy7713 2012-05-21  

在下认为应该用辨证的观点看待一个事物.我一直用velocity做view,我是用webwork的action,通过hibernate取得结果存入valuestack,然后用velocity显示,除了处理不了数组(其实也能处理,就是#foreach数组,别的方法在下就不知了),其他一切表现良好!
个人认为,velocity的优势如下:
1.可以方便地操纵对象(ogna),如valueStack里有一个user,则velocity视图里可以写$user.name
2.语法简洁,简单,有foreach和if else end就够了(它设计的初衷也是成为标准的模板(语言))!
3.使用dreamweaver可以方便编写(注:velocity做view时扩展名直接用htm就可以,在下一直这么用)
4.#parse可以使你方便地复用或模块化view块.
其不方便的地方也有
1.最不方便的就是处理数组等.
   比如:
   action代码,
  
Java代码  收藏代码

    this.setResult("select sum(t.backNum),sum(t.hits) from article as t"); 

,随便说的一个例子,取得总的评论数和点击数,这样valueStack里就有了result,供velocity视图使用.如何显示呢?我没有好的办法,只能是:
Java代码  收藏代码

       
    #foreach($temp in $result) 
      #if($velocityCount == 1) 
        #set($number = $temp) 
      #else 
        #set($hits = $temp) 
      #end 
    #end 
    总的评论数为:$number; 
    总的点击数为:$hits 


大家有好的方法请告诉在下,不胜感激!
至于freemarker,个人认为其功能的确要强一些.但由于涉猎较少,不便出言评论,呵呵!

4 楼 snoopy7713 2012-05-21  

还是比较喜欢 freemarker 的 macro

我的页面框架、分页组件，全部做到 macro，用起来超方便。

在 BaseAction 里面内置分页对象，通过 freemarker macro 根据 pagination 对象状态控制分页组件。觉得比 vel 方便得多。

3 楼 snoopy7713 2012-05-21  

在项目中我一直使用Velocity.
我们并没有大量的使用macro来做分页,格式化,select等标签生成,
而是使用一个util类来完成.
在java中控制代码的能力要比macro强多了吧.

并且不使用eclipse插件来完成velocity代码添加,
而是使用dw cs3,
加入一个velocity插件,
能比较明显的分离出velocity脚本.

总之,个人觉得velocity做模板不错了.
freemarker不怎么用过,
以前听说用的人很多,
不过今天看来velocity要火点呢.

2 楼 snoopy7713 2012-05-21  

velocity我没用过。
不过freemarker用下来，最大的缺点就是中文支持不好。在中文页面上，常常因为汉字只算1个字节，变形。

1 楼 snoopy7713 2012-05-21  

VELOCITY用过一段时间， 里面是有很多特性是很独到的， 暂时感觉查询数据用VM就行了， 做增删改的操作还是和ACTION交互， 这样可以更容易优化整个系统。没有用过FREEMARKER，所以只能说说和JSP的比较。与JSP相比，VM的＃逻辑语句和JSP标签基本都可以实现现有的页面逻辑需求（都比STRTUS好用 ^_^个人习惯），速度方面差不多了，就是有时如果VM文件大小不变的修改了一下， 有时页面不会马上就体现出来。VM直接调用定义好的VELOCITY-TOOLS，这点我是最喜欢，非常方便， 就是有点不爽的，那个VELOCITY的在ECLIPSE中的插件没有自动提示定义的TOOLS的方法的功能（希望以后能够加强，不然每次调用一个方法，还要来回看拼写对否）