2. 程式人生 > >[前端]全面探索 FreeMarker 模版引擎的擴充套件性

[前端]全面探索 FreeMarker 模版引擎的擴充套件性

阿新 • • 發佈：2018-12-10

*******************************************************************************

*******************************************************************************

內容

全面探索 FreeMarker 模版引擎的擴充套件性

FreeMarker 模版引擎簡介

FreeMarker 是一個採用 Java 開發的模版引擎，是一個基於模版生成文字的通用工具。 FreeMarker 被設計用來生成 HTML Web 頁面，特別是基於 MVC 模式的應用程式。雖然 FreeMarker 具有一些程式設計的能力，但通常由 Java 程式準備要顯示的資料，由 FreeMarker 生成頁面，並通過模板顯示準備的資料（如下圖）。

圖 1. FreeMarker 工作原理

FreeMarker 工作原理

FreeMarker 非常簡單，只需要一個 Freemarker.jar 檔案（無需任何配置檔案）即可包含所有的功能。但 FreeMarker 的功能卻是非常的強大，相比較另外一個非常著名的 Java 模版引擎 —— Velocity 來說，FreeMarker 的功能讓您驚歎，但其學習的曲線也較 Velocity 要長很多。

本文主要介紹如何利用 FreeMarker 強大的可擴充套件性來輸出各種文字資訊，這不是 FreeMarker 的入門學習材料，如果您尚未對 FreeMarker 有所瞭解，或者還沒有使用過 FreeMarker 的話，那不妨先上手後再來閱讀本文。

FreeMarker 主要提供瞭如下幾個方面的擴充套件性功能：

  1. 自定義巨集
  2. 自定義函式
  3. 自定義模版檔案載入器
  4. 快取處理
  5. 異常處理

FreeMarker 自定義巨集

FreeMarker 和 Velocity 都提供可自定義巨集的功能，但 FreeMarker 的巨集功能更加強大，包括允許通過名稱和引數的位置進行引數傳遞；允許設定引數的預設值；支援巨集的巢狀；巨集可以先使用再宣告；支援名稱空間等。

下面我們針對這些功能給出一個簡單但是完整的演示例子，先看看程式碼：

清單 1. 巨集定義檔案 ( html.ftl )

1

2

3

4

5

6

7

8

9

10

11

12

<#macro html title charset="utf-8" lang="zh-CN">

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=${charset}" />

<meta http-equiv="Content-Language" content="${lang}"/>

<title>${title}</title>

</head>

<body>

<#nested>

</body>

</html>

</#macro>

在這個巨集定義檔案中，我們聲明瞭一個名為 html 的巨集，該巨集是為了生成一個 HTML 頁面的框架。它具有三個引數分別是 title 、charset 和 lang ，其中 charset 和 lang 分別指定了預設的值。

再來看看如何呼叫該巨集：

清單 2. 呼叫巨集

1

2

3

4

<#include "html.ftl">

<@html title="FreeMarker 巨集測試 ">

歡迎使用 FreeMarker 模版引擎

</@html>

在 FreeMarker 中，使用者自定義的巨集必須以 @ 開頭來呼叫，並傳入頁面標題 title 的引數。而 <@html> 標籤中包含的文字“歡迎使用 FreeMarker 模版引擎”將替換巨集定義中的 <#nested> 標籤。因此這個模版將會生成如下的 HTML 資訊：

清單 3. 模版生成結果

1

2

3

4

5

6

7

8

9

10

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<meta http-equiv="Content-Language" content="zh-CN"/>

<title>FreeMarker 巨集測試 </title>

</head>

<body>

歡迎使用 FreeMarker 模版引擎

</body>

</html>

而 Velocity 本身並不提供巢狀模版的功能，它必須依賴 Velocity-Tools 這個專案來實現。另外對於一些需要實現更復雜邏輯的巨集，還可以通過 Java 類來進行定義。 FreeMarker 提供了一個 TemplateDirectiveModel 介面，通過實現該介面可以實現自定義巨集的功能，這樣可以更好的跟應用邏輯進行整合，不過需要注意的是暫不支援通過引數的位置來呼叫巨集，呼叫時必須指定引數名，該問題將在 FreeMarker 2.4 中得以解決。下面是一個簡單的例子：

