因公司项目需求,需要对Velocity进行学习,进行记录学习。
Velocity是一个基于Java的模板引擎,通过特定的语法,Velocity可以获取在java语言中定义的对象,从而实现界面和java代码的真正分离,这意味着可以使用velocity替代jsp的开发模式了(实际上笔者所在的公司已经这么做了)。这使得前端开发人员可以和 Java 程序开发人员同步开发一个遵循 MVC 架构的 web 站点,在实际应用中,velocity还可以应用于很多其他的场景.
- Velocity的介绍
Velocity是一个基于Java的模板引擎,其提供了一个Context容器,在java代码里面我们可以往容器中存值,然后在vm文件中使用特定的语法获取,这是velocity基本的用法,其与jsp、freemarker并称为三大视图展现技术,相对于jsp而言,velocity对前后端的分离更加彻底:在vm文件中不允许出现java代码,而jsp文件中却可以.
作为一个模块引擎,除了作为前后端分离的MVC展现层,Velocity还有一些其他用途,比如源代码生成、自动email和转换xml等,具体的用法可以参考这篇文章.
2. Velocty的基本用法
在这里我们以一个HelloVelocity作为Velocity的入门实例.首先在官网下载velocity的最新发布包,新建普通java项目,引入其中的velocity-1.7.jar和lib文件夹下的所有jar包即可. 然后分为如下两步:
2.1 初始化Velocity引擎
编写HelloVelocity.java文件如下:
public static void main(String[] args) {
// 初始化模板引擎
VelocityEngine ve = new VelocityEngine();
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
ve.init();
// 获取模板文件
Template t = ve.getTemplate("hellovelocity.vm");
// 设置变量
VelocityContext ctx = new VelocityContext();
ctx.put("name", "Velocity");
List list = new ArrayList();
list.add("1");
list.add("2");
ctx.put("list", list);
// 输出
StringWriter sw = new StringWriter();
t.merge(ctx,sw);
System.out.println(sw.toString());
}
首先,我们在代码中初始化了VelocityEngine这个模板引擎,对其设置参数进行初始化,指定使用ClasspathResourceLoader来加载vm文件。然后我们就可以往VelocityContext这个Velocity容器中存放对象了,在vm文件中我们可以取出这些变量,从而进行模板输出.
2.2 编写hellovelocity.vm文件
其中,vm文件放在classpath目录下即可,类加载器会进行加载
hellovelocity.vm文件如下:
#set($greet = 'hello')
$greet $name
#foreach($i in $list)
$i
#end
控制台输出如下:
hello Velocity
1
2
2.3 Velocity的基本语法
本文中只简单的介绍几个Velocity的基本语法,具体可以参考这篇文章
3.1 变量
在Velocity中也有变量的概念,使用 符声明变量,可以声明变量也可以对变量进行赋值(变量是弱类型的)。另外还可以使用 取出在VelocityContext容器中存放的值
#set(${!name} = "velocity")
#set(${!foo} = $bar)
#set($foo =“hello”)
#set($foo.name = $bar.name)
#set($foo.name = $bar.getName($arg))
#set($foo = 123)
#set($foo = [“foo”,$bar])
需要注意,上面代码中
!的写法,使用
vari获取变量时,如果变量不存在,Velocity引擎会将其原样输出,通过使用$!{}的形式可以将不存在的变量变成空白输出.
3.2 布局母版vm文件
布局layout.vm文件是所有要展示的vm文件的母版,如下所示:
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>${page_title}</title>
#if($!{CSS})
#foreach($_css in ${CSS})
<link type="text/css" rel="stylesheet" href="${ContextPath}/$_css">
#end
#end
</head>
<body>
<div class="header">
#parse("/templates/layout/header.vm")
</div>
<div class="container">
<div class="sub">
#parse($sub)
</div>
<div class="main">
$screen_content
</div>
</div>
#if($!JS)
#foreach($_js in $JS)
<script type="text/javascript" src="${CntextPath}/${_js}">
#end
#end
</body>
</html>
其中,有个特殊的变量 screen_content,这是Velocity内置的变量,代表将要转发的页面
3.3 编写转发的vm文件
#set($layout = "/templates/layout/layout.vm")
#set($CSS = ["scripts/css/index.css"])
#set($JS = ["scripts/js/jquery-1.11.3.js"])
#set($page_title = "主页")
#set($sub = "/templates/sub.vm")
<div id="main-show">
this is main-show
</div>
学习地址:http://blog.csdn.net/qq_25237663/article/details/52262532