freemarker常見語法大全

木叔發表於2017-11-07

推薦freemarker系列教程:http://swiftlet.net/archives/category/freemarker

 

FreeMarker的插值有如下兩種型別:1,通用插值${expr};2,數字格式化插值:#{expr}或#{expr;format} 
${book.name?if_exists } //用於判斷如果存在,就輸出這個值 
${book.name?default(‘xxx’)}//預設值xxx 
${book.name!"xxx"}//預設值xxx 
${book.date?string('yyyy-MM-dd')} //日期格式 
${book?string.number} 20 //三種不同的數字格式 
${book?string.currency}--<#-- $20.00 --> 
${book?string.percent}—<#-- 20% -->

<#assign foo=ture /> //宣告變數,插入布林值進行顯示 
${foo?string("yes","no")} <#-- yes -->

大小比較符號使用需要注意:(xml的原因),可以用於比較數字和日期 
使用lt、lte、gt和gte來替代<、<=、>和>= 也可以使用括號<#if (x>y)>

內建函式: 呼叫區別於屬性的訪問,使用?代替. 
常見的一些內建函式 
對於字串 
html-對字串進行HTML編碼 
cap_first-使字串第一個字母大寫 
lower_case-將字串轉換成小寫 
trim-去掉字串前後的空白字元

示例:${“freeMarker”?cap_first} 

 

對於Sequences(序列) 
size-獲得序列中元素的數目

對於數字 
int-取得數字的整數部分(如-1.9?int的結果是-1)

對於集合,可以使用陣列的方式,使用下標索引進行訪問

邏輯判斷: 
if................

<#if condition>... 
<#elseif condition2>... 
<#elseif condition3>...... 
<#else>... 
Boolean型別的空值判斷 
空值判斷可以寫成<#if book.name?? > //注意${}為變數的渲染顯示,而<>為定義等操作符的定義

switch............ 
<#switch value> 
<#case refValue1> 
... 
<#break> 
<#case refValue2> 
... 
<#break> 
... 
<#case refValueN> 
... 
<#break> 
<#default> 
... 
</#switch>

快速定義int區間的集合 
<#assign l=0..100/> //注意不需要[]

3:迴圈讀取集合: 注意/的使用 
<#list student as stu> 
${stu}<br/> 
</#list> 
與jstl迴圈類似,也可以訪問迴圈的狀態 
item_index:當前變數的索引值 
item_has_next:是否存在下一個物件 其中item名稱為as後的變數名,如stu

集合長度判斷 
<#if student?size != 0></#if> 判斷=的時候,注意只要一個=符號,而不是==

巨集/模板 
初步瞭解: 使用更像一個閉包closure,可以定義後,在指令碼中任意地方引用,並原地起作用 
<#macro greet> 
<font size="+2">Hello Joe!</font> 
</#macro> 
使用的方式為: 
<@greet></@greet> //同xml可以簡寫成<@greet/>

巨集的引數定義,類似js,在巨集名後 帶引數進行傳遞定義 
<#macro greet person color> 
${person} 
</#macro>

呼叫帶引數時,注意使用類似XML的屬性格式進行傳遞,不需要關心順序問題 
<@greet person="Fred" color="black"/>

引數預設值定義,如果沒有,就必須要求傳遞完整的引數列表 
<#macro greet person color="black"> 
<font size="+2" color="${color}">Hello ${person}!</font> 
</#macro>

使用xml的巢狀內容進行傳遞巨集呼叫,關鍵標籤 <#nested> 
<#macro border> 
<table border=4 cellspacing=0 cellpadding=4><tr><td> 
<#nested> 
</tr></td></table> 
</#macro>

呼叫時: 
<@border>The bordered text</@border>

<#nested> 標籤可以在巨集中多次呼叫,也可以將多個巨集組合進行巢狀

for迴圈的精簡版: 
<#list 1..count as x> 
</#list>

巨集的迴圈變數,配合巢狀標籤進行引數傳遞, 
<#macro repeat count> 
<#list 1..count as x> 
<#nested x, x/2, x==count> //這裡的三個引數,將會傳遞到巢狀內容中 
</#list> 
</#macro>

<@repeat count=4 ; c, halfc, last> 
${c}. ${halfc}<#if last> Last!</#if> //這裡的內容由macro中的<#nested>進行引數的傳遞,傳遞的數量任意,當注意需要巨集接受這些 
</@repeat> 
上述還需要注意;的使用

引數的數量是可變的,並不要求全部都有,但是效果不同

