Freemarker中遍历List以及内置函数使用

= 

在Freemarker应用中经常会遍历List获取需要的数据，并对需要的数据进行排序加工后呈现给用户。

那么在Freemarker中如何遍历List，并对List中数据进行适当的排序呢？
一、 Freemarker中list指令简单介绍
要想在Freemarker中遍历list,必须通过使用list指令,即<#list sequence as item>…</#list>
sequence是集合(collection)的表达式，item是循环变量的名字，不能是表达式。
当在遍历sequence时，会将遍历变量的值保存到item中。
举个例子说明吧：
<#list userList as user>
…
</#list>
userList中封装了很多个User对象，我们在遍历userList时候，会将遍历的User对象的值，保存到上述的user变量中。那么在取值时，我们可以通过${user.userName }来获取User对象的userName属性值。

List指令还隐含了两个循环变量：
item_index:当前迭代项在所有迭代项中的位置，是数字值。
item_has_next:用于判断当前迭代项是否是所有迭代项中的最后一项。
注意：在使用上述两个循环变量时，一定要将item换成你自己定义的循环变量名,item其实就是前缀罢了。
例如，如果你使用<# list list as l>..</#list>定义，那么就要使用l_index,l_has_next。
在循环过程中，如果您想跳出循环，那么可以使用结合break指令，即<#break>来完成。

二、 Freemarker中对List进行排序
通常我们的排序操作都是通过DAO层来实现的，如果我们想随时更改我们的排序，那么就必须修改我们的DAO层代码，确实不方便。但Freemarker为我们提供了这样的排序方法，解决了这个问题。
1. sort升序排序函数
sort对序列(sequence)进行排序，要求序列中的变量必须是：字符串（按首字母排序）,数字，日期值。
<#list list?sort as l>…</#list>
2. sort_by函数
sort_by有一个参数,该参数用于指定想要排序的子变量，排序是按照变量对应的值进行排序,如：
<#list userList?sort_by(“age”) as user>…</#list>
age是User对象的属性，排序是按age的值进行的。
3. reverse降序排序函数
<#list list? reverse as l>…</#list>
reverse使用同sort相同。reverse还可以同sort_by一起使用
如：想让用户按年龄降序排序，那么可以这样写：

<#list userList?sort_by(“age”)?reverse as user>…</#list>

Freemrker内置了很多函数，如操作字符串，数字，集合等，可以方便的在页面处理数据。

一、 Sequence的内置函数

1. sequence?first 返回sequence的第一个值。

2. sequence?last 返回sequence的最后一个值。

3. sequence?reverse 将sequence的现有顺序反转，即倒序排序

4. sequence?size 返回sequence的大小

5. sequence?sort 将sequence中的对象转化为字符串后顺序排序

6. sequence?sort_by(value) 按sequence中对象的属性value进行排序

注意：Sequence不能为null。以上方法在我的另一篇博客Freemarker中如何遍历List有详细的应用，感兴趣的朋友可以参考。

二、 Hash的内置函数

1. hash?keys 返回hash里的所有key,返回结果为sequence

2. hash?values 返回hash里的所有value,返回结果为sequence

例如：

<#assign user={“name”:“hailang”, “sex”:“man”}>
<#assign keys=user?keys>
<#list keys as key>
key=key={user[key]}
</#list>

三、 操作字符串函数

1. substring（start,end）从一个字符串中截取子串
start:截取子串开始的索引，start必须大于等于0，小于等于end

end: 截取子串的长度，end必须大于等于0，小于等于字符串长度，如果省略该参数，默认为字符串长度。

例子：

${‘str’?substring(0)}à结果为str

${‘str’?substring(1)}à结果为tr

${‘str’?substring(2)}à结果为r

${‘str’?substring(3)}à结果为

${‘str’?substring(0,0)}à结果为

${‘str’?substring(0,1)}à结果为s

${‘str’?substring(0,2)}à结果为st

${‘str’?substring(0,3)}à结果为str

2. cap_first 将字符串中的第一个单词的首字母变为大写。
${‘str’？cap_first}à结果为Str

3. uncap_first将字符串中的第一个单词的首字母变为小写。
${‘Str’？cap_first}à结果为str

4. capitalize将字符串中的所有单词的首字母变为大写
${‘str’？ capitalize}à结果为STR

