freemarker学习笔记

在模板中定义的变量有三种类型： 

引用

1：plain变量：可以在模板的任何地方访问，包括使用include指令插入的模板，使用assign指令创建和替换。
2：局部变量：在宏定义体中有效，使用local指令创建和替换。 
3：循环变量：只能存在于指令的嵌套内容，由指令（如list）自动创建；宏的参数是局部变量，而不是循环变量

　　

局部变量隐藏（而不是覆盖）同名的plain变量；循环变量隐藏同名的局部变量和plain变量 

<#assign x = "plain">    
1. ${x} <br>  
宏开始<br>  
<@test/>  
宏结束<br>  
6. ${x}  <br>    
    
<#list ["loop"] as x>    
    7. ${x}  <br>  
    <#assign x = "plain2">  <#-- replace the plain var -->    
    8*. ${x}  <br> <#-- it still hides the plain var. -->    
</#list>    
    
9*. ${x} <br>    
    
<#macro test>    
    2. ${x}  <br>    
    <#local x = "local">    
    3. ${x}  <br>  
  
    <#list ["loop"] as x>    
    4. ${x}  <br>    
    </#list>    
    5. ${x} <br>    
</#macro>     

　　

模板中的变量会隐藏（而不是覆盖）数据模型中同名变量，如果需要访问数据模型中的同名变量，使用特殊变量global，下面的例子假设数据模型中的user的值是Big Joe： 
<#assign user = "Joe Hider"> 
${user}          <#-- prints: Joe Hider --> 
${.globals.user} <#-- prints: Big Joe --> 

一.输出 

1：判断list记录大于2 

<#if (data?size>2)>  
    size 大于 2  
<#else>  
    size 小于 2  
</#if>  　

2：插入布尔值： 

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

3：默认值： 

<#--<#assign name="liuwentao" />-->  
${name?default('xxx')} 

或者 

<#--<#assign name="liuwentao" />-->  
${name!"xxx"}  　　

4：if_exists ： 

<#assign name="liuwentao" />  
${name?if_exists }  

5：日期格式： 

${current?string('yyyy-MM-dd HH:mm:ss E')}  

 6：数字格式：

<#setting number_format="#">  
${data.num}<br>  
${data.num?string.number}<br>  
${data.num?string.currency}<br>  
${data.num?string.percent}<br>  

　

　

　

 二.逻辑判断 

1：if .. elseif .. else : 

<#assign name="刘文涛" />  
  
<#if !name??>  
    name这个变量不存在  
<#elseif name="liuwentao">  
    name的名字等于 liuwentao  
<#elseif name="刘文涛">  
    name的名字等于 刘文涛  
<#else>  
    name的名字等于 ${name}  
</#if>  

　空值判断可以写成<#if name??> 　

2：switch .. case .. default .. ： 

<#assign name="刘文涛" />  
  
<#switch name>  
    <#case "liuwentao">  
        name的名字等于 liuwentao  
        <#break>  
    <#case "刘文涛">  
        name的名字等于 刘文涛  
        <#break>  
    <#default>  
        name的名字等于 ${name}  
</#switch>  　

三.循环 

1：list : 

<#assign topics=data.list2 />  
  
<#list topics as topic>  
    ${topic_index}. ${topic.title2} <br>  
</#list>　　

四. Macro(宏) 

1：基本用法 : 
宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量 

1.1：定义宏 

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

1.2：调用宏 

<@greet></@greet>  

或者 

<@greet/>  

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

2：带参数的宏 
宏的参数是局部变量，只能在宏定义中有效 
2.1：带一个参数的宏 

<#macro greet person>  
    <font size="+2">Hello ${person}!</font>  
</#macro>  
  
<@greet person="刘文涛"/>  　　

2.2：带多个参数的宏 

<#macro greet person color>  
    <font size="+2" color="${color}">Hello ${person}!</font>  
</#macro>  
  
<@greet person="刘文涛" color="blue"/>  

2.3： 带参数缺省值的宏 

<#macro greet person color="blue">  
    <font size="+2" color="${color}">Hello ${person}!</font>  
