一、引言

展示层有三大典型技术，分别是JSP、freemaker和velocity。本文主要介绍velocity。

Velocity 主要使用场景如下：

Web 应用：开发者在不使用 JSP 的情况下，可以用 Velocity 让 HTML 具有动态内容的特性。

源代码生成：Velocity 可以被用来生成 Java 代码、SQL 或者 PostScript。

自动 Email：很多软件的用户注册、密码提醒或者报表都是使用 Velocity 来自动生成的。

转换 xml。

二、入门

velocity是一个基于java的模板引擎，与freemarker齐名，下面写一个velocity的hello world的demo。

maven依赖

org.apache.velocity

velocity

${velocity.version}

测试servelt

import org.apache.velocity.Template;

import org.apache.velocity.VelocityContext;

import org.apache.velocity.app.VelocityEngine;

import org.apache.velocity.runtime.RuntimeConstants;

import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;

import java.io.StringWriter;

import java.util.ArrayList;

import java.util.List;

/**

* ==Velocity之Hello Wordld入门程序==

*

* 首先，我们在代码中初始化了VelocityEngine这个模板引擎，对其设置参数进行初始化，

* 指定使用ClasspathResourceLoader来加载vm文件。然后我们就可以往VelocityContext这个Velocity

* 容器中存放对象了，在vm文件中我们可以取出这些变量，从而进行模板输出。

*/

public class VelocityTest {

private static final String VM_PATH = "template/velocity/helloworld.vm";

public static void main(String[] args) {

// 初始化模板引擎

VelocityEngine velocityEngine = new VelocityEngine();

velocityEngine.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");

velocityEngine.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());

velocityEngine.init();

// 获取模板文件

Template template = velocityEngine.getTemplate(VM_PATH);

// 设置变量，velocityContext是一个类似map的结构

VelocityContext velocityContext = new VelocityContext();

velocityContext.put("name", "world");

List list = new ArrayList();

list.add("jack");

list.add("kitty");

velocityContext.put("list", list);

// 输出渲染后的结果

StringWriter stringWriter = new StringWriter();

template.merge(velocityContext, stringWriter);

System.out.println(stringWriter.toString());

}

}

测试结果

hello world

1: This is jack

2: This is kitty

二、语法

2.1 变量

和我们所熟知的其他编程语言一样，Velocity 也可以在模板文件中有变量的概念。

变量定义

#set($name =“velocity”)

等号后面的字符串 Velocity 引擎将重新解析，例如出现以$开始的字符串时，将做变量的替换。

#set($hello =“hello $name”)

上面的这个等式将会给 $hello 赋值为“hello velocity”

变量的使用

在模板文件中使用

{name} 来使用定义的变量。推荐使用

name 和

names 这个变量。

#set($name =“ricky”)

Welcome $name to velocity.com

2.2 循环

在 Velocity 中循环语句的语法结构如下：

#foreach($element in $list)

This is $element

$velocityCount

#end

Velocity 引擎会将 list 中的值循环赋给 element 变量，同时会创建一个 $velocityCount 的变量作为计数，从 1 开始，每次循环都会加 1.

2.3 条件语句

条件语句的语法如下：

#if(condition)

#elseif(condition)

#else

#end

2.4 关系操作符

Velocity 引擎提供了 AND、OR 和 NOT 操作符，分别对应&&、||和! 例如：

#if($foo && $bar)

#end

2.5 宏

Velocity 中的宏可以理解为函数定义。定义的语法如下：

#macro(macroName arg1 arg2 …)

#end

调用这个宏的语法是：

#macroName(arg1 arg2 …)

这里的参数之间使用空格隔开，下面是定义和使用 Velocity 宏的例子：

#macro(sayHello $name)

hello $name

#end

#sayHello(“velocity”)

输出的结果为 hello velocity

2.6 内嵌和引用

#parse 和 #include 指令的功能都是在外部引用文件，二者的区别是：

