Velocity

Velocity是一个基于Java的模板引擎，其提供了一个Context容器，在java代码里面我们可以往容器中存值，然后在vm文件中使用特定的语法获取，这是velocity基本的用法，其与jsp、freemarker并称为三大视图展现技术，相对于jsp而言，velocity对前后端的分离更加彻底：在vm文件中不允许出现java代码，而jsp文件中却可以

简单示例

java代码

  1. public class HelloVelocity {
  3.     public static void main(String[] args) {
  4.         // 初始化模板引擎
  5.         VelocityEngine ve = new VelocityEngine();
  6.         ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
  7.         ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
  8.         ve.init();
  9.         // 获取模板文件
  10.         Template t = ve.getTemplate("hellovelocity.vm");
  11.         // 设置变量
  12.         VelocityContext ctx = new VelocityContext(); //velocity模板的上下文对象可以存储java对象，可以再vm模板中获取
  13.         ctx.put("name", "Velocity");
  14.         List<String> list = new ArrayList();
  15.         list.add("1");
  16.         list.add("2");
  17.         ctx.put("list", list);
  18.         // 输出
  19.         StringWriter sw = new StringWriter();
  20.         t.merge(ctx,sw);
  21.         System.out.println(sw.toString());
  22.     }
  23. }

vm模板

  1. #set($greet = 'hello')       ##设置变量
  2. $greet $name
  3. #foreach($item in $list)     ##遍历list
  4.     $velocityCount             ##当前item的索引
  5.     $item    
  6.     $abc                     ##如果找不到变量abc则$abc会原样输出，而 $!{abc} 这回输出空白                
  7.     $!{abc}
  8. #end                         ##遍历结束

变量

1.变量的定义

  1. #set($name ="velocity”)         ##给name变量赋值为velocity
  3. #set($hello ="hello $name”)     ##等价#set($hello ="hello velocity”)

2.变量的使用

在模板文件中使用$name 或者 ${name} 来使用定义的变量。推荐使用 ${name} 这种格式，因为在模板中同时可能定义了类似 $name 和 $names 的两个变量，如果不选用大括号的话，引擎就没有办法正确识别 $names 这个变量。

对于一个复杂对象类型的变量，例如 $person，可以使用 ${person.name} 来访问 person 的 name 属性。值得注意的是，这里的 ${person.name} 并不是直接访问 person 的 name 属性，而是访问 person 的 getName() 方法，所以 ${person.name} 和 ${person.getName()} 是一样的。

3. 变量赋值

在第一小点中，定义了一个变量，同时给这个变量赋了值。对于 Velocity 来说，变量是弱数据类型的，可以在赋了一个 String 给变量之后再赋一个数字或者数组给它。可以将以下六种数据类型赋给一个 Velocity 变量：变量引用, 字面字符串, 属性引用, 方法引用, 字面数字, 数组列表。

  1. #set($foo = $bar) 
  2. #set($foo ="hello”)
  3. #set($foo.name = $bar.name)
  4. #set($foo.name = $bar.getName($arg))
  5. #set($foo = 123)
  6. #set($foo = ["foo”,$bar])

循环

  1. #foreach($element in $list)   
  2.  This is $element
  3.  $velocityCount               ##当前element元素在list中的下表
  4. #end

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

条件语句

  1. #if(condition)
  2. ...
  3. #elseif(condition)
  4. ...
  5. #else
  6. ...
  7. #end

关系操作符

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

  1. #if($foo && $bar)
  2. #end

宏

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

  1. #macro(macroName arg1 arg2...)
  2. ...
  3. #end

调用这个宏的语法是：

  1. #macroName(arg1 arg2...)

示例

  1. #macro(sayHello $name)
  2. hello $name
  3. #end
  4. #sayHello("velocity")              ##结果显示  hello velocity

#parse 和 #include

parse 和 #include 指令的功能都是在外部引用文件，而两者的区别是，#parse 会将引用的内容当成类似于源码文件，会将内容在引入的地方进行解析，#include 是将引入文件当成资源文件，会将引入内容原封不动地以文本输出

foo.vm

  1. #set($name ="velocity")

parse.vm

  1. #parse("foo.vm")
  2. $!{name}                    ##结果输出   velocity

include.vm

  1. #include("foo.vm")
  2. $!{name}                    ##结果输出   #set($name ="velocity")