FreeMarker 数据类型 基础语法

FreeMarker 数据类型
Freemarker 模板中的数据类型由如下⼏种：
布尔型：等价于 Java 的 Boolean 类型，不同的是不能直接输出，可转换为字符串输出
⽇期型：等价于 java 的 Date 类型，不同的是不能直接输出，需要转换成字符串再输出
数值型：等价于 java 中的 int,float,double 等数值类型
有三种显示形式：数值型(默认)、货币型、百分⽐型
字符型：等价于 java 中的字符串，有很多内置函数
sequence 类型：等价于 java 中的数组，list，set 等集合类型
hash 类型：等价于 java 中的 Map 类型
布尔类型

1. 在Servlet中设置布尔类型的数据

// 布尔类型
request.setAttribute("flag", true);

2. 获取数据

<#--
 数据类型：布尔类型
 在freemarker中布尔类型不能直接输出；如果输出要先转成字符串
 ⽅式⼀：?c
 ⽅式⼆：?string 或 ?string("true时的⽂本","false时的⽂本")
-->
${flag?c} <br>
${flag?string} <br>
${flag?string("yes","no")} <br>

⽇期类型

1. 在Servlet中设置⽇期类型的数据

// ⽇期类型
request.setAttribute("createDate",new Date());

2. 获取数据

<#--
 数据类型：⽇期类型
 在freemarker中⽇期类型不能直接输出；如果输出要先转成⽇期型或字符串
 1. 年⽉⽇ ?date
 2. 时分秒 ?time
 3. 年⽉⽇时分秒 ?datetime
 4. 指定格式 ?string("⾃定义格式")
 y：年 M：⽉ d：⽇
 -->
<#-- 输出⽇期格式 -->
${createDate?date} <br> 
<#-- 输出时间格式 -->
${createDate?time} <br> <#-- 输出⽇期时间格式 -->
${createDate?datetime} <br> 
<#-- 输出格式化⽇期格式 -->
${createDate?string("yyyy年MM⽉dd⽇ HH:mm:ss")} <br>
 

数值类型

1. 在Servlet设置数值型的数据

// 数值类型
request.setAttribute("age",18); // 数值型
request.setAttribute("salary",10000); // 数值型
request.setAttribute("avg",0.545); // 浮点型

2. 获取数据

<#--
 数据类型：数值类型
 在freemarker中数值类型可以直接输出；
 1. 转字符串
 普通字符串 ?c
 货币型字符串 ?string.currency
 百分⽐型字符串 ?string.percent
 2. 保留浮点型数值指定⼩数位（#表示⼀个⼩数位）
 ?string["0.##"]
-->
<#-- 直接输出数值型 -->
${age} <br>
${salary} <br> <#-- 将数值转换成字符串输出 -->
${salary?c} <br> <#-- 将数值转换成货币类型的字符串输出 -->
${salary?string.currency} <br> <#-- 将数值转换成百分⽐类型的字符串输出 -->
${avg?string.percent} <br> <#-- 将浮点型数值保留指定⼩数位输出 （##表示保留两位⼩数） -->
${avg?string["0.##"]} <br>

字符串类型
3. 在Servlet中设置字符串类型的数据

// 字符串类型
request.setAttribute("msg","Hello ");
request.setAttribute("msg2","freemarker");

4. 获取数据

<#--
 数据类型：字符串类型
 在freemarker中字符串类型可以直接输出；
 1. 截取字符串（左闭右开） ?substring(start,end)
 2. ⾸字⺟⼩写输出 ?uncap_first
 3. ⾸字⺟⼤写输出 ?cap_first
 4. 字⺟转⼩写输出 ?lower_case
 5. 字⺟转⼤写输出 ?upper_case
 6. 获取字符串⻓度 ?length
 7. 是否以指定字符开头（boolean类型） ?starts_with("xx")?string
 8. 是否以指定字符结尾（boolean类型） ?ends_with("xx")?string
 9. 获取指定字符的索引 ?index_of("xx")
 10. 去除字符串前后空格 ?trim
 11. 替换指定字符串 ?replace("xx","xx")