清單 4. 自定義巨集功能的例子

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

/**

* 將標籤中的程式碼全部轉為大寫並輸出

* @author Winter Lau ([email protected])

* 使用方法：

* <@upper>Welcome to http://www.oschina.net</@upper>

*/

public class UpperDirective implements TemplateDirectiveModel {

public void execute(Environment env,

Map params, TemplateModel[] loopVars,

TemplateDirectiveBody body)

throws TemplateException, IOException {

// Check if no parameters were given:

if (!params.isEmpty()) {

throw new TemplateModelException(

"This directive doesn't allow parameters.");

}

if (loopVars.length != 0) {

throw new TemplateModelException(

"This directive doesn't allow loop variables.");

}

// If there is non-empty nested content:

if (body != null) {

// Executes the nested body. Same as <#nested> in FTL, except

// that we use our own writer instead of the current output writer.

body.render(new UpperCaseFilterWriter(env.getOut()));

} else {

throw new RuntimeException("missing body");

}

}

/**

* A {@link Writer} that transforms the character stream to upper case

* and forwards it to another {@link Writer}.

*/

private static class UpperCaseFilterWriter extends Writer {

private final Writer out;

UpperCaseFilterWriter (Writer out) {

this.out = out;

}

public void write(char[] cbuf, int off, int len)

throws IOException {

char[] transformedCbuf = new char[len];

for (int i = 0; i < len; i++) {

transformedCbuf[i] = Character.toUpperCase(cbuf[i + off]);

}

out.write(transformedCbuf);

}

public void flush() throws IOException {

out.flush();

}

public void close() throws IOException {

out.close();

}

}

}

接下來我們需要過載 FreemarkerServlet ，植入該指令擴充套件，程式碼如下：

清單 5. 過載 FreemarkerServlet

1

2

3

4

5

6

@Override

protected Configuration createConfiguration() {

Configuration cfg = super.createConfiguration();

cfg.setSharedVariable("upper", new UpperDirective());

return cfg;

}

在頁面模版中使用<@upper>Welcome to http://www.oschina.net</@upper>試試吧。

FreeMarker 自定義函式

與巨集不同，巨集一般用來執行某個過程，而函式可以定義返回值，例如對一組資料求和、平均值、最大值、最小值等等運算。 FreeMarker 的函式支援可變個數的引數。例如下面定義了一個求平均值的函式：

清單 6. 求平均值的函式例子

1

2

3

4

5

6

7

8

9

<#function avg nums...>

<#local sum = 0>

<#list nums as num>

<#local sum = sum + num>

</#list>

<#if nums?size != 0>

<#return sum / nums?size>

</#if>

</#function>

其中函式名為 avg ，支援可變個數的引數 nums 。可用下面的程式碼來要呼叫該函式：

1

${avg(3,5,100,3453)}

跟巨集相同，FreeMarker 也可以用 Java 來編寫自定義函式。例如我們用 Java 程式碼來生成一個隨機的整數，其程式碼如下：

清單 7. 使用 Java 編寫的自定義函式

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

/**

* 生成一個隨機的整數

* @author Winter Lau ([email protected])

* @url http://www.oschina.net

*/

public class RandomFunction implements TemplateMethodModel {

final static Random rnd_seed = new Random(System.currentTimeMillis());

/* (non-Javadoc)

* @see freemarker.template.TemplateMethodModel#exec(java.util.List)

*/

@SuppressWarnings("unchecked")

public Object exec(List args) throws TemplateModelException {

return rnd_seed.nextInt(Integer.parseInt((String)args.get(0)));

}

}

同樣的，需要將該函式的定義植入 FreeMarker ：

1

cfg.setSharedVariable("rand",newRandomFunction());

使用方法：${rand(1000)} 。

FreeMarker 自定義模版檔案載入器

模版檔案載入器用來告訴 FreeMarker 引擎到什麼地方去載入模版檔案。 FreeMarker 自帶了三種檔案載入器，分別是：檔案目錄載入器、類路徑載入器以及 Web 上下文載入器。當在 Web 環境中使用 FreemarkerServlet 來載入模版檔案時，預設使用第三種載入器，並通過 Servlet 的配置 TemplatePath 來指定模版檔案所存放的路徑，該路徑是相對於 Web 的根目錄的。

