ftl 语法

Posted 2021-01-07 hjy2018

freemaker注释:<#-- 注释内容 -->格式部分,不会输出。

1、字符输出

1.  
   ${emp.name?if_exists}　　　　　　// 变量存在，输出该变量，否则不输出
2.  
   ${emp.name!}　　　　　　　　　　 // 变量存在，输出该变量，否则不输出
3.  
    
4.  
   ${emp.name?default("xxx")} // 变量不存在，取默认值xxx
5.  
   ${emp.name!"xxx"} 　　　　　　// 变量不存在，取默认值xxx

常用内部函数：

1.  
   ${"123<br>456"?html} 　　// 对字符串进行HTML编码，对html中特殊字符进行转义
2.  
   ${"str"?cap_first} 　　 // 使字符串第一个字母大写
3.  
   ${"Str"?lower_case} // 将字符串转换成小写
4.  
   ${"Str"?upper_case} // 将字符串转换成大写
5.  
   ${"str"?trim} // 去掉字符串前后的空白字符

字符串的两种拼接方式拼接：

1.  
   ${"hello${emp.name!}"} // 输出hello+变量名
2.  
   ${"hello"+emp.name!} // 使用+号来连接，输出hello+变量名

可以通过如下语法来截取子串:

1.  
   <#assign str = "abcdefghijklmn"/>
2.  
    
3.  
   // 方法1
4.  
   ${str?substring(0,4)} // 输出abcd
5.  
    
6.  
   // 方法2
7.  
   ${str[0]}${str[4]} // 结果是ae
8.  
   ${str[1..4]} 　　　 // 结果是bcde
9.  
    
10.  
    // 返回指定字符的索引
11.  
    ${str?index_of("n")}

2、日期输出

${emp.date?string(‘yyyy-MM-dd‘)} //日期格式

3、数字输出(以数字20为例)

1.  
   ${emp.name?string.number} 　// 输出20
2.  
   ${emp.name?string.currency} // ￥20.00
3.  
   ${emp.name?string.percent} // 20%
4.  
   ${1.222?int} 　　　　　　　　　　 // 将小数转为int，输出1
5.  
    
6.  
   <#setting number_format="percent"/> // 设置数字默认输出方式(‘percent‘,百分比)
7.  
   <#assign answer=42/> 　　　　　　　　 // 声明变量 answer 42
8.  
   #{answer} 　　　　　　　　 // 输出 4,200%
9.  
   ${answer?string} 　　　　 // 输出 4,200%
10.  
    ${answer?string.number} 　　// 输出 42
11.  
    ${answer?string.currency} // 输出 ￥42.00
12.  
    ${answer?string.percent} 　// 输出 4,200%
13.  
    #{answer} 　　　　　　　　// 输出 42
14.  
    复制代码

1.  
   数字格式化插值可采用#{expr;format}形式来格式化数字,其中format可以是:
2.  
   mX:小数部分最小X位
3.  
   MX:小数部分最大X位

如下面的例子:

1.  
   <#assign x=2.582/>
2.  
   <#assign y=4/>
3.  
   #{x; M2} // 输出2.58
4.  
   #{y; M2} // 输出4
5.  
   #{x; m2} // 输出2.58
6.  
   #{y; m2} // 输出4.0
7.  
   #{x; m1M2} // 输出2.58
8.  
   #{x; m1M2} // 输出4.0

4、申明变量

1.  
   <#assign foo=false/> // 声明变量,插入布尔值进行显示,注意不要用引号
2.  
   ${foo?string("yes","no")} // 当为true时输出"yes",否则输出"no"

申明变量的几种方式

1.  
   <#assign name=value>
2.  
   <#assign name1=value1 name2=value2 ... nameN=valueN>
3.  
   <#assign same as above... in namespacehash>
4.  
    
5.  
   <#assign name>
6.  
   capture this
7.  
   </#assign>
8.  
    
9.  
   <#assign name in namespacehash>
10.  
    capture this
11.  
    </#assign>

5、比较运算符

表达式中支持的比较运算符有如下几个:
= 或 == ：判断两个值是否相等.
!= ：判断两个值是否不等.
> 或 gt ：判断左边值是否大于右边值
>= 或 gte ：判断左边值是否大于等于右边值
< 或 lt ：判断左边值是否小于右边值
<= 或 lte ：判断左边值是否小于等于右边值

6、算术运算符

FreeMarker表达式中完全支持算术运算,
FreeMarker支持的算术运算符包括:+, - , * , / , % 
注意：
（1）、运算符两边必须是数字
（2）、使用+运算符时,如果一边是数字,一边是字符串,就会自动将数字转换为字符串再连接,如:${3 + "5"},结果是:35

7、逻辑运算符