</#macro>  
<@greet person="刘文涛" color="yellow"/>  <br>  
<@greet person="刘文涛"/> 

　

3：在宏里嵌套内容 

3.1：<#nested> 指令 　

<#macro table>  
<table border=4 cellspacing=0 cellpadding=4>  
    <tr>  
        <td>第一次使用:<#nested></td>  
    </tr>  
    <tr>  
        <td>第二次使用:<#nested></td>  
    </tr>  
</table>  
</#macro>  
  
<@table>这些内容显示在哪里...</@table>  

　　

3.2：嵌套内容可以是有效的FTL 

<#macro greet person color="blue">  
    <font size="+2" color="${color}">Hello ${person}!</font>  
</#macro>  
  
<#macro table>  
<table border=4 cellspacing=0 cellpadding=4>  
    <tr>  
        <td>第一次使用:<#nested></td>  
    </tr>  
    <tr>  
        <td>第二次使用:<#nested></td>  
    </tr>  
</table>  
</#macro>  
  
<@table><@greet person="刘文涛"/></@table>  

　　

4：循环变量 

4.1：基本用法 

<#macro repeat count>  
    <#list 1..count as x>  
        <#nested>  
    </#list>  
</#macro>  
  
<@repeat count=4>  
    freemarker...  
</@repeat> 

　　

4.2：nestted指令也可以有循环变量 

<#macro repeat count>  
     <#nested 2, 3, true>  
</#macro>  
  
<@repeat count=4 ; c, halfc, last>  
    ${c}. ${halfc} <#if last> Last!</#if> <br>  
</@repeat>  

　

这里count是宏的参数，c, halfc,last则为循环变量 

下面的写法是不对的： 

<#macro repeat count>  
     <#nested 2, 3, true>  
</#macro>  
  
<@repeat count=4 ; c, halfc, last>  
    ${count}| ${c}. ${halfc} <#if last> Last!</#if> <br>  
</@repeat> 

因为：宏的参数是局部变量，而不是循环变量 

再看一个复杂一点例子： 

<#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> <br>  
</@repeat>  

循环变量和宏标记指定的不同不会有问题，如果调用时少指定了循环变量，那么多余的值不可见。调用时多指定了循环变量，多余的循环变量不会被创建： 

五.命名空间 
通常情况,只使用一个名字空间,称为主名字空间,但为了创建可重用的宏、变换器或其它变量的集合（通常称库）,必须使用多名字空间,其目的是防止同名冲突。 

1：创建库(假设保存在lib/my_test.ftl中) 

<#macro copyright date>  
   <p>Copyright (C) ${date} Julia Smith. All rights reserved.  
   <br>Email: ${mail}</p>  
</#macro>   
<#assign mail="liuwentao@lib.com"> 

2：使用import指令导入库到模板中 

Freemarker会为导入的库创建新的名字空间，并可以通过import指令中指定的散列变量访问库中的变量 

<#import "/lib/my_test.ftl" as my>  
<#assign mail="wentao@outer.com">  
<@my.copyright date="1999-2002"/>  
${my.mail}  
${mail} 

输出结果： 

<p>Copyright (C) 1999-2002 Julia Smith. All rights reserved.  
<br>Email: liuwentao@lib.com</p>  
liuwentao@lib.com  
wentao@outer.com  

可以看到例子中使用的两个同名变量并没有冲突，因为它们位于不同的名字空间。 

3:还可以使用assign指令在导入的名字空间中创建或替代变量 

<#import "/lib/my_test.ftl" as my>  
${my.mail}  
<#assign mail="wentao@outer.com" in my>  
${my.mail}

输出结果： 

liuwentao@lib.com  
wentao@outer.com  　　

4:数据模型中的变量任何地方都可见，也包括不同的名字空间 
下面是修改的库： 

<#macro copyright date>  
   <p>Copyright (C) ${date} ${user}. All rights reserved.</p>  
</#macro>  
<#assign mail = "${user}@acme.com">  

假设数据模型中的user变量的值是liuwentao，则下面的代码： 

