Velocity示例

最新推荐文章于 2022-12-20 08:56:35 发布

mohaiyong

最新推荐文章于 2022-12-20 08:56:35 发布

阅读量155

点赞数

分类专栏： Velocity模板语言文章标签： java web.xml

本文链接：https://blog.csdn.net/mohaiyong/article/details/84416951

版权

Velocity模板语言专栏收录该内容

2 篇文章 0 订阅

订阅专栏

[size=xx-large][color=orange][b]Velocity示例[/b][/color][/size]

HelloController.java类：
[size=medium][b][color=red]示例01：[/color][/b][/size]


package com.xiaonei.rose.gettingStarted.controllers;

import java.util.ArrayList;
import java.util.Date;
import java.util.Hashtable;
import java.util.List;

import net.paoding.rose.web.Invocation;
import net.paoding.rose.web.annotation.Path;
import net.paoding.rose.web.annotation.rest.Get;

import com.xiaonei.rose.model.User;

@Path("/")
public class HelloController {
	@Get("")
	public String world(Invocation inv) {
		inv.addModel("now", new Date()); // 显示页面hello-world.vm: $date.format("yy-MM-dd HH:mm:ss",$now)

		inv.addModel("flag", "Rose-属性");

		User user = new User();
		user.setAge(23);
		user.setName("momo");
		inv.addModel("user", user);

		Hashtable mytable = new Hashtable<String, String>() ;
		mytable.put("key1", "HashTable-值1") ;
		inv.addModel("mytable", mytable);

		inv.addModel("email","398875193@qq.com") ;

		User user1 = new User() ;
		User user2 = new User() ;
		user1.setName("momo1") ;
		user2.setName("momo2") ;
		List<User> users = new ArrayList<User>() ;
		users.add(user1) ;
		users.add(user2) ;
//		User users[] = {user1,user2} ;
		inv.addModel("users", users) ;

		return "hello-world"; // 跳转到页面hello-world.vm||返回指定字符串：return "@mohaiyong" ;
	}
}

hello-world.vm页面：


