Welcome ${user}!

Our latest product: ${latestProduct.name}!  这个例子是在简单的 HTML 中加入了一些由${… }包围的特定代码，这些特定代码 是 FreeMarker 的指令，而包含 FreeMarker 的指令的文件就称为模板（Template）  至于 user、latestProduct.url 和 latestProduct.name 来自于数据模型（data model）  数据模型由程序员编程来创建，向模板提供变化的信息，这些信息来自于数据库、 文件，甚至于在程序中直接生成  模板设计者不关心数据从那儿来，只知道使用已经建立的数据模型  下面是一个可能的数据模型： (root) | +- user = "Big Joe" | +- latestProduct | +- url = "products/greenmouse.html" | +- name = "green mouse"  数据模型类似于计算机的文件系统，latestProduct 可以看作是目录，而 user、url 和 name 看作是文件，url 和 name 文件位于 latestProduct 目录中（这只是一个比喻，实 际并不存在）  当 FreeMarker 将上面的数据模型合并到模板中，就创建了下面的输出：

Welcome Big Joe!

Our latest product: FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 green mouse! （2）数据模型  典型的数据模型是树型结构，可以任意复杂和深层次，如下面的例子： (root) | +- animals | | | +- mouse | | | | | +- size = "small" | | | | | +- price = 50 | | | +- elephant | | | | | +- size = "large" | | | | | +- price = 5000 | | | +- python | | | +- size = "medium" | | | +- price = 4999 | +- test = "It is a test" | +- whatnot FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 | +- because = "don't know"  类似于目录的变量称为 hashes，包含保存下级变量的唯一的查询名字  类似于文件的变量称为 scalars，保存单值  scalars 保存的值有两种类型：字符串（用引号括起，可以是单引号或双引号）和 数字（不要用引号将数字括起，这会作为字符串处理）  对 scalars 的访问从 root 开始，各部分用“.”分隔，如 animals.mouse.price  另外一种变量是 sequences，和 hashes 类似，只是不使用变量名字，而使用数字索 引，如下面的例子： (root) | +- animals | | | +- (1st) | | | | | +- name = "mouse" | | | | | +- size = "small" | | | | | +- price = 50 | | | +- (2nd) | | | | | +- name = "elephant" | | | | | +- size = "large" | | | | | +- price = 5000 | | | +- (3rd) | | | +- name = "python" FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 | | | +- size = "medium" | | | +- price = 4999 | +- whatnot | +- fruits | +- (1st) = "orange" | +- (2nd) = "banana"  这种对 scalars 的访问使用索引，如 animals[0].name （3）模板  在 FreeMarker 模板中可以包括下面三种特定部分：  ${… }：称为 interpolations，FreeMarker 会在输出时用实际值进行替代  FTL 标记（FreeMarker 模板语言标记）：类似于 HTML 标记，为了与 HTML 标记区分，用#开始（有些以@开始，在后面叙述）  注释 圣经注释小学小古文100篇及注释小古文100篇及注释简短小古文100篇及注释译文小古文100篇及注释 ：包含在<#--和-->（而不是）之间  下面是一些使用指令的例子：  if 指令 <#if animals.python.price < animals.elephant.price> Pythons are cheaper than elephants today. <#else> Pythons are not cheaper than elephants today.  list 指令

We have these animals:

We have these animals:

Test page

Blah blah... <#include "/copyright_footer.html">  一起使用指令

We have these animals:

Welcome ${user}!

We have these animals:[BR]

[BR] <#list animals as being>[BR]
• ${being.name} for ${being.price} Euros[BR] [BR] FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集

