FreeMarker常见用法教程

一、认识FreeMarker

FreeMarker是一款模板引擎：一种基于模板的、用来生成输出文本的通用工具。类似模板引擎还有Velocity，Common Template等。

对于java web开发来说，使用FreeMarker模板，可以将java代码从页面中分离出来。开发人员只需关注业务逻辑代码，而由页面设计人员去设计显示效果，两类人员各司其职，发挥其擅长的一面。

FreeMarker注释：类似HTML的注释，用<#--和-->来分隔的。任何介于这两个分隔符（包含分隔符本身）之间的内容会被FreeMarker忽略，不会执行或输出。

二、常用指令

if指令

if指令进行条件输出控制，类似程序语言中的if语句。

格式：

<#if condition>content</#if>
<#if condition>content<#else>other content</#if>

示例：

<#if username == "boss">Hi boss!</#if>
<#if username == "boss">Hi boss!<#else>Hi!</#if>

说明：上例意思是如果变量username值为"boss"，输出Hi boss!，否则输出Hi!。

==是来判断在它两侧的值相等的操作符，比较的结果是布尔值，true 或者false。在==的左侧，是引用的变量，右侧是指定的字符串。

注意：右侧字面量可以是字符串或数字，如果是字符串，要用引号（单，双引号都行）括起来，并且==左右两边类型要一致，否则出报错。

list指令

list指令用来遍历集合中的内容。

格式：

<#list vars as var>
	repeat content
</#list>

示例：

<#list ["星期一", "星期二", "星期三"] as day>
${day}
</#list>

说明：上例输出三行，每行依次输出星期一、星期二、星期三。

集合中元素可以是简单的字符串，如上例，也可以是复杂对象

assign指令

assign指令用来定义一个变量并给其赋值，或者替换原有变量的值

格式：

<#assign name=value [name1=value1...]>

<#assign name>capture this</#assign>

示例：

<#assign username="master">

说明：

后一种格式为复杂用法。将assign对中的内容输出作为name变量的值

include指令

使用include指令，我们可以在当前的模板中插入其他文件的内容。

格式：

<#include "filepath">

示例：

<#include "/copyright_footer.html">

说明：

被包含进来的文件，既可以是静态页，也可以是动态页（即ftl模板）。include指令会先将该文件内容包含进当前模板，然后再跟数据模型结合输出。

处理未定义变量或值为null

当变量未定义时，或值为null时，默认设置下FreeMarker会报错。下面有两种处理方式

1.设置默认值

格式：

${varname!default_value}

示例：

${user!"visitor"}
${apple.price!0}

说明：对于多级访问的变量，比如animals.python.price，书写代码：${animals.python.price!0}，当animals或者python不存在，那么模板处理过程将会以“未定义的变量”错误而停止。为了防止这种情况的发生，可以这样来书写代码${(animals.python.price)!0}。这种情况下当animals或python不存在时表达式的结果仍然是0。

2.加if判断

格式：

<#if varname??>content</#if>
<#if varname?exists>content</#if>

示例：

<#if user??>Hi,${user}</#if>
<#if user?exists>Hi,${user}</#if>

说明：

如果user变量存在，且值不为NULL时，才输出Hi,user变量值。同样对于多级访问的变量，??前面的变量名最好被()包含，原因参照!设置默认值。

3.修改全局配置

classic_compatible=true

当FreeMarker指定为"Classic Compatibile"(兼容经典)模式运作时，引擎将会按下列方式输出：

1.友好的处理未定义表达式（即不报错），所谓未定义表达式，就是指“expr”变量未定义，或值为null.

像<assign varname=expr>、${expr}、“otherexpr == expr”、“otherexpr != expr”、hash[expr]中expr未定义时当成空字符串对待

像<list expr as item>、<foreach item in expr>中expr未定义时，循环体不会执行（就像expr是一个空List一样）

像用在<if>指令中或作为布尔表达式时，空值将被当成是false来处理。非布尔数据模型或者逻辑操作数也可以放在<if>指令中，空模型（长度为零的字符串，空的数组或者hash集合）被当成是false来对待，其他情况下都被当成是true来处理。

2.布尔值被看作字符串时（比如用${...}输出，或者是和其他字符串连接时），true值将被转换成“true”字符串处理，false值将被转换成空字符串

3.传给<list>和<foreach>的标量模型被当成只包含一个该元素的list来处理。

4.<include>指令的路径参数将被作为绝对路径处理

三、常见操作汇总

直接指定值

字符串："Foo" 或者 'Foo' 或者 "It's \"quoted\"" 或者"C:\raw\string"
数字：123.45
布尔值：true, false
序列：["foo", "bar", 123.45], 1..100
哈希表：{"name":"green mouse", "price":150}

检索变量

顶层变量：user
从哈希表中检索数据：user.name, user[“name”]
从序列中检索：products[5]
特殊变量：.main

字符串操作

插值（或连接）："Hello ${user}!"（或"Free" + "Marker"）
获取一个字符：name[0]

序列操作

连接：users + ["guest"]
序列切分：products[10..19] 或 products[5..]

哈希表操作

连接：passwords + {"joe":"secret42"}

算数运算

(x * 1.5 + 10) / 2 - y % 100

比较运算

x == y, x != y, x < y, x > y, x >= y, x <= y, x &lt; y, x &gt; y 等等

逻辑操作

!registered && (firstVisit || fromEurope)

内建函数

name?upper_case

方法调用

repeat("What", 3)

处理不存在的值

指定默认值：name!"unknown" 或name! 多级访问变量(user.name)!"unknown" 或者 (user.name)!
检测不存在的值：name?? ，(user.name)??

四、数字格式化问题

当数字超过3位的时候,默认输出会自动带上逗号。例如2000，会显示为2,000。还有当小数位数超过3位时，默认只显示小数点后3位。例如1.33213，会显示为1.332；1.33253，会显示为1.333；

如何解决呢？

1> 加?c,即转成字符串,如：${userId?c}

2> 修改配置文件freemarker.properties加上number_format=#

五、格式化输出

${xx?c} //转成字符串显示
${xx?string.number}//按数字显示
${xx?string.currency}//按贷币格式显示
${xx?string.percent} //按百分比格式显示

六、去空格

${xx?trim}

七、格式化日期

${date?string("yyyy-MM-dd HH:mm:ss")}
${date?string("yyyyMMdd")}

版权声明：本文为博主原创文章，未经博主允许不得转载。