<html>
        <head></head>
        <body>
      0.注释：
            ## 当行注释

            #*
                                    多行注释
            *#

            #**
		                   注释快
				@author mohaiyong
				@version 1.0
			*#<br><hr>

    1.取messages文件里的值和变量格式化输出：<br>
	        #msg("hello")-#msg("hellorose"), it's $date.format("yy-MM-dd HH:mm:ss", $now)<hr>

	2.set 赋值：<br>
	        ##当set语句和控制层java语句里都设置了变量verValue,该界面优先显示set语句设置的变量值
	        #set( $velValue = "Velocity" )
            Hello $velValue World!<hr>

	3.形式引用符：<br>
	        my name is  ${flag}-ewf_momo<br>
	        my name is  ${flag}-Rose<hr>

	4.安静引用符：<br>
	        <input type="text" name="email" value="$email"/><br>
	        <input type="text" name="email" value="$!email"/><hr>

	5.单选按钮：<br>  
			<input type="radio" name="a" value="$!name"/>
			<input type="radio" name="a" value="$!age"/><hr>

	6.属性：<br>
			##(HashTable|默认属性的方法)
			$mytable.key1<br>
			## 首先尝试$getname()如果失败，再尝试 $getName().如果是$user.Name则先尝试$user.getName()后尝试$user.getname()		 
            $user.name<hr>

    7.方法：<br>
            $user.name == $user.getName()
		    $user.getAge()
		    $user.setAddress("方法设置地址setAddress()")
		    $user.getAddress()
            #set( $user.telephone = "18801491886" )
            $user.getTelephone()
            $user.setAttributes( ["Strange", "Weird", "Excited"] )
            <hr>

	8.取得语义：<br>
		    $10.5<br>
		    $flag<br>
		    \$flag<br>
		    \\$flag<br>
		    \\\$flag<hr>

	9.#set赋值：<br>
		    #set( $fuzhi = "赋值")
            $newValue = $fuzhi <br>

            #set( $monkey = $bill ) ## variable reference
			#set( $monkey.Friend = "monica" ) ## string literal
			#set( $monkey.Blame = $whitehouse.Leak ) ## property reference
			#set( $monkey.Plan = $spindoctor.weave($web) ) ## method reference
			#set( $monkey.Number = 123 ) ##number literal
			#set( $monkey.Say = ["Not", $my, "fault"] )
            $monkey.Say.get(0)<br>
            #set( $value = $foo + 1 )
			#set( $value = $bar - 1 )
			#set( $value = $foo * $bar )
			#set( $value = $foo / $bar )

            #set( $result = $query.criteria("name") )
			The result of the first query is $result
			#set( $result = $query.criteria("address") )
			The result of the second query is $result<br>
			#set( $criteria = ["name", "address"] )
			#foreach( $criterion in $criteria )
			    #set( $result = $query.criteria($criterion) )
			    #if( $result )
			        Query was successful
			    #end
			#end

			#set( $criteria = ["name", "address"] )
			#foreach( $criterion in $criteria )
			    #set( $result = false )
			    #set( $result = $query.criteria($criterion) )
			    #if( $result )
				        Query was successful
			    #end
			#end		

		    #set( $directoryRoot = "www" )
			#set( $templateName = "index.vm" )
			#set( $template = "$directoryRoot/$templateName" )
            $template<br>
            #set( $blargh = '$templateName' )
            $blargh<hr>

    10.If/ElseIf/Else：<br>
             #if( $user.age )
             <strong>Velocity!</strong><br>
             #end

            #if( $user.age < 18 )
		    <strong>未成年</strong>
			#elseif( $user.age >= 18 && $user.age<=60 )
			    <strong>成年人</strong>
			#else
			    <strong>老年人</strong>
			#end<br>

            #set ($flag01 = "rose")
			#set ($flag02 = "rose")
			 
			#if ($flag01 == $flag02)
			  flag01 == flag02
			#else
			  flag01 != flag02
			#end<br>

            #if( $flag01 && $flag02 )
            <strong> flag01 AND flag02</strong>
            #end<br>
            #if( $flag01 || $flag03 )
            <strong> flag01 OR flag03</strong>
            #end<br>

            #if( !$flag03 )
            <strong>NOT flag03</strong>
			#end<br>

            <ul>
			#foreach( $key in $mytable.keySet() )
			    <li>Key: $key -> Value: $mytable.get($key)</li>
			#end
            </ul>

            <ul>
			#foreach( $employee in $users )
			    <tr><td>$velocityCount</td>
			        <td>$employee.getName()</td>
			    </tr>
			    ##或者 $employee.name/$employee.Name
			#end
            </ul><hr>

    11.包含：<br>
            ##include( "data.txt" )

    12.解析：<br>
            　　        ##parse("data.vm")<hr>
                            解析<hr>

    13.宏：<br>
            #macro( tablerows $color $somelist )
				#foreach( $something in $somelist )
				    <tr><td bgcolor=$color>$something</td></tr>
				#end
			#end
			#set( $greatlakes = ["Superior","Michigan","Huron","Erie","Ontario"] )
			#set( $color = "#CC00FF" )
			<table>
			    #tablerows( $color $greatlakes )
			</table>

			#macro( callThree $a )
              $a $a $a
            #end
              #set( $hong = $user.getName())
              #callThree( $hong )<hr>

    14.转义 VTL 指令：<br>
            \#if( $jazz )
                                  转义if else
            \#end<hr>

    15.格式化：<br>
            #set( $imperial = ["momo1","momo2","momo3","momo4"] )
			#foreach( $shogun in $imperial )
			    $shogun
			#end<br>

			Send me
			#set( $foo = ["$10 and ","a cake"] )
			#foreach( $a in $foo )
			$a
			#end
            please.<hr>

    16.数学特征：<br>
            #set( $bar = $user.age )   age：$bar
            #set( $foo = $bar + 3 )         $foo
			#set( $foo = $bar - 4 )         $foo
			#set( $foo = $bar * 6 )         $foo
			#set( $foo = $bar / 2 )         $foo
			#set( $foo = $bar % 5 )         $foo
			<hr>

	17.范围操作符：<br>
			#foreach( $foo in [1..5] )
			$foo
			#end
			 
			#foreach( $bar in [2..-2] )
			$bar
			#end
			 
			#set( $arr = [0..1] )
			#foreach( $i in $arr )
			$i
			#end
			 
			[1..3]<hr>

	18.进阶：<br>
			#set( $foo = "bar" )
			$\!foo<br>
			$\!{foo}<br>
			$\\!foo<br>
			$\\\!foo<br>
			\$foo<br>
			\$!foo<br>
			\$!{foo}<br>
			\\$!{foo}<hr>

	19.字符串拼接：<br>
			#set( $size = "莫" )
			#set( $name = "涌" )
			#set($clock = "${size}-海-$name" )
			$clock   
        </body>  