在某種情況下，我們可能會希望把模版檔案的原始碼進行加密處理，例如我們使用 DES 加密方式將模版原始檔加密後進行儲存，然後我們通過自行實現一個加密的模版檔案載入器來讀取這些模版檔案，解密後交給 FreeMarker 引擎解釋執行並得到執行的結果。 FreeMarker 為模版檔案載入器定義了一個統一的介面 —— TemplateLoader ，該介面有以下四個方法：

closeTemplateSource 關閉模版資源
findTemplateSource 根據名稱返回指定的模版資源
getLastModified 返回模版資源最後一次修改的時間
getReader 返回讀取模版資源的 Reader

為了簡單起見，我們可以在 FreeMarker 自帶的載入器上進行擴充套件，重寫 getReader 方法對讀取到的模版檔案內容進行解密後生成一個新的 Reader 例項並返回（詳細過程不再敘述）。

FreeMarker 自帶的幾個 TemplateLoader 分別是：

  1. ClassTemplateLoader ：基於類路徑的模版載入器
  2. FileTemplateLoader ：基於檔案目錄的模版載入器
  3. MultiTemplateLoader ：多種載入器的混合
  4. StringTemplateLoader ：基於字串的模版載入器
  5. URLTemplateLoader ：基於 URL 的模版載入器
  6. WebappTemplateLoader ：基於 Web 上下文的模版載入器

過載模版載入器後通過下面程式碼使之生效：

1

cfg.setTemplateLoader(loader)

FreeMarker 快取處理

FreeMarker 的快取處理主要用於模版檔案的快取，一般來講，模版檔案改動不會很頻繁，在一個流量非常大的網站中，如果頻繁的讀取模版檔案對系統的負擔還是很重的，因此 FreeMarker 通過將模版檔案的內容進行快取，來降低模版檔案讀取的頻次，降低系統的負載。

當處理某個模版時，FreeMarker 直接從快取中返回對應的 Template 物件，並有一個預設的機制來保證該模版物件是跟模版檔案同步的。如果使用的時候 FreemarkerServlet 時，有一個配置項 template_update_delay 用來指定更新模版檔案的間隔時間，相當於多長時間檢測一下是否有必要重新載入模版檔案，0 表示每次都重新載入，否則為多少毫秒鐘檢測一下模版是否更改。

FreeMarker 定義了一個統一的快取處理介面 CacheStorage ，預設的實現是 MruCacheStorage 最近最少使用的快取策略。一般情況下，很少需要對快取進行擴充套件處理。您可以通過下面的程式碼指定最大快取的模版數：

1

cfg.setCacheStorage(new freemarker.cache.MruCacheStorage(20, 250))

其中第一個引數是最大的強引用物件數，第二個為最大的弱引用物件數。這兩個值 FreeMarker 預設的是 0 和 Integer.MAX_VALUE，表明模版快取數是無限的。

FreeMarker 異常處理

當使用 FreeMarker 做為模版引擎的時候，可能發生的異常包括：

配置異常：配置異常指的是 FreeMarker 初始化時發生的異常，例如錯誤的配置導致，該異常時由 FreeMarker 的 API 丟擲來的。

模版載入異常：模版載入異常可能是模版不存在或者沒有讀許可權，或者是解析模版時發生錯誤，例如模版語法錯誤等。

模版執行異常：模版執行異常是指模版已經成功的載入但在執行過程中由於程式碼執行錯誤所丟擲的異常，這類異常一般都是使用者的程式碼導致。

正常情況下，前兩種異常會在開發過程中就會發現並得以解決，而第三種異常往往跟實際的執行環境和資料有關，例如由於某些資料不存在導致的空指標異常等等。因此第三種異常才是我們真正需要關心以及監控的。

為此，FreeMarker 定義了一個統一的異常處理介面 TemplateExceptionHandler 。該介面只有一個方法如下：

1

2

3

void handleTemplateException(TemplateException te,

Environment env,

java.io.Writer out)

