《freemarker中文手册.doc》由会员分享，可在线阅读，更多相关《freemarker中文手册.doc（31页珍藏版）》请在三一办公上搜索。
1、FreeMarker概述FreeMarker概述l FreeMarker是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写 l FreeMarker被设计用来生成HTML Web页面，特别是基于MVC模式的应用程序 l 虽然FreeMarker具有一些编程的能力，但通常由Java程序准备要显示的数据，由FreeMarker生成页面，通过模板显示准备的数据（如下图）l FreeMarker不是一个Web应用框架，而适合作为Web应用框架一个组件 l FreeMarker与容器无关，因为它并不知道HTTP或Servlet；FreeMarker同样可以应用于非Web应用程序环境
2、l FreeMarker更适合作为Model2框架（如Struts）的视图组件，你也可以在模板中使用JSP标记库 l FreeMarker是免费的 1、通用目标 l 能够生成各种文本：HTML、XML、RTF、Java源代码等等 l 易于嵌入到你的产品中：轻量级；不需要Servlet环境 l 插件式模板载入器：可以从任何源载入模板，如本地文件、数据库等等 l 你可以按你所需生成文本：保存到本地文件；作为Email发送；从Web应用程序发送它返回给Web浏览器 2、强大的模板语言 l 所有常用的指令：include、if/elseif/else、循环结构 l 在模板中创建和改变变量 l 几乎在任
3、何地方都可以使用复杂表达式来指定值 l 命名的宏，可以具有位置参数和嵌套内容 l 名字空间有助于建立和维护可重用的宏库，或者将一个大工程分成模块，而不必担心名字冲突 l 输出转换块：在嵌套模板片段生成输出时，转换HTML转义、压缩、语法高亮等等；你可以定义自己的转换 3、通用数据模型 l FreeMarker不是直接反射到Java对象，Java对象通过插件式对象封装，以变量方式在模板中显示 l 你可以使用抽象（接口）方式表示对象（JavaBean、XML文档、SQL查询结果集等等），告诉模板开发者使用方法，使其不受技术细节的打扰 4、为Web准备 l 在模板语言中内建处理典型Web相关任务（如
4、HTML转义）的结构 l 能够集成到Model2 Web应用框架中作为JSP的替代 l 支持JSP标记库 l 为MVC模式设计：分离可视化设计和应用程序逻辑；分离页面设计员和程序员 5、智能的国际化和本地化 l 字符集智能化（内部使用UNICODE） l 数字格式本地化敏感 l 日期和时间格式本地化敏感 l 非US字符集可以用作标识（如变量名） l 多种不同语言的相同模板 6、强大的XML处理能力 l 和指令（2.3版本）用于递归遍历XML树 l 在模板中清楚和直觉的访问XML对象模型 FreeMarker设计指南(1)1、快速入门（1）模板 + 数据模型 = 输出l FreeMarker基于
5、设计者和程序员是具有不同专业技能的不同个体的观念l 他们是分工劳动的：设计者专注于表示创建HTML文件、图片、Web页面的其它可视化方面；程序员创建系统，生成设计页面要显示的数据l 经常会遇到的问题是：在Web页面（或其它类型的文档）中显示的信息在设计页面时是无效的，是基于动态数据的l 在这里，你可以在HTML（或其它要输出的文本）中加入一些特定指令，FreeMarker会在输出页面给最终用户时，用适当的数据替代这些代码l 下面是一个例子： Welcome! Welcome $user! Our latest product: $latestProduct.name! l 这个例子是在简单的H
6、TML中加入了一些由$包围的特定代码，这些特定代码是FreeMarker的指令，而包含FreeMarker的指令的文件就称为模板（Template）l 至于user、latestProduct.url和latestProduct.name来自于数据模型（data model）l 数据模型由程序员编程来创建，向模板提供变化的信息，这些信息来自于数据库、文件，甚至于在程序中直接生成l 模板设计者不关心数据从那儿来，只知道使用已经建立的数据模型l 下面是一个可能的数据模型：(root) | +- user = Big Joe | +- latestProduct | +- url = product
7、s/greenmouse.html | +- name = green mousel 数据模型类似于计算机的文件系统，latestProduct可以看作是目录，而user、url和name看作是文件，url和name文件位于latestProduct目录中（这只是一个比喻，实际并不存在）l 当FreeMarker将上面的数据模型合并到模板中，就创建了下面的输出： Welcome! Welcome Big Joe! Our latest product: green mouse! （2）数据模型l 典型的数据模型是树型结构，可以任意复杂和深层次，如下面的例子：(root) | +- animal
8、s | | | +- mouse | | | | | +- size = small | | | | | +- price = 50 | | | +- elephant | | | | | +- size = large | | | | | +- price = 5000 | | | +- python | | | +- size = medium | | | +- price = 4999 | +- test = It is a test | +- whatnot | +- because = dont knowl 类似于目录的变量称为hashes，包含保存下级变量的唯一的查询名字l 类似于
9、文件的变量称为scalars，保存单值l scalars保存的值有两种类型：字符串（用引号括起，可以是单引号或双引号）和数字（不要用引号将数字括起，这会作为字符串处理）l 对scalars的访问从root开始，各部分用“.”分隔，如animals.mouse.pricel 另外一种变量是sequences，和hashes类似，只是不使用变量名字，而使用数字索引，如下面的例子：(root) | +- animals | | | +- (1st) | | | | | +- name = mouse | | | | | +- size = small | | | | | +- price = 50
10、| | | +- (2nd) | | | | | +- name = elephant | | | | | +- size = large | | | | | +- price = 5000 | | | +- (3rd) | | | +- name = python | | | +- size = medium | | | +- price = 4999 | +- whatnot | +- fruits | +- (1st) = orange | +- (2nd) = bananal 这种对scalars的访问使用索引，如animals0.name（3）模板l 在FreeMarker模板中可以
11、包括下面三种特定部分： $：称为interpolations，FreeMarker会在输出时用实际值进行替代 FTL标记（FreeMarker模板语言标记）：类似于HTML标记，为了与HTML标记区分，用#开始（有些以开始，在后面叙述） 注释：包含在（而不是）之间l 下面是一些使用指令的例子： if指令#if animals.python.price Pythons are cheaper than elephants today. Pythons are not cheaper than elephants today. list指令We have these animals: NamePr
12、ice $being.name$being.price Euros 输出为：We have these animals: NamePrice mouse50 Euros elephant5000 Euros python4999 Euros include指令 Test page Test page Blah blah. 一起使用指令We have these animals: NamePrice $being.name $being.price Euros FreeMarker设计指南(3)3、模板（1）整体结构l 模板使用FTL（FreeMarker模板语言）编写，是下面各部分的一个组合：
13、 文本：直接输出 Interpolation：由$和，或#和来限定，计算值替代输出 FTL标记：FreeMarker指令，和HTML标记类似，名字前加#予以区分，不会输出 注释：由限定，不会输出l 下面是以一个具体模板例子：BRBRWelcome!BRBRBRBRWelcome$user!BRWehavetheseanimals:BRBRBR$being.namefor$being.price EurosBRBRBRBR l BR是用于换行的特殊字符序列l 注意事项： FTL区分大小写，所以list是正确的FTL指令，而List不是；$name和$NAME是不同的 Interpolation只
14、能在文本中使用 FTL标记不能位于另一个FTL标记内部，例如：#if =bar. 注释可以位于FTL标记和Interpolation内部，如下面的例子：Welcome$user !BRWehavetheseanimals:BRBR#list animals as beingBR. 多余的空白字符会在模板输出时移除（2）指令l 在FreeMarker中，使用FTL标记引用指令l 有三种FTL标记，这和HTML标记是类似的： 开始标记： 结束标记： 空内容指令标记：l 有两种类型的指令：预定义指令和用户定义指令l 用户定义指令要使用替换#，如.（会在后面讲述）l FTL标记不能够交叉，而应该正确的
15、嵌套，如下面的代码是错误的： $being.name for $being.price Euros (except for you) l 如果使用不存在的指令，FreeMarker不会使用模板输出，而是产生一个错误消息l FreeMarker会忽略FTL标记中的空白字符，如下面的例子：BR$being.namefor$being.priceEurosBR l 但是，、/和指令之间不允许有空白字符（3）表达式l 直接指定值 字符串n 使用单引号或双引号限定n 如果包含特殊字符需要转义，如下面的例子：$Its quoted andthis is a backslash: $Its quoted a
16、ndthis is a backslash: 输出结果是：Its quoted andthis is a backslash: Its quoted andthis is a backslash: n 下面是支持的转义序列：转义序列含义双引号(u0022)单引号(u0027)反斜杠(u005C)n换行(u000A)rReturn (u000D)tTab (u0009)bBackspace (u0008)fForm feed (u000C)la&xCode4位16进制Unicode代码n 有一类特殊的字符串称为raw字符串，被认为是纯文本，其中的和等不具有特殊含义，该类字符串在引号前面加r，下面
17、是一个例子：$r$foo$rC:foobar 输出的结果是：$fooC:foobar 数字n 直接输入，不需要引号n 精度数字使用“.”分隔，不能使用分组符号n 目前版本不支持科学计数法，所以“1E3”是错误的n 不能省略小数点前面的0，所以“.5”是错误的n 数字8、+8、08和8.00都是相同的 布尔值n true和false，不使用引号 序列n 由逗号分隔的子变量列表，由方括号限定，下面是一个例子：$x输出的结果是：winterspringsummerautumnn 列表的项目是表达式，所以可以有下面的例子：2 + 2, 1, 2, 3, 4, whatnotn 可以使用数字范围定义数字
18、序列，例如2.5等同于2, 3, 4, 5，但是更有效率，注意数字范围没有方括号n 可以定义反递增的数字范围，如5.2 散列（hash）n 由逗号分隔的键/值列表，由大括号限定，键和值之间用冒号分隔，下面是一个例子：name:greenmouse, price:150n 键和值都是表达式，但是键必须是字符串l 获取变量 顶层变量： $variable，变量名只能是字母、数字、下划线、$、和#的组合，且不能以数字开头 从散列中获取数据n 可以使用点语法或方括号语法，假设有下面的数据模型：(root) | +- book | | | +- title = Breeding green mouses
19、 | | | +- author | | | +- name = Julia Smith | | | +- info = Biologist, 1923-1985, Canada | +- test = title下面都是等价的：book.author.namebookauthor.namebook.author.namebookauthornamen 使用点语法，变量名字有顶层变量一样的限制，但方括号语法没有该限制，因为名字是任意表达式的结果 从序列获得数据：和散列的方括号语法语法一样，只是方括号中的表达式值必须是数字；注意：第一个项目的索引是0 序列片断：使用startIndex.endI
20、ndex语法，从序列中获得序列片断（也是序列）；startIndex和endIndex是结果为数字的表达式 特殊变量：FreeMarker内定义变量，使用.variablename语法访问l 字符串操作 Interpolation（或连接操作）n 可以使用$.（或#.）在文本部分插入表达式的值，例如：$Hello $user!$user$user$user$user n 可以使用+操作符获得同样的结果$Hello + user + !$user + user + user + usern $.只能用于文本部分，下面的代码是错误的：Wow!Wow!应该写成：Wow! 子串n 例子（假设user的
21、值为“Big Joe”）：$user0$user4$user1.4结果是（注意第一个字符的索引是0）：BJig Jl 序列操作 连接操作：和字符串一样，使用+，下面是一个例子：- $user输出结果是：- Joe- Fred- Julia- Katel 散列操作 连接操作：和字符串一样，使用+，如果具有相同的key，右边的值替代左边的值，例如：- Joe is $ages.Joe- Fred is $ages.Fred- Julia is $ages.Julia 输出结果是：- Joe is 30- Fred is 25- Julia is 18 l 算术运算 、，下面是一个例子：$x * x
22、 - 100$x / 2$12 % 10输出结果是（假设x为5）：-752.52 操作符两边必须是数字，因此下面的代码是错误的：$3 * 5 使用+操作符时，如果一边是数字，一边是字符串，就会自动将数字转换为字符串，例如：$3 + 5 输出结果是：35 使用内建的int（后面讲述）获得整数部分，例如：$(x/2)?int$1.1?int$1.999?int$-1.1?int$-1.999?int输出结果是（假设x为5）：211-1-1l 比较操作符 使用=（或=，完全相等）测试两个值是否相等，使用!= 测试两个值是否不相等 =和!=两边必须是相同类型的值，否则会产生错误，例如会引起错误 Fre
23、emarker是精确比较，所以对x、x 和X是不相等的 对数字和日期可以使用、和=，但不能用于字符串 由于Freemarker会将解释成FTL标记的结束字符，所以对于和=可以使用括号来避免这种情况，例如 y) 另一种替代的方法是，使用lt、lte、gt和gte来替代、和=l 逻辑操作符 &（and）、|（or）、!（not），只能用于布尔值，否则会产生错误 例子：#if x We have less than 12 things, and they are green. Its not hot. l 内建函数 内建函数的用法类似访问散列的子变量，只是使用“?”替代“.”，下面列出常用的一些函数
24、 字符串使用的：n html：对字符串进行HTML编码n cap_first：使字符串第一个字母大写n lower_case：将字符串转换成小写n upper_case：将字符串转换成大写n trim：去掉字符串前后的空白字符 序列使用的：n size：获得序列中元素的数目 数字使用的：n int：取得数字的整数部分（如-1.9?int的结果是-1） 例子（假设test保存字符串Tom & Jerry）：$test?html$test?upper_case?html输出结果是：Tom & JerryTOM & JERRY l 操作符优先顺序操作符组操作符后缀subvarName
25、 subStringRange . (methodParams)一元+expr、-expr、!内建?乘法*、 / 、%加法+、-关系、=（lt、lte、gt、gte）相等=（=）、!=逻辑and&逻辑or|数字范围.（4）Interpolationl Interpolation有两种类型：select userid count 通用Interpolation：$expr 数字Interpolation：#expr或#expr; formatl 注意：Interpolation只能用于文本部分l 通用Interpolation 插入字符串值：直接输出表达式结果 插入数字值：根据缺省格式（由#se
26、tting指令设置）将表达式结果转换成文本输出；可以使用内建函数string格式化单个Interpolation，下面是一个例子：$answer$answer?string $answer?string.number$answer?string.currency$answer?string.percent输出结果是：$42.00$42.0042$42.004,200% 插入日期值：根据缺省格式（由#setting指令设置）将表达式结果转换成文本输出；可以使用内建函数string格式化单个Interpolation，下面是一个使用格式模式的例子：$lastUpdated?string(yyyy-
27、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 TimeTue, Apr 8, 03Tuesday, April 08, 2003, 09:24:44 PM (PDT) 插入布尔值：根据缺省格式（由#setting指令设置）将表达式结果转换成文本输出；可以使用内建函数string格式化单个Interpolation，下面
28、是一个例子：$foo?string(yes, no)输出结果是：yesl 数字Interpolation的#expr; format形式可以用来格式化数字，format可以是： mX：小数部分最小X位 MX：小数部分最大X位 例子： #x; M2 #y; M2 #x; m1 #y; m1 #x; m1M2 #y; m1M2 FreeMarker设计指南(4)4、杂项（1）用户定义指令l 宏和变换器变量是两种不同类型的用户定义指令，它们之间的区别是宏是在模板中使用macro指令定义，而变换器是在模板外由程序定义，这里只介绍宏l 基本用法 宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令
29、使用该变量，下面是一个例子： Hello Joe! 作为用户定义指令使用宏变量时，使用替代FTL标记中的# 如果没有体内容，也可以使用：l 参数 在macro指令中可以在宏变量之后定义参数，如： Hello $person! 可以这样使用这个宏变量： and 输出结果是： Hello Fred! and Hello Batman! 宏的参数是FTL表达式，所以下面的代码具有不同的意思： 这意味着将Fred变量的值传给person参数，该值不仅是字符串，还可以是其它类型，甚至是复杂的表达式 宏可以有多参数，下面是一个例子： Hello $person! 可以这样使用该宏变量： 其中参数的次序是无关的，因此下面是等价的： 只能使用在macro指令中定义的参数，并且对所有参数赋值，所以下面的代码是错误的： 可以在定义参数时指定缺省值，如： Hello $person! 这样就正确了 宏的参数是局部变量，只能在宏定义中有效l 嵌套内容