</html>

[size=medium][color=red][b]示例02：[/b][/color][/size]


目   录
1.变量………………………………………………………………………………1
2.循环………………………………………………………………………………2
3.条件语句…………………………………………………………………………2
4.语句的嵌套………………………………………………………………………2
5.注释………………………………………………………………………………2
6.关系和逻辑运算符………………………………………………………………3
7.宏…………………………………………………………………………………3
8. #stop.................................................4
9. #include与#parse......................................4
10.转义字符的使用 ………………………………………………………………4
11.内置对象 ………………………………………………………………………5
12.数组的访问 ……………………………………………………………………5
示例部分……………………………………………………………………………5


Velocity语法
变量
变量的定义：
　　#set($name = "hello")      说明：velocity中变量是弱类型的。
当使用#set 指令时，括在双引号中的字面字符串将解析和重新解释，如下所示：
　#set($directoryRoot = "www" )
　#set($templateName = "index.vm" )
　#set($template = "$directoryRoot/$templateName" )
　$template
　输出将会是：www/index.vm
注：在velocity中使用$2.5这样的货币标识是没有问题得的，因为velocity中的变量总是以一个大写或者小写的字母开始的。
变量规范的写法
　　${name} ，也可以写成：$name。提倡用前面的写法。
例如：你希望通过一个变量$vice来动态的组织一个字符串。
 Jack is a $vicemaniac.
本来变量是$vice现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以，应该使用规范的格式书写 ： Jack is a ${vice}maniac现在Velocity知道变量是$vice而不是$vicemaniac。
注意：当引用属性的时候不能加{}
变量的赋值:  
　　$name="hello"
赋值的左边必须是一个变量或者是属性引用。右边可以是下面六种类型之一： 
变量引用,字面字符串,属性引用,方法引用,字面数字,数组列表。
下面的例子演示了上述的每种类型：
#set( $monkey = $bill ) ## variable reference
#set( $monkey.Friend = "monica" ) ## string 
#set( $monkey.Blame = $whitehouse.Leak ) ## property reference
#set( $monkey.Plan = $spindoctor.weave($web) ) ## method reference
#set( $monkey.Number = 123 ) ##number 
#set( $monkey.Say = ["Not", $my, "fault"] ) ## ArrayList
注意：①如果上述例子中的右值是null, 则左值不会被赋值，也就是说会保留以前的值。
　　　　　　　②velocity模板中未被定义的变量将被认为是一个字符串。例如：
#set($foo = "gibbous") $moon = $foo输出结果为：$moon = gibbous
③velocity模板中不会将reference解释为对象的实例变量。例如：$foo.Name将被解释为Foo对象的getName（）方法，而不是Foo对象的Name实例变量。例如：
$foo.getBar()  等同于$foo.Bar ；
$data.getUser("jon") 等同于$data.User("jon") ；
data.getRequest().getServerName() 等同于
$data.Request.ServerName等同于${data.Request.ServerName}

