Freemarker的使用

来源:互联网 发布:淘宝试用如何申请成功 编辑:程序博客网 时间:2024/06/05 04:57

转自:http://blog.csdn.net/a79412906/article/details/8923043

FreeMarker的模板文件并不比HTML页面复杂多少,FreeMarker模板文件主要由如下4个部分组成:
1,文本:直接输出的部分
2,注释:<#– … –>格式部分,不会输出
3,插值:即${…}或#{…}格式的部分,将使用数据模型中的部分替代输出
4,FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出

下面是一个FreeMarker模板的例子,包含了以上所说的4个部分

<html><br> <head><br> <title>Welcome!</title><br> </head><br> <body><br> <#-- 注释部分 --><br> <#-- 下面使用插值 --> <h1>Welcome ${user} !</h1><br> <p>We have these animals:<br> <u1><br> <#-- 使用FTL指令 --> <#list animals as being><br>    <li>${being.name} for ${being.price} Euros<br> <#list><br> <u1><br> </body><br> </html>

1, FTL指令规则

在FreeMarker中,使用FTL标签来使用指令,FreeMarker有3种FTL标签,这和HTML标签是完全类似的.
1,开始标签:<#directivename parameter>
2,结束标签:

<#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.0042.00
42
$42.00
4,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 Time
Tue, Apr 8, ‘03
Tuesday, April 08, 2003, 08:08:08 PM (PDT)
4,插值结果为布尔值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:

<#assign foo=true/> ${foo?string("yes", "no")} 

输出结果是:
yes

2.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\bar

2,数值
表达式中的数值直接输出,不需要引号.小数点使用”.”分隔,不能使用分组”,”符号.FreeMarker目前还不支持科学计数法,所以”1E3”是错误的.在FreeMarker表达式中使用数值需要注意以下几点:
1,数值不能省略小数点前面的0,所以”.5”是错误的写法
2,数值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..2

5,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.name //全部使用点语法
book[“author”].name
book.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!

<#assign test="Tom & Jerry"> ${test?html} ${test?upper_case?html} 

结果是:Tom & Jerry TOM & JERRY

3.10 空值处理运算符

FreeMarker对空值的处理非常严格,FreeMarker的变量必须有值,没有被赋值的变量就会抛出异常,因为FreeMarker未赋值的变量强制出错可以杜绝很多潜在的错误,如缺失潜在的变量命名,或者其他变量错误.这里所说的空值,实际上也包括那些并不存在的变量,对于一个Java的 null值而言,我们认为这个变量是存在的,只是它的值为null,但对于FreeMarker模板而言,它无法理解null值,null值和不存在的变量完全相同.

为了处理缺失变量,FreeMarker提供了两个运算符:
!:指定缺失变量的默认值
??:判断某个变量是否存在

其中,!运算符的用法有如下两种:
variable!或variable!defaultValue,第一种用法不给缺失的变量指定默认值,表明默认值是空字符串,长度为0的集合,或者长度为0的Map对象.

使用!指定默认值时,并不要求默认值的类型和变量类型相同.使用??运算符非常简单,它总是返回一个布尔值,用法为:variable??,如果该变量存在,返回true,否则返回false

3.11 运算符的优先级

FreeMarker中的运算符优先级如下(由高到低排列):
1,一元运算符:!
2,内建函数:?
3,乘除法:*, / , %
4,加减法:- , +
5,比较:> , < , >= , <= (lt , lte , gt , gte)
6,相等:== , = , !=
7,逻辑与:&&
8,逻辑或:||
9,数字范围:..

实际上,我们在开发过程中应该使用括号来严格区分,这样的可读性好,出错少

4 FreeMarker的常用指令

FreeMarker的FTL指令也是模板的重要组成部分,这些指令可实现对数据模型所包含数据的抚今迭代,分支控制.除此之外,还有一些重要的功能,也是通过FTL指令来实现的.

4.1 if指令

这是一个典型的分支控制指令,该指令的作用完全类似于Java语言中的if,if指令的语法格式如下:

<#if condition>... <#elseif condition>... <#elseif condition>... <#else> ... </#if> 

例子如下:

<#assign age=23> <#if (age>60)>老年人 <#elseif (age>40)>中年人 <#elseif (age>20)>青年人 <#else> 少年人 </#if> 

