1. 什么是Beetl
Beetl目前版本是2.2.8,相對於其他java模板引擎,具有功能齊全,語法直觀,性能超高,以及編寫的模板容易維護等特點。使得開發和維護模板有很好的體驗。是新一代的模板引擎。總得來說,它的特性如下:
-
功能完備:作為主流模板引擎,Beetl具有相當多的功能和其他模板引擎不具備的功能。適用於*各種應用場景*,從對響應速度有很高要求的大網站到功能繁多的CMS管理系統都適合。Beetl本身還具有很多獨特功能來完成模板編寫和維護,這是其他模板引擎所不具有的。
-
非常簡單:類似Javascript語法和習俗,只要半小時就能通過半學半猜完全掌握用法。拒絕其他模板引擎那種非人性化的語法和習俗。同時也能支持html 標簽,使得開發CMS系統比較容易
-
超高的性能:Beetl 遠超過主流java模板引擎性能(引擎性能5-6倍與freemaker,2倍於JSP。參考附錄),而且消耗較低的CPU
-
易於整合:Beetl能很容易的與各種web框架整合,如Spring MVC,JFinal,Struts,Nutz,Jodd,Servlet等。
-
支持模板單獨開發和測試,即在MVC架構中,即使沒有M和C部分,也能開發和測試模板。
-
擴展和個性化:Beetl支持自定義方法,格式化函數,虛擬屬性,標簽,和HTML標簽. 同時Beetl也支持自定義占位符和控制語句起始符號也支持使用者完全可以打造適合自己的工具包.
2. 基本用法
2.1. 從GroupTemplate開始
1 2 3 4 5 6 7 |
StringTemplateResourceLoader resourceLoader = new StringTemplateResourceLoader(); Configuration cfg = Configuration.defaultConfiguration(); GroupTemplate gt = new GroupTemplate(resourceLoader, cfg); Template t = gt.getTemplate("hello,${name}"); t.binding("name", "beetl"); String str = t.render(); System.out.println(str);
|
Beetl的核心是GroupTemplate,創建GroupTemplate需要倆個參數,一個是模板資源加載器,一個是配置類,模板資源加載器Beetl內置了4種,分別是
-
StringTemplateResourceLoader:字符串模板加載器,用於加載字符串模板,如本例所示
-
FileResourceLoader:文件模板加載器,需要一個根目錄作為參數構造,,傳入getTemplate方法的String是模板文件相對於Root目錄的相對路徑
-
ClasspathResourceLoader:文件模板加載器,模板文件位於Classpath里
-
WebAppResourceLoader:用於webapp集成,假定模板根目錄就是WebRoot目錄,參考web集成章
-
MapResourceLoader : 可以動態存入模板
代碼第5行將變量name傳入模板里,其值是“Beetl”。 代碼第6行是渲染模板,得到輸出,template提供了多種獲得渲染輸出的方法,如下
-
tempalte.render() 返回渲染結果,如本例所示
-
template.renderTo(Writer) 渲染結果輸出到Writer里
-
template.renderTo(OutputStream ) 渲染結果輸出到OutputStream里
2.2. 模板基礎配置
Beetl提供不但功能齊全,而且還有很多獨特功能,通過簡單的配置文件,就可以定義眾多的功能,默認情況下,Configuration類總是會先加載默認的配置文件(位於/org/beetl/core/beetl-default.properties,作為新手,通常只需要關注3,4,5,6行定界符的配置,以及11行模板字符集的配置就可以了,其他配置會在后面章節陸續提到)下,其內容片斷如下:
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 |
#默認配置
ENGINE=org.beetl.core.engine.FastRuntimeEngine
DELIMITER_PLACEHOLDER_START=${
DELIMITER_PLACEHOLDER_END=}
DELIMITER_STATEMENT_START=<%
DELIMITER_STATEMENT_END=%>
DIRECT_BYTE_OUTPUT = FALSE
HTML_TAG_SUPPORT = true
HTML_TAG_FLAG = #
HTML_TAG_BINDING_ATTRIBUTE = var
NATIVE_CALL = TRUE
TEMPLATE_CHARSET = UTF-8
ERROR_HANDLER = org.beetl.core.ConsoleErrorHandler
NATIVE_SECUARTY_MANAGER= org.beetl.core.DefaultNativeSecurityManager
MVC_STRICT = FALSE
\#資源配置,resource后的屬性只限於特定ResourceLoader
RESOURCE_LOADER=org.beetl.core.resource.ClasspathResourceLoader
#classpath 根路徑
RESOURCE.root= /
#是否檢測文件變化
RESOURCE.autoCheck= true
#自定義腳本方法文件的Root目錄和后綴
RESOURCE.functionRoot = functions
RESOURCE.functionSuffix = html
#自定義標簽文件Root目錄和后綴
RESOURCE.tagRoot = htmltag
RESOURCE.tagSuffix = tag
##### 擴展 ##############
## 內置的方法
FN.date = org.beetl.ext.fn.DateFunction
......
##內置的功能包
FNP.strutil = org.beetl.ext.fn.StringUtil
......
##內置的默認格式化函數
FTC.java.util.Date = org.beetl.ext.format.DateFormat
.....
## 標簽類
TAG.include= org.beetl.ext.tag.IncludeTag
|
第2行配置引擎實現類,默認即可.
第3,4行指定了占位符號,默認是${ }.也可以指定為其他占位符。
第5,6行指定了語句的定界符號,默認是<% %>,也可以指定為其他定界符號
第7行指定IO輸出模式,默認是FALSE,即通常的字符輸出,在考慮高性能情況下,可以設置成true。詳細請參考高級用法
第8,9行指定了支持HTML標簽,且符號為#,默認配置下,模板引擎識別<#tag ></#tag>這樣的類似html標簽,並能調用相應的標簽函數或者模板文件。你也可以指定別的符號,如bg: 則識別<bg:
第10行 指定如果標簽屬性有var,則認為是需要綁定變量給模板的標簽函數
第11行指定允許本地Class直接調用
第12行指定模板字符集是UTF-8
第13行指定異常的解析類,默認是ConsoleErrorHandler,他將在render發生異常的時候在后台打印出錯誤信息(System.out)。
第14行指定了本地Class調用的安全策略
第15行配置了是否進行嚴格MVC,通常情況下,此處設置為false.
第18行指定了默認使用的模板資源加載器
第20到22行配置了模板資源加載器的一些屬性,如設置根路徑為/,即Classpath的頂級路徑,並且總是檢測模板是否更改
第23行配置了自定義的方法所在的目錄以及文件名后綴。beetl既支持通過java類定義方法,也支持通過模板文件來定義方法
第26行配置了自定義的html標簽所在的目錄以及文件名后綴。beetl既支持通過java類定義標簽,也支持通過模板文件來定義標簽
第31行注冊了一個date方法,其實現類是org.beetl.ext.fn.DateFunction
第34行注冊了一個方法包strutil,其實現類org.beetl.ext.fn.StringUtil,此類的每個public方法都將注冊為beetl的方法
第37行注冊了一個日期格式化函數
第40行注冊了一個include標簽函數
2.3. 模板資源加載器
資源加載器是根據String值獲取Resource實例的工場類,同時資源加載器還要負責響應模板引擎詢問模板是否變化的調用。對於新手來說,無需考慮模板資源加載器如何實現,只需要根據自己場景選擇系統提供的三類模板資源加載器即可
2.3.1. 字符串模板加載器
在創建GroupTemplate過程中,如果傳入的是StringTemplateResourceLoader,則允許通過調用gt.getTemplate(String template)來獲取模板實例對象,如2.1所示
2.3.2. 文件資源模板加載器
更通常情況下,模板資源是以文件形式管理的,集中放在某一個文件目錄下(如webapp的模板根目錄就可能是WEB-INF/template里),因此,可以使用FileResourceLoader來加載模板實例,如下代碼:
1 2 3 4 5 6 7 |
String root = System.getProperty("user.dir")+File.separator+"template"; FileResourceLoader resourceLoader = new FileResourceLoader(root,"utf-8"); Configuration cfg = Configuration.defaultConfiguration(); GroupTemplate gt = new GroupTemplate(resourceLoader, cfg); Template t = gt.getTemplate("/s01/hello.txt"); String str = t.render(); System.out.println(str);
|
第1行代碼指定了模板根目錄,即位於項目工程下的template目錄 第2行構造了一個資源加載器,並指定字符集為UTF-8 (也可不指定,因為配置文件默認就是UTF-8); 第5行通過模板的相對路徑/s01/hello.txt來加載模板
2.3.3. Classpath資源模板加載器
還有種常情況下,模板資源是打包到jar文件或者同Class放在一起,因此,可以使用ClasspathResourceLoader來加載模板實例,如下代碼:
1 2 3 4 5 6 |
ClasspathResourceLoader resourceLoader = new ClasspathResourceLoader(); Configuration cfg = Configuration.defaultConfiguration(); GroupTemplate gt = new GroupTemplate(resourceLoader, cfg); Template t = gt.getTemplate("/org/beetl/sample/s01/hello.txt"); String str = t.render(); System.out.println(str);
|
第1行代碼指定了模板根目錄,即搜索模板的時候從根目錄開始,如果new ClasspathResourceLoader("/template"),則表示搜索/template下的模板。此處用空構造函數,表示搜索路徑是根路徑,且字符集默認字符集UTF-8.
第4行通過模板的相對路徑org/beetl/sample/s01/hello.txt來加載模板
2.3.4. WebApp資源模板加載器
WebAppResourceLoader 是用於web應用的資源模板加載器,默認根路徑是WebRoot目錄。也可以通過制定root屬性來設置相對於WebRoot的的模板根路徑,從安全角考慮,建議放到WEB-INF目錄下
如下是Jfinal集成 里初始化GroupTemplate的方法
1 2 3 |
Configuration cfg = Configuration.defaultConfiguration(); WebAppResourceLoader resourceLoader = new WebAppResourceLoader(); groupTemplate = new GroupTemplate(resourceLoader, cfg);
|
2.3.5. 自定義資源模板加載器
有時候模板可能來自文件系統不同目錄,或者模板一部分來自某個文件系統,另外一部分來自數據庫,還有的情況模板可能是加密混淆的模板,此時需要自定義資源加載,繼承ResouceLoader才能實現模板功能,這部分請參考高級部分
2.4. 定界符與占位符號
Beetl模板語言類似JS語言和習俗,只需要將Beetl語言放入定界符號里即可,如默認的是<% %> ,占位符用於靜態文本里嵌入占位符用於輸出,如下是正確例子
1 2 3 4 5 6 |
<%
var a = 2; var b = 3; var result = a+b; %> hello 2+3=${result}
|
千萬不要在定界符里使用占位符號,因為占位符僅僅嵌在靜態文本里,如下例子是錯誤例子
1 2 3 4 |
<%
var a = "hi"; var c = ${a}+"beetl"; //應該是var c = a+"beetl" %>
|
每次有人問我如上例子為啥不能運行的時候,我總是有點憎惡velocity 帶來的這種非人性語法
定界符號里是表達式,如果表達式跟定界符有沖突,可以在表達式里用 “\” 符號,如
1 2 |
${[1,2,3]} //輸出一個json列表 ${ {key:1,value:2 \} } //輸出一個json map,} 需要加上\
|
定界符和占位符 通常還有別的選擇,如下定界符
-
@ 和回車換行 (此時,模板配置DELIMITER_STATEMENT_END= 或者 DELIMITER_STATEMENT_END=null 都可以)
-
#: 和回車換行
-
<!--: 和 -→
-
<!--# 和 -→
-
<? 和 ?>
占位符: - - #{ } - # #
你也可以與團隊達成一致意見來選擇團隊喜愛擇定界符號和占位符號。
2.5. 注釋
Beetl語法類似js語法,所以注釋上也同js一樣: 單行注釋采用//
多行注視采用/**/
1 2 3 4 5 6 7 8 |
<%
/*此處是一個定義變量*/ var a = 3; //定義一個變量. /* 以下內容都將被注釋 %> <% */ %>
|
第2行是一個多行注釋
第3行是一個單行注釋
第5行到第8行采用的是多行注釋,因此里面有內容也是注釋,模板將不予處理
2.6. 臨時變量定義
在模板中定義的變量成為臨時變量,這類似js中采用var 定義的變量,如下例子
1 2 3 4 5 6 7 8 |
<%
var a = 3; var b = 3,c = "abc",d=true,e=null; var f = [1,2,3]; var g = {key1:a,key2:c}; var i = a+b; %>
|
2.7. 全局變量定義
全局變量是通過template.binding傳入的變量,這些變量能在模板的任何一個地方,包括子模板都能訪問到。如java代碼里
1 2 3 4 5 6 7 8 |
template.binding("list",service.getUserList()); //在模板里 <% for(user in list){ %> hello,${user.name}; <%}%>
|
2.8. 共享變量
共享變量指在所有模板中都可以引用的變量,可過groupTemplate.setSharedVars(Map<String, Object> sharedVars)傳入的變量,這些變量能在 所有模板 的任何一個地方
1 2 3 4 5 6 7 8 9 10 11 |
.....
GroupTemplate gt = new GroupTemplate(resourceLoader, cfg); Map<String,Object> shared = new HashMap<String,Object>(); shared.put("name", "beetl"); gt.setSharedVars(shared); Template t = gt.getTemplate("/org/beetl/sample/s0208/t1.txt"); String str = t.render(); System.out.println(str); t = gt.getTemplate("/org/beetl/sample/s0208/t2.txt"); str = t.render(); System.out.println(str);
|
1 2 3 4 |
//t1.txt
hi,${name} //t2.txt hello,${name}
|
2.9. 模板變量
模板變量是一種特殊的變量,即可以將模板中任何一段的輸出賦值到該變量,並允許稍后在其他地方使用,如下代碼
1 2 3 4 5 6 7 8 |
<%
var content = { var c = "1234"; print(c); %> 模板其他內容: <%}; %>
|
第2行定義了一個模板變量content = { …} ; 此變量跟臨時變量一樣,可以在其他地方使用,最常見的用戶是用於復雜的布局。請參考高級用法布局
2.10. 引用屬性
屬性引用是模板中的重要一部分,beetl支持屬性引用如果javascript的支持方式一樣,如下
1 Beetl支持通過”.”號來訪問對象的的屬性,如果javascript一樣。如果User對象有個getName()方法,那么在模板中,可以通過${xxx.name}來訪問
2 如果模板變量是數組或者List類,這可以通過[] 來訪問,如${userList[0]}
3 如果模板變量是Map類,這可以通過[]來訪問,如${map[“name”]},如果key值是字符串類型,也可以使用${map.name}.但不建議這么使用,因為會讓模板閱讀者誤以為是一個Pojo對象
4 Beetl也支持Generic Get方式,即如果對象有一個public Object get(String key)方法,可以通過”.”號或者[]來訪問,譬如 ${activityRecord.name}或者${activityRecord[“name”] }都將調用activityRecord的 get(String key)方法。如果對象既有具體屬性,又有Generic get(這種模型設計方式是不值得鼓勵),則以具體屬性優先級高.
5 Beetl也可以通過[]來引用屬性,如${user[“name”]} 相當於${user.name}.這跟javascript保持一致。但建議不這么做,因為容易讓閱讀模板的人誤認為這是一個Map類型
6 Beetl 還可以定位額外的對象屬性,而無需更改java對象,這叫着虛擬屬性,如,對於所有集合,數組,都有共同的虛擬熟悉size.虛擬屬性是“.~”+虛擬1屬性名
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
template.binding("list",service.getUserList()); template.binding("pageMap",service.getPage()); //在模板里 總共 ${list.~size} <% for(user in list){ %> hello,${user.name}; <%}%> 當前頁${pageMap['page']},總共${pageMap["total"]}
|
2.11. 算數表達式
Beetl支持類似javascript的算術表達式和條件表達式,如+ - * / % 以及(),以及自增++,自減--
1 2 3 4 5 6 7 8 |
<%
var a = 1; var b = "hi"; var c = a++; var d = a+100.232; var e = (d+12)*a; var f = 122228833330322.1112h %>
|
Beetl里定義的臨時變量類型默認對應的java是Int型或者double類型,對於模板常用情況說,已經夠了.如果需要定義長精度類型(對應java的BigDecimal),則需要在數字末尾加上h以表示這是長精度BigDecimal,其后的計算和輸出以及邏輯表達式都將按照長精度類型來考慮。
2.12. 邏輯表達式
Beetl支持類似Javascript,java的條件表達式 如>, <, == ,!=,>= , ⇐ 以及 !, 還有&&和 || ,還有三元表達式等,如下例子
1 2 3 4 5 6 7 8 9 |
<%
var a = 1; var b=="good"; var c = null; if(a!=1&&b=="good"&&c==null){ ...... } %>
|
三元表達式如果只考慮true條件對應的值的話,可以做簡化,如下倆行效果是一樣的。
1 2 3 4 5 |
<%
var a = 1 ; %> ${a==1?"ok":''} ${a==1?"ok"}
|
2.13. 循環語句
Beetl支持豐富的循環方式,如for-in,for(exp;exp;exp),以及while循環,以及循環控制語句break;continue; 另外,如果沒有進入for循環體,還可以執行elsefor指定的語句。
2.13.1. for-in
for-in循環支持遍歷集合對象,對於List和數組來說以及Iterator,對象就是集合對象,對於Map來說,對象就是Map.entry,如下倆個例子
1 2 3 4 5 6 7 |
<%
for(user in userList){ print(userLP.index); print(user.name); } %>
|
第三行代碼userLP是Beetl隱含定義的變量,能在循環體內使用。其命名規范是item名稱后加上LP,他提供了當前循環的信息,如
-
userLP.index :當前的索引,從1開始
-
userLP.size:集合的長度
-
userLP.first 是否是第一個
-
userLP.last 是否是最后一個
-
userLP.even 索引是否是偶數
-
userLP.odd 索引是否是奇數
如下是Map使用例子
1 2 3 4 5 6 7 8 |
<%
for(entry in map){ var key = entry.key; var value = entry.value; print(value.name); } %>
|
2.13.2. for(exp;exp;exp)
對於渲染邏輯更為常見的是經典的for循環語句,如下例子
1 2 3 4 5 6 |
<%
var a = [1,2,3]; for(var i=0;i<a.~size;i++){ print(a[i]); } %>
|
2.13.3. while
對於渲染邏輯同樣常見的有的while循環語句,如下例子
1 2 3 4 5 6 7 |
<%
var i = 0; while(i<5){ print(i); i++; } %>
|
2.13.4. elsefor
不同於通常程序語言,如果沒有進入循環體,則不需額外的處理,模板渲染邏輯更常見情況是如果沒有進入循環體,還需要做點什么,因此,對於for循環來說,還有elsefor 用來表達如果循環體沒有進入,則執行elsefor 后的語句
1 2 3 4 5 6 7 8 |
<%
var list = []; for(item in list){ }elsefor{ print("未有記錄"); } %>
|
2.14. 條件語句
2.14.1. if else
同js一樣,支持if else,如下例子
1 2 3 4 5 6 7 8 9 10 11 12 |
<%
var a =true; var b = 1; if(a&&b==1){ }else if(a){ }else{ } %>
|
2.14.2. switch-case
同js一樣,支持switch-case,如下例子
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<%
var b = 1; switch(b){ case 0: print("it's 0"); break; case 1: print("it's 1"); break; default: print("error"); } %>
|
2.14.3. select-case
select-case 是switch case的增強版。他允許case 里有邏輯表達式,同時,也不需要每個case都break一下,默認遇到合乎條件的case執行后就退出。
1 2 3 4 5 6 7 8 9 10 11 12 |
<%
var b = 1; select(b){ case 0,1: print("it's small int"); case 2,3: print("it's big int"); default: print("error"); } %>
|
select 后也不需要一個變量,這樣case 后的邏輯表達式將決定執行哪個case.其格式是
1 2 3 4 5 6 |
select { case boolExp,orBoolExp2: doSomething(); } %>
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<%
var b = 1; select{ case b<1,b>10: print("it's out of range"); break; case b==1: print("it's 1"); break; default: print("error"); } %>
|
2.15. try-catch
通常模板渲染邏輯很少用到try-catch 但考慮到渲染邏輯復雜性,以及模板也有不可控的地方,所以提供try catch,在渲染失敗的時候仍然能保證輸出正常
1 2 3 4 5 6 7 8 |
<%
try{ callOtherSystemView() }catch(error){ print("暫時無數據"); } %>
|
error代表了一個異常,你可以通過error.message 來獲取可能的錯誤信息
也可以省略catch部分,這樣出現異常,不做任何操作
2.16. 虛擬屬性
虛擬屬性也是對象的屬性,但是虛擬的,非模型對象的真實屬性,這樣的好處是當模板需要額外的用於顯示的屬性的時候但又不想更改模型,便可以采用這種辦法 如beetl內置的虛擬屬性.~size 針對了數組以及集合類型。
1 2 |
${user.gender} ${user.~genderShowName}
|
~genderShowName 是虛擬屬性,其內部實現根據boolean變量gender來顯示性別
如何完成虛擬屬性,請參考高級用法
2.17. 函數調用
Beetl內置了少量實用函數,可以在Beetl任何地方調用。如下例子是調用date 函數,不傳參數情況下,返回當前日期
1 2 3 4 5 6 |
<%
var date = date(); var len = strutil.length("cbd"); println("len="+len); %>
|
注意函數名支持namespace方式,因此代碼第3行調用的函數是strutil.length
Beetl內置函數請參考附錄,以下列出了常用的函數
-
date 返回一個java.util.Date類型的變量,如 date() 返回一個當前時間(對應java的java.util.Date); ${date( "2011-1-1" , "yyyy-MM-dd" )} 返回指定日期
-
print 打印一個對象 print(user.name);
-
println 打印一個對象以及回車換行符號,回車換號符號使用的是模板本身的,而不是本地系統的.如果僅僅打印一個換行符,則直接調用println() 即可
-
nvl 函數nvl,如果對象為null,則返回第二個參數,否則,返回自己 nvl(user,"不存在")
-
isEmpty 判斷變量或者表達式是否為空,變量不存在,變量為null,變量是空字符串,變量是空集合,變量是空數組,此函數都將返回true
-
isNotEmpty 同上,判斷對象是否不為空
-
has 變量名為參數,判斷是否存在此全局變量,如 has(userList),類似於1.x版本的exist("userList"),但不需要輸入引號了
-
assert 如果表達式為false,則拋出異常
-
trunc 截取數字,保留指定的小數位,如trunc(12.456,2) 輸出是12.45
-
decode 一個簡化的if else 結構,如 decode(a,1,"a=1",2,"a=2","不知道了")},如果a是1,這decode輸出"a=1",如果a是2,則輸出"a==2", 如果是其他值,則輸出"不知道了"
-
debug 在控制台輸出debug指定的對象以及所在模板文件以及模板中的行數,如debug(1),則輸出1 [在3行@/org/beetl/core/lab/hello.txt],也可以輸出多個,如debug("hi",a),則輸出hi,a=123,[在3行@/org/beetl/core/lab/hello.txt]
-
parseInt 將數字或者字符解析為整形 如 parseInt("123");
-
parseLong 將數字或者字符解析為長整形,parseInt(123.12);
-
parseDouble 將數字或者字符解析為浮點類型 如parseDouble("1.23")
-
range 接收三個參數,初始值,結束值,還有步增(可以不需要,則默認為1),返回一個Iterator,常用於循環中,如for(var i in range(1,5)) {print(i)},將依次打印1234.
-
flush 強制io輸出。
-
json,將對象轉成json字符串,如 var data = json(userList) 可以跟一個序列化規則 如,var data = json(userList,"[*].id:i"),具體參考https://git.oschina.net/xiandafu/beetl-json
-
pageCtx ,僅僅在web開發中,設置一個變量,然后可以在頁面渲染過程中,調用此api獲取,如pageCtx("title","用戶添加頁面"),在其后任何地方,可以pageCtx("title") 獲取該變量
2.18. 安全輸出
安全輸出是任何一個模板引擎必須重視的問題,否則,將極大困擾模板開發者。Beetl中,如果要輸出的模板變量為null,則beetl將不做輸出,這點不同於JSP,JSP輸出null,也不同於Feemarker,如果沒有用!,它會報錯.
模板中還有倆種情況會導致模板輸出異常
-
有時候模板變量並不存在(譬如子模板里)
-
模板變量為null,但輸出的是此變量的一個屬性,如${user.wife.name}
針對前倆種種情況,可以在變量引用后加上!以提醒beetl這是一個安全輸出的變量。
如${{user.wife.name! },即使user不存在,或者user為null,或者user.wife為null,或者user.wife.name為null beetl都不將輸出
可以在!后增加一個常量(字符串,數字類型等),或者另外一個變量,方法,本地調用,作為默認輸出,譬如:
${user.wife.name!”單身”},如果user為null,或者user.wife為null,或者user.wife.name為null,輸出”單身”
譬如
${user.birthday!@System.constants.DefaultBir}, 表示如果user為null,或者user. birthday為null,輸出System.constants.DefaultBir
還有一種情況很少發生,但也有可能,輸出模板變量發生的任何異常,如變量內部拋出的一個異常
這需要使用格式${!(變量)},這樣,在變量引用發生任何異常情況下,都不作輸出,譬如
${!(user.name)},,beetl將會調用user.getName()方法,如果發生異常,beetl將會忽略此異常,繼續渲染
值得注意的是,在變量后加上!不僅僅可以應用於占位符輸出(但主要是應用於占位符輸出),也可以用於表達式中,如:
1 2 3 4 5 6 7 8 |
<%
<% var k = user.name!'N/A'+user.age!; %> ${k} %>
|
如果user為null,則k值將為N/A
在有些模板里,可能整個模板都需要安全輸出,也可能模板的部分需要安全輸出,使用者不必為每一個表達式使用!,可以使用beetl的安全指示符號來完成安全輸出 如:
1 2 3 4 5 6 7 8 9 |
<%
DIRECTIVE SAFE_OUTPUT_OPEN; %> ${user.wife.name} 模板其他內容,均能安全輸出…… <% //關閉安全輸出。 DIRECTIVE SAFE_OUTPUT_CLOSE; %>
|
Beetl不建議每一個頁面都使用DIRECTIVE SAFE_OUTPUT_OPEN,這樣,如果如果真有不期望的錯誤,不容易及時發現,其次,安全輸出意味着beetl會有額外的代碼檢測值是否存在或者是否為null,性能會略差點。所以建議及時關閉安全輸出(這不是必須的,但頁面所有地方是安全輸出,可能不容易發現錯誤)
在for-in 循環中 ,也可以為集合變量增加安全輸出指示符號,這樣,如果集合變量為null,也可以不進入循環體,如:
1 2 3 4 5 6 7 8 |
<%
var list = null; for(item in list!){ }eslefor{ print("no data"); } %>
|
2.18.1. 變量是否存在
判斷變量是否存在,可以采用內置的has或者isEmpty方法來判斷,參數是變量,如
1 2 3 4 5 |
<%
if(has(flag)){ print("not exit") } %>
|
如果需要判斷變量是否存在,如果存在,還有其他判斷條件,通常都這么寫
1 2 3 4 5 |
<%
if(has(flag)||flag==0){ //code } %>
|
如果flag不存在,或者flag存在,但值是0,都將執行if語句
但是,有更為簡便的方法是直接用安全輸出,如
1 2 3 4 5 |
<%
if(flag!0==0){ //code } %>
|
flag!0 取值是這樣的,如果flag不存在,則為0,如果存在,則取值flag的值,類似三元表達式 has(flag)?falg:0
2.18.2. 安全輸出表達式
安全輸出表達式可以包括
-
字符串常量,如 ${user.count!"無結果"}
-
boolean常量 ${user.count!false}
-
數字常量,僅限於正數,因為如果是負數,則類似減號,容易誤用,因此,如果需要表示負數,請用括號,如${user.count!(-1)}
-
class直接調用,如${user.count!@User.DEFAULT_NUM}
-
方法調用,如 ${user.count!getDefault() }
-
屬性引用,如 ${user.count!user.maxCount }
-
任何表達式,需要用括號
2.19. 格式化
幾乎所有的模板語言都支持格式化,Beetl也不列外,如下例子Beetl提供的內置日期格式
1 2 3 4 |
<% var date = date(); %> Today is ${date,dateFormat="yyyy-MM-dd"}. Today is ${date,dateFormat} salary is ${salary,numberFormat="##.##"}
|
格式化函數只需要一個字符串作為參數放在=號后面,如果沒有為格式化函數輸入參數,則使用默認值,dateFormat格式化函數默認值是local
Beetl也允許為指定的java class設定格式化函數,譬如已經內置了對java.util.Date,java.sql.Date 設置了了格式化函數,因此上面的例子可以簡化為
1 |
${date,“yyyy-MM-dd”}.
|
Beetl針對日期和數字類型提供的默認的格式化函數,在org/beetl/core/beetl-default.properties里,注冊了
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
##內置的格式化函數 FT.dateFormat = org.beetl.ext.format.DateFormat FT.numberFormat = org.beetl.ext.format.NumberFormat ##內置的默認格式化函數 FTC.java.util.Date = org.beetl.ext.format.DateFormat FTC.java.sql.Date = org.beetl.ext.format.DateFormat FTC.java.sql.Time = org.beetl.ext.format.DateFormat FTC.java.sql.Timestamp = org.beetl.ext.format.DateFormat FTC.java.lang.Short = org.beetl.ext.format.NumberFormat FTC.java.lang.Long = org.beetl.ext.format.NumberFormat FTC.java.lang.Integer = org.beetl.ext.format.NumberFormat FTC.java.lang.Float = org.beetl.ext.format.NumberFormat FTC.java.lang.Double = org.beetl.ext.format.NumberFormat FTC.java.math.BigInteger = org.beetl.ext.format.NumberFormat FTC.java.math.BigDecimal = org.beetl.ext.format.NumberFormat FTC.java.util.concurrent.atomic.AtomicLong = org.beetl.ext.format. |