-->
<#-- 直接输出 -->
${msg} - ${msg2} <br>
${msg?string} - ${msg2?string} <br> <#-- 1. 截取字符串（左闭右开） ?substring(start,end) -->
${msg2?substring(1,4)} <br> <#-- 2. ⾸字⺟⼩写输出 ?uncap_first -->
${msg?uncap_first} <br> <#-- 3. ⾸字⺟⼤写输出 ?cap_first -->
${msg2?cap_first} <br> <#-- 4. 字⺟转⼩写输出 ?lower_case -->
${msg?lower_case} <br> <#-- 5. 字⺟转⼤写输出 ?upper_case -->
${msg?upper_case} <br> <#-- 6. 获取字符串⻓度 ?length -->
${msg?length} <br> <#-- 7. 是否以指定字符开头（boolean类型） ?starts_with("xx")?string -->
${msg?starts_with("H")?string} <br> <#-- 8. 是否以指定字符结尾（boolean类型） ?ends_with("xx")?string -->
${msg?ends_with("h")?string} <br> <#-- 9. 获取指定字符的索引 ?index_of("xxx") -->
${msg?index_of("e")} <br> <#-- 10. 去除字符串前后空格 ?trim -->
${msg?trim?length} <br> <#-- 11. 替换指定字符串 ?replace("xx","xxx") -->
${msg?replace("o","a")}<br>

字符串空值情况处理
FreeMarker 的变量必须赋值，否则就会抛出异常。⽽对于 FreeMarker 来说，null 值和不存在的变量是
完全⼀样的，因为 FreeMarker ⽆法理解 null 值。
FreeMarker 提供两个运算符来避免空值：
① ! ：指定缺失变量的默认值
${value!}：如果value值为空，则默认值是空字符串
${value!“默认值”}：如果value值为空，则默认值是字符串"默认值"
② ?? ：判断变量是否存在
如果变量存在，返回 true，否则返回 false
${(value??)?string}

 <#-- 如果值不存在，直接输出会报错 -->
<#--${str}-->
<#-- 使⽤!，当值不存在时，默认显示空字符串 -->
${str!}<br> <#-- 使⽤!"xx"，当值不存在时，默认显示指定字符串 -->
${str!"这是⼀个默认值"}<br> <#-- 使⽤??，判断字符串是否为空；返回布尔类型。如果想要输出，需要将布尔类型转换成字符串 -->
${(str??)?string}<br>

sequence 类型

1. 在Servlet中设置序列类型的数据

// 序列类型 （数组、List、Set）
// 数组操作
String[] stars = new String[]{"周杰伦","林俊杰","陈奕迅","五⽉天"};
request.setAttribute("stars",stars);
// List操作
List<String> citys = Arrays.asList("上海","北京","杭州","深圳");
request.setAttribute("cityList",citys);
// JavaBean集合
List<User> userList = new ArrayList<>();
userList.add(new User(1,"zhangsan",22));
userList.add(new User(2,"lisi",18));
userList.add(new User(3,"wangwu",20));
request.setAttribute("userList",userList);

2. 获取数据

<#--
 数据类型：序列类型 （数组、List、Set）
 通过list指令输出序列
 <#list 序列名 as 元素名>
 ${名称}
 </#list>
 获取序列的⻓度 ${序列名?size}
 获取序列元素的下标 ${元素名?index}
 获取第⼀个元素 ${序列名?first}
 获取最后⼀个元素 ${序列名?last}
 倒序输出 序列名?reverse
 升序输出 序列名?sort
 降序输出 序列名?sort?reverse
 指定字段名排序 序列名?sort_by("字段名")
 注：⼀般是JavaBean集合，对应的字段名需要提供get⽅法
-->
<#-- 数组操作 -->
<#list stars as star>
 下标：${star?index} -- 名字：${star} <br> </#list>
数组的⻓度：${stars?size} <br> <#-- 获取第⼀个元素 -->
第⼀个元素：${stars?first} <br> <#-- 获取最后⼀个元素 -->
最后⼀个元素：${stars?last} <br> <hr> <#-- List操作 -->
<#list cityList as city >
 ${city} <br> </#list>