循环
#foreach ($element in $list)     This is $element.     $velocityCount #end
例子：
#set( $list = ["pine", "oak", "maple"])
#foreach ($element in $list)
　　　$velocityCount
　　　This is $element.<br>#end
输出的结果为：
1 This is pine. 2 This is oak. 3 This is maple.
每次循环$list中的一个值都会赋给$element变量。$list可以是一个Vector、Hashtable或者Array。分配给$element的值是一个java对象，并且可以通过变量被引用。例如：如果$element t是一个java的Product类，并且这个产品的名字可以通过调用他的getName（）方法得到。
#foreach ( $key in $list.keySet())Key: $key -> Value: $list.get($key) <br>#end
提示：velocity中大小写敏感。
Velocity还特别提供了得到循环次数的方法，$velocityCount变量的名字是Velocity默认的名字。

例子：
First example:  #foreach ( $foo in [1..5] )    $foo  #end  Second example:  #foreach ( $bar in [2..-2] )    $bar  #end  Third example:  #set ( $arr = [0..1] )  #foreach ( $i in $arr )    $i  #end上面三个例子的输出结果为：  First example：  1 2 3 4 5  Second example：  2 1 0 -1 -2  Third example：  0 1
条件语句
#if (condition) 
#elseif (condition) 
#else 
#end
语句的嵌套
	#foreach ($element in $list) 
		## inner foreach 内循环 
		#foreach ($element in $list) 
		This is $element. $velocityCount <br>inner<br>
		#end 
		## inner foreach 内循环结束 
	## outer foreach 
	This is $element. 
	$velocityCount <br>outer<br>
　　	#end
　　语句中也可以嵌套其他的语句，如#if…#else…#end等。
注释(1)单行注释：  ## This is a single line comment.(2)多行注释：  #*   Thus begins a multi-line comment. Online visitors won’t   see this text because the Velocity Templating Engine will  ignore it.  *#(3)文档格式：  #**   This is a VTL comment block and   may be used to store such information  as the document author and versioning   information:   @version 1.1
　　   @author  xiao     *#
关系和逻辑操作符
　　Velocity 也具有逻辑AND, OR 和 NOT 操作符。	
　　如
　　## example for AND
　　#if($foo && $bar)
   <strong> This AND that</strong>
　　#end
例子中#if() 指令仅在$foo 和$bar 斗为真的时候才为真。如果$foo 为假，则表达式也为假；并且 $bar 将不被求值。如果 $foo 为真，Velocity 模板引擎将继续检查$bar的值，如果 $bar 为真，则整个表达式为真。并且输出This AND that 。如果 $bar 为假，将没有输出因为整个表达式为假。
7.Velocity 中的宏
　　Velocity中的宏我们可以理解为函数。
　　①宏的定义
　　#macro(宏的名称 $参数1 $参数2 …)
　　   语句体(即函数体)
　　#end
　　　②宏的调用
　　　#宏的名称($参数1 $参数2 …)
	说明：参数之间用空格隔开。
8．#stop
   停止执行模板引擎并返回,把它应用于debug是很有帮助的。