输出结果是:青年人
上面的代码中的逻辑表达式用括号括起来主要是因为里面有>符号,由于FreeMarker会将>符号当成标签的结束字符,可能导致程序出错,为了避免这种情况,我们应该在凡是出现这些符号的地方都使用括号.

4.2 switch , case , default , break指令

这些指令显然是分支指令,作用类似于Java的switch语句,switch指令的语法结构如下:

<#switch value> <#case refValue>...<#break> <#case refValue>...<#break> <#default>... </#switch> 

4.3 list, break指令

list指令是一个迭代输出指令,用于迭代输出数据模型中的集合,list指令的语法格式如下:
<#list sequence as item>

<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x> ${x_index + 1}.${x}<#if x_has_next>,</if> <#if x="星期四"><#break></#if> </#list> 

4.4 include指令

include指令的作用类似于JSP的包含指令,用于包含指定页.include指令的语法格式如下:
<#include filename [options]>
在上面的语法格式中,两个参数的解释如下:
filename:该参数指定被包含的模板文件
options:该参数可以省略,指定包含时的选项,包含encoding和parse两个选项,其中encoding指定包含页面时所用的解码集,而parse指定被包含文件是否作为FTL文件来解析,如果省略了parse选项值,则该选项默认是true.

4.5 import指令

该指令用于导入FreeMarker模板中的所有变量,并将该变量放置在指定的Map对象中,import指令的语法格式如下:
<#import “/lib/common.ftl” as com>
上面的代码将导入/lib/common.ftl模板文件中的所有变量,交将这些变量放置在一个名为com的Map对象中.

4.6 noparse指令

noparse指令指定FreeMarker不处理该指定里包含的内容,该指令的语法格式如下:
<#noparse>…

<#noparse> <#list books as book>    <tr><td>${book.name}<td>作者:${book.author} </#list> </#noparse> 

输出如<#list books as book>
book.name<td>:{book.author}

<#escape identifier as expression>... <#noescape>...</#noescape> </#escape> 

看如下的代码:

<#escape x as x?html> First name:${firstName} Last name:${lastName} Maiden name:${maidenName} </#escape> 

上面的代码等同First name:firstName?htmlLastname:{lastName?html}
Maiden name:${maidenName?html} ape指令在解析模板时起作用而不是在运行时起作用,除此之外,escape指令也嵌套使用,子escape继承父escape的规则,如下例子:

<#escape x as x?html> Customer Name:${customerName} Items to ship; <#escape x as itemCodeToNameMap[x]>    ${itemCode1}    ${itemCode2}    ${itemCode3}    ${itemCode4} </#escape> </#escape> 

上面的代码类似于:
Customer Name:customerName?htmlItemstoship;{itemCodeToNameMap[itemCode1]?html}
itemCodeToNameMap[itemCode2]?html{itemCodeToNameMap[itemCode3]?html}
${itemCodeToNameMap[itemCode4]?html}

对于放在escape指令中所有的插值而言,这此插值将被自动加上escape表达式,如果需要指定escape指令中某些插值无需添加escape表达式,则应该使用noescape指令,放在noescape指令中的插值将不会添加escape表达式.

4.8 assign指令

assign指令在前面已经使用了多次,它用于为该模板页面创建或替换一个顶层变量,assign指令的用法有多种,包含创建或替换一个顶层变量, 或者创建或替换多个变量等,它的最简单的语法如下:<#assign name=value [in namespacehash]>,这个用法用于指定一个名为name的变量,该变量的值为value,此外,FreeMarker允许在使用 assign指令里增加in子句,in子句用于将创建的name变量放入namespacehash命名空间中.

assign指令还有如下用法:<#assign name1=value1 name2=value2 … nameN=valueN [in namespacehash]>,这个语法可以同时创建或替换多个顶层变量,此外,还有一种复杂的用法,如果需要创建或替换的变量值是一个复杂的表达式,则可以使用如下语法格式:<#assign name [in namespacehash]>capture this

<#assign x> <#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as n> ${n} </#list> </#assign> ${x} 

上面的代码将产生如下输出:星期一 星期二 星期三 星期四 星期五 星期六 星期天

虽然assign指定了这种复杂变量值的用法,但是我们也不要滥用这种用法,如下例子:<#assign x>Hello {user}!</#assign>,以上代码改为如下写法更合适:<#assign x="Hello{user}!”>

4.9 setting指令

