Apache Velocity：讓模板更簡單優美

Apache Velocity是一個開源的、快速的模板引擎工具，它提供了一種簡單而優美的方式來將數據與模板結合，生成所需的輸出結果。在這篇文章中，我們將探討Velocity的基本原理、應用場景、常用語法和用法技巧等方面，並給出一些實例代碼供大家參考。

一、什麼是Velocity？

Apache Velocity是一款用Java語言編寫的開源模板引擎，可用於生成Web頁面、郵件、XML、JSON、SQL等任意文本數據。它的核心思想是將數據和模板分離，使用模板來描述如何渲染數據，從而實現了數據與呈現的分離。

Velocity的關鍵詞是「簡單、清晰和易用」，其模板語法簡潔而靈活，易於理解和維護，而且支持Java（大多數應用場景）、JavaScript、PHP等多種語言。

二、應用場景

Velocity的應用場景非常廣泛，特別是在Web應用開發過程中。比如：

• 在Web應用中，Velocity可以用來渲染頁面，生成HTML/CSS/JavaScript等前端代碼。通過將模板和數據分離，我們可以輕鬆地改變頁面的樣式，而無需修改底層業務邏輯。
• 在郵件和簡訊發送過程中，Velocity可以用來生成郵件正文和簡訊內容。我們可以根據模板和數據模型來生成動態文本，從而提高用戶體驗。
• 在XML和JSON格式輸出方面，Velocity也非常有用。通過將數據與模板分離，我們可以靈活地構建自己的數據格式。

三、常用語法

1. 變數

Velocity中的變數使用$符號來表示，其格式為$variable。變數可以引用任意對象，包括Java基本類型、數組、集合、Map、自定義Java對象等。

#set($name = "Apache Velocity")
Welcome to $name!

以上代碼將會輸出:

Welcome to Apache Velocity!

2. 表達式

Velocity支持各種類型的表達式，包括算術表達式、邏輯表達式、關係表達式、三元表達式等等。

#set($a = 3)
#set($b = 5)
$a + $b = $a $b
$a < $b = $($a  $b = $($a > $b)
$a == $b = $($a == $b)
$a != $b = $($a != $b)
$($a > $b ? $a : $b)

以上代碼將會輸出:

3 + 5 = 8
3  5 = false
3 == 5 = false
3 != 5 = true
5

3. 控制結構

Velocity提供了豐富的控制結構，包括if-else、foreach、while、switch等等，這裡只展示常用的if-else和foreach兩種。

#set($score = 80)
#set($gender = "M")
#if($score >= 60)
    #if($gender == "M")
        Congratulations, boy!
    #else
        Congratulations, girl!
    #end
#else
    Sorry, you failed!
#end

#set($list = ["apple", "banana", "orange"])
#foreach($item in $list)
    $item
#end

以上代碼將會輸出:

Congratulations, boy!
apple
banana
orange

四、用法技巧

1. 定義函數和宏

通過在模板中定義函數和宏，我們可以將常用代碼封裝起來，提高代碼重用性。定義函數和宏的語法如下：

#macro(方法名 參數1 參數2 ...)
    #foreach ...
#end

#macro(宏名 參數1 參數2 ...)
    #if ...
#end

以下是一個簡單的例子：

#macro(sayhello name)
    Hello, $name!
#end

#set($name = "World")
#sayhello($name)

以上代碼將會輸出:

Hello, World!

2. 使用Velocity工具類

Velocity提供了很多工具類來幫助我們簡化模板渲染過程。比如，VelocityContext是一個非常重要的類，它表示模板與數據的上下文關係。使用VelocityContext，我們可以輕鬆地設置和獲取模板中的變數。

#set($name = "Apache Velocity")
#set($context = $velocityContext.put("name", $name))
Welcome to $context.get("name")!

以上代碼將會輸出:

Welcome to Apache Velocity!

3. 防止XSS攻擊

在Web應用中，經常會遇到XSS（跨站腳本攻擊）問題。為了避免這種攻擊，我們應該在渲染之前對數據進行HTML實體化處理。Velocity提供了一些內置的工具類，如EscapeTool和LinkTool，可以幫助我們實現這個功能。

#set($text = "alert('xss');")
$esc.html($text)

以上代碼將會輸出:

<script>alert('xss');</script>

總結

Apache Velocity是一個非常方便、簡潔、易用的模板引擎，在Web應用開發和文本數據輸出中都有著廣泛的應用。通過本文的介紹，相信大家已經對Velocity有了更加深入的了解，後續可以嘗試運用到自己的開發實踐中。