List的size：${cityList?size} <br> <#-- 倒序输出 -->
<#list cityList?reverse as city >
 ${city} - </#list> <br> <#-- 升序输出 -->
<#list cityList?sort as city >
 ${city} - </#list> <br> <#-- 降序输出 -->
<#list cityList?sort?reverse as city >
 ${city} - </#list> <hr> <#-- JavaBean集合 -->
<#list userList as user>
 编号：${user.userId}&nbsp;&nbsp;
 姓名：${user.uname}&nbsp;&nbsp;
 年龄：${user.uage}&nbsp;&nbsp;
 <br> </#list> <#-- 按照指定字段名排序 -->
 <#list userList?sort_by("uage") as user>
 ${user.uname} | </#list>

hash 类型
3. 在Servlet中设置hash类型的数据

// Map操作
Map<String,String> cityMap = new HashMap<>();
cityMap.put("sh","上海");
cityMap.put("bj","北京");
cityMap.put("sz","深圳");
request.setAttribute("cityMap",cityMap);

2. 获取数据

<#--
 数据类型：hash类型
 key遍历输出
 <#list hash?keys as key>
 ${key} -- ${hash[key]}
 </#list>
 value遍历输出
 <#list hash?values as value>
 ${value}
 </#list>
-->
<#-- key遍历输出 -->
<#list cityMap?keys as key>
 ${key} -- ${cityMap[key]} <br> </#list> <#-- value遍历输出 -->
<#list cityMap?values as value>
 ${value} | </#list>

FreeMarker 常⻅指令
assign ⾃定义变量指令
使⽤ assign 指令你可以创建⼀个新的变量， 或者替换⼀个已经存在的变量。

 <#--
 assign ⾃定义变量指令
 语法：
 <#assign 变量名=值>
 <#assign 变量名=值 变量名=值> （定义多个变量）
-->
<#assign str="hello">
${str} <br> <#assign num=1 names=["zhangsan","lisi","wangwu"] >
${num} -- ${names?join(",")}

if elseif else 逻辑判断指令

可以使⽤ if ， elseif 和 else 指令来条件判断是否满⾜某些条件。
<#--
 if, else, elseif 逻辑判断指令
 格式：
 <#if condition>
 ...
 <#elseif condition2>
 ...
 <#elseif condition3>
 ...
 <#else>
 ...
 </#if>
 注：
 1. condition, condition2等：将被计算成布尔值的表达式。
 2. elseif 和 else 指令 是可选的。
-->
<#assign score = 80> <#if score < 60>
 你个⼩渣渣！
 <#elseif score == 60>
 分不在⾼，及格就⾏！
 <#elseif score gt 60 && score lt 80>
 哎哟不错哦！
 <#else>
 你很棒棒哦！
</#if> <br> <#-- 判断数据是否存在 -->
<#assign list=""> <#if list??>
 数据存在
 <#else>
 数据不存在
</#if>

list 遍历指令

 可以使⽤ list 指令来对序列进⾏遍历。
 <#--
 list指令
 格式1：
 <#list sequence as item>
 </#list>
 格式2：
 <#list sequence as item>
 <#else>
 当没有选项时，执⾏else指令
 </#list>
 注：
 1. else 部分是可选的
 2. sequence： 想要迭代的项，可以是序列或集合的表达式
 3. item： 循环变量 的名称
 4. 当没有迭代项时，才使⽤ else 指令， 可以输出⼀些特殊的内容⽽不只是空在那⾥
-->
<#assign users = ["张三","李四","王五"]> <#-- 遍历序列 -->
<#list users as user>
 ${user} </#list> <br> <#--判断数据不为空，再执⾏遍历 （如果序列不存在，直接遍历会报错）-->
<#if users2??>
 <#list users2 as user>
 ${user}
 </#list> </#if> <br> <#assign users3 = []> <#-- 当序列没有数据项时，使⽤默认信息 -->
