一、FreeMarker概述
FreeMarker 是一款 模板引擎: 即一種基於模板和要改變的數據, 並用來生成輸出文本(HTML網頁,電子郵件,配置文件,源代碼等)的通用工具。 它不是面向最終用戶的,而是一個Java類庫,是一款程序員可以嵌入他們所開發產品的組件。
FreeMarker 被設計⽤來⽣成 HTML Web ⻚⾯,特別是基於 MVC 模式的應⽤程序,將視圖從業務邏輯中抽離處理,業務中不再包括視圖的展示,⽽是將視圖交給 FreeMarker 來輸出。由FreeMarker生成頁面,通過模板顯示準備的數據。
FreeMarker不是Web應用框架,而是一個Web應用框架的組件。與容器無關,它並不知道HTTP或者Servlet。FreeMarker同樣可以應用在非Web應用程序環境中
二、FreeMarker的特性
1、通用目標
FreeMarker可以生成各種文件,,例如HTML、XML、RTF、JAVA源代碼等等。
FreeMarker易於嵌入到產品中:輕量級、不需要Servlet環境。
FreeMarker可以從任何源載入模板。
FreeMarker可以按需生成文本。可以保存到本地、作爲Email發送,從Web程序返回給Web瀏覽器。
2、強大的模板語言
FreeMarker自帶一些常用的指令:include、if-else、if-else-if、循環結構。也可以在模板中創建變量。幾乎在任何地方都可以使用複雜的表達式來指定值。
3、通用數據模型
FreeMarker不是直接反射到Java對象,Java對象通過插件式對象封裝,以變量方式在模板中顯示。可以使用抽象(接口)方式表示對象(JavaBean、XML文檔、SQL查詢結果集等等),告訴模板開發者使用方法,使其不受技術細節的打擾
4、爲Web準備
FreeMarker內建處理典型Web相關任務的結構。
可以集成到Mode2 Web框架中作爲代替JSP的存在。
支持JSP標記庫
分離可視化設計和程序邏輯;分離頁面設計員與程序員
5、智能的國際化和本地化
字符集智能化(內部使用UNICODE)
數字格式本地化敏感
日期和時間格式本地化敏感
非US字符集可以用作標識(如變量名)
多種不同語言的相同模板
6、強大的XML處理能力
<#recurse> 和 <#visit> 指令(2.3版本)用於遞歸遍歷XML樹。在模板中清楚和直接的訪問XML對象模型。開源論壇 JForum 就是使用了 FreeMarker 做爲頁面模板。
三、FreeMarker環境搭建
1、常規新建Maven Web項目
2、配置FreeMarker依賴,添加服務器插件
<?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>cn.yanghuisen</groupId>
<artifactId>FreeMarkerTest</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<name>FreeMarkerTest 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>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
<!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
<!-- 配置 freemarker依賴-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.23</version>
</dependency>
<!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
<!-- 配置servlet依賴 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<finalName>FreeMarkerTest</finalName>
<plugins>
<!-- 添加tomcat服務器插件 -->
<plugin>
<groupId>org.apache.tomcat.maven</groupId>
<artifactId>tomcat7-maven-plugin</artifactId>
<version>2.2</version>
<configuration>
<!--端口-->
<port>8899</port>
<!-- 站點名 -->
<path>/web</path>
<!-- 設置編碼 -->
<uriEncoding>UTF-8</uriEncoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
3、修改web.xml配置文件
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<!-- 相關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>
</servlet>
<!-- 處理所有以.ftl結尾的文件;ftl是freemarker默認的文件後綴 -->
<servlet-mapping>
<servlet-name>freemarker</servlet-name>
<url-pattern>*.ftl</url-pattern>
</servlet-mapping>
</web-app>
4、新建模板文件
在webapp
目錄下創建templaate
文件夾,然後創建fm.ftl
文件
${msg}
5、編寫Servlet類
package cn.yanghuisen.servlet;
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("/ser")
public class Servlet extends HttpServlet {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// 添加數據
req.setAttribute("msg","Hello FreeMarker!");
// 請求轉發跳轉到模板文件中
req.getRequestDispatcher("template/fm.ftl").forward(req,resp);
}
}
6、啓動項目
四、FreeMarker的數據類型
FreeMarker中常用的數據類型由以下幾種
類型 | 描述 | 備註 |
---|---|---|
boolean | 等價於Java中的boolean | 不能直接輸出,需要先轉換爲字符串 |
日期類型 | 等價於Java中的Date | 不能直接輸出,需要先轉換爲字符串 |
數值類型 | 等價於Java中的數值類型 | |
字符類型 | 等價於Java中的字符串 | |
空值 | 空字符串或者null | |
sequence | 等價於Java中的數組,list,set等集合 | |
hash類型 | 等價於Java中的Map |
1、布爾類型
布爾類型不能直接輸出,需要轉換爲字符串
req.setAttribute("flag",true);
獲取數據s
<#--將boolean轉換爲字符串-->
${flag?c}
<#--將boolean值轉化爲爲字符串,已被棄用,使用?c代替-->
${flag?string}
<#--將boolean值轉化爲爲指定字符串,已被棄用,使用?then代替-->
${flag?string("Yes","No")}
<#--將boolean值轉化爲爲指定字符串-->
${flag?then("Yes","No")}
2、日期類型
不能直接輸出,需要轉換爲字符串
req.setAttribute("date",new Date());
獲取數據
<#--轉換爲日期格式,只有年月日-->
${date?date}
<#--轉換爲時間模式,只有時分秒-->
${date?time}
<#--同屬有年月日時分秒-->
${date?datetime}
<#--自定義格式-->
${date?string("yyyy-MM-dd HH:mm:ss")}
3、數值類型
req.setAttribute("age",10);
req.setAttribute("number",10000);
req.setAttribute("avg",3.1415926);
獲取數據
<p>${age}</p>
<p>${number}</p>
<p>${avg}</p>
<p>${age?c}</p>
<#-- 轉字符串 -->
<p>${number?c}</p>
<#--¥-->
<p>${number?string.currency}</p>
<#-- 百分比 -->
<p>${number?string.percent}</p>
<#--保留兩位小數並且四捨五入-->
<p>${avg?string["0.2"]}</p>
4、字符類型
req.setAttribute("msg","Hello");
req.setAttribute("msg1","freemarker");
req.setAttribute("msg2"," ahh ");
獲取數據
${msg}<br>
<#--1. 截取字符串(左閉右開) ?substring(start,end)-->
${msg?substring(0,2)}<br>
<#--2. 首字母小寫輸出 ?uncap_first-->
${msg?uncap_first}<br>
<#--3. 首字母大寫輸出 ?cap_first-->
${msg?cap_first}<br>
<#--4. 字母轉小寫輸出 ?lower_case-->
${msg?lower_case}<br>
<#--5. 字母轉大寫輸出 ?upper_case-->
${msg1?upper_case}<br>
<#--6. 獲取字符串長度 ?length-->
${msg?length}<br>
<#--7. 是否以指定字符開頭(boolean類型) ?starts_with("xx")?string-->
${msg?starts_with("h")?c}<br>
<#--8. 是否以指定字符結尾(boolean類型) ?ends_with("xx")?string-->
${msg?ends_with("o")?c}<br>
<#--9. 獲取指定字符的索引 ?index_of("xx")-->
${msg?index_of("l")?c}<br>
<#--10. 去除字符串前後空格 ?trim-->
${msg?trim}<br>
<#--11. 替換指定字符串 ?replace("xx","xx")-->
${msg?replace("l","A")}<br>
5、空值
req.setAttribute("str1","");
req.setAttribute("str2",null);
獲取數據
<#--不存在則什麼都不顯示-->
${abc!}<br>
<#-- 空字符串 -->
${str1!}<br>
<#--如果爲空,則顯示沒有字符-->
${str1!"沒有字符"}<br>
<#--null-->
${str2!}<br>
<#--如果爲空,則顯示null-->
${str2!"null"}<br>
<#--是否存在,返回的是一個boolean類型,需要轉換爲字符串-->
${(abc??)?c}<br>
${(str1??)?c}<br>
${(str2??)?c}<br>
6、sequenct
String[] strs = {"張三","李四","王二","麻子"};
req.setAttribute("strs",strs);
List<String> list = Arrays.asList("河南","河北","山東","山西");
req.setAttribute("list",list);
List<User> userList = new ArrayList<>();
userList.add(new User(1,"張三",20));
userList.add(new User(2,"李四",18));
userList.add(new User(3,"王二",22));
userList.add(new User(4,"麻子",21));
req.setAttribute("userList",userList);
獲取數據
獲取序列的長度${strs?size}<br>
獲取第一個元素${strs?first}<br>
獲取最後一個元素${strs?last}<br>
<#--數組-->
<#list strs as str >
${str?index}:${str}<br>
</#list>
<#--List-->
<#list list as str >
${str?index}:${str}<br>
</#list>
<#--倒敘-->
<#list list?reverse as str >
${str}
</#list>
<br>
<#--正序-->
<#list list?sort as str >
${str}
</#list>
<br>
<#--倒序後正序-->
<#list list?reverse?sort as str >
${str}
</#list>
<br>
<#--JavaBean-->
<#list userList as user >
${user}-${user.userId}-${user.userName}-${user.userAge}<br>
</#list>
<br>
<#--按照指定屬性排序-->
<#list userList?sort_by("userAge") as user >
{user.userId}-${user.userName}-${user.userAge}<br>
</#list>
7、hash類型
hash類型就是java中的Map集合
Map<String,String> map = new HashMap<>();
map.put("hn","河南");
map.put("hb","河北");
map.put("sd","山東");
map.put("sx","山西");
req.setAttribute("map",map);
獲取數據
<#--獲取所有的key,通過key獲取所有的value-->
<#list map?keys as m>
${m}-${map[m]}<br>
</#list>
<#--獲取所有的value-->
<#list map?values as v>
${v}<br>
</#list>
五、常用的指令
1、assign自定義變量指令
<#--定義單個變量-->
<#assign name="張三">
${name}<br>
<#--定義多個變量-->
<#assign age=20 names=["張三","李四","王二","麻子"]>
${age}<br>
${names?join("-")}<br>
- join:把數組按照指定字符分割
2、邏輯判斷指定
<#assign age = 95>
<#if age < 60>
成績不合格
<#elseif age<=80>
還可以
<#elseif age<=90>
不錯
<#else >
你很牛逼
</#if>
<br>
<#if age?? >
存在
<#else >
不存在
</#if>
3、list遍歷指令
<#assign list=[1,2,3]>
<#list list as item>
${item}
</#list>
<#list list as item>
${item}
<#else >
沒有數據
</#list>
<#--判斷數據是否存在,存在則則遍歷-->
<#if aaa??>
<#list aaa as item>
${item}
</#list>
</#if>
4、自定義指令
自定義指定的指令名不能重複
<#--指令名不能重複-->
<#macro test1>
自定義指令
</#macro>
<@test1></@test1>
<br>
<#macro test2 str>
自定義指令,並傳遞參數:${str}
</#macro>
<@test2 str="張三"></@test2>
<br>
<#macro test3 name age>
自定義指令,並傳遞多個參數:${name}-${age}
</#macro>
<@test3 name="啊哈哈" age=20></@test3>
<br>
<#--自定義指令中包含內置指令-->
<#macro cfb>
<#list 1..9 as i>
<#list 1..i as j>
${j} * ${i} = ${i*j}
</#list>
<br>
</#list>
</#macro>
<@cfb></@cfb>
5、佔位指令
`nested` 指令執行自定義指令開始和結束標籤中間的模板片段。嵌套的片段可以包含模板中任意合法的內容。
<#--
nested 佔位指令
nested 相當於佔位符,一般結合macro指令一起使用。
可以將自定義指令中的內容通過nested指令佔位,當使用自定義指令時,會將佔位內容顯示。
-->
<#macro test>
這是一段文本!
<#nested>
<#nested>
</#macro>
<@test><h4>這是文本後面的內容!</h4></@test>
<#macro a1>
佔位指令
</#macro>
<@a1>xxxx</@a1>
<br>
<#macro a1>
佔位指令
<#nested >
<#nested >
<#nested >
</#macro>
<@a1>xxxx</@a1>
6、導入指令
可以引入另外一個模板
commons.ftl
<#macro cfb1 num>
<#list 1..num as i>
<#list 1..i as j>
${j} * ${i} = ${i*j}
</#list>
<br>
</#list>
</#macro>
<#--導入指令-->
<#--可以使用其他文件中定義的自定義指令-->
<#import "commons.ftl" as cm>
<@cm.cfb1 num = 9></@cm.cfb1>
7、包含指令
可以將任意文本內容包含到FerrMarker中。
要保證被包含的文件存在
<#--引入其他文件的內容-->
<#include "test.html">
<#include "test.ftl">
<#include "test.txt">
六、運算符
1、算術運算符
<!--
算術運算
+、-、*、/、%
-->
<#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"}
2、邏輯運算符
<#--
邏輯運算符
&&、||、!
-->
3、比較運算符
<#--
比較運算符
> (gt): 大於號,推薦使用 gt
< (lt): 小於號,推薦使用 lt
>= (gte): 大於等於, 推薦是用 gte
<= (lte): 小於等於,推薦使用 lte
== : 等於
!= : 不等於
-->
4、空值運算符
<#--
空值運算符
1. ??:判斷是否爲空,返回布爾類型
如果不爲空返回 false, 如果爲空返回 true,不能直接輸出
${(name??)?string}
2. !: 設置默認值,如果爲空,則設置默認值
1. 設置默認爲空字符串:
${name!}
2. 設置指定默認值
${name!'zhangsan'}
-->
七、頁面靜態化
Freemarker 是一種基於模板的、用來生成輸出文本的通用工具,所以可以定製符合自己業務的模板,然後生成自己的 html 頁面。Freemarker 是通過freemarker.template.Configuration 這個對象對模板進行加載的(它也處理創建和緩存預解析模板的工作),然後通過 getTemplate 方法獲得想要的模板,有一點要記住freemarker.template.Configuration 在整個應用必須保證唯一實例。
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<h2 align="center">${title}</h2>
<p align="center">
新聞來源:${source}
發佈時間:${pubTime}
</p>
<p style="text-indent: 2em">
${content}
</p>
</body>
</html>
package cn.yanghuisen.servlet;
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.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(),"/template");
// 設置模板編碼格式
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","2020年03月27日 21:25");
map.put("content","新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。新聞內容。");
// 獲取項目根目錄
String path = getServletContext().getRealPath("/");
// 設置html文件的存放目錄
File htmlFile = new File(path+"/html");
// 文件夾是否存在,不存在則創建
if (!htmlFile.exists()){
htmlFile.mkdir();
}
// 生成隨機文件名
String fileName = System.currentTimeMillis()+".html";
// 創建html文件
File file = new File(htmlFile,fileName);
FileWriter writer = new FileWriter(file);
try {
template.process(map,writer);
System.out.println("成功");
} catch (TemplateException e) {
e.printStackTrace();
}finally {
writer.flush();
writer.close();
}
System.out.println(fileName);
}
}