Welcome ${user <#-- The name of user -->}!

We have these animals:[BR]

[BR] <#list <#-- some comment... --> animals as <#-- again... --> being>[BR] ...  多余的空白字符会在模板输出时移除 （2）指令  在 FreeMarker中，使用 FTL 标记引用指令  有三种 FTL标记，这和 HTML 标记是类似的：  开始标记：<#directivename parameters>  结束标记：  空内容指令标记：<#directivename parameters/>  有两种类型的指令：预定义指令和用户定义指令  用户定义指令要使用@替换#，如<@mydirective>...（会在后面讲 述）  FTL 标记不能够交叉，而应该正确的嵌套，如下面的代码是错误的：
<#list animals as being>
• ${being.name} for ${being.price} Euros <#if use = "Big Joe"> (except for you) <#-- WRONG! -->
 如果使用不存在的指令，FreeMarker 不会使用模板输出，而是产生一个错误消息 FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集  FreeMarker会忽略 FTL 标记中的空白字符，如下面的例子： <#list[BR] animals as[BR] being[BR] >[BR] ${being.name} for ${being.price} Euros[BR]  但是，<、 \a & \{ { \xCode 4 位 16 进制 Unicode 代码  有一类特殊的字符串称为 raw 字符串，被认为是纯文本，其中的\和{等不 具有特殊含义，该类字符串在引号前面加 r，下面是一个例子： ${r"${foo}"} ${r"C:\foo\bar"} 输出的结果是： ${foo} C:\foo\bar  数字  直接输入，不需要引号  精度数字使用“.”分隔，不能使用分组符号  目前版本不支持科学计数法，所以“1E3”是错误的  不能省略小数点前面的 0，所以“.5”是错误的  数字 8、+8、08和 8.00 都是相同的  布尔值  true和 false，不使用引号  序列  由逗号分隔的子变量列表，由方括号限定，下面是一个例子： <#list ["winter", "spring", "summer", "autumn"] as x> ${x} 输出的结果是： winter spring summer autumn  列表的项目是表达式，所以可以有下面的例子： [2 + 2, [1, 2, 3, 4], "whatnot"] FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集  可以使用数字范围定义数字序列，例如 2..5 等同于[2, 3, 4, 5]，但是 更有效率，注意数字范围没有方括号  可以定义反递增的数字范围，如 5..2  散列（hash）  由逗号分隔的键/值列表，由大括号限定，键和值之间用冒号分隔，下面 是一个例子： {"name":"green mouse", "price":150}  键和值都是表达式，但是键必须是字符串  获取变量  顶层变量： ${variable}，变量名只能是字母、数字、下划线、$、@和#的组 合，且不能以数字开头  从散列中获取数据  可以使用点语法或方括号语法，假设有下面的数据模型： (root) | +- book | | | +- title = "Breeding green mouses" | | | +- author | | | +- name = "Julia Smith" | | | +- info = "Biologist, 1923-1985, Canada" | +- test = "title" 下面都是等价的： book.author.name book["author"].name book.author.["name"] book["author"]["name"]  使用点语法，变量名字有顶层变量一样的限制，但方括号语法没有该限制， 因为名字是任意表达式的结果  从序列获得数据：和散列的方括号语法语法一样，只是方括号中的表达式值必 须是数字；注意：第一个项目的索引是 0 FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集  序列片断：使用[startIndex..endIndex]语法，从序列中获得序列片断（也 是序列）；startIndex 和 endIndex 是结果为数字的表达式  特殊变量：FreeMarker 内定义变量，使用.variablename 语法访问  字符串操作  Interpolation（或连接操作）  可以使用${..}（或#{..}）在文本部分插入表达式的值，例如： ${"Hello ${user}!"} ${"${user}${user}${user}${user}"}  可以使用+操作符获得同样的结果 ${"Hello " + user + "!"} ${user + user + user + user}  ${..}只能用于文本部分，下面的代码是错误的： <#if ${isBig}>Wow! <#if "${isBig}">Wow! 应该写成： <#if isBig>Wow!  子串  例子（假设 user 的值为“Big Joe”）： ${user[0]}${user[4]} ${user[1..4]} 结果是（注意第一个字符的索引是 0）： BJ ig J  序列操作  连接操作：和字符串一样，使用+，下面是一个例子： <#list ["Joe", "Fred"] + ["Julia", "Kate"] as user> - ${user} 输出结果是： - Joe - Fred - Julia - Kate  散列操作  连接操作：和字符串一样，使用+，如果具有相同的 key，右边的值替代左边的值，例如： FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 <#assign ages = {"Joe":23, "Fred":25} + {"Joe":30, "Julia":18}> - Joe is ${ages.Joe} - Fred is ${ages.Fred} - Julia is ${ages.Julia} 输出结果是： - Joe is 30 - Fred is 25 - Julia is 18  算术运算  ＋、－、×、／、％，下面是一个例子： ${x * x - 100} ${x / 2} ${12 % 10} 输出结果是（假设 x 为 5）： -75 2.5 2  操作符两边必须是数字，因此下面的代码是错误的： ${3 * "5"} <#-- WRONG! -->  使用+操作符时，如果一边是数字，一边是字符串，就会自动将数字转换为字符串，例如： ${3 + "5"} 输出结果是： 35  使用内建的 int（后面讲述）获得整数部分，例如： ${(x/2)?int} ${1.1?int} ${1.999?int} ${-1.1?int} ${-1.999?int} 输出结果是（假设 x 为 5）： 2 1 FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 1 -1 -1  比较操作符  使用=（或==，完全相等）测试两个值是否相等，使用!= 测试两个值是否不相等  =和!=两边必须是相同类型的值，否则会产生错误，例如<#if 1 = "1">会引起错误  Freemarker 是精确比较，所以对"x"、"x "和"X"是不相等的  对数字和日期可以使用<、<=、>和>=，但不能用于字符串  由于 Freemarker 会将>解释成 FTL 标记的结束字符，所以对于>和>=可以使用括号来避免这 种情况，例如<#if (x > y)>  另一种替代的方法是，使用 lt、lte、gt 和 gte 来替代<、<=、>和>=  逻辑操作符  &&（and）、||（or）、!（not），只能用于布尔值，否则会产生错误  例子： <#if x < 12 && color = "green"> We have less than 12 things, and they are green. <#if !hot> <#-- here hot must be a boolean --> It's not hot.  内建函数  内建函数的用法类似访问散列的子变量，只是使用“?”替代“.”，下面列出常用的一些 函数  字符串使用的：  html：对字符串进行 HTML 编码  cap_first：使字符串第一个字母大写  lower_case：将字符串转换成小写  upper_case：将字符串转换成大写  trim：去掉字符串前后的空白字符  序列使用的：  size：获得序列中元素的数目  数字使用的：  int：取得数字的整数部分（如-1.9?int 的结果是-1）  例子（假设 test 保存字符串"Tom & Jerry"）： ${test?html} ${test?upper_case?html} 输出结果是： Tom & Jerry FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 TOM & JERRY  操作符优先顺序 操作符组 操作符 后缀 [subvarName] [subStringRange] . (methodParams) 一元 +expr、-expr、! 内建 ? 乘法 *、 / 、% 加法 +、- 关系 <、>、<=、>=（lt、lte、gt、gte） 相等 ==（=）、!= 逻辑 and && 逻辑 or || 数字范围 .. （4）Interpolation  Interpolation 有两种类型：  通用 Interpolation：${expr}  数字 Interpolation：#{expr}或#{expr; format}  注意：Interpolation 只能用于文本部分  通用 Interpolation  插入字符串值：直接输出表达式结果  插入数字值：根据缺省格式（由#setting 指令设置）将表达式结果转换成文本输出；可以 使用内建函数 string 格式化单个 Interpolation，下面是一个例子： <#setting number_format="currency"/> <#assign answer=42/> ${answer} ${answer?string} <#-- the same as ${answer} --> ${answer?string.number} ${answer?string.currency} ${answer?string.percent} 输出结果是： $42.00 $42.00 42 FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 $42.00 4,200%  插入日期值：根据缺省格式（由#setting 指令设置）将表达式结果转换成文本输出；可以 使用内建函数 string 格式化单个 Interpolation，下面是一个使用格式模式的例子： ${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')'")} 输出的结果类似下面的格式： 2003-04-08 21:24:44 Pacific Daylight Time Tue, Apr 8, '03 Tuesday, April 08, 2003, 09:24:44 PM (PDT)  插入布尔值：根据缺省格式（由#setting 指令设置）将表达式结果转换成文本输出；可以 使用内建函数 string 格式化单个 Interpolation，下面是一个例子： <#assign foo=true/> ${foo?string("yes", "no")} 输出结果是： yes  数字 Interpolation 的#{expr; format}形式可以用来格式化数字，format 可以是：  mX：小数部分最小 X 位  MX：小数部分最大 X 位  例子： <#-- If the language is US English the output is: --> <#assign x=2.582/> <#assign y=4/> #{x; M2} <#-- 2.58 --> #{y; M2} <#-- 4 --> #{x; m1} <#-- 2.6 --> #{y; m1} <#-- 4.0 --> #{x; m1M2} <#-- 2.58 --> #{y; m1M2} <#-- 4.0 --> FreeMarker 设计指南(4) FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 4、杂项 （1）用户定义指令  宏和变换器变量是两种不同类型的用户定义指令，它们之间的区别是宏是在模板中使用 macro 指令定义，而变换器是在模板外由程序定义，这里只介绍宏  基本用法  宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量，下面是一 个例子： <#macro greet> Hello Joe!  作为用户定义指令使用宏变量时，使用@替代 FTL 标记中的# <@greet>  如果没有体内容，也可以使用： <@greet/>  参数  在 macro 指令中可以在宏变量之后定义参数，如： <#macro greet person> Hello ${person}!  可以这样使用这个宏变量： <@greet person="Fred"/> and <@greet person="Batman"/> 输出结果是： Hello Fred! and Hello Batman!  宏的参数是 FTL 表达式，所以下面的代码具有不同的意思： <@greet person=Fred/>  这意味着将 Fred 变量的值传给 person 参数，该值不仅是字符串，还可以是其它类型，甚 至是复杂的表达式  宏可以有多参数，下面是一个例子： <#macro greet person color> Hello ${person}! FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集  可以这样使用该宏变量： <@greet person="Fred" color="black"/>  其中参数的次序是无关的，因此下面是等价的： <@greet color="black" person="Fred"/>  只能使用在 macro 指令中定义的参数，并且对所有参数赋值，所以下面的代码是错误的： <@greet person="Fred" color="black" background="green"/> <@greet person="Fred"/>  可以在定义参数时指定缺省值，如： <#macro greet person color="black"> Hello ${person}!  这样<@greet person="Fred"/>就正确了  宏的参数是局部变量，只能在宏定义中有效  嵌套内容  用户定义指令可以有嵌套内容，使用<#nested>指令执行指令开始和结束标记之间的模板片 断  例子： <#macro border>

<#nested>

这样使用该宏变量： <@border>The bordered text 输出结果：

The bordered text

 <#nested>指令可以被多次调用，例如： <#macro do_thrice> <#nested> FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 <#nested> <#nested> <@do_thrice> Anything. 输出结果： Anything. Anything. Anything.  嵌套内容可以是有效的 FTL，下面是一个有些复杂的例子： <@border>
<@do_thrice>
• <@greet person="Joe"/>
输出结果：

Hello Joe! Hello Joe! Hello Joe!

 宏定义中的局部变量对嵌套内容是不可见的，例如： FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 <#macro repeat count> <#local y = "test"> <#list 1..count as x> ${y} ${count}/${x}: <#nested> <@repeat count=3>${y?default("?")} ${x?default("?")} ${count?default("?")} 输出结果： test 3/1: ? ? ? test 3/2: ? ? ? test 3/3: ? ? ?   在宏定义中使用循环变量  用户定义指令可以有循环变量，通常用于重复嵌套内容，基本用法是：作为 nested指令的 参数传递循环变量的实际值，而在调用用户定义指令时，在<@…>开始标记的参数后面指定 循环变量的名字  例子： <#macro repeat count> <#list 1..count as x> <#nested x, x/2, x==count> <@repeat count=4 ; c, halfc, last> ${c}. ${halfc}<#if last> Last! 输出结果： 1. 0.5 2. 1 3. 1.5 4. 2 Last!  指定的循环变量的数目和用户定义指令开始标记指定的不同不会有问题 FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集  调用时少指定循环变量，则多指定的值不可见  调用时多指定循环变量，多余的循环变量不会被创建 （2）在模板中定义变量  在模板中定义的变量有三种类型：  plain 变量：可以在模板的任何地方访问，包括使用 include 指令插入的模板， 使用 assign 指令创建和替换  局部变量：在宏定义体中有效，使用 local 指令创建和替换  循环变量：只能存在于指令的嵌套内容，由指令（如 list）自动创建；宏的参 数是局部变量，而不是循环变量  局部变量隐藏（而不是覆盖）同名的 plain 变量；循环变量隐藏同名的局部变量和 plain 变量，下面是一个例子： <#assign x = "plain"> 1. ${x} <#-- we see the plain var. here --> <@test/> 6. ${x} <#-- the value of plain var. was not changed --> <#list ["loop"] as x> 7. ${x} <#-- now the loop var. hides the plain var. --> <#assign x = "plain2"> <#-- replace the plain var, hiding does not mater here --> 8. ${x} <#-- it still hides the plain var. --> 9. ${x} <#-- the new value of plain var. --> <#macro test> 2. ${x} <#-- we still see the plain var. here --> <#local x = "local"> 3. ${x} <#-- now the local var. hides it --> <#list ["loop"] as x> 4. ${x} <#-- now the loop var. hides the local var. --> 5. ${x} <#-- now we see the local var. again --> 输出结果： 1. plain FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 2. plain 3. local 4. loop 5. local 6. plain 7. loop 8. loop 9. plain2  内部循环变量隐藏同名的外部循环变量，如： <#list ["loop 1"] as x> ${x} <#list ["loop 2"] as x> ${x} <#list ["loop 3"] as x> ${x} ${x} ${x} 输出结果： loop 1 loop 2 loop 3 loop 2 loop 1  模板中的变量会隐藏（而不是覆盖）数据模型中同名变量，如果需要访问数据模型 中的同名变量，使用特殊变量 global，下面的例子假设数据模型中的 user 的值是 Big Joe： <#assign user = "Joe Hider"> FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 ${user} <#-- prints: Joe Hider --> ${.globals.user} <#-- prints: Big Joe --> （3）名字空间  通常情况，只使用一个名字空间，称为主名字空间  为了创建可重用的宏、变换器或其它变量的集合（通常称库），必须使用多名字空 间，其目的是防止同名冲突  创建库  下面是一个创建库的例子（假设保存在 lib/my_test.ftl 中）： <#macro copyright date>

Copyright (C) ${date} Julia Smith. All rights reserved.
Email: ${mail}

<#assign mail = "jsmith@acme.com">  使用 import 指令导入库到模板中，Freemarker 会为导入的库创建新的名字空 间，并可以通过 import 指令中指定的散列变量访问库中的变量： <#import "/lib/my_test.ftl" as my> <#assign mail="fred@acme.com"> <@my.copyright date="1999-2002"/> ${my.mail} ${mail} 输出结果：

Copyright (C) 1999-2002 Julia Smith. All rights reserved.
Email: jsmith@acme.com

jsmith@acme.com fred@acme.com 可以看到例子中使用的两个同名变量并没有冲突，因为它们位于不同的名字空间  可以使用 assign 指令在导入的名字空间中创建或替代变量，下面是一个例子： <#import "/lib/my_test.ftl" as my> ${my.mail} <#assign mail="jsmith@other.com" in my> ${my.mail}  输出结果： jsmith@acme.com FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 jsmith@other.com  数据模型中的变量任何地方都可见，也包括不同的名字空间，下面是修改的库： <#macro copyright date>

Copyright (C) ${date} ${user}. All rights reserved.

<#assign mail = "${user}@acme.com">  假设数据模型中的 user 变量的值是 Fred，则下面的代码： <#import "/lib/my_test.ftl" as my> <@my.copyright date="1999-2002"/> ${my.mail}  输出结果：

Copyright (C) 1999-2002 Fred. All rights reserved.

Fred@acme.com Freemarker - 几个比较实用的例子 - - 用Freemarker做模本语言有一 段时间了，列出几个和 JSP 或者 Velocity 相比起来比较方便的用途， 目的是引诱更多的人跳上 Freemarker 这个贼船， 1. String 内置的 JavaScript 转换： js_string 用途：用于 JavaScript 转义，转换',",换行等特殊字符 模板: 输出: 2.内置的默认值处理：default 用途: 用于处理默认值 模本: User: ${userLogin.name?default("Anonymous")} ${(employee.department.manager.name)?default(" ")} 输出: User: Anonymous FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 注，可以对整个对象树加上()，再用内置处理器这种方便的做法，偶 也是最近刚学会的，以前一直用很傻的方法做..... 3. Sequence 内置的计数器: xxx_index 用途：显示序号 模板: <#list employees as e> ${e_index}. ${e.name} 输出: 1. Readonly 2. Robbin 4. Sequence 内置的分段器: chunk FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 用途：某些比较 BT 的排版需求 模板: <#assign seq = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']> <#list seq?chunk(4) as row>
• <#list row as cell>${cell}
<#list seq?chunk(4, '-') as row> <#list row as cell>${cell} 输出:
• a
FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集
• b
• c
• d
• e
• f
• g
• h
• i
• j
a b c d FreeMarker 中文文档 福州 IT 信息网 http://www.fzic.net 整理收集 e f g h