#parse会将引用的内容当成类似于源码文件，会将内容在引入的地方进行解析

#include是将引入文件当成资源文件，会将引入内容原封不动地以文本输出

下面分别看两个例子：

案例1：

## foo.vm 文件：

#set($name =“velocity”)

## parse.vm文件：

#parse(“foo.vm”)

输出结果为：

velocity

案例2：

## foo.vm 文件：

#set($name =“velocity”)

## include.vm：

#include(“foo.vm”)

输出结果为：

#set($name =“velocity”)

三、Spring整合velocity进行页面展示

3.1 初步整合

添加依赖

org.apache.velocity

velocity

1.6.2

org.apache.velocity

velocity-tools

2.0

web.xml

mvc-dispatcher

org.springframework.web.servlet.DispatcherServlet

contextConfigLocation

classpath:springMVC.xml

1

mvc-dispatcher

/

编写/resources/spring-mvc.xml

UTF-8

UTF-8

添加resources/velocity.properties

## 设置模板文件加载器，webapp从应用根目录加载

resource.loader = webapp

webapp.resource.loader.class = org.apache.velocity.tools.view.WebappResourceLoader

## 模板路径，根目录下的vm文件夹，比如访问http://localhost:8080/velocity/t.htm，则选中的模板路径是webapp/vm/t.htm，如果没配置，默认是模板路径是webapp/t.htm

webapp.resource.loader.path = /vm

## 设置编码，不设置会中文乱码

input.encoding = UTF-8

output.encoding = UTF-8

tools.view.servlet.layout.default.template=default.vm

# 默认的布局文件位置

tools.view.servlet.layout.directory=/WEB-INF/layout/

编写webapp/vm/layout/layout.vm

编写webapp/vm/test/index.vm

hello world!${name}

编写测试Controller

import org.springframework.stereotype.Controller;

import org.springframework.ui.Model;

import org.springframework.web.bind.annotation.RequestMapping;

/**

* velocity与Spring MVC集成作为展示页面Demo

*/

@Controller

@RequestMapping(value = "/velocity")

