freemarker 语法
常用语法EG.一个对象BOOK 1.输出 ${book.name} 空值判断：${book.name?if_exists }, ${book.name?default(‘xxx’)}//默认值xxx${ book.name!"xxx"}//默认值xxx 日期格式：${book.date?string('yyyy-MM-dd')} 数字格式：${book?string.number}--20 ${book?string.currency}--<#--$20.00--> ${book?string.percent}—<#-- 20% -->插入布尔值： <#assignfoo=ture/> ${foo?string("yes","no")}<#--yes--> exp1?exists将会被exp1??代替 exp1?if_exists将会被exp1!代替 exp1?default(exp2)将会被exp1!exp2. 2．逻辑判断 a: <#ifcondition>... <#elseifcondition2>... <#elseifcondition3>...... <#else>... 其中空值判断可以写成<#ifbook.name??> </#if>b: <#switchvalue> <#caserefValue1> ... <#break> <#caserefValue2> ... <#break> ... <#caserefValueN> ... <#break> <#default> ... </#switch> 3．循环读取 <#listsequenceasitem> ... </#list> 空值判断<#if bookList?size = 0></#list>e.g. <#listemployeesase> ${e_index}.${e.name} </#list> 输出: 1.Readonly 2. Robbin4.FreeMarker 3 宏/模板 宏Macro 宏是在模板中使用macro指令定义 l.1基本用法 宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量，下面是一个例子：<#macro greet> <fontsize="+2">HelloJoe!</font> </#macro>调用宏时，与使用FreeMarker的其他指令类似，只是使用@替代FTL标记中的#。 <@greet></@greet> <#--<@greet/>--> 在macro指令中可以在宏变量之后定义参数，如： <#macro greet person> <fontsize="+2">Hello${person}!</font> </#macro> 可以这样使用这个宏变量： <@greetperson="Fred"/> 但是下面的代码具有不同的意思： <@greetperson=Fred/> 这意味着将Fred变量的值传给person参数，该值不仅是字符串，还可以是其它类型，甚至是复杂的表达式。宏可以有多参数，下面是一个例子： <#macrogreetpersoncolor> <fontsize="+2"color="${color}">Hello${person}!</font> </#macro>可以这样使用该宏变量，其中参数的次序是无关的：<@greet person="Fred" color="black"/> 可以在定义参数时指定缺省值，否则，在调用宏的时候，必须对所有参数赋值： <#macrogreetpersoncolor="black"> <fontsize="+2"color="${color}">Hello${person}!</font> </#macro>注意：宏的参数是局部变量，只能在宏定义中有效。 在宏里嵌套内容 FreeMarker的宏可以有嵌套内容， <#nested>指令会执行宏调用指令开始和结束标记之间的模板片断，举一个简单的例子：<#macro border> <tableborder=4cellspacing=0cellpadding=4><tr><td> <#nested> </tr></td></table> </#macro>执行宏调用： <@border>Theborderedtext</@border> 输出结果： <tableborder=4cellspacing=0cellpadding=4> <tr><td> Theborderedtext </tr></td> </table><#nested>指令可以被多次调用，每次都会执行相同的内容。 <#macrodo_thrice> <#nested> <#nested> <#nested> </#macro><@do_thrice> Anything. </@do_thrice>FMPP 输出结果： Anything. Anything. Anything.嵌套内容可以是有效的FTL，下面是一个有些复杂的例子，我们将上面三个宏组合起来： <@border> <ul> <@do_thrice> <li><@greetperson="Joe"/> </@do_thrice> </ul> </@border> 输出结果： <tableborder=4cellspacing=0cellpadding=4><tr><td> <ul> <li><fontsize="+2">HelloJoe!</font> <li><fontsize="+2">HelloJoe!</font> <li><fontsize="+2">HelloJoe!</font> </ul> </tr></td></table>宏定义中的局部变量对嵌套内容是不可见的，例如： <#macrorepeatcount> <#localy="test"> <#list1..countasx> ${y}${count}/${x}:<#nested> </#list> </#macro><@repeat count=3>${y?default("?")} ${x?default("?")} ${count?default("?")}</@repeat> 输出结果： test3/1:??? test3/2:??? test 3/3: ? ? ?在宏定义中使用循环变量 nestted指令也可以有循环变量（循环变量的含义见下节），调用宏的时候在宏指令的参数后面依次列出循环变量的名字，格式如下：<@ macro_name paramter list; loop variable list[,]> 例如： <#macrorepeatcount> <#list1..countasx> <#nestedx,x/2,x==count> </#list> </#macro><@repeat count=4 ; c, halfc, last> ${c}.${halfc}<#iflast>Last!</#if> </@repeat>这里count是宏的参数，c, halfc,last则为循环变量，输出结果： 1.0.5 2.1 3.1.5 4.2Last! 循环变量和宏标记指定的不同不会有问题，如果调用时少指定了循环变量，那么多余的值不可见。调用时多指定了循环变量，多余的循环变量不会被创建： <@repeatcount=4;c,halfc,last> ${c}.${halfc}<#iflast>Last!</#if> </@repeat><@repeat count=4 ; c, halfc> ${c}.${halfc} </@repeat><@repeat count=4> Justrepeatit... </@repeat>在模板中定义变量 在模板中定义的变量有三种类型： plain变量：可以在模板的任何地方访问，包括使用include指令插入的模板，使用assign指令创建和替换。 局部变量：在宏定义体中有效，使用local指令创建和替换。 循环变量：只能存在于指令的嵌套内容，由指令（如list）自动创建；宏的参数是局部变量，而不是循环变量 局部变量隐藏（而不是覆盖）同名的plain变量；循环变量隐藏同名的局部变量和plain变量，下面是一个例子：<#assign x = "plain">${x} <#-- we see the plain var. here --> <@test/> 6.${x}<#--thevalueofplainvar.wasnotchanged--> <#list["loop"]asx> 7.${x}<#--nowtheloopvar.hidestheplainvar.--> <#assignx="plain2"><#--replacetheplainvar,hidingdoesnotmaterhere--> 8.${x}<#--itstillhidestheplainvar.--> </#list> 9.${x}<#--thenewvalueofplainvar.--> <#macrotest> 2.${x}<#--westillseetheplainvar.here--> <#localx="local"> 3.${x}<#--nowthelocalvar.hidesit--> <#list["loop"]asx> 4.${x}<#--nowtheloopvar.hidesthelocalvar.--> </#list> 5.${x}<#--nowweseethelocalvar.again--> </#macro> 输出结果： 1.plain 2.plain 3.local 4.loop 5.local 6.plain 7.loop 8.loop 9.plain2 内部循环变量隐藏同名的外部循环变量，如： <#list["loop1"]asx> ${x} <#list["loop2"]asx> ${x} <#list["loop3"]asx> ${x} </#list> ${x} </#list> ${x} </#list> 输出结果： loop1 loop2 loop3 loop2 loop1 模板中的变量会隐藏（而不是覆盖）数据模型中同名变量，如果需要访问数据模型中的同名变量，使用特殊变量global，下面的例子假设数据模型中的user的值是Big Joe： <#assignuser="JoeHider"> ${user}<#--prints:JoeHider--> ${.globals.user}<#--prints:BigJoe--> 名字空间 通常情况，只使用一个名字空间，称为主名字空间，但为了创建可重用的宏、变换器或其它变量的集合（通常称库），必须使用多名字空间，其目的是防止同名冲突 创建库 下面是一个创建库的例子（假设保存在lib/my_test.ftl中）： <#macrocopyrightdate> <p>Copyright(C)${date}JuliaSmith.Allrightsreserved. <br>Email:${mail}</p> </#macro> <#assignmail="[email protected]"> 使用import指令导入库到模板中，Freemarker会为导入的库创建新的名字空间，并可以通过import指令中指定的散列变量访问库中的变量： <#import"/lib/my_test.ftl"asmy> <#assignmail="[email protected]"> <@my.copyrightdate="1999-2002"/> ${my.mail} ${mail} 输出结果： <p>Copyright(C)1999-2002JuliaSmith.Allrightsreserved. <br>Email:[email protected]</p> 可以看到例子中使用的两个同名变量并没有冲突，因为它们位于不同的名字空间。还可以使用assign指令在导入的名字空间中创建或替代变量，下面是一个例子： <#import"/lib/my_test.ftl"asmy> ${my.mail} <#assignmail="[email protected]"inmy> ${my.mail} 输出结果： 数据模型中的变量任何地方都可见，也包括不同的名字空间，下面是修改的库： <#macrocopyrightdate> <p>Copyright(C)${date}${user}.Allrightsreserved.</p> </#macro> <#assignmail="${user}@acme.com"> 假设数据模型中的user变量的值是Fred，则下面的代码： <#import"/lib/my_test.ftl"asmy> <@my.copyrightdate="1999-2002"/> ${my.mail} 输出结果： <p>Copyright (C) 1999-2002 Fred. All rights reserved.</p>[email protected]四．Freemarker与Struts结合 1.输出文件换成以ftl格式的文件 E.G. <action name="bookActionForm" parameter="method" path="/bookAction" scope="request" type="example.BookAction" validate="true"> <forward name="list" path="/index.ftl"/> </action> 2.使用struts，jstl等标签 a.导入à<#global html=JspTaglibs["/WEB-INF/tags/struts-html.tld"]> 或<#assign html=JspTaglibs["/WEB-INF/struts-html.tld"]> <#assignbean=JspTaglibs["/WEB-INF/struts-bean.tld"]> <#assign logic=JspTaglibs["/WEB-INF/struts-logic.tld"]>b.使用à<@bean.page id="request" property="request"/>,<@html.text property="vo.newsTitle" styleclass="input1"/> 五．用Freemarker生成Html页面 例子：MakeFileManager.java package example; import freemarker.template.Configuration; importjava.text.SimpleDateFormat; importjava.io.File; importfreemarker.template.DefaultObjectWrapper; importjava.util.Map; importjava.util.HashMap; importjava.io.Writer; importjava.io.OutputStreamWriter; importjava.io.FileOutputStream; importfreemarker.template.TemplateException; importjava.io.IOException; import freemarker.template.Template;public class MakeFileManager { publicStringmake(Bookbook,BookFtlbookFtl){ Configuration cfg = new Configuration();//配制String realPath = bookFtl.getRealPath(); StringtemplatePath=realPath+"/WEB-INF/templates/book"; StringcDateStr="book/"+ newSimpleDateFormat("yyyyMMdd").format(newjava.util. Date()); StringfilePostfix=".html"; Stringpath=realPath+"/"+cDateStr; StringfileTimeName=newSimpleDateFormat("yyyyMMddhhmmss").format(new java.util.Date()); StringreturnFileName=cDateStr+"/"+fileTimeName+filePostfix; Stringfilename=""; FilebookDir=newFile(path); if(bookDir.exists()){ fileName=path+"/"+fileTimeName+filePostfix; }else{ bookDir.mkdirs(); fileName=path+"/"+fileTimeName+filePostfix; } try{ //设置freemarker的参数 cfg.setNumberFormat("0.##########");//生成html文件时web.xml配制无效 //cfg.setEncoding(); cfg.setDirectoryForTemplateLoading(newFile(templatePath)); cfg.setObjectWrapper(newDefaultObjectWrapper()); TemplatebookTemplate=cfg.getTemplate(bookFtl.getTemplateName());//模板对象 Maproot=newHashMap(); root.put("book",book); root.put("book2",book); Writerout=newOutputStreamWriter(newFileOutputStream(fileName)); try{ bookTemplate.process(root,out); }catch(TemplateExceptione){ e.printStackTrace(); } out.flush(); }catch(IOExceptione){ e.printStackTrace(); } returnreturnFileName; } }表达式是FreeMarker的核心功能，FreeMarker中的插值支持多种表达式。一、直接指定值 直接指定值可以是字符串、数值、布尔值、集合及Map对象。 1.字符串 直接指定字符串值使用单引号或双引号限定。字符串中可以使用转义字符”\"。如果字符串内有大量的特殊字符，则可以在引号的前面加上一个字母r，则字符串内的所有字符都将直接输出。2.数值 数值可以直接输入，不需要引号。FreeMarker不支持科学计数法。3.布尔值 直接使用true或false，不使用引号。4.集合 集合用中括号包括，集合元素之间用逗号分隔。 使用数字范围也可以表示一个数字集合，如1..5等同于集合[1,2,3,4,5]；同样也可以用5..1来表示[5,4,3,2,1]。5.Map对象 Map对象使用花括号包括，Map中的key-value对之间用冒号分隔，多组key-value对之间用逗号分隔。 注意：Map对象的key和value都是表达式，但key必须是字符串。二、输出变量值 FreeMarker的表达式输出变量时，这些变量可以是顶层变量，也可以是Map对象的变量，还可以是集合中的变量，并可以使用点（.）语法来访问Java对象的属性。1.顶层变量 所谓顶层变量就是直接放在数据模型中的值。输出时直接用${variableName}即可。2.输出集合元素 可以根据集合元素的索引来输出集合元素，索引用中括号包括。如：输出[“1”，“2”，“3”]这个名为number的集合，可以用${number[0]}来输出第一个数字。FreeMarker还支持用number[1..2]来表示原集合的子集合[“2”，“3”]。3.输出Map元素 对于JavaBean实例，FreeMarker一样把它看作属性为key，属性值为value的Map对象。 输出Map对象时，可以使用点语法或中括号语法，如下面的几种写法的效果是一样的： book.author.name book.author["name"] book["author"].name book["author"]["name"] 使用点语法时，变量名字有和顶层变量一样的限制，但中括号语法没有任何限制。三、字符串操作 1.字符串连接 字符串连接有两种语法： （1）使用${..}或#{..}在字符串常量内插入表达式的值； (2)直接使用连接运算符“+”连接字符串。 如，下面两种写法等效： ${"Hello,${user}"} ${"Hello,"+user+"!"} 有一点需要注意：${..}只能用于文本部分作为插值输出，而不能用于比较等其他用途，如： <#if${isBig}>Wow!</#if> <#if"${isBig}">Wow!</#if> 应该写成： <#ifisBig>Wow!</#if>2.截取子串 截取子串可以根据字符串的索引来进行，如果指定一个索引值，则取得字符串该索引处的字符；如果指定两个索引值，则截取两个索引中间的字符串子串。如： <#assignnumber="01234"> ${number[0]}<#--输出字符0--> ${number[0..3]}<#--输出子串“0123”-->四、集合连接操作 连接集合的运算符为“+”五、Map连接操作 Map连接操作的运算符为“+”六、算术运算符 FreeMarker表达式中支持“+”、“－”、“*”、“/”、“%”运算符。七、比较运算符 表达式中支持的比较运算符有如下几种： 1.=（或者==）：判断两个值是否相等； 2.!=：判断两个值是否不相等； 注：=和!=可以用作字符串、数值和日期的比较，但两边的数据类型必须相同。而且FreeMarker的比较是精确比较，不会忽略大小写及空格。 3.>（或者gt）：大于 4.>=（或者gte）：大于等于 5.<（或者lt）：小于 6.<=（或者lte）：小于等于 注：上面这些比较运算符可以用于数字和日期，但不能用于字符串。大部分时候，使用gt比>有更好的效果，因为FreeMarker会把>解释成标签的结束字符。可以使用括号来避免这种情况，如：<#if(x>y)>。八、逻辑运算符 1.&&：逻辑与； 2.||：逻辑或； 3.!：逻辑非 逻辑运算符只能用于布尔值。九、内建函数 FreeMarker提供了一些内建函数来转换输出，可以在任何变量后紧跟?，?后紧跟内建函数，就可以通过内建函数来转换输出变量。字符串相关常用的内建函数： 1.html：对字符串进行HTML编码； 2.cap_first：使字符串第一个字母大写； 3.lower_case：将字符串转成小写； 4.upper_case：将字符串转成大写；集合相关常用的内建函数： 1.size：获得集合中元素的个数；数字值相关常用的内建函数： 1.int：取得数字的整数部分。十、空值处理运算符 FreeMarker的变量必须赋值，否则就会抛出异常。而对于FreeMarker来说，null值和不存在的变量是完全一样的，因为FreeMarker无法理解null值。 FreeMarker提供两个运算符来避免空值： 1.!：指定缺失变量的默认值； 2.??：判断变量是否存在。 !运算符有两种用法：variable!或variable!defaultValue。第一种用法不给变量指定默认值，表明默认值是空字符串、长度为0的集合、或长度为0的Map对象。 使用!运算符指定默认值并不要求默认值的类型和变量类型相同。 ??运算符返回布尔值，如：variable??，如果变量存在，返回true，否则返回false。 |