Freemarker简单总结

转自：http://blog.163.com/ksm19870304@126/blog/static/37455233201071743420838/

 

Freemaker是一个”模板引擎”,也可以说是一个基于模板技术的生成文本输出的一个通用工具

 

一般的用途:

l 能用来生成任意格式的文本:HTML,XML,RTF,JAVA源码,等等.

l可以更好的嵌入到你的产品中,轻量级的.并不需要servlet环境.不依赖javax.servlet.classes.

 

空值判断：${book.name?if_exists },

${book.name?default(‘xxx’)}//默认值xxx
${ book.name!"xxx"}//默认值xxx

 

日期格式：${book.date?string('yyyy-MM-dd')}

 

数字格式：${book?string.number}—20

${book?string.currency}--<#-- $20.00 -->
${book?string.percent}—<#-- 20% -->

 

插入布尔值：
<#assign foo=ture />
${foo?string("yes","no")} <#-- yes -->
2．逻辑判断
a:
<#if condition>...
<#elseif condition2>...
<#elseif condition3>......
<#else>...
其中空值判断可以写成<#if book.name?? >
</#if>

 

 

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

 

3．循环读取
<#list sequence as item>
...
</#list>
空值判断<#if bookList?size = 0></#list>

 

3 宏/模板

宏Macro

宏是在模板中使用macro指令定义
l.1 基本用法
宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量，下面是一个例子：

<#macro greet>
<font size="+2">Hello Joe!</font>
</#macro>

调用宏时，与使用FreeMarker的其他指令类似，
只是使用@替代FTL标记中的#。

<@greet></@greet>

<#--<@greet/>-->

 

在macro指令中可以在宏变量之后定义参数，如：

<#macro greet person>
<font size="+2">Hello ${person}!</font>
</#macro>
可以这样使用这个宏变量：
<@greet person="Fred"/>

可以这样使用这个宏变量：
<@greet person="Fred"/>
但是下面的代码具有不同的意思：
<@greet person=Fred/>
这意味着将Fred变量的值传给person参数，该值不仅是字符串，还可以是其它类型，甚至是复杂的表达式。

 

宏可以有多参数，下面是一个例子：
<#macro greet person color>
<font size="+2" color="${color}">Hello ${person}!</font>
</#macro>

可以这样使用该宏变量，其中参数的次序是无关的：
<@greet person="Fred" color="black"/>

 

可以在定义参数时指定缺省值，否则，在调用宏的时候，必须对所有参数赋值：
<#macro greet person color="black">
<font size="+2" color="${color}">Hello ${person}!</font>
</#macro>

注意：宏的参数是局部变量，只能在宏定义中有效。

在宏里嵌套内容
FreeMarker的宏可以有嵌套内容，
<#nested>指令会执行宏调用指令开始和结束标记之间的模板片断，举一个简单的例子：

<#macro border>
<table border=4 cellspacing=0 cellpadding=4><tr><td>
<#nested>
</tr></td></table>
</#macro>

执行宏调用：
<@border>The bordered text</@border>
输出结果：
<table border=4 cellspacing=0 cellpadding=4>
<tr><td>
The bordered text
</tr></td>
</table>

<#nested>指令可以被多次调用，每次都会执行相同的内容。
<#macro do_thrice>
<#nested>
<#nested>
<#nested>
</#macro>

<@do_thrice>
Anything.
</@do_thrice>

FMPP 输出结果：
Anything.
Anything.
Anything.

 

在模板中定义的变量有三种类型：
plain变量：可以在模板的任何地方访问，包括使用include指令插入的模板，使用assign指令创建和替换。
局部变量：在宏定义体中有效，使用local指令创建和替换。
循环变量：只能存在于指令的嵌套内容，由指令（如list）自动创建；宏的参数是局部变量，而不是循环变量
局部变量隐藏（而不是覆盖）同名的plain变量；循环变量隐藏同名的局部变量和plain变量，下面是一个例子：

 

//////////////////////////////////////////////////////////////////////////////////////////////////////

 

常用于法：

${book.name?if_exists } //用于判断如果存在,就输出这个值
${book.name?default(‘xxx’)}//默认值xxx
${book.name!"xxx"}//默认值xxx
${book.date?string('yyyy-MM-dd')} //日期格式
${book?string.number} 20 //三种不同的数字格式
${book?string.currency}--<#-- $20.00 -->
${book?string.percent}—<#-- 20% -->
<#assign foo=ture />   //声明变量,插入布尔值进行显示
${foo?string("yes","no")} <#-- yes -->
<等大小比较符号使用需要注意:(xml的原因),可以用于比较数字和日期
使用lt、lte、gt和gte来替代<、<=、>和>= 也可以使用括号<#if (x>y)>

 

内置函数: 调用区别于属性的访问,使用?代替.
常见的一些内置函数
对于字符串
html－对字符串进行HTML编码
cap_first－使字符串第一个字母大写
lower_case－将字符串转换成小写
trim－去掉字符串前后的空白字符
对于Sequences(序列)
size－获得序列中元素的数目
对于数字
int－取得数字的整数部分（如-1.9?int的结果是-1）
对于集合,可以使用数组的方式,使用下标索引进行访问

Boolean类型的空值判断
空值判断可以写成<#if book.name?? >   //注意${}为变量的渲染显示,而<>为定义等操作符的定义

 