该指令用于设置FreeMarker的运行环境,该指令的语法格式如下:<#setting name=value>,在这个格式中,name的取值范围包含如下几个:
locale:该选项指定该模板所用的国家/语言选项
number_format:指定格式化输出数字的格式
boolean_format:指定两个布尔值的语法格式,默认值是true,false
date_format,time_format,datetime_format:指定格式化输出日期的格式
time_zone:设置格式化输出日期时所使用的时区

4.10 macro , nested , return指令

macro可以用于实现自定义指令,通过使用自定义指令,可以将一段模板片段定义成一个用户指令,使用macro指令的语法格式如下:
<#macro name param1 param2 … paramN>

<#nested loopvar1, loopvar2, …, loopvarN>

<#return>

<#macro book>   //定义一个自定义指令 j2ee </#macro> <@book />    //使用刚才定义的指令 

上面的代码输出结果为:j2ee

在上面的代码中,可能很难看出自定义标签的用处,因为我们定义的book指令所包含的内容非常简单,实际上,自定义标签可包含非常多的内容,从而可以实现更好的代码复用.此外,还可以在定义自定义指令时,为自定义指令指定参数,看如下代码:

<#macro book booklist>     //定义一个自定义指令booklist是参数 <#list booklist as book>    ${book} </#list> </#macro> <@book booklist=["spring","j2ee"] />   //使用刚刚定义的指令 

上面的代码为book指令传入了一个参数值,上面的代码的输出结果为:spring j2ee

不仅如此,还可以在自定义指令时使用nested指令来输出自定义指令的中间部分,看如下例子:

<#macro page title> <html> <head>    <title>FreeMarker示例页面 - ${title?html}</title> </head> <body>    <h1>${title?html}</h1>    <#nested>      //用于引入用户自定义指令的标签体 </body> </html> </#macro> 

上面的代码将一个HTML页面模板定义成一个page指令,则可以在其他页面中如此page指令:

<#import "/common.ftl" as com>     //假设上面的模板页面名为common.ftl,导入页面 <@com.page title="book list"> <u1> <li>spring</li> <li>j2ee</li> </ul> </@com.page> 

从上面的例子可以看出,使用macro和nested指令可以非常容易地实现页面装饰效果,此外,还可以在使用nested指令时,指定一个或多个循环变量,看如下代码:
<#macro book>
<#nested 1> //使用book指令时指定了一个循环变量值
<#nested 2>

<#macro repeat count> <#list 1..count as x>     //使用nested指令时指定了三个循环变量    <#nested x, x/2, x==count> </#list> </#macro> <@repeat count=4 ; c halfc last> ${c}. ${halfc}<#if last> Last! </#if> </@repeat> 

上面的输出结果为:
1. 0.5 2. 1 3. 1.5 4. 2 Last;

return指令用于结束macro指令,一旦在macro指令中执行了return指令,则FreeMarker不会继续处理macro指令里的内容,看如下代码:
<#macro book>
spring
<#return>
j2ee

<#if condition>   ... <#elseif condition2>   ... <#elseif condition3>   ... ... <#else>   ... </#if> 

用例

<#if x = 1>   x is 1 </#if> <#if x = 1>   x is 1 <#else>   x is not 1 </#if> 

switch, case, default, break
语法

<#switch value>   <#case refValue1>     ...     <#break>   <#case refValue2>     ...     <#break>   ...   <#case refValueN>     ...     <#break>   <#default>     ... </#switch> 

用例
字符串

<#switch being.size>   <#case "small">      This will be processed if it is small      <#break>   <#case "medium">      This will be processed if it is medium      <#break>   <#case "large">      This will be processed if it is large      <#break>   <#default>      This will be processed if it is neither </#switch> 

数字

<#switch x>   <#case x = 1>     1   <#case x = 2>     2   <#default>     d </#switch> 

如果x=1 输出 1 2, x=2输出 2, x=3 输出d

list, break
语法
<#list sequence as item>

<#if item = “spring”><#break>

<#assign seq = ["winter", "spring", "summer", "autumn"]> <#list seq as x>   ${x_index + 1}. ${x}<#if x_has_next>,</#if> </#list> 

输出
1. winter,
2. spring,
3. summer,
4. autumn