逻辑运算符有如下几个:
逻辑与:&&
逻辑或:||
逻辑非:!
逻辑运算符只能作用于布尔值,否则将产生错误

8、FreeMarker中的运算符优先级如下(由高到低排列):

①、一元运算符:!
②、内建函数:?
③、乘除法:*, / , %
④、加减法:- , +
⑤、比较:> , < , >= , <= (lt , lte , gt , gte)
⑥、相等:== , = , !=
⑦、逻辑与:&&
⑧、逻辑或:||
⑨、数字范围:..
实际上,我们在开发过程中应该使用括号来严格区分,这样的可读性好,出错少

9、if 逻辑判断（注意：elseif 不加空格）

1.  
   <#if condition>
2.  
   ...
3.  
   <#elseif condition2>
4.  
   ...
5.  
   <#elseif condition3>
6.  
   ...
7.  
   <#else>
8.  
   ...
9.  
   </#if>

if 空值判断

1.  
   <!-- 当 photoList 不为空时-->
2.  
   <#if photoList??>...</#if>
3.  
    
4.  
   <!--值得注意的是,${..}只能用于文本部分,不能用于表达式,下面的代码是错误的:-->
5.  
   <#if ${isBig}>Wow!</#if>
6.  
   <#if "${isBig}">Wow!</#if>
7.  
    
8.  
   <!-- 正确写法-->
9.  
   <#if isBig>Wow!</#if>

10、switch (条件可为数字，可为字符串)

1.  
   <#switch value>
2.  
   <#case refValue1>
3.  
   ....
4.  
   <#break>
5.  
   <#case refValue2>
6.  
   ....
7.  
   <#break>
8.  
   <#case refValueN>
9.  
   ....
10.  
    <#break>
11.  
    <#default>
12.  
    ....
13.  
    </#switch>

11、集合 & 循环

1.  
   <!-- 遍历集合: -->
2.  
   <#list empList! as emp>
3.  
   ${emp.name!}
4.  
   </#list>
5.  
    
6.  
   <!-- 可以这样遍历集合: -->
7.  
   <#list 0..(empList!?size-1) as i>
8.  
   ${empList[i].name!}
9.  
   </#list>
10.  
     
11.  
    <!-- 与jstl循环类似,也可以访问循环的状态。 -->
12.  
     
13.  
    empList?size 　　　// 取集合的长度
14.  
    emp_index: 　　　　// int类型，当前对象的索引值
15.  
    emp_has_next: // boolean类型，是否存在下一个对象
16.  
     
17.  
    <!-- 使用<#break>跳出循环 -->
18.  
    <#if emp_index = 0><#break></#if>
19.  
     
20.  
    <!-- 集合长度判断 -->
21.  
    <#if empList?size != 0></#if> <!-- 判断=的时候,注意只要一个=符号,而不是== -->
22.  
     
23.  
    <#assign l=0..100/> <!-- 定义一个int区间的0~100的集合，数字范围也支持反递增,如100..2 -->
24.  
    <#list 0..100 as i> 　　<!-- 等效于java for(int i=0; i <= 100; i++) -->
25.  
    　　${i}
26.  
    </#list>
27.  
     
28.  
    <!-- 截取子集合： -->
29.  
    empList[3..5] <!-- 返回empList集合的子集合,子集合中的元素是empList集合中的第4-6个元素 -->
30.  
     
31.  
    <!-- 创建集合： -->
32.  
    <#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x>
33.  
     
34.  
    <!-- 集合连接运算,将两个集合连接成一个新的集合 -->
35.  
    <#list ["星期一","星期二","星期三"] + ["星期四","星期五","星期六","星期天"] as x>
36.  
     
37.  
    <!-- 除此之外,集合元素也可以是表达式,例子如下: -->
38.  
    [2 + 2, [1, 2, 3, 4], "whatnot"]
39.  
     
40.  
    <!-- seq_contains：判断序列中的元素是否存在 -->
41.  
    <#assign x = ["red", 16, "blue", "cyan"]>
42.  
    ${x?seq_contains("blue")?string("yes", "no")} // yes
43.  
    ${x?seq_contains("yellow")?string("yes", "no")} // no
44.  
    ${x?seq_contains(16)?string("yes", "no")} // yes
45.  
    ${x?seq_contains("16")?string("yes", "no")} // no
46.  
     
47.  
    <!-- seq_index_of：第一次出现的索引 -->
48.  
    <#assign x = ["red", 16, "blue", "cyan", "blue"]>
49.  
    ${x?seq_index_of("blue")} <!-- 2 -->
50.  
     
51.  
    <!-- sort_by：排序（升序） -->
52.  
    <#list movies?sort_by("showtime") as movie></#list>
53.  
     
54.  
    <!-- sort_by：排序（降序） -->
