FreeMarker 是一款 模板引擎: 即一種基於模板和要改變的數據, 並用來生成輸出文本(HTML網頁,電子郵件,配置文件,源代碼等)的通用工具。 是一個Java類庫。html
FreeMarker 被設計用來生成 HTML Web 頁面,特別是基於 MVC 模式的應用程序,將視圖從業務邏輯中抽離處理,業務中再也不包括視圖的展現,而是將視圖交給 FreeMarker 來輸出。雖然 FreeMarker 具備一些編程的能力,但一般由 Java 程序準備要顯示的數據,由 FreeMarker 生成頁面,經過模板顯示準備的數據(以下圖):java
FreeMarker不是一個Web應用框架,而適合做爲Web應用框架一個組件。程序員
FreeMarker與容器無關,由於它並不知道HTTP或Servlet。FreeMarker一樣能夠應用web
於非Web應用程序環境。數據庫
FreeMarker更適合做爲Model2框架(如Struts)的視圖組件,你也能夠在模板中使用apache
JSP標記庫。編程
可以生成各類文本:HTML、XML、RTF、Java 源代碼等等api
易於嵌入到你的產品中:輕量級;不須要 Servlet 環境數組
插件式模板載入器:能夠從任何源載入模板,如本地文件、數據庫等等瀏覽器
你能夠按你所需生成文本:保存到本地文件;做爲 Email 發送;從 Web 應用程序發送它返回給 Web 瀏覽器
全部經常使用的指令:include、if/elseif/else、循環結構
在模板中建立和改變變量
幾乎在任何地方均可以使用複雜表達式來指定值
命名的宏,能夠具備位置參數和嵌套內容
名字空間有助於創建和維護可重用的宏庫,或將大工程分紅模塊,而沒必要擔憂名字衝突
輸出轉換塊:在嵌套模板片斷生成輸出時,轉換HTML轉義、壓縮、語法高亮等等;你能夠定義本身的轉換
FreeMarker不是直接反射到Java對象,Java對象經過插件式對象封裝,以變量方式在模板中顯示
你可使用抽象(接口)方式表示對象(JavaBean、XML文檔、SQL查詢結果集等等),告訴模板開發者使用方法,使其不受技術細節的打擾
在模板語言中內建處理典型Web相關任務(如HTML轉義)的結構
可以集成到Model2 Web應用框架中做爲JSP的替代
支持JSP標記庫
爲MVC模式設計:分離可視化設計和應用程序邏輯;分離頁面設計員和程序員
字符集智能化(內部使用UNICODE)
數字格式本地化敏感
日期和時間格式本地化敏感
非US字符集能夠用做標識(如變量名)
多種不一樣語言的相同模板
<#recurse> 和 <#visit> 指令(2.3版本)用於遞歸遍歷XML樹。在模板中清楚和直接的訪問XML對象模型。開源論壇 JForum 就是使用了 FreeMarker 作爲頁面模板。
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>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>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <!-- freemarker的座標依賴 --> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</version> </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-maven-plugin.html --> <plugins> <!-- 配置jetty插件 --> <plugin> <groupId>org.eclipse.jetty</groupId> <artifactId>jetty-maven-plugin</artifactId> <version>9.2.1.v20140609</version> </plugin> </plugins> </build> </project>
在項目的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> </servlet> <!-- 處理全部以.ftl結尾的文件;ftl是freemarker默認的文件後綴 --> <servlet-mapping> <servlet-name>freemarker</servlet-name> <url-pattern>*.ftl</url-pattern> </servlet-mapping> </web-app>
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); } }
在webapp目錄下新建template文件夾,建立f01.ftl文件
瀏覽器地址欄輸入:http://localhost:8989/f01
Freemarker 模板中的數據類型由以下幾種:
有三種顯示形式:數值型(默認)、貨幣型、百分比型
在Servlet中設置布爾類型的數據
// 布爾類型 request.setAttribute("flag", true);
獲取數據
<#-- 數據類型:布爾類型 在freemarker中布爾類型不能直接輸出;若是輸出要先轉成字符串 方式一:?c 方式二:?string 或 ?string("true時的文本","false時的文本") --> ${flag?c} <br> ${flag?string} <br> ${flag?string("yes","no")} <br>
在Servlet中設置日期類型的數據
// 日期類型 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>
在Servlet設置數值型的數據
// 數值類型 request.setAttribute("age",18); // 數值型 request.setAttribute("salary",10000); // 數值型 request.setAttribute("avg",0.545); // 浮點型
獲取數據
<#-- 數據類型:數值類型 在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>
在Servlet中設置字符串類型的數據
// 字符串類型 request.setAttribute("msg","Hello "); request.setAttribute("msg2","freemarker");
獲取數據
<#-- 數據類型:字符串類型 在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>
在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);
獲取數據
<#-- 數據類型:序列類型 (數組、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} 姓名:${user.uname} 年齡:${user.uage} <br> </#list> <#-- 按照指定字段名排序 --> <#list userList?sort_by("uage") as user> ${user.uname} | </#list>
在Servlet中設置hash類型的數據
// Map操做 Map<String,String> cityMap = new HashMap<>(); cityMap.put("sh","上海"); cityMap.put("bj","北京"); cityMap.put("sz","深圳"); request.setAttribute("cityMap",cityMap);
獲取數據
<#-- 數據類型: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>
使用 assign
指令你能夠建立一個新的變量, 或者替換一個已經存在的變量。
<#-- assign 自定義變量指令 語法: <#assign 變量名=值> <#assign 變量名=值 變量名=值> (定義多個變量) --> <#assign str="hello"> ${str} <br> <#assign num=1 names=["zhangsan","lisi","wangwu"] > ${num} -- ${names?join(",")}
可使用 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指令 格式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 自定義指令 (宏) 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} </#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} </#list> <br> </#list> </#macro> <@cfb2 num=5></@cfb2>
nested
指令執行自定義指令開始和結束標籤中間的模板片斷。嵌套的片斷能夠包含模板中任意合法的內容。
<#-- nested 佔位指令 nested 至關於佔位符,通常結合macro指令一塊兒使用。 能夠將自定義指令中的內容經過nested指令佔位,當使用自定義指令時,會將佔位內容顯示。 --> <#macro test> 這是一段文本! <#nested> <#nested> </#macro> <@test><h4>這是文本後面的內容!</h4></@test>
import
指令能夠引入一個庫。也就是說,它建立一個新的命名空間, 而後在那個命名空間中執行給定路徑的模板。可使用引入的空間中的指令。
commons.ftl
<#macro cfb> <#list 1..9 as i> <#list 1..i as j> ${j}*${i}=${j*i} </#list> <br> </#list> </#macro>
在其餘ftl頁面中經過import導入commons.ftl的命名空間,使用該命名空間中的指令
test.ftl
<#-- 導入命名空間 --> <#import "commons.ftl" as common> <#-- 使用命名空間中的指令 --> <@common.cfb></@common.cfb>
可使用 include
指令在你的模板中插入另一個 FreeMarker 模板文件 。 被包含模板的輸出格式是在 include
標籤出現的位置插入的。 被包含的文件和包含它的模板共享變量,就像是被複制粘貼進去的同樣。
<#--包含指令(引入其餘頁面文件) include--> <#--html文件--> <#include "test.html"> <#--freemarker文件--> <#include "test.ftl"> <#--text文件--> <#include "test.txt">
經過上述介紹可知 Freemarker 是一種基於模板的、用來生成輸出文本的通用工具,因此
咱們必需要定製符合本身業務的模板,而後生成本身的 html 頁面。Freemarker 是經過
freemarker.template.Configuration 這個對象對模板進行加載的(它也處理建立和緩存預
解析模板的工做),而後咱們經過 getTemplate 方法得到你想要的模板,有一點要記住
freemarker.template.Configuration 在你整個應用必須保證惟一實例。
news.ftl
<#-- 新聞標題 --> <h1>${title}</h1> <p> 新聞來源:${source} 發佈時間:${pubTime?sring("yyyy-MM-dd HH:mm")} </p> <#-- 新聞內容 --> <p> ${content} </p>
@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(),"/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", new Date()); map.put("content", "中共中央政治局常務委員會近日召開會議強調," + "要有針對性地開展援企、穩崗、擴就業工做," + "作好高校畢業生、農民工等重點羣體就業工做," + "積極幫助個體工商戶紓困。疫情期間,穩就業狀況如何?還有哪些問題待解?" + "記者採訪了不一樣羣體,記錄這個特別的就業季。"); // 獲取項目所在的根目錄 String basePath = request.getServletContext().getRealPath("/"); // 設置頁面存放的目錄 File htmlFile = new File(basePath + "/html"); // 判斷目錄是否存在 if (!htmlFile.exists()) { // 若是目錄不存在,則新建目錄 htmlFile.mkdir(); } // 獲取文件名(隨機生成不重複的文件名) String fileName = System.currentTimeMillis() + ".html"; // 建立html文件 File file = new File(htmlFile, fileName); // 獲取文件輸出流 FileWriter writer = new FileWriter(file); try { // 輸出html 將模型數據填充到模板中 template.process(map, writer); // 輸出成功 System.out.println("新聞建立成功!"); } catch (TemplateException e) { e.printStackTrace(); } finally { writer.flush(); writer.close(); } } }
瀏覽器地址欄輸入:
http://localhost:8989/news
生成的文件存放在當前項目的webapp目錄下的html目錄中。
<!-- 算術運算 +、-、*、/、% --> <#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): 大於號,推薦使用 gt < (lt): 小於號,推薦使用 lt >= (gte): 大於等於, 推薦是用 gte <= (lte): 小於等於,推薦使用 lte == : 等於 != : 不等於 -->
<#-- 空值運算符 1. ??:判斷是否爲空,返回布爾類型 若是不爲空返回 false, 若是爲空返回 true,不能直接輸出 ${(name??)?string} 2. !: 設置默認值,若是爲空,則設置默認值 1. 設置默認爲空字符串: ${name!} 2. 設置指定默認值 ${name!'zhangsan'} -->