include
语法
<#include filename>
or
<#include filename options>
options包含两个属性
encoding=”GBK” 编码格式
parse=true 是否作为ftl语法解析,默认是true,false就是以文本方式引入.注意在ftl文件里布尔值都是直接赋值的如parse=true,而不是parse=”true”
用例
/common/copyright.ftl包含内容
Copyright 2001-2002 ${me}

All rights reserved.
模板文件

<#assign me = "Juila Smith"> <h1>Some test</h1> <p>Yeah. <hr> <#include "/common/copyright.ftl" encoding=”GBK”> 

输出结果

Some test

Yeah.


Copyright 2001-2002 Juila Smith All rights reserved. Import 语法

<#import "/libs/mylib.ftl" as my> <@my.copyright date="1999-2002"/> 

”my”在freemarker里被称作namespace

compress
语法

<#compress>   ... </#compress> 

用来压缩空白空间和空白的行
用例

<#assign x = "    moo  \n\n   "> (<#compress>   1 2  3   4    5   ${moo}   test only   I said, test only </#compress>) 

输出
(1 2 3 4 5
moo
test only
I said, test only)
escape, noescape
语法

<#escape identifier as expression>   ...   <#noescape>...</#noescape>   ... </#escape> 

用例
主要使用在相似的字符串变量输出,比如某一个模块的所有字符串输出都必须是html安全的,这个时候就可以使用该表达式

<#escape x as x?html>   First name: ${firstName}   <#noescape>Last name: ${lastName}</#noescape>   Maiden name: ${maidenName} </#escape> 

相同表达式
First name: firstName?htmlLastname:{lastName }
Maiden name: ${maidenName?html}
assign
语法

<#assign name=value> or <#assign name1=value1 name2=value2 ... nameN=valueN> or <#assign same as above... in namespacehash> or <#assign name>   capture this </#assign> or <#assign name in namespacehash>   capture this </#assign> 

用例
生成变量,并且给变量赋值
给seasons赋予序列值
<#assign seasons = [“winter”, “spring”, “summer”, “autumn”]>

给变量test加1
<#assign test = test + 1>

给my namespage 赋予一个变量bgColor,下面可以通过my.bgColor来访问这个变量
<#import “/mylib.ftl” as my>
<#assign bgColor=”red” in my>

将一段输出的文本作为变量保存在x里
下面的阴影部分输出的文本将被赋值给x

<#assign x>   <#list 1..3 as n>     ${n} <@myMacro />   </#list> </#assign> Number of words: ${x?word_list?size} ${x} <#assign x>Hello ${user}!</#assign>     error <#assign x=” Hello ${user}!”>         true 

同时也支持中文赋值,如:
<#assign 语法>
java

<#macro name param1 param2 ... paramN>   ...   <#nested loopvar1, loopvar2, ..., loopvarN>   ...   <#return>   ... </#macro> 

用例

<#macro test foo bar="Bar" baaz=-1>   Test text, and the params: ${foo}, ${bar}, ${baaz} </#macro> <@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>   <p>${title?cap_first}:   <ul>     <#list items as x>       <li>${x?cap_first}     </#list>   </ul> </#macro> <@list items=["mouse", "elephant", "python"] title="Animals"/> 

输出结果

Animals:

<ul>       <li>Mouse       <li>Elephant       <li>Python   </ul> 

包含body的宏

<#macro repeat count>   <#list 1..count as x>     <#nested x, x/2, x==count>   </#list> </#macro> <@repeat count=4 ; c halfc last>   ${c}. ${halfc}<#if last> Last!</#if> </@repeat> 

输出
1. 0.5
2. 1
3. 1.5
4. 2 Last!

t, lt, rt
语法
<#t> 去掉左右空白和回车换行

<#lt>去掉左边空白和回车换行

<#rt>去掉右边空白和回车换行

<#nt>取消上面的效果

3一些常用方法或注意事项

表达式转换类
${expression}计算expression并输出

{ expression }数字计算#{ expression ;format}安格式输出数字format为M和m

M表示小数点后最多的位数,m表示小数点后最少的位数如#{121.2322;m2M2}输出121.23

数字循环
1..5 表示从1到5,原型number..number
对浮点取整数
123.23?int123{var?default(“hello world
”)?html}如果var is null那么将会被hello world
替代

判断对象是不是null
<#if mouse?exists>
Mouse found
<#else>
也可以直接${mouse?if_exists})输出布尔形
常用格式化日期
openingTime必须是Date型,详细查看freemarker文档 Reference->build-in referece->build-in for date

