freemarkermacro(宏)的使用
- 格式:doc
- 大小:30.50 KB
- 文档页数:7
FreeMarker概述●FreeMarker是一个模板引擎,一个基于模板生成文本输出的通用工具,使用纯Java编写●FreeMarker被设计用来生成HTML Web页面,特别是基于MVC模式的应用程序●虽然FreeMarker具有一些编程的能力,但通常由Java程序准备要显示的数据,由FreeMarker生成页面,通过模板显示准备的数据(如下图)●FreeMarker不是一个Web应用框架,而适合作为Web应用框架一个组件●FreeMarker与容器无关,因为它并不知道HTTP或Servlet;FreeMarker同样可以应用于非Web应用程序环境●FreeMarker更适合作为Model2框架(如Struts)的视图组件,你也可以在模板中使用JSP标记库●FreeMarker是免费的1、通用目标●能够生成各种文本:HTML、XML、RTF、Java源代码等等●易于嵌入到你的产品中:轻量级;不需要Servlet环境●插件式模板载入器:可以从任何源载入模板,如本地文件、数据库等等●你可以按你所需生成文本:保存到本地文件;作为Email发送;从Web应用程序发送它返回给Web浏览器2、强大的模板语言●所有常用的指令:include、if/elseif/else、循环结构●在模板中创建和改变变量●几乎在任何地方都可以使用复杂表达式来指定值●命名的宏,可以具有位置参数和嵌套内容●名字空间有助于建立和维护可重用的宏库,或者将一个大工程分成模块,而不必担心名字冲突●输出转换块:在嵌套模板片段生成输出时,转换HTML转义、压缩、语法高亮等等;你可以定义自己的转换3、通用数据模型●FreeMarker不是直接反射到Java对象,Java对象通过插件式对象封装,以变量方式在模板中显示●你可以使用抽象(接口)方式表示对象(JavaBean、XML文档、SQL查询结果集等等),告诉模板开发者使用方法,使其不受技术细节的打扰4、为Web准备●在模板语言中内建处理典型Web相关任务(如HTML转义)的结构●能够集成到Model2 Web应用框架中作为JSP的替代●支持JSP标记库●为MVC模式设计:分离可视化设计和应用程序逻辑;分离页面设计员和程序员5、智能的国际化和本地化●字符集智能化(内部使用UNICODE)●数字格式本地化敏感●日期和时间格式本地化敏感●非US字符集可以用作标识(如变量名)●多种不同语言的相同模板6、强大的XML处理能力●<#recurse> 和<#visit>指令(2.3版本)用于递归遍历XML树●在模板中清楚和直觉的访问XML对象模型FreeMarker设计指南(1)1、快速入门(1)模板+ 数据模型= 输出●FreeMarker基于设计者和程序员是具有不同专业技能的不同个体的观念●他们是分工劳动的:设计者专注于表示——创建HTML文件、图片、Web页面的其它可视化方面;程序员创建系统,生成设计页面要显示的数据●经常会遇到的问题是:在Web页面(或其它类型的文档)中显示的信息在设计页面时是无效的,是基于动态数据的●在这里,你可以在HTML(或其它要输出的文本)中加入一些特定指令,FreeMarker会在输出页面给最终用户时,用适当的数据替代这些代码●下面是一个例子:●这个例子是在简单的HTML中加入了一些由${…}包围的特定代码,这些特定代码是FreeMarker的指令,而包含FreeMarker的指令的文件就称为模板(Template)●至于user、latestProduct.url和来自于数据模型(data model)●数据模型由程序员编程来创建,向模板提供变化的信息,这些信息来自于数据库、文件,甚至于在程序中直接生成●模板设计者不关心数据从那儿来,只知道使用已经建立的数据模型●下面是一个可能的数据模型:●数据模型类似于计算机的文件系统,latestProduct可以看作是目录,而user、url和name看作是文件,url和name文件位于latestProduct目录中(这只是一个比喻,实际并不存在)●当FreeMarker将上面的数据模型合并到模板中,就创建了下面的输出:(2)数据模型典型的数据模型是树型结构,可以任意复杂和深层次,如下面的例子:●类似于文件的变量称为scalars,保存单值●scalars保存的值有两种类型:字符串(用引号括起,可以是单引号或双引号)和数字(不要用引号将数字括起,这会作为字符串处理)●对scalars的访问从root开始,各部分用“.”分隔,如animals.mouse.price●另外一种变量是sequences,和hashes类似,只是不使用变量名字,而使用数字索引,如下面的例子:(3)模板●在FreeMarker模板中可以包括下面三种特定部分:➢${…}:称为interpolations,FreeMarker会在输出时用实际值进行替代➢FTL标记(FreeMarker模板语言标记):类似于HTML标记,为了与HTML 标记区分,用#开始(有些以@开始,在后面叙述)➢注释:包含在<#--和-->(而不是<!--和-->)之间●下面是一些使用指令的例子:➢if指令➢list指令输出为:3、模板(1)整体结构●模板使用FTL(FreeMarker模板语言)编写,是下面各部分的一个组合:➢文本:直接输出➢Interpolation:由${和},或#{和}来限定,计算值替代输出➢FTL标记:FreeMarker指令,和HTML标记类似,名字前加#予以区分,不会输出➢注释:由<#--和-->限定,不会输出●下面是以一个具体模板例子:●注意事项:➢FTL区分大小写,所以list是正确的FTL指令,而List不是;${name}和${NAME}是不同的➢Interpolation只能在文本中使用➢FTL标记不能位于另一个FTL标记内部,例如:(2)指令●在FreeMarker中,使用FTL标记引用指令●有三种FTL标记,这和HTML标记是类似的:➢开始标记:<#directivename parameters>➢结束标记:</#directivename>➢空内容指令标记:<#directivename parameters/>●有两种类型的指令:预定义指令和用户定义指令●用户定义指令要使用@替换#,如<@mydirective>...</@mydirective>(会在后面讲述)●FTL标记不能够交叉,而应该正确的嵌套,如下面的代码是错误的:●FreeMarker会忽略FTL标记中的空白字符,如下面的例子:(3)表达式●直接指定值➢字符串⏹使用单引号或双引号限定⏹如果包含特殊字符需要转义,如下面的例子:输出结果是:转义序列含义\"双引号(u0022)\'单引号(u0027)\\反斜杠(u005C)\n换行(u000A)\r Return (u000D)\t Tab (u0009)\b Backspace (u0008)\f Form feed (u000C)\l<\g>\a&\{{\x Code4位16进制Unicode代码⏹有一类特殊的字符串称为raw字符串,被认为是纯文本,其中的\和{等不具有特殊含义,该类字符串在引号前面加r,下面是一个例子:⏹直接输入,不需要引号⏹精度数字使用“.”分隔,不能使用分组符号⏹目前版本不支持科学计数法,所以“1E3”是错误的⏹不能省略小数点前面的0,所以“.5”是错误的⏹数字8、+8、08和8.00都是相同的➢布尔值⏹true和false,不使用引号➢序列⏹由逗号分隔的子变量列表,由方括号限定,下面是一个例子:输出的结果是:⏹可以使用数字范围定义数字序列,例如2..5等同于[2, 3, 4, 5],但是更有效率,注意数字范围没有方括号⏹可以定义反递增的数字范围,如5..2➢散列(hash)⏹由逗号分隔的键/值列表,由大括号限定,键和值之间用冒号分隔,下面是一个例子:●获取变量➢顶层变量: ${variable},变量名只能是字母、数字、下划线、$、@和#的组合,且不能以数字开头➢从散列中获取数据⏹可以使用点语法或方括号语法,假设有下面的数据模型:下面都是等价的:因为名字是任意表达式的结果➢从序列获得数据:和散列的方括号语法语法一样,只是方括号中的表达式值必须是数字;注意:第一个项目的索引是0➢序列片断:使用[startIndex..endIndex]语法,从序列中获得序列片断(也是序列);startIndex和endIndex是结果为数字的表达式➢特殊变量:FreeMarker内定义变量,使用.variablename语法访问●字符串操作➢Interpolation(或连接操作)⏹可以使用${..}(或#{..})在文本部分插入表达式的值,例如:⏹可以使用+操作符获得同样的结果⏹${..}只能用于文本部分,下面的代码是错误的:应该写成:➢子串⏹例子(假设user的值为“Big Joe”):结果是(注意第一个字符的索引是0):●序列操作➢连接操作:和字符串一样,使用+,下面是一个例子:输出结果是:●散列操作➢连接操作:和字符串一样,使用+,如果具有相同的key,右边的值替代左边的值,例如:输出结果是:●算术运算➢+、-、×、/、%,下面是一个例子:输出结果是(假设x为5):➢操作符两边必须是数字,因此下面的代码是错误的:➢使用+操作符时,如果一边是数字,一边是字符串,就会自动将数字转换为字符串,例如:输出结果是:➢使用内建的int(后面讲述)获得整数部分,例如:输出结果是(假设x为5):●比较操作符➢使用=(或==,完全相等)测试两个值是否相等,使用!=测试两个值是否不相等➢=和!=两边必须是相同类型的值,否则会产生错误,例如<#if 1 = "1">会引起错误➢Freemarker是精确比较,所以对"x"、"x "和"X"是不相等的➢对数字和日期可以使用<、<=、>和>=,但不能用于字符串➢由于Freemarker会将>解释成FTL标记的结束字符,所以对于>和>=可以使用括号来避免这种情况,例如<#if (x > y)>➢另一种替代的方法是,使用lt、lte、gt和gte来替代<、<=、>和>=●逻辑操作符➢&&(and)、||(or)、!(not),只能用于布尔值,否则会产生错误➢例子:●内建函数➢内建函数的用法类似访问散列的子变量,只是使用“?”替代“.”,下面列出常用的一些函数➢字符串使用的:⏹html:对字符串进行HTML编码⏹cap_first:使字符串第一个字母大写⏹lower_case:将字符串转换成小写⏹upper_case:将字符串转换成大写⏹trim:去掉字符串前后的空白字符➢序列使用的:⏹size:获得序列中元素的数目➢数字使用的:⏹int:取得数字的整数部分(如-1.9?int的结果是-1)➢例子(假设test保存字符串"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指令设置)将表达式结果转换成文本输出;可以使用内建函数string格式化单个Interpolation,下面是一个使用格式模式的例子:输出的结果类似下面的格式:➢插入布尔值:根据缺省格式(由#setting指令设置)将表达式结果转换成文本输出;可以使用内建函数string格式化单个Interpolation,下面是一个例子:输出结果是:●数字Interpolation的#{expr; format}形式可以用来格式化数字,format可以是:➢mX:小数部分最小X位➢MX:小数部分最大X位➢例子:4、杂项(1)用户定义指令●宏和变换器变量是两种不同类型的用户定义指令,它们之间的区别是宏是在模板中使用macro指令定义,而变换器是在模板外由程序定义,这里只介绍宏●基本用法➢宏是和某个变量关联的模板片断,以便在模板中通过用户定义指令使用该变量,下面是一个例子:➢作为用户定义指令使用宏变量时,使用@替代FTL标记中的#➢如果没有体内容,也可以使用:●参数➢在macro指令中可以在宏变量之后定义参数,如:➢可以这样使用这个宏变量:输出结果是:➢宏的参数是FTL表达式,所以下面的代码具有不同的意思:➢这意味着将Fred变量的值传给person参数,该值不仅是字符串,还可以是其它类型,甚至是复杂的表达式➢宏可以有多参数,下面是一个例子:➢可以这样使用该宏变量:➢其中参数的次序是无关的,因此下面是等价的:➢只能使用在macro指令中定义的参数,并且对所有参数赋值,所以下面的代码是错误的:➢可以在定义参数时指定缺省值,如:➢这样<@greet person="Fred"/>就正确了➢宏的参数是局部变量,只能在宏定义中有效●嵌套内容➢用户定义指令可以有嵌套内容,使用<#nested>指令执行指令开始和结束标记之间的模板片断➢例子:这样使用该宏变量:输出结果:➢<#nested>指令可以被多次调用,例如:输出结果:➢嵌套内容可以是有效的FTL,下面是一个有些复杂的例子:输出结果:➢宏定义中的局部变量对嵌套内容是不可见的,例如:输出结果:➢●在宏定义中使用循环变量➢用户定义指令可以有循环变量,通常用于重复嵌套内容,基本用法是:作为nested指令的参数传递循环变量的实际值,而在调用用户定义指令时,在<@…>开始标记的参数后面指定循环变量的名字➢例子:输出结果:➢指定的循环变量的数目和用户定义指令开始标记指定的不同不会有问题⏹调用时少指定循环变量,则多指定的值不可见⏹调用时多指定循环变量,多余的循环变量不会被创建(2)在模板中定义变量●在模板中定义的变量有三种类型:➢plain变量:可以在模板的任何地方访问,包括使用include指令插入的模板,使用assign指令创建和替换➢局部变量:在宏定义体中有效,使用local指令创建和替换➢循环变量:只能存在于指令的嵌套内容,由指令(如list)自动创建;宏的参数是局部变量,而不是循环变量●局部变量隐藏(而不是覆盖)同名的plain变量;循环变量隐藏同名的局部变量和plain变量,下面是一个例子:输出结果:●内部循环变量隐藏同名的外部循环变量,如:输出结果:中的同名变量,使用特殊变量global,下面的例子假设数据模型中的user的值是Big Joe:(3)名字空间●通常情况,只使用一个名字空间,称为主名字空间●为了创建可重用的宏、变换器或其它变量的集合(通常称库),必须使用多名字空间,其目的是防止同名冲突●创建库➢下面是一个创建库的例子(假设保存在lib/my_test.ftl中):间,并可以通过import指令中指定的散列变量访问库中的变量:输出结果:可以看到例子中使用的两个同名变量并没有冲突,因为它们位于不同的名字空间●可以使用assign指令在导入的名字空间中创建或替代变量,下面是一个例子:●输出结果:●数据模型中的变量任何地方都可见,也包括不同的名字空间,下面是修改的库:Freemarker - 几个比较实用的例子- -用Freemarker做模本语言有一段时间了,列出几个和JSP或者Velocity相比起来比较方便的用途,目的是引诱更多的人跳上Freemarker这个贼船,1. String内置的JavaScript转换: js_string用途:用于JavaScript转义,转换',",换行等特殊字符模板:<script>alert("${errorMessage?js_string}");</script>输出:<script>alert("Readonly\'s pet name is \"Cross Bone\"");</script>2.内置的默认值处理:default用途: 用于处理默认值模本:User: ${?default("Anonymous")}<td>${()?default(" ")}</td >输出:User: Anonymous<td> </td>注,可以对整个对象树加上(),再用内置处理器这种方便的做法,偶也是最近刚学会的,以前一直用很傻的方法做.....3. Sequence内置的计数器: xxx_index用途:显示序号模板:<#list employees as e>${e_index}. ${}</#list>输出:1. Readonly2. Robbin4. Sequence内置的分段器: chunk用途:某些比较BT的排版需求模板:<#assign seq = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']><#list seq?chunk(4) as row><ul><li><#list row as cell>${cell} </#list></li></ul></#list><#list seq?chunk(4, '-') as row><tr><td><#list row as cell>${cell} </#list></td></tr></#list>输出:<ul><li>a</li> <li>b</li> <li>c</li> <li>d</li> </ul><ul><li>e</li> <li>f</li> <li>g</li> <li>h</li> </ul><ul><li>i</li> <li>j</li> </ul><tr><td>a</td><td>b</td> <td>c</td> <td>d</td> </tr><tr><td>e</td> <td>f</td> <td>g</td> <td>h</td> </tr><tr><td>i</td> <td>j</td> <td>-</td> <td>-</td> </tr>语法FreeMarker的模板文件并不比HTML页面复杂多少,FreeMarker模板文件主要由如下4个部分组成:1. 文本:直接输出的部分2. 注释:<#-- ... -->格式部分,不会输出3. 插值:即${...}或#{...}格式的部分,将使用数据模型中的部分替代输出4. FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出1.FTL指令规则在FreeMarker中,使用FTL标签来使用指令,FreeMarker有3种FTL标签,这和HTML标签是完全类似的.1.开始标签:<#directivename parameter>2.结束标签:</#directivename>3.空标签:<#directivename parameter/>实际上,使用标签时前面的符号#也可能变成@,如果该指令是一个用户指令而不是系统内建指令时,应将#符号改成@符号.使用FTL标签时, 应该有正确的嵌套,而不是交叉使用,这和XML标签的用法完全一样.如果全用不存在的指令,FreeMarker不会使用模板输出,而是产生一个错误消息.FreeMarker会忽略FTL标签中的空白字符.值得注意的是< , /> 和指令之间不允许有空白字符.2.插值规则FreeMarker的插值有如下两种类型:1,通用插值${expr};2,数字格式化插值:#{expr}或#{expr;format}2.1 通用插值对于通用插值,又可以分为以下4种情况:1. 插值结果为字符串值:直接输出表达式结果2. 插值结果为数字值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:<#settion number_format="currency"/><#assign answer=42/>${answer}${answer?string} <#-- the same as ${answer} -->${answer?string.number}${answer?string.currency}${answer?string.percent}${answer}输出结果是:$42.00$42.0042$42.004,200%3. 插值结果为日期值:根据默认格式(由#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 08, 2003, 08:08:08 PM (PDT)4. 插值结果为布尔值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:<#assign foo=true/>${foo?string("yes", "no")}输出结果是:yes2.2 数字格式化插值数字格式化插值可采用#{expr;format}形式来格式化数字,其中format可以是:mX:小数部分最小X位MX:小数部分最大X位如下面的例子:<#assign x=2.582/><#assign y=4/>#{x; M2} <#-- 输出2.58 -->#{y; M2} <#-- 输出4 -->#{x; m2} <#-- 输出2.6 -->#{y; m2} <#-- 输出4.0 -->#{x; m1M2} <#-- 输出2.58 -->#{x; m1M2} <#-- 输出4.0 -->3.表达式表达式是FreeMarker模板的核心功能,表达式放置在插值语法${}之中时,表明需要输出表达式的值;表达式语法也可与FreeMarker 标签结合,用于控制输出.实际上FreeMarker的表达式功能非常强大,它不仅支持直接指定值,输出变量值,也支持字符串格式化输出和集合访问等功能.3.1 直接指定值使用直接指定值语法让FreeMarker直接输出插值中的值,而不是输出变量值.直接指定值可以是字符串,数值,布尔值,集合和MAP对象.1. 字符串直接指定字符串值使用单引号或双引号限定,如果字符串值中包含特殊字符需要转义,看下面的例子:${"我的文件保存在C:\\盘"}${'我名字是\"annlee\"'}输出结果是:我的文件保存在C:\盘我名字是"annlee"FreeMarker支持如下转义字符:\";双引号(u0022)\';单引号(u0027)\\;反斜杠(u005C)\n;换行(u000A)\r;回车(u000D)\t;Tab(u0009)\b;退格键(u0008)\f;Form feed(u000C)\l;<\g;>\a;&\{;{\xCode;直接通过4位的16进制数来指定Unicode码,输出该unicode码对应的字符.如果某段文本中包含大量的特殊符号,FreeMarker提供了另一种特殊格式:可以在指定字符串内容的引号前增加r标记,在r标记后的文件将会直接输出.看如下代码:${r"${foo}"}${r"C:\foo\bar"}输出结果是:${foo}C:\foo\bar2. 数值表达式中的数值直接输出,不需要引号.小数点使用"."分隔,不能使用分组","符号.FreeMarker目前还不支持科学计数法,所以"1E3"是错误的.在FreeMarker表达式中使用数值需要注意以下几点:a)数值不能省略小数点前面的0,所以".5"是错误的写法b)数值8 , +8 , 8.00都是相同的3. 布尔值直接使用true和false,不使用引号.4. 集合集合以方括号包括,各集合元素之间以英文逗号","分隔,看如下的例子:<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x>${x}</#list>输出结果是:星期一星期二星期三星期四星期五星期六星期天除此之外,集合元素也可以是表达式,例子如下:[2 + 2, [1, 2, 3, 4], "whatnot"]还可以使用数字范围定义数字集合,如2..5等同于[2, 3, 4, 5],但是更有效率.注意,使用数字范围来定义集合时无需使用方括号,数字范围也支持反递增的数字范围,如5..25,Map对象Map对象使用花括号包括,Map中的key-value对之间以英文冒号":"分隔,多组key-value 对之间以英文逗号","分隔.下面是一个例子:{"语文":78, "数学":80}Map对象的key和value都是表达式,但是key必须是字符串3.2 输出变量值FreeMarker的表达式输出变量时,这些变量可以是顶层变量,也可以是Map对象中的变量,还可以是集合中的变量,并可以使用点(.)语法来访问Java对象的属性.下面分别讨论这些情况1. 顶层变量所谓顶层变量就是直接放在数据模型中的值,例如有如下数据模型:Map root = new HashMap(); //创建数据模型root.put("name","annlee"); //name是一个顶层变量对于顶层变量,直接使用${variableName}来输出变量值,变量名只能是字母,数字,下划线,$,@和#的组合,且不能以数字开头号.为了输出上面的name的值,可以使用如下语法: ${name}2. 输出集合元素如果需要输出集合元素,则可以根据集合元素的索引来输出集合元素,集合元素的索引以方括号指定.假设有索引:["星期一","星期二","星期三","星期四","星期五","星期六","星期天"].该索引名为week,如果需要输出星期三,则可以使用如下语法:${week[2]} //输出第三个集合元素此外,FreeMarker还支持返回集合的子集合,如果需要返回集合的子集合,则可以使用如下语法:week[3..5] //返回week集合的子集合,子集合中的元素是week集合中的第4-6个元素3. 输出Map元素这里的Map对象可以是直接HashMap的实例,甚至包括JavaBean实例,对于JavaBean实例而言,我们一样可以把其当成属性为key,属性值为value的Map实例.为了输出Map元素的值,可以使用点语法或方括号语法.假如有下面的数据模型:Map root = new HashMap();Book book = new Book();Author 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"].namebook.author["name"] //混合使用点语法和方括号语法book["author"]["name"] //全部使用方括号语法使用点语法时,变量名字有顶层变量一样的限制,但方括号语法没有该限制,因为名字可以是任意表达式的结果.3.3字符串操作FreeMarker的表达式对字符串操作非常灵活,可以将字符串常量和变量连接起来,也可以返回字符串的子串等.字符串连接有两种语法:1. 使用${..}或#{..}在字符串常量部分插入表达式的值,从而完成字符串连接.2. 直接使用连接运算符+来连接字符串例如有如下数据模型:Map root = new HashMap(); root.put("user","annlee");下面将user变量和常量连接起来:${"hello, ${user}!"} //使用第一种语法来连接${"hello, " + user + "!"} //使用+号来连接上面的输出字符串都是hello,annlee!,可以看出这两种语法的效果完全一样.值得注意的是,${..}只能用于文本部分,不能用于表达式,下面的代码是错误的:<#if ${isBig}>Wow!</#if><#if "${isBig}">Wow!</#if>应该写成:<#if isBig>Wow!</#if>截取子串可以根据字符串的索引来进行,截取子串时如果只指定了一个索引值,则用于取得字符串中指定索引所对应的字符;如果指定两个索引值,则返回两个索引中间的字符串子串.假如有如下数据模型:Map root = new HashMap(); root.put("book","struts2,freemarker");可以通过如下语法来截取子串:${book[0]}${book[4]} //结果是su。
freemarker模板中定义变量在模板中能够定义三种类型的变量:简单变量:它能从模板中的不论什么位置来訪问,或者从使⽤ include 指令引⼊的模板訪问。
能够使⽤ assign 或 macro 指令来创建或替换这些变量。
局部变量:它们仅仅能被设置在宏定义体内,并且仅仅在宏内可见。
⼀个局部变量的⽣存周期仅仅是宏的调⽤过程。
能够使⽤ local 指令在宏定义体内创建或替换局部变量。
循环变量:循环变量是由指令(如 list )⾃⼰主动创建的,并且它们仅仅在指令的開始和结束标记内有效。
宏的參数是局部变量⽽不是循环变量。
演⽰样例:使⽤ assign 创建和替换变量<#assign x = 1> <#-- 创建变量 x -->${x}<#assign x = x + 3> <#-- 替换变量 x -->${x}14局部变量也会隐藏(不是覆盖)同名的简单变量。
循环变量也会隐藏(不是覆盖)同名的局部变量和简单变量。
⽐如:<#assign x = "plain">1. ${x} <#-- 这⾥是普通变量 --><@test/>6. ${x} <#-- 普通变量的值没有被改变 --><#list ["loop"] as x>7. ${x} <#-- 如今循环变量隐藏了普通变量 --><#assign x = "plain2"> <#-- 替换普通变量, 隐藏在这⾥不起作⽤-->8. ${x} <#-- 它仍然隐藏普通变量 --></#list>9. ${x} <#-- 普通变量的新值 --><#macro test>2. ${x} <#-- 这⾥我们仍然看到的是普通变量 --><#local x = "local">3. ${x} <#-- 如今局部变量隐藏了它 --><#list ["loop"] as x>4. ${x} <#-- 如今循环变量隐藏了局部变量 --></#list>5. ${x} <#-- 如今⼜能够看到局部变量了 --></#macro>1. plain2. plain3. local4. loop5. local6. plain7. loop8. loop9. plain2注意到循环变量的设置是通过指令调⽤时创建的(本例中的 <list ...> 标签)。
framemaker 语法FreeMarker是一款用Java语言编写的模板引擎,用于生成各种文本,如HTML、XML、Java等。
以下是FreeMarker语法的一些示例:1.变量替换:2.freemarker复制代码<#assign name="John">Hello ${name}!1.控制结构:2.freemarker复制代码<#if name == "John">Hello John!<#else>Hello ${name}!</#if>1.宏定义和调用:2.freemarker复制代码<#macro greet person><font size="+2">Hello ${person}!</font></#macro><@greet person="John"/>1.列表和迭代:2.freemarker复制代码<#list items as item>${item}</#list>1.内置函数:2.freemarker复制代码<#function formatDate date><#return date?string("yyyy-MM-dd HH:mm:ss")></#function>${formatDate(date)}这些只是FreeMarker语法的一些基本示例,FreeMarker还支持更复杂的表达式和控制结构。
By zhxing1、if, else, elseif语法:<#if condition>...<#elseif condition2>...<#elseif condition3>......<#else>...</#if>备注:condition、condition2···必须为boolean 类型,<#elseif ··>、<#else>可有0或多个。
实例:<#if x == 1>x is 1<#elseif x == 2>x is 2<#elseif x == 3>x is 3<#elseif x > 4>x is 4<#else>x is not 1 nor 2 nor 3 nor 4</#if>备注:< 或 > 号必须转义,否则出错。
转义请参考其他文档。
2、switch, case, default, break语法<#switch value><#case refValue1>...<#break><#case refValue2>...<#break>...<#case refValueN>...<#break><#default>...</#switch>备注:该指令官方不推荐使用了,可以用if, else, elseif 指令代替。
3、list, break语法<#list sequence as item>...</#list>备注: sequence 为一个sequence 或者 collection 类型。
item 为循环的变量。
常⽤freemarker使⽤⽂档设置价格格式<#setting number_format = "currency" /><#assign price = 42 />${price}-${price?string}--${price?string.number}---${price?string.currency}----${price?string.percent}-----输出结果:设置价格格式¥42.00- ¥42.00-- 42--- ¥42.00---- 4,200%-----设置⽇期格式<#assign lastUpdated = "2009-01-07 15:05"?datetime("yyyy-MM-dd HH:mm") />${lastUpdated?string("yyyy-MM-dd HH:mm:ss zzzz")};${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')'")};${lastUpdated?string.short};${lastUpdated?string.long};输出结果:2009-01-07 15:05:00 中国标准时间;2009-01-07 15:05:00 中国标准时间;星期三,⼀⽉ 7,09;星期三,⼀⽉ 07,2009,03:05:00 下午 (CST);09-1-7 下午3:05;2009年1⽉7⽇下午03时05分00秒;判断布尔<#assign foo=true />${foo?string("是foo","⾮foo")}输出结果:是foo集合<#assign mynums=[11,12,13,14,15,16,17,18,19]/><#list mynums as mn>${mn}<br></#list>输出结果:(¥是默认格式数字)¥12.00¥13.00¥14.00¥15.00¥16.00¥17.00¥18.00¥19.00拆分序列<#-- 这⾥是将mynums序列中下标从3到6之间的元素拆分出来,组成⼀个新的序列 --> <#assign mynum01=mynums[3..6]/><#list mynum01 as mn01>${mn01}</#list>输出结果:¥14.00¥15.00¥16.00¥17.00字符串的拆分(截取字符串)<br>${"你好,你来了吗今天看书了吗!"[0..8]}<br>你好,你来了吗今天...输出结果:你好,你来了吗今天你好,你来了吗今天...连续序列(即num01为完整集合不是拆分的)从55到58:注意此时若写成[55..58]或者[66..68]则会报错<#assign num01=55..58/><#list num01 as num>${num}</#list><#list 66..68 as num>${num}</#list>哈希表(Map)定义哈希表<#assign maps={"1":"张三","2":"李四"}>${maps["1"]}输出结果:张三<#--以下代码可以将map的key转换为相应的序列--><#assign keys=maps?keys><#list keys as key>${key}---${maps[key]}</#list>输出结果:1---张三2---李四<#assign users={"username":"张三","password":"123"}>${ername}---${users["password"]}输出结果:张三---123字符串操作a、字符串链接字符串连接有两种语法A、使⽤${..}(或#{..})在字符串常量部分插⼊表达式的值,从⽽完成字符串连接B、直接使⽤连接运算符(+)来连接字符串使⽤第⼀种语法来连接字符串${"Hello,${user}!"}第⼆种使⽤连接符号来连接字符串${"Hello,"+user+"!"};值的注意的是,${..}只能⽤于⽂本部分,因此,下⾯的代码是错误的:<#if ${isBig}>Wow!</#if><#if "${isBig}">Wow!</#if>应该写成:<#if isBig>Wow!</#if>集合连接运算符这⾥所说的集合连接运算时将两个集合连接成⼀个新的集合,连接集合的运算符是+,例如<#list ["星期⼀"," 星期⼆","星期三"]+["星期四","星期五"] as x>${x}</#list>Map连接运算符Map对象的连接运算也是将两个Map对象连接成⼀个新的Map对象,Map对象的连接运算符是+。
freemarker用法FreeMarker是一种模板引擎,在Java技术栈中被广泛使用。
它可用于生成动态的web页面,如HTML文件、XML文件、电子邮件呈现等等。
接下来,我们将介绍FreeMarker的用法。
首先,我们需要在Java项目中添加FreeMarker库的依赖项,以便在代码中使用FreeMarker。
然后,需要创建FreeMarker的配置对象,以便配置FreeMarker的一些参数,如模板文件存放位置、编码等。
在创建配置对象后,我们需要创建一个模板文件,并将其存储在指定的目录中。
模板文件是一个普通的文本文件,其中包含静态文本和FreeMarker标记。
在模板文件中,静态文本会直接呈现在生成的页面中,而FreeMarker标记将会被解释和转换成动态的内容。
FreeMarker标记的格式为${expression},其中expression是一个表达式,可以是一个变量、一个函数、一个条件语句等等。
例如,${name}表示输出变量name的值,而${if condition}...${/if}表示条件判断,如果condition成立,则输出其中的内容。
除了上述标记,FreeMarker还提供了很多其他的标记,如循环、宏、包含、导入等等。
使用FreeMarker,我们可以轻松地将Java对象与模板文件结合起来,生成动态的页面。
我们首先需要创建一个数据模型,即一个Java对象,其中包含了我们想要在页面中呈现的数据。
接着,我们需要将数据模型传递给一个模板文件,并执行解析和渲染过程,将数据和模板结合起来生成HTML代码。
最后,将HTML代码输出到客户端。
总结来说,FreeMarker是一种强大的模板引擎,它可以帮助我们生成动态页面和电子邮件。
FreeMarker标记和Java代码的结合,可以使我们更有效地处理和呈现动态内容,从而使我们的网站更加生动和富有可读性。
freemarker菜鸟教程Freemarker菜鸟教程1. 介绍Freemarker是一种模板引擎,用于将数据模型与文本模板合并生成输出内容。
它提供了多种功能,使开发人员能够轻松地生成动态网页、邮件、XML文件等。
2. Freemarker的优点- 简洁易学:Freemarker使用简单的语法和模板指令,易于学习和使用。
即使是没有编程经验的初学者也可以快速上手。
- 强大灵活:Freemarker提供了丰富的模板指令和表达式,可以满足各种动态内容生成的需求。
- 高性能:Freemarker运行速度快,生成的输出内容效率高,非常适合用于大规模的数据处理和生成。
3. Freemarker基本语法- 插值:使用${}来插入变量或表达式的值。
```html<p>欢迎来到Freemarker教程,${username}!</p>```- 条件判断:使用if-else指令进行条件判断。
```html<#if age < 18><p>您是未成年人。
</p><#else><p>您已成年。
</p></#if>```- 循环:使用list指令实现列表的循环遍历。
```html<ul><#list users as user><li>${}</li></#list></ul>```- 宏定义:使用#macro指令定义宏,可以实现代码的重复使用。
```html<#macro hello /><h1>Hello, ${name}!</h1></#macro>```4. Freemarker内置指令- include指令:用于引入其他模板文件。
```html<#include \。
freemarker !用法Freemarker是一种模板引擎,可以在Web应用中轻松地生成HTML,XML,JSON等文件。
它允许我们将数据和静态模板分离,从而使我们的代码更加清晰易读。
在这篇文章中,我们将探讨Freemarker的用法和一些最佳实践。
首先,我们需要了解Freemarker的基本语法。
Freemarker使用尖括号标记“<% %>"来定义内容块。
在这些标记内,我们可以使用变量,表达式,条件和迭代语句等。
例如,以下是一个简单的Freemarker模板:```<html><head><title>Hello, ${name}!</title></head><body><p>Welcome to our website!</p></body></html>```在这个模板中,我们使用了变量“name”。
这个变量可以在Java 代码中设置,并在生成HTML时插入到相应的位置。
为了在Java中使用Freemarker,我们需要引入Freemarker库,并创建一个Configuration对象:```Configuration cfg = newConfiguration(Configuration.VERSION_2_3_30);cfg.setClassForTemplateLoading(Main.class, "/templates"); cfg.setDefaultEncoding("UTF-8");```在这个例子中,我们设置了模板目录,并设置了默认编码为UTF-8。
然后,我们可以使用TemplateLoader从模板文件读取模板:```Template template = cfg.getTemplate("hello.ftl");```接下来,我们需要将我们的数据传递给数据模型。
FreeMarker macro(宏)的使用.txt14热情是一种巨大的力量,从心灵内部迸发而出,激励我们发挥出无穷的智慧和活力;热情是一根强大的支柱,无论面临怎样的困境,总能催生我们乐观的斗志和顽强的毅力……没有热情,生命的天空就没的色彩。FreeMarker macro(宏)的使用
有人说用freemarker,但没有用到它的宏(macro),就=没有真正用过freemarker。说的就是宏是freemarker的一大特色。
宏的定义可以查看相关的文档,里面介绍得很清楚,下面来看看它的一个用法(javaeye帖子里有讨论)。
/WEB-INF/template/common/: <#macro html title> ${title}
<#nested/>
然后在里定义: auto_import=/WEB-INF/template/common/ as c
然后其他的ftl文件就可以使用它了 : title="OA"> 你的内容 >
如果不在里定义,可以在每个文件里包含这个ftl: <#import "/WEB-INF/template/common/" as c>
不同的场合有不同的运用。使用得好的话,将会大大节省你的开发时间。
macro, nested, return 语法 <#macro name param1 param2 ... paramN> ... <#nested loopvar1, loopvar2, ..., loopvarN> ... <#return> ... 用例 <#macro test foo bar="Bar" baaz=-1> Test text, and the params: ${foo}, ${bar}, ${baaz} <@test foo="a" bar="b" baaz=5*5-2/> <@test foo="a" bar="b"/> <@test foo="a" baaz=5*5-2/> <@test foo="a"/>
输出 Test text, and the params: a, b, 23 Test text, and the params: a, b, -1 Test text, and the params: a, Bar, 23 Test text, and the params: a, Bar, -1
定义循环输出的宏 <#macro list title items>
${titlecap_first}:
输出结果
Animals:
输出 1. 2. 1 3. 4. 2 Last!
-------------------------------------------------------------------------------- 注意在使用的时候:别忘了双引号。 <#import "/pagelibs/" as book> value="${}" />
宏Macro 宏是在模板中使用macro指令定义
基本用法 宏是和某个变量关联的模板片断,以便在模板中通过用户定义指令使用该变量,下面是一个例子:
<#macro greet> Hello Joe! 调用宏时,与使用FreeMarker的其他指令类似,只是使用@替代FTL标记中的#。
<@greet> <#--<@greet/>--> 在macro指令中可以在宏变量之后定义参数,如:
<#macro greet person> Hello ${person}! 可以这样使用这个宏变量:
<@greet person="Fred"/> 但是下面的代码具有不同的意思: <@greet person=Fred/> 这意味着将Fred变量的值传给person参数,该值不仅是字符串,还可以是其它类型,甚至是复杂的表达式。
宏可以有多参数,下面是一个例子: <#macro greet person color> Hello ${person}! 可以这样使用该宏变量,其中参数的次序是无关的:
<@greet person="Fred" color="black"/> 可以在定义参数时指定缺省值,否则,在调用宏的时候,必须对所有参数赋值:
<#macro greet person color="black"> Hello ${person}! 注意:宏的参数是局部变量,只能在宏定义中有效。
嵌套内容 FreeMarker的宏可以有嵌套内容,<#nested>指令会执行宏调用指令开始和结束标记之间的模板片断,举一个简单的例子:
<#macro border>
<@border>The bordered text 输出结果:
<#macro do_thrice> <#nested> <#nested> <#nested><@do_thrice> Anything. FMPP 输出结果:
嵌套内容可以是有效的FTL,下面是一个有些复杂的例子,我们将上面三个宏组合起来: <@border>
<#macro repeat count> <#local y = "test"> <#list 1..count as x> ${y} ${count}/${x}: <#nested> <@repeat count=3>${ydefault("")} ${xdefault("")} ${countdefault("")} 输出结果:
test 3/1: test 3/2: test 3/3: 在宏定义中使用循环变量 nestted指令也可以有循环变量(循环变量的含义见下节),调用宏的时候在宏指令的参数后面依次列出循环变量的名字,格式如下:
<@ macro_name paramter list; loop variable list[,]> 例如:
<#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! 这里count是宏的参数,c, halfc,last则为循环变量,输出结果:
1. 2. 1 3. 4. 2 Last! 循环变量和宏标记指定的不同不会有问题,如果调用时少指定了循环变量,那么多余的值不可见。调用时多指定了循环变量,多余的循环变量不会被创建:
<@repeat count=4 ; c, halfc, last> ${c}. ${halfc}<#if last> Last!<@repeat count=4 ; c, halfc> ${c}. ${halfc}<@repeat count=4> Just repeat it... 在模板中定义变量 在模板中定义的变量有三种类型:
plain变量:可以在模板的任何地方访问,包括使用include指令插入的模板,使用assign指令创建和替换。 局部变量:在宏定义体中有效,使用local指令创建和替换。 循环变量:只能存在于指令的嵌套内容,由指令(如list)自动创建;宏的参数是局部变量,而不是循环变量 局部变量隐藏(而不是覆盖)同名的plain变量;循环变量隐藏同名的局部变量和plain变量,下面是一个例子:
<#assign x = "plain">${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} <#--