<#list users3 as user>
 ${user}
 <#else>
 当前没有数据！
</#list>
 

macro ⾃定义指令

 可以使⽤ macro 指令来⾃定义⼀些⾃定义指令。
 <#--
 macro ⾃定义指令 （宏）
 1. 基本使⽤
 格式：
 <#macro 指令名>
 指令内容
 </#macro>
 使⽤：
 <@指令名></@指令名>
 2. 有参数的⾃定义指令
 格式：
 <#macro 指令名 参数名1 参数名2>
 指令内容
 </#macro>
 使⽤：
 <@指令名 参数名1=参数值1 参数名2=参数值2></@指令名>
 注：
 1. 指令可以被多次使⽤。
 2. ⾃定义指令中可以包含字符串，也可包含内置指令
-->
<#-- 定义基本的⾃定义指令 -->
<#macro address>
 © 1999–2015 The FreeMarker Project. All rights reserved. </#macro> <#-- 使⽤指令 -->
<@address></@address> <br> <@address></@address> <hr> <#-- 定义有参数的⾃定义指令 -->
<#macro queryUserByName uname>
 通过⽤户名查询⽤户信息 - ${uname} </#macro> <#-- 使⽤指令，并传递参数 -->
<@queryUserByName uname="admin"></@queryUserByName> <br> <#-- 定义有多个参数的⾃定义指令 -->
<#macro queryUserByParams uname uage>
 通过多个餐宿查询⽤户信息 - ${uname} - ${uage} </#macro> <#-- 使⽤指令，并传递多个参数 -->
<@queryUserByParams uname="admin" uage=18></@queryUserByParams> <br> <hr> <#-- ⾃定义指令中包含内置指令 -->
<#macro cfb>
 <#list 1..9 as i>
 <#list 1..i as j>
 ${j}*${i}=${j*i}&nbsp;
 </#list>
 <br>
 </#list> </#macro> <@cfb></@cfb> <@cfb></@cfb> <#-- 动态数据 -->
<#macro cfb2 num>
 <#list 1..num as i>
 <#list 1..i as j>
 ${j}*${i}=${j*i}&nbsp;
 </#list>
 <br>
 </#list> </#macro> <@cfb2 num=5></@cfb2>

nested 占位指令
nested 指令执⾏⾃定义指令开始和结束标签中间的模板⽚段。嵌套的⽚段可以包含模板中任意合法的内容。

<#--
 nested 占位指令
 nested 相当于占位符,⼀般结合macro指令⼀起使⽤。
 可以将⾃定义指令中的内容通过nested指令占位，当使⽤⾃定义指令时，会将占位内容显示。
-->
<#macro test>
 这是⼀段⽂本！
 <#nested>
 <#nested> </#macro> <@test><h4>这是⽂本后⾯的内容！</h4></@test>

import 导⼊指令
import 指令可以引⼊⼀个库。也就是说，它创建⼀个新的命名空间， 然后在那个命名空间中执⾏给定路径的模板。可以使⽤引⼊的空间中的指令。
commons.ftl

<#macro cfb>
 <#list 1..9 as i>
 <#list 1..i as j>
 ${j}*${i}=${j*i}&nbsp;
 </#list>
 <br>
 </#list> </#macro>

在其他ftl⻚⾯中通过import导⼊commons.ftl的命名空间，使⽤该命名空间中的指令
test.ftl

<#-- 导⼊命名空间 -->
<#import "commons.ftl" as common> <#-- 使⽤命名空间中的指令 -->
<@common.cfb></@common.cfb>

include 包含指令
可以使⽤ include 指令在你的模板中插⼊另外⼀个FreeMarker 模板⽂件 。 被包含模板的输出格式是在 include 标签出现的位置插⼊的。 被包含的⽂件和包含它的模板共享变量，就像是被复制粘贴进去的⼀样。

 <#--包含指令(引⼊其他⻚⾯⽂件) include-->
<#--html⽂件-->
<#include "test.html"> <#--freemarker⽂件-->
<#include "test.ftl"> <#--text⽂件-->
<#include "test.txt">