快速定义int区间的集合
<#assign l=0..100/> //注意不需要[]

 

3:循环读取集合: 注意/的使用
<#list student as stu>
    ${stu}<br/>
</#list>
与jstl循环类似,也可以访问循环的状态
item_index:当前变量的索引值
item_has_next:是否存在下一个对象 其中item名称为as后的变量名,如stu

 

集合长度判断
<#if student?size != 0></#if> 判断=的时候,注意只要一个=符号,而不是==

 

for循环的精简版:
<#list 1..count as x>
</#list>

布尔值都是直接赋值的如parse=true,而不是
parse=”true”
hash与list的定义
<#assign c= {"a":"orz","b":"czs"}>
${c.a}
List片段可以采用： products[10..19] or products[5..] 的格式进行定义,当只局限于数字
<#assign c= [1,2,3,4,5,6,6,7]>
    <#list c[1..3] as v>
    ${v}
    </#list>
对变量的缺省处理
product.color!"red"

数字输出的另外一种方式
#{c.a;m0} 区别于${},这个例子是用于输出数字的格式化,保留小数的位数,详细如下
数字格式化插值可采用#{expr;format}形式来格式化数字,其中format可以是:
mX:小数部分最小X位
MX:小数部分最大X位
在定义字符串的时候,可以使用''或者"",对特殊字符,需要使用\进行转义

 

Map对象的key和value都是表达式,但是key必须是字符串
可以混合使用.和[""]访问
book.author["name"] //混合使用点语法和方括号语法

 

为了处理缺失变量,FreeMarker提供了两个运算符: 用于防止对象不存在而导致的异常
!:指定缺失变量的默认值
??:判断某个变量是否存在,返回boolean值

 

定义全局变量的方式
<#assign name1=value1 name2=value2 / > // 可以同时定义多个变量,也可以使用循环来给变量赋值
<#assign x>
<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as n>
${n}
</#list>
</#assign>

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

include

语法

Freemarker代码

<#include filename>  

<#include filename>

  或则

Java代码

<#include filename options>  

<#include filename options>

 

options包含两个属性
encoding="GBK" 编码格式
parse=true 是否作为ftl语法解析,默认是true，false就是以文本方式引入.注意在ftl文件里布尔值都是直接赋值
的如parse=true,而不是parse="true"

 

假设mylib.ftl 里定义了宏copyright 那么我们在其他模板页面里可以这样使用

Freemarker代码

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

<#-- "my"在freemarker里被称作namespace --> 

 

compress

语法

Freemarker代码

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

<#compress>

  ...

</#compress>

 

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

 

 

global

语法

Freemarker代码

<#global name=value>   
  
<#--或则-->   
  
<#global name1=value1 name2=value2 ... nameN=valueN>   
  
<#--或则-->   
  
<#global name>   
  capture this   
</#global>  

<#global name=value>

 

<#--或则-->

 

<#global name1=value1 name2=value2 ... nameN=valueN>

 

<#--或则-->

 

<#global name>

  capture this

</#global>

 

     全局赋值语法，利用这个语法给变量赋值，那么这个变量在所有的namespace [A1] 中是可见的, 如果这个变量被当前的assign 语法覆盖 如<#global x=2> <#assign x=1> 在当前页面里x=2 将被隐藏，或者通过${.global.x} 来访问

 

 

数字循环

1..5 表示从1 到5 ，原型number..number

 

对浮点取整数

${123.23?int} 输出 123

 

（1）解决输出中文乱码问题：

     freemarker乱码的原因：

没有使用正确的编码格式读取模版文件,表现为模版中的中文为乱码

解决方法：在classpath上放置一个文件freemarker.properties，在里面写上模版文件的编码方式，比如

default_encoding=UTF-8
locale=zh_CN

 

（2）提高freemarker的性能

在freemarker.properties中设置：

template_update_delay=60000

 

（5）一些特殊的指令：  

r代表原样输出：${r"C:\foo\bar"}
<#list ["winter", "spring", "summer", "autumn"] as x>${x}</#list>
？引出内置指令
String处理指令：
html:特殊的html字符将会被转义，比如"<"，处理后的结果是&lt;
cap_first 、lower_case 、upper_case
trim :除去字符串前后的空格
sequences处理指令
size ：返回sequences的大小
numbers处理指令
int:number的整数部分，(e.g. -1.9?int is -1)

 

 

日期处理的例子：

    ${openingTime?string.short}
    ${openingTime?string.medium}
    ${openingTime?string.long}
    ${openingTime?string.full}
    ${nextDiscountDay?string.short}
    ${nextDiscountDay?string.medium}
    ${nextDiscountDay?string.long}
    ${nextDiscountDay?string.full}
    ${lastUpdated?string.short}
    ${lastUpdated?string.medium}
    ${lastUpdated?string.long}
    ${lastUpdated?string.full}

 

注意：
    由于java语言中的Date类型的不足，freemarker不能根据Date变量判断出变量包含的部分（日期、时间还是全部），在这种情况下，freemarker
    不能正确显示出${lastUpdated?string.short} 或者 simply ${lastUpdated}，因此，可以通过?date, ?time and ?datetime built-ins
    来帮助freemarker来进行判断，比如${lastUpdated?datetime?string.short}
    除了使用内置的日期转换格式外，可以自己指定日期的格式，使用的是Java date format syntax，比如：

    ${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')'")}