Java API 開發中使用 FreeMarker 進行 Web 範本引擎處理
- PHPz原創
- 2023-06-18 08:39:541613瀏覽
隨著網路的快速發展，Web 應用程式的開發也變得越來越常見。為了使 Web 應用程式更具可讀性和可維護性，開發人員通常使用 Web 模板引擎來進行視圖渲染。在 Java 開發中，有許多流行的 Web 模板引擎，FreeMarker 就是其中之一。
本文將介紹 FreeMarker Web 範本引擎及其在 Java API 開發中的使用，包括其核心特性、配置及其在實戰中的應用。
一、什麼是 FreeMarker
FreeMarker 是一款開源的 Java 範本引擎，它使用基於範本的方法來產生靜態文字或動態網頁。它的特色是模板與程式碼分離，明確了表現與邏輯的界限，將頁面渲染和業務邏輯分離，提高了程式碼的可讀性和可維護性。 FreeMarker 支援文字範本、XML 範本、HTML 範本、JSP 標籤庫等多種範本類型，可與多種 Web 框架集成，如 Struts2、Spring MVC 等。
FreeMarker 有以下特性：
- 關注點分離：範本檔案只定義了頁面的展示效果和對前端使用者的互動行為，沒有內嵌業務邏輯程式碼。
- 強型別支援：比較 JSP，FreeMarker 具有強型別支援能力，能在編譯時幫我們檢查型別錯誤，減少執行時錯誤。
- 各種範本檔案格式：FreeMarker 支援多種範本檔案格式的處理，包括，但不限於 HTML、XML、JSON。
- 相容性：FreeMarker 可以整合到各種 Web 框架中使用，在 SpringMVC、Struts2 等框架中都有很廣泛的使用。
二、FreeMarker API 的使用
FreeMarker 提供了許多 API 以便使用它產生模板，我們最初的呼叫要涉及到配置 FreeMarker 來發出模板。接下來，我們將展示如何設定和使用 FreeMarker API。
- 引入FreeMarker 的依賴套件
首先，我們需要在專案的pom.xml 檔案中加入FreeMarker 的依賴項：
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>- #配置FreeMarker
要建立FreeMarker or 需要一個配置，來告訴它如何載入模板，參考如下程式碼範例：
Configuration configuration = new Configuration(Configuration.VERSION_2_3_28); configuration.setClassForTemplateLoading(YourClass.class, "templates");
其中，VERSION_2_3_28 是FreeMarker 版本號，setClassForTemplateLoading()方法設定FreeMarker 載入範本的路徑。
- 設定資料模型
接下來，需要設定範本的輸入資料。在 FreeMarker 中，這個背景是一個 Map，這個 Map 需要包含我們希望在範本中使用的所有資料。我們可以使用 SimpleHash 類型來建立這個 Map：
Map<String, Object> input = new HashMap<String, Object>();
input.put("title", "FreeMarker Example");在這個範例中，我們將 "title" 作為鍵，"FreeMarker Example" 作為值，加入了 input 中。
- 載入並渲染模板
最後，我們需要載入模板，並將輸入資料渲染到模板中，參考如下程式碼範例：
Template template = configuration.getTemplate("example.ftl");
Writer out = new OutputStreamWriter(System.out);
template.process(input, out);
out.flush();在這個例子中，"example.ftl" 是模板文件，我們使用configuration.getTemplate() 方法來載入它，template.process() 方法來將input 中的資料渲染到模板中，最終透過out 輸出。
- FreeMarker 範本語法
FreeMarker 範本語法定義了範本標記、內建格式和方法。模板標記是模板裡的指令，由一對 ${} 或 72637aecae1027e7d023ac098a170986 標記中的 FreeMarker 模板程式碼組成。
以下是一些 FreeMarker 的標記：
- ${...}：FreeMarker 表達式可以包含任何合法的 Java 表達式。
- 210ed1318abde7834e36492ec8375eb8：包含原始範本標記。
- f3e420799a6591d1a980bb00b8364694..9b0e62076707393bcdcc1fdedef2cb31：指示一個聚合範本片段。
- #...#list..#assign...#recover...#stop：操作與控制範本實例的原始標記。
- b6171c79e43d4ace7268281c91ab5617...ef41338967419463344c621c1409f21c611f73697c333334ce54ec171d4b0f56：定義一個可重複使用的範本區塊。
三、FreeMarker 的應用程式範例
#下面我們將示範如何在 Java API 開發中使用 FreeMarker 編寫範本。
- 寫範本文件
首先，我們需要寫一個FreeMarker 範本文件，例如，test.ftl：
<html>
<head>
<title>${title}</title>
</head>
<body>
<h1>${title}</h1>
<ul>
<#list users as user>
<li>${user.name} (${user.email})</li>
</#list>
</ul>
</body>
</html>在這個例子中，我們使用${...} 標記來引用輸入中的數據，使用364e9d80cdc5c997ad29773a08b6c2809fc13d131a1403f8a03377ed174a3a41 標記來循環遍歷users，從每個user 中取得name 和email 屬性。
- 設定資料模型並載入範本
然後，我們需要設定資料模型，參考如下程式碼範例：
Map<String, Object> input = new HashMap<String, Object>();
input.put("title", "FreeMarker Example");
List userList = new ArrayList();
userList.add(new User("Tom", "tom@example.com"));
userList.add(new User("Jerry", "jerry@example.com"));
input.put("users", userList);
Configuration configuration = new Configuration(Configuration.VERSION_2_3_28);
configuration.setClassForTemplateLoading(YourClass.class, "/templates");
Template template = configuration.getTemplate("test.ftl");
Writer out = new OutputStreamWriter(System.out);
template.process(input, out);
out.flush(); 在這個範例中，我們建立了一個名為User 的JavaBean 類，在建立Map 時，我們將userList 作為鍵，List 引用作為值，將其加入input 中。
三、總結
本文介紹了 FreeMarker Web 範本引擎及其在 Java API 開發中的使用。 FreeMarker 讓 Web 應用程式的開發變得更容易，同時提高了程式碼的可讀性和可維護性。我們透過講解 FreeMarker 的核心特性、配置及其在實務上的應用，希望能幫助讀者更好地理解並應用 FreeMarker。
以上是Java API 開發中使用 FreeMarker 進行 Web 範本引擎處理的詳細內容。更多資訊請關注PHP中文網其他相關文章！