通過呼叫 cfg.setTemplateExceptionHandler 來使用自定義的異常處理方法。下面是一個簡單的異常處理擴充套件的例子：

清單 8. 異常處理擴充套件的例子

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

class MyTemplateExceptionHandler implements TemplateExceptionHandler {

public void handleTemplateException(TemplateException te,

Environment env, java.io.Writer out)

throws TemplateException {

try {

out.write("[ERROR: " + te.getMessage() + "]");

} catch (IOException e) {

throw new TemplateException(

"Failed to print error message. Cause: " + e, env);

}

}

}

...

cfg.setTemplateExceptionHandler(new MyTemplateExceptionHandler());

Eclipse 的 FreeMarker 外掛

為了方便編寫 FreeMarker 模版，您可以使用 FreeMarker IDE 這個 Eclipse 外掛。該外掛具有語法高亮、錯誤提示等功能。雖然該外掛還有很多問題，而且已經很久沒更新了，但也能很好地使用。

總結

從上面對於 FreeMarker 的可擴充套件性的介紹來看，FreeMarker 確實是一個功能非常之強大的模版引擎，可以說遠在 Velocity 之上。不過從使用的直觀程度以及上手的時間來看，其複雜度也大大的超過了 Velocity 。當我們在面臨這兩個模版引擎的選擇時，不能只是從功能或者容易上手的角度來決定，更應該根據業務本身的需要綜合進行比較。

相關主題

  • 檢視 FreeMarker 的 Eclipse 編輯外掛 相關資訊。
  • “編寫自定義的 Velocity 指令”（developerWorks，2009 年 4 月）：本文通過一個實際應用例子對 Velocity 的模板語言中的指令系統進行了介紹，並演示瞭如何通過編寫自定義的指令來擴充套件 Velocity 的功能。
  • Java 技術專區：尋找 Java 程式設計各方面的技術文章。

相關推薦

[前端]全面探索 FreeMarker 模版引擎的擴充套件性

******************************************************************************* *******************************************************

全面探索 FreeMarker 模版引擎的擴充套件性

FreeMarker 模版引擎簡介 FreeMarker 是一個採用 Java 開發的模版引擎，是一個基於模版生成文字的通用工具。 FreeMarker 被設計用來生成 HTML Web 頁面，特別是基於 MVC 模式的應用程式。雖然 FreeMarker 具有一些程式設計的能力，但通常由 Ja

JAVA模版引擎Freemarker常用標籤(一)

1. if指令 這是一個典型的分支控制指令,該指令的作用完全類似於Java語言中的if,if指令的語法格式如下: <#if condition>... <#elseif condition>... <#elseif condition>

Phalcon 使用Volt模版引擎

min vol 更換 phalcon 編譯過程 base false 年齡 擴展 volt 是Phalcon中集成的模板引擎，我們也可以更換為其他模板引擎或同時使用多個模板引擎。本文只介紹 Phalcon 自帶的 volt模板引擎。 啟用Volt 和其他模板引擎一樣，我們需

比較Apache Hadoop生態系統中不同的文件格式和存儲引擎的性能

報告 indent 然而 microsoft 要花 ont 目錄 總結 千兆 這篇文章提出了在Apache Hadoop生態系統中對比一些當前流行的數據格式和可用的存儲引擎的性能：Apache Avro，Apache Parquet，Apache HBase和Apache

js模版引擎開發實戰以及對eval函數的改進

fun 開發 else if 積極 rto 工作 eva mov nbsp 簡介 　　前段時間，想著自己寫一個簡單的模版引擎，便於自己平時開發demo時使用，同時也算是之前學習的知識的一種總結吧！ 　　首先我們先了解一下模版引擎的工作原理吧！ 　　1. 模版引擎其實就

【11】 Express安裝入門與模版引擎ejs

scrip png js文件 是我 use 處理 ica direct 配置 前言 Express簡介和安裝 運行第一個基於express框架的Web 模版引擎 ejs express項目結構 express項目分析 app.set(name,value) app

php-angular／think-angular／php模版引擎

