FreeMarker是什么?
是一款 模板引擎: 即一种基于模板和要改变的数据, 并用来生成 HTML Web 页面
优点
1、不能编写java代码,可以实现严格的mvc分离
2、性能非常不错
3、对jsp标签支持良好
4、内置大量常用功能,使用非常方便
5、宏定义(类似jsp标签)非常方便
6、使用表达式语言
能够生成各种文本:HTML、XML、RTF、Java 源代码等等
易于嵌入到你的产品中:轻量级;不需要 Servlet 环境
插件式模板载入器:可以从任何源载入模板,如本地文件、数据库等等
你可以按你所需生成文本:保存到本地文件;作为 Email 发送;从 Web 应用程序发送它返回给 Web
浏览器
FreeMarker特性
1.通用目标
1.能够生成各种文本:HTML、XML、RTF、Java 源代码等等
2.易于嵌入到你的产品中:轻量级;不需要 Servlet 环境
3.插件式模板载入器:可以从任何源载入模板,如本地文件、数据库等等
4.你可以按你所需生成文本:保存到本地文件;作为 Email 发送;从 Web 应用程序发送它返回给 Web浏览器
2.强大的模板语言
3.通用数据模型
4.为Web准备
5.智能的国际化和本地化
6.强大的XML处理能力
FreeMarker使用
1.导入坐标依赖
<?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>com.xxxx</groupId>
<artifactId>freemarker</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<name>freemarker Maven Webapp</name>
<!-- FIXME change it to the project's website -->
<url>http://www.example.com</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<dependencies>
<!-- freemarker的坐标依赖 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.23</version>
2.3.3. 修改配置文件 web.xml
在项目的webapp/WEB-INF目录下的web.xml文件中,添加freemarker 相关 servlet 配置
</dependency>
<!-- servlet-api的坐标依赖 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.0.1</version>
</dependency>
</dependencies>
<build>
<finalName>freemarker</finalName>
<!--
插件地址:
Tomcat
http://tomcat.apache.org/maven-plugin-2.2/
Jetty
https://www.eclipse.org/jetty/documentation/current/jetty-mavenplugin.html
-->
<plugins>
<!-- 配置jetty插件 -->
<plugin>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-maven-plugin</artifactId>
<version>9.2.1.v20140609</version>
</plugin>
</plugins>
</build>
</project>
2.修改配置文件 web.xml
在项目的webapp/WEB-INF目录下的web.xml文件中,添加freemarker 相关 servlet 配置
<?xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_ID" version="3.0"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
<!-- FreeMarker 的Servlet配置 -->
<servlet>
<servlet-name>freemarker</servlet-name>
<servlet-class>freemarker.ext.servlet.FreemarkerServlet</servlet-class>
<init-param>
<!-- 模板路径 -->
<param-name>TemplatePath</param-name>
<!-- 默认在webapp目录下查找对应的模板文件 -->
<param-value>/</param-value>
</init-param>
<init-param>
<!-- 模板默认的编码:UTF-8 -->
<param-name>default_encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
2.3.4. 编写Servlet类
2.3.5. 新建模板文件 ftl
在webapp目录下新建template文件夹,创建f01.ftl文件
2.3.6. 启动项目
</servlet>
<!-- 处理所有以.ftl结尾的文件;ftl是freemarker默认的文件后缀 -->
<servlet-mapping>
<servlet-name>freemarker</servlet-name>
<url-pattern>*.ftl</url-pattern>
</servlet-mapping>
</web-app>
3.编写Servlet类
package com.xxxx.controllter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@WebServlet("/f01")
public class FreeMarker01 extends HttpServlet {
@Override
protected void service(HttpServletRequest request, HttpServletResponse
response) throws ServletException, IOException {
// 添加数据
request.setAttribute("msg","Hello FreeMarker!");
// 请求转发跳转到ftl文件中
request.getRequestDispatcher("template/f01.ftl").forward(request,response);
}
}
4.在webapp目录下新建template文件夹,创建.ftl文件
5.启动
FreeMarker 数据类型
1.布尔型:转换为字符串输出
1. 在Servlet中设置布尔类型的数据
2. 获取数据
// 布尔类型
request.setAttribute("flag", true);
3.2. 日期类型
1. 在Servlet中设置日期类型的数据
2. 获取数据
3.3. 数值类型
1. 在Servlet设置数值型的数据
2. 获取数据
<#--
数据类型:布尔类型
在freemarker中布尔类型不能直接输出;如果输出要先转成字符串
方式一:?c
方式二:?string 或 ?string("true时的文本","false时的文本")
-->
${flag?c} <br>
${flag?string} <br>
${flag?string("yes","no")} <br>
日期型:需要转换成字符串再输出
1. 在Servlet中设置日期类型的数据
2. 获取数据
3.3. 数值类型
1. 在Servlet设置数值型的数据
2. 获取数据
<#--
数据类型:布尔类型
在freemarker中布尔类型不能直接输出;如果输出要先转成字符串
方式一:?c
方式二:?string 或 ?string("true时的文本","false时的文本")
-->
${flag?c} <br>
${flag?string} <br>
${flag?string("yes","no")} <br>
// 日期类型
request.setAttribute("createDate",new Date());
<#--
数据类型:日期类型
在freemarker中日期类型不能直接输出;如果输出要先转成日期型或字符串
1. 年月日 ?date
2. 时分秒 ?time
3. 年月日时分秒 ?datetime
4. 指定格式 ?string("自定义格式")
y:年 M:月 d:日
H:时 m:分 s:秒
-->
<#-- 输出日期格式 -->
${createDate?date} <br>
<#-- 输出时间格式 -->
${createDate?time} <br>
<#-- 输出日期时间格式 -->
${createDate?datetime} <br>
<#-- 输出格式化日期格式 -->
${createDate?string("yyyy年MM月dd日 HH:mm:ss")} <br>
数值型:等价于 java 中的 int,float,double 等数值类型有三种显示形式:数值型(默认)、货币型、百分比型
1. 在Servlet设置数值型的数据
request.setAttribute("age",18); // 数值型
request.setAttribute("salary",10000); // 数值型
request.setAttribute("avg",0.545); // 浮点型
2. 获取数据
1. 转字符串
普通字符串 ?c
货币型字符串 ?string.currency
百分比型字符串 ?string.percent
2. 保留浮点型数值指定小数位(#表示一个小数位)?string["0.##"]
字符型:有很多内置函数
1. 在Servlet中设置字符串类型的数据
request.setAttribute("msg","Hello ");
request.setAttribute("msg2","freemarker");
2. 获取数据
1. 截取字符串(左闭右开) ?substring(start,end)
${msg2?substring(1,4)} <br>
2. 首字母小写输出 ?uncap_first
${msg2?substring(1,4)} <br>
3. 首字母大写输出 ?cap_first
${msg2?substring(1,4)} <br>
4. 字母转小写输出 ?lower_case
${msg2?substring(1,4)} <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("xx")
${msg?index_of("e")} <br>
10. 去除字符串前后空格 ?trim
${msg?trim?length} <br>
11. 替换指定字符串 ?replace("xx","xx")
${msg?trim?length} <br>
3.字符串空值情况处理
FreeMarker 的变量必须赋值,否则就会抛出异常
① ! :指定缺失变量的默认值
${value!}:如果value值为空,则默认值是空字符串
${value!"默认值"}:如果value值为空,则默认值是字符串"默认值"
② ?? :判断变量是否存在
如果变量存在,返回 true,否则返回 false
${(value??)?string}
sequence 类型:等价于 java 中的数组,list,set 等集合类型
获取序列的长度 ${序列名?size}
获取序列元素的下标 ${元素名?index}
获取第一个元素 ${序列名?first}
获取最后一个元素 ${序列名?last}
倒序输出 序列名?reverse
升序输出 序列名?sort
降序输出 序列名?sort?reverse
指定字段名排序 序列名?sort_by("字段名")
注:一般是JavaBean集合,对应的字段名需要提供get方法
hash 类型:等价于 java 中的 Map 类型
key遍历输出
<#list hash?keys as key>
${key} -- ${hash[key]}
</#list>
<#-- key遍历输出 -->
<#list cityMap?keys as key>
${key} -- ${cityMap[key]} <br>
</#list>
value遍历输出
<#list hash?values as value>
${value}
</#list>
<#-- value遍历输出 -->
<#list cityMap?values as value>
${value} |
</#list>
<#-- 直接输出 -->
${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 -->
字符串空值情况处理
FreeMarker 的变量必须赋值,否则就会抛出异常。而对于 FreeMarker 来说,null 值和不存在的变
量是完全一样的,因为 FreeMarker 无法理解 null 值。
FreeMarker 提供两个运算符来避免空值:
① ! :指定缺失变量的默认值
${value!}:如果value值为空,则默认值是空字符串
${value!"默认值"}:如果value值为空,则默认值是字符串"默认值"
② ?? :判断变量是否存在
如果变量存在,返回 true,否则返回 false
${(value??)?string}
3.5. sequence 类型
1. 在Servlet中设置序列类型的数据
${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 常见指令
assign 自定义变量指令
1.<#assign 变量名=值>
2.<#assign 变量名=值 变量名=值> (定义多个变量)
if elseif else 逻辑判断指令
list 遍历指令
<#list sequence as item>
</#list>
<#list sequence as item>
<#else>
当没有选项时,执行else指令
</#list>
macro 自定义指令 宏
可以使用 macro 指令来自定义一些自定义指令。
无参
格式:
<#macro 指令名>
指令内容
</#macro>
使用:
<@指令名></@指令名>
有参
格式:
<#macro 指令名 参数名1 参数名2>
指令内容
</#macro>
使用:
<@指令名 参数名1=参数值1 参数名2=参数值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}
</#list>
<br>
</#list>
</#macro>
<@cfb></@cfb>
<@cfb></@cfb>
<#-- 动态数据 -->
<#macro cfb2 num>
<#list 1..num as i>
<#list 1..i as j>
4.5. nested 占位指令
nested 指令执行自定义指令开始和结束标签中间的模板片段。嵌套的片段可以包含模板中任意合法
的内容。
4.6. import 导入指令
import 指令可以引入一个库。也就是说,它创建一个新的命名空间, 然后在那个命名空间中执行给
定路径的模板。可以使用引入的空间中的指令。
commons.ftl
在其他ftl页面中通过import导入commons.ftl的命名空间,使用该命名空间中的指令
test.ftl
${j}*${i}=${j*i}
</#list>
<br>
</#list>
</#macro>
<@cfb2 num=5></@cfb2>
nested 占位指令
nested 相当于占位符,一般结合macro指令一起使用
<#macro test>
这是一段文本!
<#nested>
<#nested>
</#macro>
<@test><h4>这是文本后面的内容!</h4></@test>
import 导入指令
在其他ftl页面中通过import导入commons.ftl的命名空间,使用该命名空间中的指令
<#-- 导入命名空间 -->
<#import "commons.ftl" as common>
<#-- 使用命名空间中的指令 -->
<@common.cfb></@common.cfb>
include 包含指令
可以使用 include 指令在你的模板中插入另外一个模板文件(可以是任何文件)
<#include "文件名字">
<#--包含指令(引入其他页面文件) include-->
<#--html文件-->
<#include "test.html">
<#--freemarker文件-->
<#include "test.ftl">
<#--text文件-->
<#include "test.txt">
FreeMarker 页面静态化
动态网页是指跟静态网页相对应的一种网页编程技术。静态网页,随着HTML代码的生成,页面的内容和显示效果就不会再发生变化(除非你修改页面代码)。而动态网页则不然,页面代码虽然没有发生变化,但是显示的内容却是可以随着时间、环境或者数据库操作的结果而发生相应的变化。
静态网页的特点
a、静态网页的内容稳定,页面加载速度快。
b、静态网页的没有数据库支持,在网站制作和维护方面的工作量较大。
c、静态网页的交互性差,有很大的局限性。
动态网页的特点
a、交互性好。
b、动态网页的信息都需要从数据库中读取,如果访问的人多,就会对服务器增加负荷,会影响运行速度
实现页面静态化
定义模板
@WebServlet("/news")
public class NewsServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest request, HttpServletResponse
response) throws ServletException, IOException {
// 实例化模板配置对象
Configuration configuration = new Configuration();
// 设置加载模板的上下文 以及 设置加载模板路径(模板存放的路径)
configuration.setServletContextForTemplateLoading(getServletContext(),"/templat
e");
创建类加载模板
package com.yjx;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
@WebServlet("/news")
public class NewsServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//准备配置类
Configuration configuration = new Configuration();
//设置加载模板的上下文,以及加载模板的路径 (模板的存放路径)
configuration.setServletContextForTemplateLoading(getServletContext(),"/tempate");
//设置模板编码格式
configuration.setDefaultEncoding("UTF-8");
//加载模板文件,获取模板对象
Template template = configuration.getTemplate("news.ftl");
//准备数据
Map<String,Object> map = new HashMap<>();
map.put("title", "特别就业季:稳就业情况如何? 哪些问题待解?");
map.put("source", "人民日报");
map.put("pubTime", new Date());
map.put("content", "中共中央政治局常务委员会近日召开会议强调," +
"要有针对性地开展援企、稳岗、扩就业工作," +
"做好高校毕业生、农民工等重点群体就业工作," +
"积极帮助个体工商户纾困。疫情期间,稳就业情况如何?还有哪些问题待解?" +
"记者采访了不同群体,记录这个特别的就业季。");
//为静态页面准备目录
String realPath = req.getServletContext().getRealPath("/");
// System.out.println(realPath);
File file = new File(realPath + "/html");
//判断目录是否存在
if(!file.exists()){
file.mkdir();
}
//准备静态页面的文件名称 (生成随机不重复的文件名 时间戳)
String fileName = System.currentTimeMillis() + ".html";
//拼接文件的真实路径 创建html文件
File filePath = new File(file, fileName);
//获取静态页面的文件流 获取文件输出流
FileWriter fileWriter = new FileWriter(filePath);
//将数据填充模板写出
try {
template.process(map,fileWriter);
} catch (TemplateException e) {
e.printStackTrace();
}finally {
//关闭资源
fileWriter.flush();
fileWriter.close();
}
}
}
FreeMarker 运算符
算术运算+、-、*、/、%
<#assign a1 = 8 a2 = 2 >
${a1} + ${a2} = ${a1 + a2} <br/>
${a1} - ${a2} = ${a1 - a2} <br/>
${a1} * ${a2} = ${a1 * a2} <br/>
${a1} / ${a2} = ${a1 / a2} <br/>
${a1} % ${a2} = ${a1 % a2} <br/>
<!--字符串运算-->
${"hello" + "," + "freemarker"}
逻辑运算符
&&、||、!
比较运算符:
> (gt) ,< (lt) ,>= (gte), <= (lte),== , !=
空值运算符
1. ??:判断是否为空,返回布尔类型
如果不为空返回 false, 如果为空返回 true,不能直接输出
${(name??)?string}
2. !: 设置默认值,如果为空,则设置默认值
1. 设置默认为空字符串:
${name!}
2. 设置指定默认值
${name!'zhangsan'}