<#import "/lib/my_test.ftl" as my>  
  
<@my.copyright date="1999-2002"/>  
${my.mail}  

　　输出结果： 

<p>Copyright (C) 1999-2002 liuwentao. All rights reserved.</p>liuwentao@acme.com  

　　

我遇到的问题 

1： html 转义 

<tr>  
    <td>姓名：</td>  
    <td><strong>${item.realName!?html}</strong></td>  
</tr>  

　　

指定变量 

<#assign categoryId =data.categoryId/>  　　

调用静态方法 

<#assign category=statics["com.koolearn.eclass.product.ProductFactory"].getProductCategory(categoryId) />  

　　

或

<#assign util=statics["com.koolearn.security.base.utils.KoolearnStringUtils"] />  
${util.subStrUnicode(item.content!?html,data.width!20,true)}  　　

1.常用的函数 

fm的函数调用语法是变量名后面跟一个问号，再写上方法名，如：${test?upper_case} 
如果要调用2个以上的内置方法，则连续写，如：${test?upper_case?html} 

引用

 

html : 将特殊html标记进行转换,如<转换成< 
cap_first : 首字母大写 
lower_case : 转换成小写 
upper_case :转换成大写 
trim : 剪掉前后空白 
size :得到序列、数组的元素个数 
int :获得小数的整数部分 
substring (from,  toExclusive)：取子串 
contains ：和java同 
ends_with ：  以…结尾 吗 
starts_with ：  以…开头吗 
last_index_of ：  最后的索引所在位置 
length ：  字符串长度 
matches ：是否 匹配 一个正则

　　

replace ：  替换 

${"this is a car acarus"?replace("car", "bulldozer")}－－－－－－－－－－－>  
this is a bulldozer abulldozerus 

　　

2.删除连续多个变量之间的换行符 

设想这样一个应用场景，你想生成一个java方法的代码，方法的参数是多个的，你一定不希望它是一行一个参数吧，那你就需要使用<#t>标签了，它的意思是去掉当前行首尾的空白，注意，换行也当成空白，比如下面的例子：

1 <#t>     
2<#t>     
3<#lt>     
4     
5<#rt>     
6    

　　

执行后的结果是： 

1 23   
4   
5 6  

<#t>在行里的位置无所谓，类似还有<#lt><#rt>，意思是去掉左侧和右侧的空白。 

3.如何判断变量是否存在或对象的属性是否为null 
  用??进行判断，如下： 

<#if user??><h1>Welcome ${user}!</h1></#if>  　

 存在或有值则为true 

4.如何输出${xxx} 这样的字符串 

  jsp el的语法和fm很像，都支持${}这样来输出变量内容，当然jsp本身其实也是一种模板技术，二者本质是一样的，你如果想生成jsp el的代码就会遇到这个问题，不能直接写，否则fm会把它当成fm的东西来解析成它变量了，这时候需要使用<#noparse>标签。 

<#noparse>${ccc}</#noparse>    

这样fm就不会把它当成变量来解析而是直接输出 ${ccc} 了 

chunk 用法 

<table width="950" border="0" cellspacing="2" cellpadding="0" align="center" class="mb12">  
<#list bBookList?chunk(5) as row>  
    <tr>  
        <#list row as item>  
            <td align="center">  
                <#if item.name??>  
                     <#assign name=util.subString(item.name!,item.shortName!,data.width)/>  
                    <a title='${item.name!}' href="${item.urlDetail!}" target="_blank">  
                        <img src="${item.photoS!}" alt="${item.name!}" width="145" height="110" border="0" class="img_border2">  
                    </a>  
                    <table border="0" cellpadding="0" cellspacing="0">  
                        <tr>  
                            <td height="36" align="center">  
                                <a title='${item.name!}' href="${item.urlDetail!}" target="_blank">  
                                    ${name}  
                                </a>  
                            </td>  
                        </tr>  
                    </table>  
                </#if>  
            </td>  
        </#list>  
    </tr>  
</#list>  
</table>  

　　

原文地址：http://wentao365.iteye.com/blog/612293