5. date,time，datetime将字符串转换为日期
例如：

<#assign date1=”2009-10-12”?date(“yyyy-MM-dd”)>
<#assign date2=”9:28:20”?time(“HH:mm:ss”)>
<#assign date3=” 2009-10-12 9:28:20”?time(“HH:mm:ss”)>

${date1}à结果为2009-10-12
${date2}à结果为9:28:20
${date3}à结果为2009-10-12 9:28:20

时间格式化： ${book.date?string('yyyy-MM-dd')}

判断长度：<#if oa.content?length gt= 20>

注意：如果指定的字符串格式不正确将引发错误。

6. ends_with 判断某个字符串是否由某个子串结尾，返回布尔值。

${“string”?ends_with(“ing”)?string} 返回结果为true

注意：布尔值必须转换为字符串才能输出

7. html 用于将字符串中的<、>、&和“替换为对应得&lt;&gt;&quot:&amp

8. index_of（substring,start）在字符串中查找某个子串，返回找到子串的第一个字符的索引，如果没有找到子串，则返回-1。

Start参数用于指定从字符串的那个索引处开始搜索，start为数字值。
如果start大于字符串长度，则start取值等于字符串长度，如果start小于0， 则start取值为0。
${“string”?index_of(“in”) à结果为3

${“string”?index_of(“ab”) à结果为-1

9. length返回字符串的长度 ${“string”?length}à结果为6

10. lower_case将字符串转为小写

${“STRING”?lower_case}à结果为string

11. upper_case将字符串转为大写

${“string”?upper_case}à结果为STRING

12. contains 判断字符中是否包含某个子串。返回布尔值

${“string”?contains(“ing”)?string} à结果为true
注意：布尔值必须转换为字符串才能输出

13. number将字符串转换为数字

${“111.11”?number}à结果为111.11

14. replace用于将字符串中的一部分从左到右替换为另外的字符串。

${“strabg”?replace(“ab”,”in”)} à结果为string

15. split使用指定的分隔符将一个字符串拆分为一组字符串

<#list “This|is|split”?split(“|”) as s>
${s}
</#list>

结果为:
This
is
split

16. trim 删除字符串首尾空格 ${“ String ”?trim} à结果为String

四、 操作数字

1. c 用于将数字转换为字符串

${123?c} à结果为123

2. string用于将数字转换为字符串

Freemarker中预订义了三种数字格式：number,currency（货币）和percent(百分比)其中number为默认的数字格式转换

例如：

<#assign tempNum=20>

${tempNum}

tempNum?string.number或tempNum?string.number或{tempNum?string(“number”)} à结果为20

tempNum?string.currency或tempNum?string.currency或{tempNum?string(“currency”)} à结果为￥20.00

tempNum?string.percent或tempNum?string.percent或{tempNum?string(“percent”)} à结果为2,000%

五、 操作布尔值

string 用于将布尔值转换为字符串输出
true转为“true”，false转换为“false”
foo?string(“yes”,”no”)如果布尔值是true,那么返回“yes”,否则返回no

FreeMarker的插值有如下两种类型:1,通用插值${expr};2,数字格式化插值:#{expr}或#{expr;format}
1、通用插值
对于FreeMarker的通用插值,又可以分为以下4种情况:
1. FreeMarker插值结果为字符串值:直接输出表达式结果
2. FreeMarker插值结果为数字值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:
<#settion number_format="currency"/>
<#assign answer=42/>
answeranswer{answer?string} <#-- the same as answer−−>answer−−>{answer?string.number}
answer?string.currencyanswer?string.currency{answer?string.percent}
answer输出结果是:answer输出结果是:42.00
42.004242.004242.00
4,200%
3. FreeMarker插值结果为日期值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子:
lastUpdated?string("yyyy−MM−ddHH:mm:sszzzz")lastUpdated?string("yyyy−MM−ddHH:mm:sszzzz"){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. FreeMarker插值结果为布尔值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子: <#assign foo=true/>{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. FreeMarker插值结果为布尔值:根据默认格式(由#setting指令设置)将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值,如下面的例子: <#assign foo=true/>{foo?string("yes", "no")}
输出结果是:
yes
2、数字格式化插值
关于FreeMarker数字格式化插值可采用#{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 -->