Java - FreeMarker + Spring MVC 如何設定

2015-07-10 11:31 AM

使用 Java 撰寫網頁最基本的是使用 JSP 產生的動態格式文件

但有使用過的都知道其實 JSP 與 HTML 語法混雜的可讀性非常之差

就我本身的立場而言 template 能有多單純就多單純

最好只用到輸出變數, 迴圈以及為數不多的判斷式就好

當然最重要的就是可以不用重啟伺服器就能讀取修改後的 template 這個功能

而 FreeMarker 剛好符合我的需求

是一個設定方便, 反應迅速並且保持 HTML 一致性的輕量級模板引擎

之前雖也有考慮過 Thymeleaf 這個模板引擎

他搭配 HTML 的一致性可以說是在 FreeMarker 之上

但似乎不能用來產生非 XML 格式的動態文件

因此就放棄使用 Thymeleaf 了

那麼以下我們就來看看 FreeMarker 搭配 Spring 的設定檔該如何使用

程式碼範例

<!-- 使用FreeMarker Templates -->
<bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
    <property name="templateLoaderPath" value="/WEB-INF/views/freemarker"/>
    <property name="defaultEncoding" value="UTF-8" /> 
    <property name="freemarkerSettings">  
        <props>
            <prop key="template_update_delay">10</prop>  
            <prop key="locale">zh_TW</prop>  
            <prop key="datetime_format">yyyy-MM-dd HH:mm:ss</prop>  
            <prop key="date_format">yyyy-MM-dd</prop>
            <prop key="time_format">HH:mm:ss</prop>
            <prop key="number_format">#.##</prop>
            <prop key="boolean_format">true,false</prop>
            <prop key="object_wrapper">beans</prop>
            <prop key="template_exception_handler">mvc.controller.exception.resolver.FreeMarkerExceptionHandler</prop>
        </props>
    </property>
</bean>

<!-- 設定預設view路徑與副檔名 -->
<bean id="viewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
 <property name="viewClass" value="org.springframework.web.servlet.view.freemarker.FreeMarkerView"/>
   <property name="cache" value="true" />
   <property name="suffix" value=".ftl" />
   <property name="contentType" value="text/html;charset=UTF-8" />
   <property name="requestContextAttribute" value="request" />
   <property name="exposeRequestAttributes" value="true" />
    <property name="exposeSessionAttributes" value="false" /> 
    <property name="exposeSpringMacroHelpers" value="true" /> 
</bean>

詳細解說

首先我們來看第一個區塊的 freemarkerConfig 設定

templateLoaderPath - FreeMarker Template 檔案放置的根目錄路徑

defaultEncoding - 預設編碼, 目前應該都設置為 UTF-8

template_update_delay - 設定 template 更新頻率, 單位為秒, 不須重啟伺服器即可讀取修改後的 template 內容

locale - 語系設定

datetime_format, date_format, time_format, number_format, boolean_format - 設定使用 FreeMarker 語法輸出日期, 時間, 數字與布林值的預設格式

object_wrapper - 設定你在 template 中可以使用的物件種類, 預設僅能使用 Java 的基本類別, 設定為 BeansWrapper 時則可以使用自訂類別

template_exception_handler - FreeMarker 解析發生 Exception 時導向的處理類別, 可避免在頁面上出現 Debug 資訊並做額外 logger 處理

再來便是第二個區塊的 viewResolver 設定

viewClass - Exposes 處理類別

cache - 是否開啟快取

suffix - template 副檔名

contentType - 輸出內容的編碼與文件類型設定

requestContextAttribute - Spring 的 RequestContext 變數在 Template 內的對應變數名稱

exposeRequestAttributes - 是否 Expose Request 變數, 設定為 true 則可以在 template 內存取

exposeSessionAttributes - 是否 Expose Session 變數, 設定為 true 則可以在 template 內存取

exposeSpringMacroHelpers - 是否 Expose SpringMacroHelpers, 設定為 true 則可以在 template 內存取

各項資料連結

FreeMarker
Thymeleaf