55.  
    <#list movies?sort_by("showtime")?reverse as movie></#list>
56.  
     
57.  
    <!-- 具体介绍： -->
58.  
    <!-- 不排序的情况： -->
59.  
    <#list movies as moive>
60.  
    　　<a href="${moive.url}">${moive.name}</a>
61.  
    </#list>
62.  
     
63.  
    <!-- 要是排序，则用 -->
64.  
    <#list movies?sort as movie>
65.  
    　　<a href="${movie.url}">${movie.name}</a>
66.  
    </#list>
67.  
     
68.  
    <!-- 这是按元素的首字母排序。若要按list中对象元素的某一属性排序的话，则用 -->
69.  
    <#list moives?sort_by(["name"]) as movie>
70.  
    　　<a href="${movie.url}">${movie.name}</a>
71.  
    </#list>
72.  
     
73.  
    <!-- 这个是按list中对象元素的[name]属性排序的，是升序，如果需要降序的话，如下所示： -->
74.  
    <#list movies?sort_by(["name"])?reverse as movie>
75.  
    　　<a href="${movie.url}">${movie.name}</a>
76.  
    </#list>

12、Map对象

1.  
   <!-- 创建map -->
2.  
   <#assign scores = {"语文":86,"数学":78}>
3.  
    
4.  
   <!-- Map连接运算符 -->
5.  
   <#assign scores = {"语文":86,"数学":78} + {"数学":87,"Java":93}>
6.  
    
7.  
   <!-- Map元素输出 -->
8.  
   emp.name // 全部使用点语法
9.  
   emp["name"] // 使用方括号

13、FreeMarker支持如下转义字符:

" ：双引号(u0022)
‘ ：单引号(u0027)
\ ：反斜杠(u005C)
：换行(u000A)
：回车(u000D)
：Tab(u0009)
 ：退格键(u0008)
f ：Form feed(u000C)
l ：<
g ：>
a ：&
{ ：{
xCode ：直接通过4位的16进制数来指定Unicode码,输出该unicode码对应的字符.

如果某段文本中包含大量的特殊符号,FreeMarker提供了另一种特殊格式:可以在指定字符串内容的引号前增加r标记,在r标记后的文件将会直接输出.看如下代码:
${r"${foo}"} // 输出 ${foo}
${r"C:/foo/bar"} // 输出 C:/foo/bar

14、include指令

1.  
   // include指令的作用类似于JSP的包含指令:
2.  
   <#include "/test.ftl" encoding="UTF-8" parse=true>
3.  
    
4.  
   // 在上面的语法格式中,两个参数的解释如下:
5.  
   encoding="GBK" // 编码格式
6.  
   parse=true 　　 // 是否作为ftl语法解析,默认是true，false就是以文本方式引入,注意:在ftl文件里布尔值都是直接赋值的如parse=true,而不是parse="true"

15、import指令

1.  
   // 类似于jsp里的import,它导入文件，然后就可以在当前文件里使用被导入文件里的宏组件
2.  
   <#import "/libs/mylib.ftl" as my>
3.  
   // 上面的代码将导入/lib/common.ftl模板文件中的所有变量,交将这些变量放置在一个名为com的Map对象中，"my"在freemarker里被称作namespace

16、compress 压缩

1.  
   // 用来压缩空白空间和空白的行
2.  
   <#compress>
3.  
   ...
4.  
   </#compress>

17、特殊标签

1.  
   <#t> // 去掉左右空白和回车换行
2.  
    
3.  
   <#lt>// 去掉左边空白和回车换行
4.  
    
5.  
   <#rt>// 去掉右边空白和回车换行
6.  
    
7.  
   <#nt>// 取消上面的效果

18、escape,noescape 对字符串进行HTML编码

1.  
   // escape指令导致body区的插值都会被自动加上escape表达式,但不会影响字符串内的插值,只会影响到body内出现的插值,使用escape指令的语法格式如下:
2.  
   <#escape x as x?html>
3.  
   　　First name: ${firstName}
4.  
   <#noescape>Last name: ${lastName}</#noescape>
5.  
   　　Maiden name: ${maidenName}
6.  
   </#escape>
7.  
    
8.  
   // 相同表达式
9.  
   First name: ${firstName?html}
10.  
    Last name: ${lastName}
11.  
    Maiden name: ${maidenName?html}

以上是关于ftl 语法的主要内容，如果未能解决你的问题，请参考以下文章

ftl 模板中的 escapeHtml="false" 引发参数类型不匹配

myeclipse2014中如何安装freeMarker插件（支持ftl语法高亮）

Freemaker FTL指令常用标签及语法

Java项目中ftl和jsp可以同时并存么，属于功能模块的

在下面的代码片段中的剩余 ='passthrough' 处的代码中出现语法错误

Freemarker 教程-模板开发手册