public class MyVelocityTestController {

/**

* 模拟首页

*

* @param model

* @return

*/

@RequestMapping(value = "/index")

public String index(Model model) {

String name = "tester";

model.addAttribute("name", name);

return "test/index";

}

3.2 velocity选择不同的模板

系统中的登录页面所使用的模板与其他普通页面使用的模板不同，或者是某些页面需要引用不同的模板。

先按照上节velocity(4) 的步骤配置好，通过以上配置后普通页面velocity会自动套用layout/default.vm模板。如果登录页面需套用自己独特的模板则如下可以在登录页面中添加：#set($layout="login_layout.vm")，则登录页面将套用"login_layout.vm"模板。

编写webapp/vm/layout/empty.vm

$screen_content

webapp/test/login.vm

#set($layout="layout/empty.vm")

This is the login page

完善测试controller

import org.springframework.stereotype.Controller;

import org.springframework.ui.Model;

import org.springframework.web.bind.annotation.RequestMapping;

/**

* velocity与Spring MVC集成作为展示页面Demo

*/

@Controller

@RequestMapping(value = "/velocity")

public class MyVelocityTestController {

/**

* 模拟首页

*

* @param model

* @return

*/

@RequestMapping(value = "/index")

public String index(Model model) {

String name = "tester";

model.addAttribute("name", name);

return "test/index";

}

/**

* 模拟使用不一样模板的登录页

*

* @param model

* @return

*/

@RequestMapping(value = "/login")

public String login(Model model) {

return "test/login";

}

}

测试

测试1:访问localhost:8080/velocity/index

test1

测试2：访问localhost:8080/velocity/login

test2

可以看到，成功实现了不同页面引用和不引用公共模板的功能。

四、参考资料

前言

关于velocity与SpringMVC的配置请参考前一篇文章，此处不再介绍。velocity作为Java模版引擎的主要目的是为了允许任何人使用简单而强大的模板语言来引用定义在Java代码中的对象。在velocity文件中可以给该页面指定模版布局，从而节省了大量的时间去写通用的模版布局。可以定义变量，与Java方法进行交互。

定义一个layout模版

在上一篇文章中提到了配置默认模版，当然也可以不使用默认模版即在要用到的页面的最上端写上

?

1

class="html plain">#set($layout='layout/yourlayout.vm')

那么如何定义一个layout，看下面的例子：

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

html?PUBLIC?"-//W3C//DTD?XHTML?1.0?Transitional//EN"?"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

????

$!page_title?测试layout页面

????

????

????

????

????

????

????$screen_content

那么$screen_content所在的位置即是你所打开页面将要占用的位置。

定义一个变量

?

1

2

3

#set($var='xxxx')

?

##输出上面的变量直接使用$var

魂环数组或者list

?

1

2

3

#foreach($ele?in?$list)

output?element:$ele

#end

条件判断

?

1

2

3

4

5

6

7

#if($var=='xxxx')

it?is?right

#elseif($var=='')

sorry

#else

it?is?wrong

#end

内置对象

类似于JSP，velocity也有自己的内置对象，如$request,$response,$session这样以来我们就可以将Java对象request和response以及session里的东西轻而易举的展现在web页面里。

自定义标签(指令)

velocity同时也支持自定义标签，或者称为指令。如果查看velocity的源码就会发现有个directive.properties

?

1

2

3

4

5

6

7

8

9

directive.1=org.apache.velocity.runtime.directive.Foreach

directive.2=org.apache.velocity.runtime.directive.Include

directive.3=org.apache.velocity.runtime.directive.Parse

directive.4=org.apache.velocity.runtime.directive.Macro

directive.5=org.apache.velocity.runtime.directive.Literal

directive.6=org.apache.velocity.runtime.directive.Evaluate

directive.7=org.apache.velocity.runtime.directive.Break

directive.8=org.apache.velocity.runtime.directive.Define

directive.9=org.apache.velocity.runtime.directive.Stop

这里正是velocity当前所提供的9个标签(指令)，下面我们新添加一个指令say

?

1

2

3

??#say("hello")

java代码实现

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

import?java.io.IOException;

import?java.io.Serializable;

import?java.io.StringWriter;

import?java.io.Writer;

import?java.util.HashMap;

import?java.util.Map;

?

import?org.apache.velocity.VelocityContext;

import?org.apache.velocity.app.VelocityEngine;

import?org.apache.velocity.context.InternalContextAdapter;

import?org.apache.velocity.exception.MethodInvocationException;

import?org.apache.velocity.exception.ParseErrorException;

import?org.apache.velocity.exception.ResourceNotFoundException;

import?org.apache.velocity.runtime.directive.Directive;

import?org.apache.velocity.runtime.parser.node.Node;

import?org.apache.velocity.runtime.parser.node.SimpleNode;

import?org.springframework.beans.factory.annotation.Autowired;

?

import?com.alibaba.citrus.service.template.TemplateService;

import?com.alibaba.click.util.HostUtil;

?

public?class?Say?extends?Directive{

?????

????@Autowired

????TemplateService?templateService;

?????

????private?static?final?VelocityEngine?velocityEngine?=?new?VelocityEngine();

?

????@Override

????public?String?getName()?{

????????return?"say";

????}

?

????@Override

????public?int?getType()?{

????????return?LINE;

????}

?

????@Override

????public?boolean?render(InternalContextAdapter?context,?Writer?writer,

????????????Node?node)?throws?IOException,?ResourceNotFoundException,

????????????ParseErrorException,?MethodInvocationException?{

????????SimpleNode?sn?=?(SimpleNode)?node.jjtGetChild(0);???

????????writer.write((String)sn.value(context));

????????return?true;

????}

?????

}

接下来就可以在velocity.properties文件里添加上

?

1

say=cn.buglife.demo.msv.directive.Say

劳动所得 不喜勿喷：获取【下载地址】