9．#include与#parse
#include和#parse的作用都是引入本地文件, 为了安全的原因，被引入的本地文件只能在TEMPLATE_ROOT目录下。
区别：
　　(1) 与#include不同的是，#parse只能指定单个对象。而#include可以有多个
如果您需要引入多个文件，可以用逗号分隔就行：#include ("one.gif", "two.txt", "three.htm" )在括号内可以是文件名，但是更多的时候是使用变量的：#include ( “greetings.txt”, $seasonalstock )
(2) #include被引入文件的内容将不会通过模板引擎解析； 
而#parse引入的文件内容Velocity将解析其中的velocity语法并移交给模板，意思就是说相当与把引入的文件copy到文件中。
#parse是可以递归调用的，例如：如果dofoo.vm包含如下行：
　　Count down.<br>
　　#set ($count = 8)
　　#parse ("parsefoo.vm")
<br>All done with dofoo.vm!
那么在parsefoo.vm模板中，你可以包含如下VTL：
　　$count
　　#set($count = $count - 1)
　　#if ( $count > 0 )<br>
　　#parse( "parsefoo.vm" )
　　#else
　　<br>All done with parsefoo.vm!
#end的显示结果为：
Count down.
8
7
6
5
4
3
2
1
0
All done with parsefoo.vm!
All done with dofoo.vm!
注意：在vm中使用#parse来嵌套另外一个vm时的变量共享问题。如：->a.vm 里嵌套 b.vm；->a.vm 里定义了变量 $param；->b.vm 里可以直接使用$param，无任何限制。但需要特别注意的是，如果b.vm里同时定义有变量$param，则b.vm里将使用b.vm里定义的值。
10．转义字符'\'的使用
　　如果reference被定义，两个’\’意味着输出一个’\’，如果未被定义，刚按原样输出。如：
#set($email = "foo" )
$email
\$email
\\$email
\\\$email
输出：
foo$email\foo\$email
如果$email 未定义
$email
\$email
\\$email
\\\$email
输出：
$email\$email\\$email\\$email
　　
11．内置对象Velocity内置了一些对象，在vm模版里可以直接调用，列举如下：$request、$response、$session，另外，模板内还可以使用 $msg内的消息工具访问 Struts 的国际化资源，达到简便实现国际化的方法。
12. 数组访问
对数组的访问在Velocity中存在问题，因为Velocity只能访问对象的方法，而数组又是一个特殊的Array，所以虽然数组可以进行循环列举，但却不能定位访问特定位置的元素，如 strs[2]，数组对固定位置元素的访问调用了Array的反射方法get(Object array, int index)，而Velocity没能提供这样的访问，所以数组要么改成List等其他类容器的方式来包装，要么就通过公用Util类的方式来提供，传入数组对象和要访问的位置参数，从而达到返回所需值的目的。


示例部分
1．Hello world的示例代码：
(1)Velocity模板(hello.html)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE> New Document </TITLE>
</HEAD>
<BODY>
    hello,$name!                 （注意：这里的name与VelocityTest.java中的名称要一致）
</BODY>
</HTML>
(2)将velocity模板的内容转换的类(VelocityTest.java)
import java.io.File;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import java.io.Writer;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.app.VelocityEngine;

/**
 * Velocity转换
 * @author
 */
public class VelocityTest
{
	/**
	 * 主函数
	 * @param args
	 */
	public static void main(String[] args)
　 {
　		//获取模板引擎
		VelocityEngine ve = new VelocityEngine();
		//模板文件所在的路径
		String path = "D:/java/jproject/regedit/webroot";		
    	//设置参数
		ve.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path);
　　　　//处理中文问题
		ve.setProperty(Velocity.INPUT_ENCODING,"GBK");
		ve.setProperty(Velocity.OUTPUT_ENCODING,"GBK");
		try 
		{
			//初始化模板
			ve.init();
			//获取模板(hello.html)
			Template template = ve.getTemplate("hello.html");    
			//获取上下文
			VelocityContext root = new VelocityContext();
            //把数据填入上下文
			root.put("name","world");                     （注意：与上面的对应）
　　　　　　//输出路径
            Strint outpath = "e:/helloworld.html";
			//输出
			Writer mywriter = new PrintWriter(new FileOutputStream(
				new File(outpath)));			
			template.merge(root, mywriter);
			mywriter.flush();			
		} 
		catch (Exception e) 
		{
			e.printStackTrace();
		}
	}
}
(3)环境的搭建
在lib目录内分别copy进：velocity-1.4.jar，velocity-dept.jar;
下载地址：http://jakarta.apache.org/velocity/
(4)运行后的结果如下：
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE> New Document </TITLE>
</HEAD>
<BODY>
　　　hello,world! 
</BODY>
</HTML>