${openingTime?date} ${openingTime?date_time} ${openingTime?time} 

添加全局共享变量数据模型
在代码里的实现

    cfg = Configuration.getDefaultConfiguration();     cfg.setSharedVariable("global", "you good"); 

页面实现可以通过global指令,具体查看指令里的global部分
直接调用java对象的方法
${object.methed(args)}

字符串处理(内置方法)
html安全输出
“abc

sdfsf”?html
返回安全的html输出,替换掉html代码
xml安全输出
var?xml
substring的用法
<#assign user=”hello jeen”>
user[0]{user[4]}
${user[1..4]}
输出 :
ho
ello
类似String.split的用法
“abc;def;ghi”?split(“;”)返回sequence
将字符串按空格转化成sequence,然后取sequence的长度
var?word_list 效果同 var?split(“ ”)
var?word_list?size

取得字符串长度
var?length

大写输出字符
var?upper_case

小写输出字符
var?lower_case

首字符大写
var?cap_first

首字符小写
var?uncap_first

去掉字符串前后空格
var?trim

每个单词的首字符大写
var?capitalize

类似String.indexof:
“babcdabcd”?index_of(“abc”) 返回1
“babcdabcd”?index_of(“abc”,2) 返回5
类似String.lastIndexOf
last_index_of和String.lastIndexOf类似,同上

下面两个可能在代码生成的时候使用(在引号前加”\”)
j_string: 在字符串引号前加”\”

<#assign beanName = 'The "foo" bean.'> String BEAN_NAME = "${beanName?j_string}"; 打印输出: String BEAN_NAME = "The \"foo\" bean."; js_string: <#assign user = "Big Joe's \"right hand\"."> <script>   alert("Welcome ${user}!"); </script> 

打印输出
alert(“Welcome Big Joe\’s \”right hand\”!”);

替换字符串 replace
s?replace(ba,XY){s?replace(‘ba’, ‘XY’ , ‘规则参数’)}将s里的所有的ba替换成xy 规则参数包含: i r m s c f 具体含义如下:
· i: 大小写不区分.
· f: 只替换第一个出现被替换字符串的字符串
· r: XY是正则表达式
· m: Multi-line mode for regular expressions. In multi-line mode the expressions ^ and $ match just after or just before, respectively, a line terminator or the end of the string. By default these expressions only match at the beginning and the end of the entire string.
· s: Enables dotall mode for regular expressions (same as Perl singe-line mode). In dotall mode, the expression . matches any character, including a line terminator. By default this expression does not match line terminators.
· c: Permits whitespace and comments in regular expressions.

在模板里对sequences和hashes初始化
sequences

  1. [“you”,”me”,”he”]
  2. 1..100
  3. [ {“Akey”:”Avalue”},{“Akey1”:”Avalue1”},
    {“Bkey”:”Bvalue”},{“Bkey1”:”Bvalue1”},
    ]

hashes {“you”:”a”,”me”:”b”,”he”:”c”}

注释标志
<#–
这里是注释
–>
旧版本的freemarker采用的是<#comment> 注释

${Request ["a"]} ${RequestParameters["a"]} ${Session ["a"]} ${Application ["a"]} ${JspTaglibs ["a"]} 

与webwork整合之后 通过配置的servlet 已经把request,session等对象置入了数据模型中
在view中存在下面的对象
我们可以在ftl中reqreqreqthecurrentHttpServletRequestresthecurrentHttpServletResponsestackthecurrentOgnlValueStackognltheOgnlToolinstancewebworkaninstanceofFreemarkerWebWorkUtilactionthecurrentWebWorkactionexceptionoptionaltheExceptioninstance,iftheviewisaJSPexceptionorServletexceptionviewview{name}将会以下面的顺序查找name值
· freemarker variables
· value stack
· request attributes
· session attributes
· servlet context attributes
在模板里ftl里使用标签
注意,如果标签的属性值是数字,那么必须采用nubmer=123方式给属性赋值
JSP页面

<%@page contentType="text/html;charset=ISO-8859-2" language="java"%> <%@taglib uri="/WEB-INF/struts-html.tld" prefix="html"%> <%@taglib uri="/WEB-INF/struts-bean.tld" prefix="bean"%> <html>   <body>     <h1><bean:message key="welcome.title"/></h1>     <html:errors/>     <html:form action="/query">       Keyword: <html:text property="keyword"/><br>       Exclude: <html:text property="exclude"/><br>       <html:submit value="Send"/>     </html:form>   </body> </html> 

