模板语言Velocity的入门认识

简介

Velocity是Apache的产品 模板文件后缀名称是 .vm，它的使用语法和JSP中的EL表达式和JSTL标签没有太大区别。
Velocity是完全基于Java语言开发的一套模板技术。可以用来生成HTML代码、JS代码、Java代码、邮件文本内容、手机短信内容、宣传广告等。

Velocity入门案例

模板 + 数据 = 输出

大家好，我是${name}

@Test 
public void test() throws Exception{ 
//创建Velocity的上下文对象（类似于JSP的四大作用域对象-身上都有一个Map集合属性） 
VelocityContext context = new VelocityContext();
 //Java语言中有哪些对象可以存放多个数据：数组、List、Set、Map //给上下文添加一些数据 这个上下文对象身上有一个Map集合的属性
  context.put("name","昌老师");
 //通过模板文件路径获取一个模板（注意这个路径默认是当前项目的根目录下）
 Template template = Velocity.getTemplate("hi.vm", "utf-8"); 
 //创建一个输出流(你想把模板的内容和数据输出到哪里，你就创建对应的输出流)
 StringWriter writer = new StringWriter(); 
 //将模板和输出流合并 template.merge(context, writer);
  System.out.println(writer); }

Velocity模板语法

声明变量+注释

## 单行注释
 #*多行注释 *#
 #*声明一个变量，声明的变量就直接放入VelocityContext对象的Map集合中 声明的变量前面要加一个$符号 *#
 #set($username = "admin100") 
 #set($age = 25) 
 #set($sex = true)

空值处理

大家好，我是${name}

如果上下文中有name这个值的话，就获取出来进行展示；
如果上下文中没有name这个值的话，就默认将$name当做普通文本直接展示出来，其实这样展示是不好的，我们需要对空值进行处理在$后面添加一个感叹号 改成 $!{name}，这样当上下文中找不到对应的值的时候，就直接忽略这个东西。

调用Java方法

context.put(“date”,new Date());
context.put(“sdf”,new SimpleDateFormat(“yyyy-MM-dd”));

今天是$!{sdf.format($date)}

输出结果：
今天是2020-04-24
在模板文件中调用java对象的方法，语法与java代码差不多

获取一个对象的属性

我们有一个部门对象，里面有name属性以及getter、setter方法

我属于$!{department.name}

这个语法就表示获取department对象的name属性值，其实底层就是去调用了该对象的getName()方法，遵守JavaBean的属性获取的规范。
如果将模板改成 $!{department}，如果department是一个对象的话，则Velocity会自动调用该对象的toString方法来获取一个字符串进行展示，如果department是一个简单类型的值的话，则直接展示。

获取数组和集合数据

#foreach($city in $citys) $!{city} #end

转化为java代码后如下

for(String city : citys){
 }

		//保存一个数组
        String[] citys = {"重庆","成都","南京"};
        context.put("citys",citys);
        //保存一个List集合
        List<String> citys1 = new LinkedList<>();
        citys1.add("重庆");
        citys1.add("成都");
        citys1.add("南京");

在单元测试中保存数组或者List集合后，在模板中循环获取数据的代码是一致的。

获取Map集合的数据

#foreach($k in $map.keySet())
    $!{k}  -->  $map.get($k)
#end

#foreach($entry in $map.entrySet())
    $!{entry.key} --> $!{entry.value}
#end

		//保存一个Map集合
        Map<String,Object> map = new HashMap<>();
        map.put("a","哈哈哈哈");
        map.put("b",department);
        map.put("c",new Date());
        context.put("map",map);

分支语句

#if($sex)
男
#else
女
#end

#if($age <= 20)
children
#elseif($age <= 30)
teenager
#elseif($age <= 50)
middle man
#else
old man
#end

完整vm文件及单元测试代码

vm文件

#set($username = "admin100")
#set($age = 30)
#set($sex = true)
大家好，我是$!{name}
今日日期$!{sdf.format($date)}
我的部门为$!{department.name}
#foreach($city in $citys)
    $!{city}
#end

#foreach($city1 in $citys1)
    $!{city1}
#end

#foreach($k in $map.keySet())
    $!{k}  -->  $map.get($k)
#end

#foreach($entry in $map.entrySet())
    $!{entry.key} --> $!{entry.value}
#end

#if($sex)
男
#else
女
#end

#if($age <= 20)
children
#elseif($age <= 30)
teenager
#elseif($age <= 50)
middle man
#else
old man
#end

单元测试

public class _07_Velovity extends BaseTest {
    @Test
    public void test() throws Exception{
        //创建Velocity的上下文对象（类似于JSP的四大作用域对象-身上都有一个Map集合属性）
        VelocityContext context = new VelocityContext();
        //Java语言中有哪些对象可以存放多个数据：数组、List、Set、Map
        //给上下文添加一些数据 这个上下文对象身上有一个Map集合的属性
        context.put("name","昌老师");
        context.put("date",new Date());
        context.put("sdf",new SimpleDateFormat("yyyy-MM-dd"));
        //创建一个对象放入上下文
        Department department = new Department(1L,"销售部");
        context.put("department",department);
        //保存一个数组
        String[] citys = {"重庆","成都","南京"};
        context.put("citys",citys);
        //保存一个List集合
        List<String> citys1 = new LinkedList<>();
        citys1.add("重庆");
        citys1.add("成都");
        citys1.add("南京");
        context.put("citys1",citys1);
        //保存一个Map集合
        Map<String,Object> map = new HashMap<>();
        map.put("a","哈哈哈哈");
        map.put("b",department);
        map.put("c",new Date());
        context.put("map",map);
        //通过模板文件路径获取一个模板（注意这个路径默认是当前项目的根目录下）
        Template template = Velocity.getTemplate("hi.vm", "utf-8");
        //创建一个输出流(你想把模板的内容和数据输出到哪里，你就创建对应的输出流)
        StringWriter writer = new StringWriter();
        //将模板和输出流合并
        template.merge(context, writer);
        System.out.println(writer);
    }
}