樹狀 and select use start 整潔 測試 get dump 最近學習thinphp5的時候發現一個好用的模版引擎——think-angular， 此模板引擎主要特點是 不需要額外的標簽定義, 全部使用屬性定義, 寫好的模板文件在IDE格式化代碼的時候很整潔

express模版引擎

發現 使用 例子 jad express 正常 div gin 喜歡 最近在用node+express做一個項目，開發中碰到一些問題記錄一下：按照例子我配置了ejs模版引擎，頁面後綴.ejs也可以正常使用，但是總感覺怪怪的，只是想簡單用html為啥要帶個ejs後綴於是看了好

在express3裏用ejs模版引擎時，如何使其支持'.html'後綴

模板 span clu 如何 自動 runnable str targe pretty ①express 默認jade模板，改為ejs模板，需執行以下命令： 　　express -e --ejs ②在app.js中，將 app.set(‘view engine‘, ‘jad

T4模版引擎之基礎入門

如何 inf 添加引用 研究 變量 sta word lis ports 　　額，T4好陌生的名字，和NuGet一樣很悲催，不為世人所熟知，卻又在背後默默無聞的奉獻著，直到現在我們項目組的人除了我之外，其它人還是對其豪無興趣，基本上是連看一眼都懶得看

Freemarker模板引擎

ack xxx mvc控制器 pro 表示 圖解 HA 出現 def 模板引擎的實質就是將頁面結構提前寫好，然後將數據渲染到模板上生成一個靜態頁面，這樣一來，下次就可以 直接訪問靜態文件，不用進行額外的獲取數據的操作（例如：訪問數據庫），這樣大大提升了網站的訪問速度。

Nodejs學習筆記（五）—Express安裝入門與模版引擎ejs

num routes 項目目錄 其中 bubuko 執行 ctrl+ ica 開發經驗 前言 　　前面也學習了一些Node.js的基本入門知道，現在開始進入Web開發的部分； 　　Node.js提供了http模塊，這個模塊中提供了一些底層接口，可以直接使用，但是直接開發網站

java 企業門戶網站 源碼 自適應響應式 freemarker 靜態引擎 html5 SSM

pan order 平板 報表 完整 普通 KS 關於 mvc 1.網站後臺采用主流的 SSM 框架 jsp JSTL，網站後臺采用freemaker靜態化模版引擎生成html 2.因為是生成的html，所以訪問速度快，輕便，對服務器負擔小 3.網站前端采用主流的響應式

JavaScript 如何工作：渲染引擎和性能優化技巧

blob 默認值 書簽 隱藏 播放 wikipedia 強制 之前 blocks 翻譯自：How JavaScript works: the rendering engine and tips to optimize its performance 這是探索 JavaScr

How Javascript works (Javascript工作原理) (十一) 渲染引擎及性能優化小技巧

for 流行 bug 文章 path mat 文本 頁面 oppo 個人總結:讀完這篇文章需要20分鐘,這篇文章主要講解了瀏覽器中引擎的渲染機制。 DOMtree ----| 　　　　　　　 |----> RenderTree CSSOMtree -

使用freemarker模板引擎生成word文檔的開發步驟

ring 進度 ram ted 彈出 模板引擎 adf XML style 1、準備模板文檔，如果word文檔中有表格，只保留表頭和第一行數據；2、定義變量，將word文檔中的變量用${var_name}替換；3、生成xml文件，將替換變量符後的word文檔另存為xml文件

在商城系統開發時遇到商品的多級分類，為增強擴充套件性，子類可以任意新增，此類問題資料庫如何設計

表結構為：  id（編號）   name（分類名）  parentID（父類編號） 簡單舉例如下： id    name      parentID 1   

使用Freemarker模板引擎渲染web檢視

一 新建pom <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>

資料庫擴充套件性設計：使用二進位制解決一條記錄關聯多個狀態的問題（轉），可以嘗試一下

程式開發中，經常遇到一條記錄有多個狀態位，比如一條商品，他屬於熱門，新品，特賣。我們的資料庫如何設計呢？ 一般有幾種方法 （1）建立關聯表 關聯表字段：關係Id，商品Id，屬性Id 查詢：使用關聯表的方式，查詢某屬性的商品。 程式：寫入時，寫商品表和關聯表；