2．Servlet和Velocity结合示例
(1)example.html
 <html>  <head><title>Velocity</title></head>  <body bgcolor="#ffffff">    <center>    <h2>Welcom to Velocity!</h2>    <i>Here's the list of people</i>    <table cellspacing="0" cellpadding="5" width="20%" >    <tr>    <td bgcolor="#eeeeee" align="center">    Names：    </td>    </tr>    #foreach ($name in $theList)    <tr>    <td bgcolor="#eeeeee" align="center">$name</td>    </tr>    #end    </table>    </center>  </body></html>
(2)servlet
package com.koal.velocity;

import java.io.IOException;
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.Properties;
import java.util.Vector;
import javax.servlet.ServletConfig;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.velocity.Template;
import org.apache.velocity.context.Context;
import org.apache.velocity.servlet.VelocityServlet;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.exception.ParseErrorException;

public class SampleServlet extends VelocityServlet  
{
	/**
     *   由VelocityServlet.init()调用，
     *   在此找出模版的路径
     */
    protected Properties loadConfiguration(ServletConfig config )
        throws IOException, FileNotFoundException {
        Properties p = new Properties();
        //取得路径
        String path = config.getServletContext().getRealPath("/");
        if (path == null) 
        {
            System.out.println(" SampleServlet.loadConfiguration() : unable to " 
                    + "get the current webapp root.  Using '/'. Please fix.");
            path = "/";
        }
        //设置路径
        p.setProperty( Velocity.FILE_RESOURCE_LOADER_PATH, path);

        return p;
    }

    /**
     *  Velocity主要的商业逻辑处理方法，由VelocityServlet自动调用
     *  @param ctx 模板上下文             
     *  @return Template 模板信息
     */   
    public Template handleRequest( HttpServletRequest request,
       HttpServletResponse response, Context ctx )
   {        
        //主要在此设置演示用的数据，开发中在此调用相应的业务处理流程，

        //并设置返回到页面的数据 
        //待展示的列表数据        String p1 = "第一位：LiuDong";        String p2 = "第二位：Liang.xf";        Vector personList = new Vector();        //中文需要转换        try {            personList.addElement(new String(p1.getBytes(), "ISO-8859-1") );            personList.addElement(new String(p2.getBytes(), "ISO-8859-1") );        } catch (Exception e) {            System.out.println("数据转换异常："+e);            }        //设置数据，供页面模版替换成显示的数据        ctx.put("theList", personList );   
        //定义模板        
        Template outty = null;        
        try 
        {
        	//取模板
            outty =  getTemplate("example.html");            
        } 
        catch( ParseErrorException pee ) 
        {
            System.out.println("SampleServlet: parse error for template " + pee);
        }
        catch( ResourceNotFoundException rnfe ) 
        {
            System.out.println("SampleServlet: template not found " + rnfe);
        } 
        catch( Exception e )
        {
            System.out.println("Error " + e);
        }

        return outty;
　　}
　　
　　(3)在web.xml中的配置：
　　<web-app>
　　<servlet>	
		<servlet-name>SampleServlet</servlet-name>
		<servlet-class>com.koal.velocity.SampleServlet</servlet-class>
　　</servlet>
	<servlet-mapping>
		<servlet-name>SampleServlet</servlet-name>
		<url-pattern>/SampleServlet</url-pattern>
　　</servlet-mapping>
　　</web-app>
　　
　　(4)环境的搭建
　　在lib目录内分别copy进：commons-collections.jar,velocity-1.4.jar，velocity-dept.jar;    Tomcat运行环境正常。    启动Tomcat，在IE上输入：http://localhost:8080/example，页面显示数据列表：
　　　　　　　　　　　　　　　　　Here's the list of people
Names: 
第一位：LiuDong
第二位：Liang.xf

扩展01：[url]http://clq9761.iteye.com/blog/1310862[/url]
扩展02：[url]http://www.cnblogs.com/likwo/archive/2010/05/13/1734936.html[/url]
扩展03：[url]http://blog.163.com/ydmx_lei/blog/static/77053405201232434611674/[/url]