FreeMarker手册.docx

1、FreeMarker手册FreeMarker教程第一篇 FreeMarker模板1. 模板文件FreeMarker的模板文件并不比HTML页面复杂多少,FreeMarker模板文件主要由如下4个部分组成: 文本:直接输出的部分 注释:格式部分,不会输出 插值:即$.或#.格式的部分,将使用数据模型中的部分替代输出 FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出下面是一个FreeMarker模板的例子,包含了以上所说的4个部分Welcome!Welcome $user !We have these animals: $being.name for $bei

2、ng.price Euros第二篇 FreeMarker规则1. FTL指令规则在FreeMarker中,使用FTL标签来使用指令,FreeMarker有3种FTL标签,这和HTML标签是完全类似的. 开始标签: 结束标签: 空标签:实际上,使用标签时前面的符号#也可能变成,如果该指令是一个用户指令而不是系统内建指令时,应将#符号改成符号.使用FTL标签时, 应该有正确的嵌套,而不是交叉使用,这和XML标签的用法完全一样.如果全用不存在的指令,FreeMarker不会使用模板输出,而是产生一个错误消息.FreeMarker会忽略FTL标签中的空白字符.值得注意的是 和指令之间不允许有空白字符.

3、2. 插值规则FreeMarker的插值有如下两种类型:1,通用插值$expr;2,数字格式化插值:#expr或#expr;format2.1. 通用插值对于通用插值,又可以分为以下4种情况: 插值结果为字符串值:直接输出表达式结果 插值结果为数字值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:$answer$answer?string $answer?string.number$answer?string.currency$answer?string.percent$answer输出结果是:$42.00$42.0

4、042$42.004,200% 插值结果为日期值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:$lastUpdated?string(yyyy-MM-dd HH:mm:ss zzzz)$lastUpdated?string(EEE, MMM d, yy)$lastUpdated?string(EEEE, MMMM dd, yyyy, hh:mm:ss a (zzz)输出结果是:2008-04-08 08:08:08 Pacific Daylight TimeTue, Apr 8, 03Tuesday, April

5、08, 2003, 08:08:08 PM (PDT) 插值结果为布尔值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:$foo?string(yes, no)输出结果是:yes2.2. 数字格式化插值数字格式化插值可采用#expr;format形式来格式化数字,其中format可以是:mX:小数部分最小X位MX:小数部分最大X位如下面的例子:#x; M2 #y; M2 #x; m2 #y; m2 #x; m1M2 #x; m1M2 3. 表达式表达式是FreeMarker模板的核心功能,表达式放置在插值语法$之中时

6、,表明需要输出表达式的值;表达式语法也可与FreeMarker 标签结合,用于控制输出.实际上FreeMarker的表达式功能非常强大,它不仅支持直接指定值,输出变量值,也支持字符串格式化输出和集合访问等功能.3.1. 直接指定值使用直接指定值语法让FreeMarker直接输出插值中的值,而不是输出变量值.直接指定值可以是字符串,数值,布尔值,集合和MAP对象.3.1.1. 字符串直接指定字符串值使用单引号或双引号限定,如果字符串值中包含特殊字符需要转义,看下面的例子:$我的文件保存在C:盘$我名字是annlee输出结果是:我的文件保存在C:盘我名字是annleeFreeMarker支持如下转

7、义字符:;双引号(u0022);单引号(u0027);反斜杠(u005C)n;换行(u000A)r;回车(u000D)t;Tab(u0009)b;退格键(u0008)f;Form feed(u000C)l;a;&;xCode;直接通过4位的16进制数来指定Unicode码,输出该unicode码对应的字符.如果某段文本中包含大量的特殊符号,FreeMarker提供了另一种特殊格式:可以在指定字符串内容的引号前增加r标记,在r标记后的文件将会直接输出.看如下代码:$r$foo$rC:foobar输出结果是:$fooC:foobar3.1.2. 数值表达式中的数值直接输出,不需要引号.小数点使用.

8、分隔,不能使用分组,符号.FreeMarker目前还不支持科学计数法,所以1E3是错误的.在FreeMarker表达式中使用数值需要注意以下几点: 数值不能省略小数点前面的0,所以.5是错误的写法 数值8 , +8 , 8.00都是相同的3.1.3. 布尔值直接使用true和false,不使用引号.3.1.4. 集合集合以方括号包括,各集合元素之间以英文逗号,分隔,看如下的例子:$x输出结果是:星期一星期二星期三星期四星期五星期六星期天除此之外,集合元素也可以是表达式,例子如下:2 + 2, 1, 2, 3, 4, whatnot还可以使用数字范围定义数字集合,如2.5等同于2, 3, 4,

9、5,但是更有效率.注意,使用数字范围来定义集合时无需使用方括号,数字范围也支持反递增的数字范围,如5.23.1.5. 对象Map对象使用花括号包括,Map中的key-value对之间以英文冒号:分隔,多组key-value对之间以英文逗号,分隔.下面是一个例子:语文:78, 数学:80Map对象的key和value都是表达式,但是key必须是字符串3.2. 输出变量值FreeMarker的表达式输出变量时,这些变量可以是顶层变量,也可以是Map对象中的变量,还可以是集合中的变量,并可以使用点(.)语法来访问Java对象的属性.下面分别讨论这些情况3.2.1. 顶层变量所谓顶层变量就是直接放在数

10、据模型中的值,例如有如下数据模型:Map root = new HashMap(); /创建数据模型root.put(name,annlee); /name是一个顶层变量对于顶层变量,直接使用$variableName来输出变量值,变量名只能是字母,数字,下划线,$,和#的组合,且不能以数字开头号.为了输出上面的name的值,可以使用如下语法:$name3.2.2. 输出集合元素如果需要输出集合元素,则可以根据集合元素的索引来输出集合元素,集合元素的索引以方括号指定.假设有索引:星期一,星期二,星期三,星期四,星期五,星期六,星期天.该索引名为week,如果需要输出星期三,则可以使用如下语法:

11、$week2 /输出第三个集合元素此外,FreeMarker还支持返回集合的子集合,如果需要返回集合的子集合,则可以使用如下语法:week3.5 /返回week集合的子集合,子集合中的元素是week集合中的第4-6个元素3.2.3. 输出Map元素这里的Map对象可以是直接HashMap的实例,甚至包括JavaBean实例,对于JavaBean实例而言,我们一样可以把其当成属性为key,属性值为value的Map实例.为了输出Map元素的值,可以使用点语法或方括号语法.假如有下面的数据模型:Map root = new HashMap();Book book = new Book();Auth

12、or author = new Author();author.setName(annlee);author.setAddress(gz);book.setName(struts2);book.setAuthor(author);root.put(info,struts);root.put(book, book);为了访问数据模型中名为struts2的书的作者的名字,可以使用如下语法:book.author.name /全部使用点语法bookauthor.namebook.authorname /混合使用点语法和方括号语法bookauthorname /全部使用方括号语法使用点语法时,变量名字有顶层变量一样的限制,但方括号语法没有该限制,因为名字可以是任意表达式的结果.3.3. 字符串操作FreeMarker的表达式对字符串操作非常灵活,可以将字符串常量和变量连接起来,也可以返回字符串的子串等.