Freemarker语法以及简单使用

Freemarker简单使用

先创建一个简单的Maven工程（这里默认大家都会啦），然后引入依赖

<!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.28</version>
</dependency>

在resources下创建模板文件test.ftl
- 模板文件中四种元素
  - 1、文本，直接输出的部分
  - 2、注释，即<#–…-->格式不会输出
  - 3、插值（Interpolation）：即${…}部分,将使用数据模型中的部分替代输出
  - 4、FTL指令：FreeMarker指令，和HTML标记类似，名字前加#予以区分，不会输出。

<html>
<head>
	<meta charset="utf-8">
	<title>Freemarker入门DEMO </title>
</head>
<body>

${name},
你好。${message}
</body>
</html>

创建Test.java类，在main方法中写上下列方法

        //1.创建配置类
		Configuration configuration=new Configuration(Configuration.getVersion());
		//2.设置模板所在的目录 
		configuration.setDirectoryForTemplateLoading(new File("H:/freemarkerDemo/src/main/resources/"));
		//3.设置字符集
		configuration.setDefaultEncoding("utf-8");
		//4.加载模板
		Template template = configuration.getTemplate("test.ftl");
		//5.创建数据模型
		Map map=new HashMap();
		map.put("name", "小猪佩奇 ");
		map.put("message", "Freemark静态化世界体验！！");
		//6.创建Writer对象
		Writer out =new FileWriter(new File("H:\\test.html"));//这里是输出文件地址
		//7.输出
		template.process(map, out);
		//8.关闭Writer对象
		out.close();

总结如下：

第一步：创建一个 Configuration 对象，直接 new 一个对象。构造方法的参数就是freemarker的版本号。

第二步：设置模板文件所在的路径。

第三步：设置模板文件使用的字符集。一般就是 utf-8.

第四步：加载一个模板，创建一个模板对象。

第五步：创建一个模板使用的数据集，可以是 pojo 也可以是 map。一般是 Map。

第六步：创建一个 Writer 对象，一般创建一 FileWriter 对象，指定生成的文件名。

第七步：调用模板对象的 process 方法输出文件。

第八步：关闭流

执行后，在H盘根目录即可看到生成的test.html ，打开看到如下
在这里插入图片描述

FTL常见语法

assign指令:此指令用于在页面上定义一个变量

定义简单类型：

<#assign linkman="小猪佩奇">

联系人：${linkman}

输出结果：
在这里插入图片描述

定义对象类型：

<#assign info={"mobile":"112233",'address':'深圳市南山区南头检查站','pepole':'波波安'} >
<br>电话：${info.mobile}  地址：${info.address}   联系人:${info.pepole}<br>

输出结果：
在这里插入图片描述

include指令：此指令用于模板文件的嵌套

创建模板文件head.ftl

<h1>测试标题</h1>

修改test.ftl，在模板文件中使用include指令引入刚才我们建立的模板

<#include "head.ftl">

if指令

在代码中对str变量赋值

map.put("success", true);

在模板文件上添加

<#if success="true">

    ${name},你好。${message}

<#else >
    没有通过哦

</#if>

输出结果：

在freemarker的判断中，可以使用= 也可以使用==

list指令

代码中对变量phoneList赋值

        List phoneList = new ArrayList();
        Map map1=new HashMap();
        map1.put("name", "华为 ");
        map1.put("price", 9999);
        Map map2=new HashMap();
        map2.put("name", "苹果 ");
        map2.put("price", 13999);
        Map map3=new HashMap();
        map3.put("name", "三星 ");
        map3.put("price", 8888);

在模板文件上添加


<br>----商品价格表----<br>
<#list phoneList as phones>
    ${phones_index+1} 商品名称： ${phones.name} 价格：${phones.price}<br>
</#list>

输出结果：

如果想在循环中得到索引，使用循环变量+_index就可以得到。

内建函数

语法格式：变量+?+函数名称

获取集合大小

我们使用size函数来实现得到某个集合的大小，代码如下：

共  ${phoneList?size}  条记录

输出结果：

转换JSON字符串为对象

将json字符串转换为对象，

<br>转换JSON字符串<br>
<#assign text="{'city':'深圳','str':'宝安区新安街道'}" />
	<#assign data=text?eval />
城市：${data.city}    街区：${data.str}

输出结果：

日期格式化

代码中对变量赋值：

dataModel.put("today", new Date());
在模板文件中加入
当前日期：${today?date} <br>
当前时间：${today?time} <br>   
当前日期+时间：${today?datetime} <br>        
日期格式化：  ${today?string("yyyy年MM月")}

运行效果如下：

数字转换为字符串

代码中对变量赋值：

map.put("tostring", 123456781);

修改模板：

转化后:${tostring}

有些时候我们不需要这个分隔符，就需要将数字转换为字符串,使用内建函数c

转化后:${tostring?c}

页面显示效果如下：

空值处理运算符

模板中使用了变量但是在代码中没有对变量赋值，运行生成时会抛出异常。

1.判断某变量是否存在:“??”

用法为:variable??,如果该变量存在,返回true,否则返回false

<br>测试空字符串<br>
<#if testnull??>
    testnull为空
<#else>
    testnull不为空
</#if>

2.缺失变量默认值:“!”
除了可以判断是否为空值，也可以使用!对null值做转换处理

<br>缺失变量默认值<br>
${nnull!'默认值'}

当aaa为null则返回！后边的内容-

运算符

算数运算符
FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括:+, - , * , / , %

逻辑运算符

逻辑与:&&

逻辑或:||

逻辑非:!

逻辑运算符只能作用于布尔值,否则将产生错误

比较运算符

1.  =或者==:判断两个值是否相等. 
2.  !=:判断两个值是否不等. 
3.  >或者gt:判断左边值是否大于右边值 
4.  >=或者gte:判断左边值是否大于等于右边值 
5.  <或者lt:判断左边值是否小于右边值 
6.  <=或者lte:判断左边值是否小于等于右边值

注意:
=和!=可以用于字符串,数值和日期来比较是否相等,但=和!=两边必须是相同类型的值,否则会产生错误,而且FreeMarker是精确比较,“x”,"x ","X"是不等的.

其它的运行符可以作用于数字和日期,但不能作用于字符串,大部分的时候,使用gt等字母运算符代替>会有更好的效果,因为FreeMarker会把>解释成FTL标签的结束字符,当然,也可以使用括号来避免这种情况,如:<#if (x>y)>