Freemarker页面语法
A概念
最常用的3个概念
sequence序列，对应java里的list、数组等非键值对的集合
hash键值对的集合
namespace对一个ftl文件的引用,利用这个名字可以访问到该ftl文件的资源
B指令
if,else,elseif
语法
Java代码
<#ifcondition>
...
<#elseifcondition2>
...
<#elseifcondition3>
...
...
<#else>
...
</#if>
用例
Freemarker代码
<#ifx=1>
xis1
</#if>
<#ifx=1>
xis1
<#else>
xisnot1
</#if>
switch,case,default,break
语法
Freemarker代码
<#switchvalue>
<#caserefValue1>
...
<#break>
<#caserefValue2>
...
<#break>
...
<#caserefValueN>
...
<#break>
<#default>
...
</#switch>
用例
字符串
Freemarker代码
<#switchbeing.size>
<#case"small">
Thiswillbeprocessedifitissmall
<#break>
<#case"medium">
Thiswillbeprocessedifitismedium
<#break>
<#case"large">
Thiswillbeprocessedifitislarge
<#break>
<#default>
Thiswillbeprocessedifitisneither
</#switch>
数字
Freemarker代码
<#switchx>
<#casex=1>
1
<#casex=2>
2
<#default>
d
</#switch>
如果x=1输出12,x=2输出2,x=3输出d
list,break
语法
Freemarker代码
<#listsequenceasitem>
...
<#ifitem="spring"><#break></#if>
...
</#list>
关键字
item_index:是list当前值的下标
item_has_next:判断list是否还有值
用例
Freemarker代码
<#assignseq=["winter","spring","summer","autumn"]>
<#listseqasx>
${x_index+1}.${x}<#ifx_has_next>,</#if>
</#list>
输出：
1.winter,
2.spring,
3.summer,
4.autumn
include
语法
Freemarker代码
<#includefilename>
或则
Java代码
<#includefilenameoptions>
options包含两个属性
encoding="GBK"编码格式
parse=true是否作为ftl语法解析,默认是true，false就是以文本方式引入.注意在ftl文件里布尔值都是直接赋值
的如parse=true,而不是parse="true"
用例
/common/copyright.ftl包含内容
Ftl代码
Copyright2001-2002${me}
Allrightsreserved.
模板文件
Java代码
<#assignme="JuilaSmith">
Sometest
Yeah
___________________________________________________________________________
<span><strong><span><#include"/common/copyright.ftl"encoding="GBK"></span>
</strong>
</span>
输出结果:
Sometest
Yeah.
Copyright2001-2002JuilaSmith
Allrightsreserved.
Import
语法
Freemarker代码
<#importpathashash>
类似于java里的import,它导入文件，然后就可以在当前文件里使用被导入文件里的宏组件
用例
假设mylib.ftl里定义了宏copyright那么我们在其他模板页面里可以这样使用
Freemarker代码
<#import"/libs/mylib.ftl"asmy>
<@my.copyrightdate="1999-2002"/>
<#--"my"在freemarker里被称作namespace-->
compress
语法
Freemarker代码
<#compress>
...
</#compress>
用来压缩空白空间和空白的行
escape,noescape
语法
Freemarker代码
<#escapeidentifierasexpression>
...
<#noescape>...</#noescape>
...
</#escape>
用例
主要使用在相似的字符串变量输出，比如某一个模块的所有字符串输出都必须是html安全的，这个时候就可以使用
该表达式
Freemarker代码
<#escapexasx?html>
Firstname:${firstName}
<#noescape>Lastname:${lastName}</#noescape>
Maidenname:${maidenName}
</#escape>
相同表达式
Ftl代码
Firstname:${firstName?html}
Lastname:${lastName}
Maidenname:${maidenName?html}
assign
语法
Freemarker代码
<#assignname=value>
<#--或则-->
<#assignname1=value1name2=value2...nameN=valueN>
<#--或则-->
<#assignsameasabove...innamespacehash>
<#--或则-->
<#assignname>
capturethis
</#assign>
<#--或则-->
<#assignnameinnamespacehash>
capturethis
</#assign>
用例
生成变量,并且给变量赋值
给seasons赋予序列值
Ftl代码
<#assignseasons=["winter","spring","summer","autumn"]>
给变量test加1
Ftl代码
<#assigntest=test+1>
给mynamespage赋予一个变量bgColor,下面可以通过my.bgColor来访问这个变量
Ftl代码
<#import"/mylib.ftl"asmy>
<#assignbgcolor="red"inmy>
将一段输出的文本作为变量保存在x里
Ftl代码
<#assignx>
<#list1..3asn>
${n}<@myMacro/>
</#list>
</#assign>
Numberofwords:${x?word_list?size}
${x}
<#assignx>Hello${user}!</#assign>error
<#assignx="Hello${user}!">true
同时也支持中文赋值，如：
Ftl代码
<#assign语法>
java
</#assign>
${语法}
打印输出:
java
global
语法
Freemarker代码
<#globalname=value>
<#--或则-->
<#globalname1=value1name2=value2...nameN=valueN>
<#--或则-->
<#globalname>
capturethis
</#global>
全局赋值语法，利用这个语法给变量赋值，那么这个变量在所有的namespace[A1]中是可见的,如果这个变量被当前的assign语法覆盖如<#globalx=2><#assignx=1>在当前页面里x=2将被隐藏，或者通过${.global.x}来访问
setting
语法
Freemarker代码
<#settingname=value>
用来设置整个系统的一个环境
locale
number_format
boolean_format
date_format,time_format,datetime_format
time_zone
classic_compatible
用例
假如当前是匈牙利的设置，然后修改成美国
Ftl代码
${1.2}
<#settinglocale="en_US">
${1.2}
输出
1,2
1.2
因为匈牙利是采用","作为十进制的分隔符，美国是用"."
macro,nested,return
语法
Freemarker代码
<#macronameparam1param2...paramN>
...
<#nestedloopvar1,loopvar2,...,loopvarN>
...
<#return>
...
</#macro>
用例
Ftl代码
<#macrotestfoobar="Bar"[A2]baaz=-1>
Testtext,andtheparams:${foo},${bar},${baaz}
</#macro>
<@testfoo="a"bar="b"baaz=5*5-2/>
<@testfoo="a"bar="b"/>
<@testfoo="a"baaz=5*5-2/>
<@testfoo="a"/>
输出
Testtext,andtheparams:a,b,23
Testtext,andtheparams:a,b,-1
Testtext,andtheparams:a,Bar,23
Testtext,andtheparams:a,Bar,-1
定义循环输出的宏
Ftl代码
<#macrolisttitleitems>
${title?cap_first}:
<#listitemsasx>
*${x?cap_first}
</#list>
</#macro>
<@listitems=["mouse","elephant","python"]title="Animals"/>
输出结果:
Animals:
*Mouse
*Elephant
*Python
包含body的宏
Ftl代码
<#macrorepeatcount>
<#list1..countasx>
<#nestedx,x/2,x==count>
</#list>
</#macro>
<@repeatcount=4;chalfclast>
${c}.${halfc}<#iflast>Last!</#if>
</@repeat>
输出
1.0.5
2.1
3.1.5
4.2Last!
t,lt,rt
语法
Freemarkder代码
<#t>去掉左右空白和回车换行
<#lt>去掉左边空白和回车换行
<#rt>去掉右边空白和回车换行
<#nt>取消上面的效果
C一些常用方法或注意事项
表达式转换类
${expression}计算expression并输出
#{expression}数字计算#{expression;format}安格式输出数字format为M和m
M表示小数点后最多的位数,m表示小数点后最少的位数如#{121.2322;m2M2}输出121.23
数字循环
1..5表示从1到5，原型number..number
对浮点取整数
${123.23?int}输出123
给变量默认值
${var?default("helloworld")?html}如果varisnull那么将会被helloworld替代
判断对象是不是null
Ftl代码
<#ifmouse?exists>
Mousefound
<#else>
也可以直接${mouse?if_exists})输出布尔形
－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－
（1）解决输出中文乱码问题：
freemarker乱码的原因：
没有使用正确的编码格式读取模版文件,表现为模版中的中文为乱码
解决方法：在classpath上放置一个文件freemarker.properties，在里面写上模版文件的编码方式，比如
default_encoding=UTF-8
locale=zh_CN
注意：eclipse中除了xml文件、java文件外，默认的文件格式iso8859-1
数据插入模版时，没有使用正确的编码，表现出模版中的新插入数据为乱码
解决方法：在result的配置中，指定charset，s2的FreemarkerResult.java会将charset传递freemarker
<actionname="ListPersons"class="ListPersons">
<resulttype="freemarker">
<paramname="location">/pages/Person/view.ftl</param>
<paramname="contentType">text/html;charset=UTF-8
</param>
</result>
</action>
（2）提高freemarker的性能
在freemarker.properties中设置：
template_update_delay=60000
避免每次请求都重新载入模版，即充分利用cached的模版
（3）尽量使用freemarker本身的提供的tag，使用S2tags的标签会在性能上有所损失
（4）freemarker的标签种类：
${..}:FreeMarkerwillreplaceitintheoutputwiththeactualvalueofthethinginthecurlybrackets.Theyarecalledinterpolations.
#,代表是FTLtags（FreeMarkerTemplateLanguagetags），heyareinstructionstoFreeMarkerandwillnotbeprintedtotheoutput
<#if...></#if>
<#listtotalListaselementObject>...</#list>
@,代表用户自定义的标签
<#---->注释标签，注意不是<!---->
（5）一些特殊的指令：
r代表原样输出：${r"C:\foo\bar"}
<#list["winter","spring","summer","autumn"]asx>${x}</#list>
？引出内置指令
String处理指令：
html:特殊的html字符将会被转义，比如"<"，处理后的结果是<
cap_first、lower_case、upper_case
trim:除去字符串前后的空格
sequences处理指令
size：返回sequences的大小
numbers处理指令
int:number的整数部分，(e.g.-1.9?intis-1)
（6）对于null，或者missvalue，freemarker会报错
?exists:旧版本的用法
!：defaultvalueoperator，语法结构为：unsafe_expr!default_expr，比如${mouse!"Nomouse."}当mouse不存在时，返回defaultvalue；
(product.color)!"red"这种方式，能够处理product或者color为missvalue的情况；
而product.color!"red"将只处理color为missvalue的情况
??:Missingvaluetestoperator,测试是否为missingvalue
unsafe_expr??：product.color??将只测试color是否为null
(unsafe_expr)??：(product.color)??将测试product和color是否存在null
Ftl代码
<#ifmouse??>
Mousefound
<#else>
Nomousefound
</#if>
Creatingmouse...
<#assignmouse="Jerry">
<#ifmouse??>
Mousefound
<#else>
Nomousefound
</#if>
（7）模版值插入方式（interpolation）
通用方式（Universalinterpolations）：${expression}
对于字符串：只是简单输出
对于数值，会自动根据local确定格式，称为humanaudience，否则称为computeraudience，可以"?c",比如，<ahref="/shop/details?id=${product.id?c}">Details...</a>,因此这里的id是给浏览器使用的，不需要进行格式化，注意?c只对数值有效
对于日期，会使用默认的日期格式转换，因此需要事先设置好默认的转换格式，包括date_format,time_format，atetime_format
对于布尔值，不能输出，会报错并停止模版的执行，比如${a=2}会出错，但是可以stringbuilt-in来进行转换
数值处理，具体参考：Built-insfornumbers
http://freemarker.org/docs/ref_builtins_number.html#ref_builtin_string_for_number
数值处理的例子：
<#settingnumber_format="currency"/>
<#assignanswer=42/>
${answer}
${answer?string}<#--thesameas${answer}-->
${answer?string.number}
${answer?string.currency}
${answer?string.percent}
除了使用内置的formate，可以使用任何用Javadecimalnumberformatsyntax书写的formate，比如
<#settingnumber_format="0.###E0"/>
<#settingnumber_format="0"/>
<#settingnumber_format="#"/>
${1234}
${12345?string("0.####E0")}
更加方便的格式：
<#settinglocale="en_US">
USpeoplewrites:${12345678?string(",##0.00")}
<#settinglocale="hu">
Hungarianpeoplewrites:${12345678?string(",##0.00")}
日期处理，参考Built-insfordates
http://freemarker.org/docs/ref_builtins_date.html#ref_builtin_string_for_date
日期处理的例子：
${openingTime?string.short}
${openingTime?string.medium}
${openingTime?string.long}
${openingTime?string.full}
${nextDiscountDay?string.short}
${nextDiscountDay?string.medium}
${nextDiscountDay?string.long}
${nextDiscountDay?string.full}
${lastUpdated?string.short}
${lastUpdated?string.medium}
${lastUpdated?string.long}
${lastUpdated?string.full}
注意：
由于java语言中的Date类型的不足，freemarker不能根据Date变量判断出变量包含的部分（日期、时间还是全部），在这种情况下，freemarker
不能正确显示出${lastUpdated?string.short}或者simply${lastUpdated}，因此，可以通过?date,?timeand?datetimebuilt-ins
来帮助freemarker来进行判断，比如${lastUpdated?datetime?string.short}
除了使用内置的日期转换格式外，可以自己指定日期的格式，使用的是Javadateformatsyntax，比如：
${lastUpdated?string("yyyy-MM-ddHH:mm:sszzzz")}
${lastUpdated?string("EEE,MMMd,''yy")}
${lastUpdated?string("EEEE,MMMMdd,yyyy,hh:mm:ssa'('zzz')'")}
数值专用方式（Numericalinterpolations）：#{expression}or#{expression;format}，这是数值专用的输出方式，但是最好使用通用方式的stringbuilt-in或者number_format来完成转换，Numericalinterpolations方式将会被停用
（8）创建自定义模版
Ftl代码
<#macrogreet>
<fontsize="+2">HelloJoe!</font>
</#macro>
<#assignuser="zhangsan"/>
字符串连接
${"Hello${user}!"}与${"Hello"+user+"!"}相同
结果：Hellozhangsan
获取字符
${user[0]}${user[4]}
结果：zg
序列的连接和访问
<#assignnums=["1","2"]+["3","4"]/>
${nums[0]}结果是1
内置函数
html使用实体引用替换字符串中所有HTML字符，例如，使用&替换&
lower_case将字符串转化成小写
substring
index_of例如”abcdc"?index_of("bc")将返回1
seq_contains序列中是否包含指定值${nums?seq_contains("1")?string("yes","no")}
seq_index_of第一个出现的索引${nums?seq_index_of("1")}结果0
sort_by用于散列