在模板中定義變數 
在模板中定義的變數有三種型別: 
plain變數:可以在模板的任何地方訪問,包括使用include指令插入的模板,使用assign指令建立和替換。 
區域性變數:在巨集定義體中有效,使用local指令建立和替換。 
迴圈變數:只能存在於指令的巢狀內容,由指令(如list)自動建立;巨集的引數是區域性變數,而不是迴圈變數

<#assign x = "plain"> //全域性的plain變數 
內部迴圈變數將會隱藏同名的外部迴圈變數

外部匯入的使用,可以用於模組化,並且提供公用性 
如:lib/my_lib.ftl檔案 
<#macro copyright date> 
<p>Copyright (C) ${date} Julia Smith. All rights reserved. 
<br>Email: ${mail}</p> 
</#macro> 
<#assign mail = "jsmith@acme.com">

lib/my_inc.ftl檔案 
<#import "/lib/my_test.ftl" as my> 
<#assign mail="fred@acme.com"> 
<@my.copyright date="1999-2002"/> 
${my.mail} 
${mail} 
輸出結果將不會出現衝突

對於庫中的變數修改,使用in關鍵字 
<#assign mail="jsmith@other.com" in my>

函式定義:區別於巨集物件,帶返回值 
<#function name param1 param2><#return val></#function>函式,有返回引數

stringA[M .. N] 取子字串,類似substring(stringA, M, N)

<#include "/copyright_footer.html"> 匯入其他頁面元素 
<#include filename options> 
options包含兩個屬性 
encoding=”GBK” 編碼格式 
parse=true 是否作為ftl語法解析,預設是true,false就是以文字方式引入.注意在ftl檔案里布林值都是直接賦值的如parse=true,而不是

parse=”true”

hash與list的定義 
<#assign c= {"a":"orz","b":"czs"}> 
${c.a}

List片段可以採用: products[10..19] or products[5..] 的格式進行定義,當只侷限於數字 
<#assign c= [1,2,3,4,5,6,6,7]> 
<#list c[1..3] as v> 
${v} 
</#list>

對變數的預設處理 
product.color!"red"

用compress directive或者transform來處理輸出。 
<#compress>...</#compress>:消除空白行。 
<@compress single_line=true>...</@compress>將輸出壓縮為一行。都需要包裹所需文件

freemarker可用"["代替"<".在模板的檔案開頭加上[#ftl].

註釋部分 
<#-- 註釋部分 -->

數字輸出的另外一種方式 
#{c.a;m0} 區別於${},這個例子是用於輸出數字的格式化,保留小數的位數,詳細如下

數字格式化插值可採用#{expr;format}形式來格式化數字,其中format可以是: 
mX:小數部分最小X位 
MX:小數部分最大X位

在定義字串的時候,可以使用''或者"",對特殊字元,需要使用\進行轉義

如果存在大量特殊字元,可以使用${r"..."}進行過濾 
${r"${foo}"} 
${r"C:\foo\bar"}

Map物件的key和value都是表示式,但是key必須是字串 
可以混合使用.和[""]訪問 
book.author["name"] //混合使用點語法和方括號語法

為了處理缺失變數,FreeMarker提供了兩個運算子: 用於防止物件不存在而導致的異常 
!:指定缺失變數的預設值 
??:判斷某個變數是否存在,返回boolean值

noparse指令指定FreeMarker不處理該指定裡包含的內容,該指令的語法格式如下: 
<#noparse>...</#noparse>

${firstName?html} 使用html對字元進行格式化處理,對於<等的過濾

escape , noescape指令,對body內的內容實用統一的表示式 
看如下的程式碼: 
<#escape x as x?html> 
First name:${firstName} 
Last name:${lastName} 
Maiden name:${maidenName} 
</#escape> 
上面的程式碼等同於: 
First name:${firstName?html} 
Last name:${lastName?html} 
Maiden name:${maidenName?html}

定義全域性變數的方式 
<#assign name1=value1 name2=value2 / > // 可以同時定義多個變數,也可以使用迴圈來給變數賦值 
<#assign x> 
<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as n> 
${n} 
</#list> 
</#assign> 
${x}

setting指令,用於動態設定freeMarker的執行環境:

該指令用於設定FreeMarker的執行環境,該指令的語法格式如下:<#setting name=value>,在這個格式中,name的取值範圍包含如下幾個: 
locale:該選項指定該模板所用的國家/語言選項 
number_format:指定格式化輸出數字的格式 
boolean_format:指定兩個布林值的語法格式,預設值是true,false 
date_format,time_format,datetime_format:指定格式化輸出日期的格式 
time_zone:設定格式化輸出日期時所使用的時區

<#return> 用於退出巨集的執行

?html 用於將字串中可能包含的html字元,進行過濾.

呼叫Java方法,需要使用實現TemplateMethodModel介面,但是好像會覆蓋掉屬性的訪問

相關文章