模板ftl页面

<#assign html=JspTaglibs["/WEB-INF/struts-html.tld"]> <#assign bean=JspTaglibs["/WEB-INF/struts-bean.tld"]> <html>   <body>     <h1><@bean.message key="welcome.title"/></h1>     <@html.errors/>     <@html.form action="/query">       Keyword: <@html.text property="keyword"/><br>       Exclude: <@html.text property="exclude"/><br>       <@html.submit value="Send"/>     </@html.form>   </body> </html> 

如何初始化共享变量
1. 初始化全局共享数据模型
freemark在web上使用的时候对共享数据的初始化支持的不够,不能在配置初始化的时候实现,而必须通过ftl文件来初始化全局变量。这是不能满主需求的,我们需要在servlet init的时候留出一个接口来初始化系统的共享数据
具体到和webwork整合,因为本身webwork提供了整合servlet,如果要增加全局共享变量,可以通过修改 com.opensymphony.webwork.views.freemarker.FreemarkerServlet来实现,我们可以在这个 servlet初始化的时候来初始化全局共享变量
与webwork整合配置
配置web.xml

<servlet>     <servlet-name>freemarker</servlet-name>     <servlet-class>com.opensymphony.webwork.views.freemarker.FreemarkerServlet</servlet-class>     <init-param>       <param-name>TemplatePath</param-name> <param-value>/</param-value> <!—模板载入文件夹,这里相对context root,递归获取该文件夹下的所有模板-->     </init-param>     <init-param>       <param-name>NoCache</param-name> <!—是否对模板缓存-->       <param-value>true</param-value>     </init-param>     <init-param>       <param-name>ContentType</param-name>       <param-value>text/html</param-value>     </init-param>     <init-param> <param-name>template_update_delay</param-name> <!—模板更新时间,0表示每次都更新,这个适合开发时候-->       <param-value>0</param-value>     </init-param>     <init-param>       <param-name>default_encoding</param-name>       <param-value>GBK</param-value>     </init-param>     <init-param>       <param-name>number_format</param-name>       <param-value>0.##########</param-value><!—数字显示格式-->     </init-param>     <load-on-startup>1</load-on-startup>   </servlet>   <servlet-mapping>     <servlet-name>freemarker</servlet-name>     <url-pattern>*.ftl</url-pattern>   </servlet-mapping> 

5高级方法
自定义方法

${timer("yyyy-MM-dd H:mm:ss", x)} ${timer("yyyy-MM-dd ", x)} 

在模板中除了可以通过对象来调用方法外(${object.methed(args)})也可以直接调用java实现的方法,java类必须实现接口TemplateMethodModel的方法exec(List args). 下面以把毫秒的时间转换成按格式输出的时间为例子

public class LongToDate implements TemplateMethodModel { public TemplateModel exec(List args) throws TemplateModelException { SimpleDateFormat mydate = new SimpleDateFormat((String) args.get(0)));         return mydate.format(new Date(Long.parseLong((String)args.get(1)));     } } 

将LongToDate对象放入到数据模型中

root.put("timer", new IndexOfMethod()); 

ftl模板里使用

<#assign x = "123112455445"> ${timer("yyyy-MM-dd H:mm:ss", x)} ${timer("yyyy-MM-dd ", x)} 

输出
2001-10-12 5:21:12
2001-10-12

自定义 Transforms
实现自定义的<@transform>文本或表达式

import java.io.*; import java.util.*; import freemarker.template.TemplateTransformModel; class UpperCaseTransform implements TemplateTransformModel {     public Writer getWriter(Writer out, Map args) {         return new UpperCaseWriter(out);     }     private class UpperCaseWriter extends Writer {         private Writer out;         UpperCaseWriter (Writer out) {             this.out = out;         }         public void write(char[] cbuf, int off, int len)                 throws IOException {             out.write(new String(cbuf, off, len).toUpperCase());         }         public void flush() throws IOException {             out.flush();         }         public void close() {         }     } } 

然后将此对象put到数据模型中

root.put("upcase", new UpperCaseTransform()); 

在view(ftl)页面中可以如下方式使用

<@upcase> hello world </@upcase> 

打印输出:

HELLO WORLD
0 0
原创粉丝点击