第一种使用方法直接赋值:
1 VelocityEngine vltEngine = new VelocityEngine(); 2 vltEngine.SetProperty(RuntimeConstants.RESOURCE_LOADER, "file"); 3 // vltEngine.SetProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, System.Web.Hosting.HostingEnvironment.MapPath("~/templates"));//模板文件所在的文件夹,Web项目下使用 4 5 vltEngine.SetProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, System.Environment.CurrentDirectory+"\templates");//模板文件所在的文件夹 6 vltEngine.Init(); 7 8 VelocityContext vltContext = new VelocityContext(); 9 vltContext.Put("username", "aa");//设置参数,在模板中可以通过$data来引用 10 vltContext.Put("password", "bb"); 11 vltContext.Put("msg", "cc"); 12 Template vltTemplate = vltEngine.GetTemplate("login.htm"); 13 System.IO.StringWriter vltWriter = new System.IO.StringWriter(); 14 vltTemplate.Merge(vltContext, vltWriter); 15 16 string html = vltWriter.GetStringBuilder().ToString();
login.htm
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head></head> <body> <strong><font color='green'>登录</font></strong> <form action='Login.ashx'> <input type='text' name='username' value='$username' /> <input type='password' name='password' value='$password' /> <input type='submit' value='登录' /> </form> <p>$msg</p> </body> </html>
第二种使用方式,使用对象赋值:
Person person = new Person(); person.Name = "yxl"; person.Age = 25; Person dad = new Person(); dad.Name = "yda"; dad.Age = 49; person.Father = dad; VelocityEngine vltEngine = new VelocityEngine(); vltEngine.SetProperty(RuntimeConstants.RESOURCE_LOADER, "file"); // vltEngine.SetProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, System.Web.Hosting.HostingEnvironment.MapPath("~/templates"));//模板文件所在的文件夹,Web项目下使用 vltEngine.SetProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, System.Environment.CurrentDirectory + "\templates");//模板文件所在的文件夹 vltEngine.Init(); VelocityContext vltContext = new VelocityContext(); vltContext.Put("p", person);//设置参数,在模板中可以通过$p来引用 Template vltTemplate = vltEngine.GetTemplate("test.htm"); System.IO.StringWriter vltWriter = new System.IO.StringWriter(); vltTemplate.Merge(vltContext, vltWriter); string html = vltWriter.GetStringBuilder().ToString();
test.htm
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html><head></head><body> $p.Name <p>我的老爹是 $p.Father.Name,他的年龄是$p.Father.Age </p> </body></html>
Person.cs
public class Person { public string Name { get; set; } public int Age { get; set; } public Person Father { get; set; } }
第三种使用方式条件判断,动态循环读取
VelocityEngine vltEngine = new VelocityEngine(); vltEngine.SetProperty(RuntimeConstants.RESOURCE_LOADER, "file"); // vltEngine.SetProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, System.Web.Hosting.HostingEnvironment.MapPath("~/templates"));//模板文件所在的文件夹,Web项目下使用 vltEngine.SetProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, System.Environment.CurrentDirectory + "\templates");//模板文件所在的文件夹 vltEngine.Init(); Dictionary<string, string> dict = new Dictionary<string, string>(); dict["tom"] = "斯坦福"; dict["jim"] = "加里敦"; dict["yzk"] = "哈佛"; string[] strs = new string[] { "余学亮", "刘德华", "阿信" }; List<Person> persons = new List<Person>(); persons.Add(new Person { Age = 30, Name = "余学亮" }); persons.Add(new Person { Age = 10, Name = "王二小" }); persons.Add(new Person { Age = 50, Name = "周扒皮" }); Person p = new Person(); p.Age = 30; p.Name = "yxl"; VelocityContext vltContext = new VelocityContext(); vltContext.Put("ps", dict);//设置参数,在模板中可以通过$data来引用 vltContext.Put("mingrens", strs); vltContext.Put("persons", persons); vltContext.Put("person", p); vltContext.Put("age", 3); Template vltTemplate = vltEngine.GetTemplate("test3.htm"); System.IO.StringWriter vltWriter = new System.IO.StringWriter(); vltTemplate.Merge(vltContext, vltWriter); string html = vltWriter.GetStringBuilder().ToString();
test3.htm
$ps.tom 1: <ul> #foreach($mr in $mingrens) <li>$mr</li> #end </ul> 2: <ul> #foreach($p in $persons) <li>$p.Name的年龄是$p.Age</li> #end </ul> 3: <ul> #foreach($p in $persons) #if($p.Age>20) <li style="color:Red">$p.Name的年龄是$p.Age</li> #else <li style="color:Green">$p.Name的年龄是$p.Age</li> #end #end </ul> <p> #if($age>10) 大于10 #else 小于等于10 #end </p>
我喜欢在Asp.Net MVC中使用NVelocity View Engine的一个很重要的理由就是 :NVleocity简洁易用的语法。几乎使用#set,#if,#foreach就可以构成完整的 应用,下面就介绍一下NVelocity中的语法及常用指令。
默认情况下,NVelocity解析是不分大小写的,当然可以通过设置 runtime.strict.math=true,采用严格解析模式。
对变量的引用:$ [ ! ][ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ][ } ]。
在NVelocity中,对变量的引用都是以$开头加上变量名称。当使用!时表示当 此变量值为空时,显示空字符串。比如当$article为空,那会显示“$article“ ,而$!article会显示为“”。{}为变量名称限定,有时候变量名称后会有字符串 ,这是就需要用到{}了。比如$articleshow,想引用$article,这时只要修改为 ${article}就可以。其实,NVelocity对整个模板解析后都会变成这种模式。
对属性的引用:$ [ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]* . [a..z, A..Z ][ a..z, A-Z, 0..9, -, _ ]* [ } ] 。
例如$article.Title或者${article.Title}。
对方法的引用:$ [ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]* .[ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]*( [ optional parameter list... ] ) [ } ]。
例如:$article.GetListByTitle('nvelocity')或 ${article.GetListByTitle('nvelocity')}。其实对对象的属性值也可以用 $article.get_Title()获得。
常用指令:
赋值指令#set:# [ { ] set [ } ] ( $ref = [ ", ' ]arg[ ", ' ] )。
例如:$article.Title='NVelocity',$$article.Categories=[1,2,3],当然 右侧也可以使用复杂的表达式: $article.Title=$otherArticle.Title.SubString(0,3),算术表达式: $article.Page=4/3等等。属性赋值也可以用$article.set_Title('NVelocity') 。
条件指令#if:# [ { ] if [ } ] ( [condition] ) [output] [ # [ { ] elseif [ } ] ( [condition] ) [output] ]* [ # [ { ] else [ } ] [output] ] # [ { ] end [ } ] 。
条件可以是返回bool的复查表达式。例如:#if($article.Total>1) $article.Title #else 没有数据 #end。
循环指令#foreach:# [ { ] foreach [ } ] ($refinarg)statement# [ { ] end [ } ]。
例如:#foreach($article in $articles) $article.Title #end。
引用静态资源指令#include:# [ { ] include [ } ] ( arg[ arg2 ... argn] )。
例如:#include('tmp.js'),会把tmp.js文件内容插入当前流。当然可以使用 表达式:#include($article.Url)。
引用并解析资源指令#parse:# [ { ] parse [ } ] ( arg )。
例如:#parse('tmp.js'),与#include不同是,假如tmp.js文件中有 NVelocity的指令,变量会进行处理,并把结果插入到当前流。
停止指令#stop:# [ { ] stop [ } ] 。
当NVelocity解析到此指令时,会停止解析过程。一般用户调试。
计算指令#evaluate:# [ { ] evaluate [ } ] ( arg )。
例如:#evaluate('$article.Title'),会在当前输出$article.Title。