本文旨在快速搭建一个入门demo,然后可以迅速的在脑海中形成一个大体的认识。如果你是需要全面的学习freemarker的话,请移步官方文档http://freemarker.foofun.cn(中文的)
1.什么是 Freemarker
FreeMarker 是一个用 Java 语言编写的模板引擎,它基于模板来生成文本输出。FreeMarker与 Web 容器无关,即在 Web 运行时,它并不知道 Servlet 或 HTTP。它不仅可以用作表现层的实现技术,而且还可以用于生成 XML,JSP 或 Java 等。
1.2 Freemarker入门小DEMO
1.2.0 文件目录(很简单)
1.2.1工程引入依赖pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>FreemarkeDemo</groupId>
<artifactId>com.freemarker.demo</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.23</version>
</dependency>
</dependencies>
</project>
1.2.2创建模板文件
1、文本,直接输出的部分
2、注释,即<#--...-->格式不会输出,并且在生成的html文件中也不会显示 这和<!--..-->这种格式的注释是有区别的
3、插值(Interpolation):即${..}部分,将使用数据模型中的部分替代输出
4、FTL指令:FreeMarker指令,和HTML标记类似,名字前加#予以区分,不会输出。
我们现在就创建一个简单的创建模板文件test.ftl
<html>
<head>
<meta charset="utf-8">
<title>Freemarker入门小DEMO </title>
</head>
<body>
<#--我是一个注释,我不会有任何输出 -->
<!--我也是个注释,但是我会在生成的文件中输出-->
${name},${message}
</body>
</html>
1.2.3生成文件
这里有文本、插值和注释
创建FreemarkerDemo类
import freemarker.template.Configuration;
import freemarker.template.Template;
import java.io.File;
import java.io.FileWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
/**
* @author suyouliang
* @version v1.0 2018年08月21日 17:17
*/
public class FreemarkerDemo {
public static void main(String[] args) throws Exception {
//1.创建配置类
Configuration configuration=new Configuration(Configuration.getVersion());
//2.设置模板所在的目录
configuration.setDirectoryForTemplateLoading(new File("D:\\freemarkerdemo"));
//3.设置字符集
configuration.setDefaultEncoding("utf-8");
//4.加载模板
Template template = configuration.getTemplate("test.ftl");
//5.创建数据模型
Map map=new HashMap();
map.put("name", "Su");
map.put("message", "Hello World!");
//6.创建Writer对象
Writer out =new FileWriter(new File("D:\\freemarkerdemo\\test.html"));
//7.输出
template.process(map, out);
//8.关闭Writer对象
out.close();
}
}
执行后,在D盘根目录即可看到生成的test.html如下:
<html>
<head>
<meta charset="utf-8">
<title>Freemarker入门小DEMO </title>
</head>
<body>
<!--我也是个注释,但是我会在生成的文件中输出-->
Su,Hello World!
</body>
</html>
1.3 FTL指令
1.3.1 assign指令
此指令用于在页面上定义一个变量
(1)定义简单类型:
<#assign linkman="某某"> 联系人:${linkman} |
(2)定义对象类型:
<#assign info={"mobile":"18888888888",'address':'北京市'} > 电话:${info.mobile} 地址:${info.address} |
1.3.2 include指令
此指令用于模板文件的嵌套
创建模板文件_head.ftl
<html>
<h1>我是这个网站的公共头</h1>
创建模板文件_foot.ftl
<h1>我是这个网站的公共底部</h1>
</body></html>
我们修改test.ftl,在模板文件中使用include指令引入刚才我们建立的模板
<#include "_head.ftl">
<head>
<meta charset="utf-8">
<title>Freemarker入门小DEMO </title>
</head>
<body>
<#--我是一个注释,我不会有任何输出 -->
<!--我也是个注释,但是我会在生成的文件中输出-->
${name},${message}
<#include "_foot.ftl">
运行结果:
<html>
<h1>我是这个网站的公共头</h1><head>
<meta charset="utf-8">
<title>Freemarker入门小DEMO </title>
</head>
<body>
<!--我也是个注释,但是我会在生成的文件中输出-->
Su,Hello World!
<h1>我是这个网站的公共底部</h1>
</body></html>
1.3.3 if指令
在模板文件上添加
<#if success=true> 你已通过实名认证 <#else> 你未通过实名认证 </#if> |
在代码中对str变量赋值
map.put("success", true); |
在freemarker的判断中,可以使用= 也可以使用==
1.3.4 list指令
需求,实现商品价格表,如下图:
(1)代码中对变量goodsList赋值
List goodsList=new ArrayList();
Map goods1=new HashMap();
goods1.put("name", "苹果");
goods1.put("price", 5.8);
Map goods2=new HashMap();
goods2.put("name", "香蕉");
goods2.put("price", 2.5);
Map goods3=new HashMap();
goods3.put("name", "橘子");
goods3.put("price", 3.2);
goodsList.add(goods1);
goodsList.add(goods2);
goodsList.add(goods3);
map.put("goodsList", goodsList);
(2)在模板文件上添加
----商品价格表----<br> <#list goodsList as goods> ${goods_index+1} 商品名称: ${goods.name} 价格:${goods.price}<br> </#list> |
如果想在循环中得到索引,使用循环变量+_index就可以得到。
1.4 内建函数
内建函数语法格式: 变量+?+函数名称
1.4.1获取集合大小
我们通常要得到某个集合的大小,如下图:
我们使用size函数来实现,代码如下:
共 ${goodsList?size} 条记录 |
1.4.2转换JSON字符串为对象
我们通常需要将json字符串转换为对象,那如何处理呢?看代码
<#assign text="{'bank':'工商银行','account':'10101920201920212'}" /> <#assign data=text?eval /> 开户行:${data.bank} 账号:${data.account} |
1.4.3日期格式化
代码中对变量赋值:
dataModel.put("today", new Date()); |
在模板文件中加入
当前日期:${today?date} <br> 当前时间:${today?time} <br> 当前日期+时间:${today?datetime} <br> 日期格式化: ${today?string("yyyy年MM月")} |
1.4.4数字转换为字符串
代码中对变量赋值:
map.put("point", 102920122); |
修改模板:
累计积分:${point} |
页面显示:
我们会发现数字会以每三位一个分隔符显示,有些时候我们不需要这个分隔符,就需要将数字转换为字符串,使用内建函数c
累计积分:${point?c} |
页面显示效果如下:
1.5空值处理运算符
如果你在模板中使用了变量但是在代码中没有对变量赋值,那么运行生成时会抛出异常。但是有些时候,有的变量确实是null,怎么解决这个问题呢?
1.5.1判断某变量是否存在:“??”
用法为:variable??,如果该变量存在,返回true,否则返回false
<#if aaa??> aaa变量存在 <#else> aaa变量不存在 </#if> |
1.5.2缺失变量默认值:“!”
我们除了可以判断是否为空值,也可以使用!对null值做转换处理
在模板文件中加入
${aaa!'-'} |
在代码中不对aaa赋值,也不会报错了 ,当aaa为null则返回!后边的内容。
1.6运算符
1.6.1算数运算符
FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括:+, - , * , / , %
1.6.2逻辑运算符
逻辑运算符有如下几个:
逻辑与:&&
逻辑或:||
逻辑非:!
逻辑运算符只能作用于布尔值,否则将产生错误
1.6.3比较运算符
表达式中支持的比较运算符有如下几个:
1 =或者==:判断两个值是否相等.
2 !=:判断两个值是否不等.
3 >或者gt:判断左边值是否大于右边值
4 >=或者gte:判断左边值是否大于等于右边值
5 <或者lt:判断左边值是否小于右边值
6 <=或者lte:判断左边值是否小于等于右边值
注意: =和!=可以用于字符串,数值和日期来比较是否相等,但=和!=两边必须是相同类型的值,否则会产生错误,而且FreeMarker是精确比较,"x","x ","X"是不等的.其它的运行符可以作用于数字和日期,但不能作用于字符串,大部分的时候,使用gt等字母运算符代替>会有更好的效果,因为 FreeMarker会把>解释成FTL标签的结束字符,当然,也可以使用括号来避免这种情况,如:<#if (x>y)>