1. 程式人生 > >FreeMarker常用標籤介紹

FreeMarker常用標籤介紹

FreeMarker標籤使用 
一、FreeMarker模板檔案主要有4個部分組成
  1、文字,直接輸出的部分
  2、註釋,即<#--...-->格式不會輸出
  3、插值(Interpolation):即${..}或者#{..}格式的部分,將使用資料模型中的部分替代輸出
  4、FTL指令:FreeMarker指令,和HTML標記類似,名字前加#予以區分,不會輸出。
  
  FTL指令規則
    FreeMarker有三種FTL標籤,這和HTML的標籤是完全類似的
     開始標籤:<#directivename parameters>
     結束標籤:</#directivename>
     空標籤: <#directivename parameters />
     實際上,使用標籤時前面的#符號也可能變成@,如果該指令是一個使用者指令而不是系統內建指令時,應將#符號改為@符號
  
   插值規則
     FreeMarker的插值有如下兩種型別
     1、通用插值:${expr}
     2、數字格式化插值:#{expr}或者#{expr;format}
    
    通用插值,有可以分為四種情況
    a、插值結果為字串值:直接輸出表達式結果
    b、插值結果為數字值:根據預設格式(#setting 指令設定)將表示式結果轉換成文字輸出。可以使用內建的字串函式格式單個插值,例如
       <#setting number_format = "currency" />
       <#assign price = 42 />
       ${price}
       ${price?string}
       ${price?string.number}
       ${price?string.currency}
       ${price?string.percent}
    
   c、輸出值為日期值:根據預設格式(由 #setting 指令設定)將表示式結果轉換成文字輸出,可以使用內建的字串函式格式化單個插值,例如
      <#assign lastUpdated = "2009-01-07 15:05"?datetime("yyyy-MM-dd HH:mm") />
      ${lastUpdated?string("yyyy-MM-dd HH:mm:ss zzzz")};
      ${lastUpdated?string("EEE,MMM d,yy")};
      ${lastUpdated?string("EEEE,MMMM dd,yyyy,hh:mm:ss a '('zzz')'")};
      ${lastUpdated?string.short};
      ${lastUpdated?string.long};
      ${lastUpdated?String.full};
   d、插值結果為布林值
      <#assign foo=true />
      ${foo?string("是foo","非foo")}
      
   數字格式化插值
     數字格式化插值可採用#{expr;format}的形式來格式化數字,其中format可以是:
     mX:小數部分最小X位
     MX:小數部分最大X位
     例如:
        <#assign x = 2.582 />
        <#assign y =4 />
        #{x;M2};
        #{y;M2};
        #{x;m1};
        #{y;m1};
        #{x;m1M2};
        #{y:m1M2};
       

二、表示式
    表示式是FreeMarker的核心功能。表示式放置在插值語法(${...})之中時,表面需要輸出表達式的值,表示式語法也可以與FreeMarker標籤結合,用於控制輸出
    
    1、直接指定值
      例如:
      a、字串
         ${'我的名字是\"yeek\"'};
         ${"我的檔案儲存在d:\\盤"};
      b、數值
      c、布林值
      d、日期型
         FreeMarker支援date、time、datetime三種類型,這三種類型的值無法直接指定,通常需要藉助字串的date、time、datetime三個內建函式進行轉換才可以
           <#assign test1 = "2009-01-22"?date("yyyy-MM-dd") />;
           <#assign test2 ="16:34:43"?time("HH:mm:ss") />
           <#assign test2 = "2009-01-22 17:23:45"?datetime("yyyy-MM-dd HH:mm:ss") />
           ${test1?string.full}
      e、集合
        集合以方括號包括,各集合元素之間以英文逗號(,)分隔,看如下的示例:
      <#list["星期一",,["星期二",["星期三",["星期四",["星期五"] as x>
         ${s};
        </#list>
      f、Map集合
         Map物件使用花括號包括,Map中的key-value對之間以英文冒號(:)隔開,多組key-value對之間以英文逗號(,) 隔開
           例如
           <#assign score = {"語文":78,"數學":83,"Java":89} >
             <#list score?key as x>
              ${x}--->${score[x]};
             </#list>
             
             
      2、輸出變數值
          FreeMarker的表示式輸出變數時,這些變數可以是頂層變數,也可以是Map物件中的變數,還可以是集合中的變數,並可以使用點(.)語法來訪問Java物件的屬性
          a、頂層變數
             Map root = new HashMap();
             root.put("name","wenchao");
             對應頂層變數,直接使用${variableName}來輸出變數值,變數名只能是數字、字母、下劃線、$、@和#的組合,並不能以數字開頭
          b、輸出集合元素
             如果需要輸出集合元素,則可以根據集合元素的索引來輸出元素。集合元素的索引以方括號指定。
             假設有集合物件為:["星期一","星期二","星期三","星期四","星期五","星期六"],該集合物件名為week, 如果需要輸出星期三,則可以使用如下語法:
                ${week[2]}
             集合裡的第一個元素的索引是0
          c、輸出Map元素
              這裡的Map物件可以是直接HashMap的例項,甚至包括 JavaBean例項,對應JavaBean例項,我們一樣可以把其當成屬性為key,屬性為value的Map例項
              
              
      3、字串操作
         a、字串連結
           字串連線有兩種語法
           A、使用${..}(或#{..})在字串常量部分插入表示式的值,從而完成字串連線
           B、直接使用連線運算子(+)來連線字串
             使用第一種語法來連線字串
             ${"Hello,${user}!"}
              第二種使用連線符號來連線字串
             ${"Hello,"+user+"!"};
               值的注意的是,${..}只能用於文字部分,因此,下面的程式碼是錯誤的:
                 <#if ${isBig}>Wow!</#if>
                 <#if "${isBig}">Wow!</#if>
                 應該寫成:
                 <#if isBig>Wow!</#if>
         
         b、擷取字串
            Map root = new HashMap();
            root.put("book","瘋狂Ajax講義");
            
            ${book[0]}
            ${book[4]}
            ${book[1..4]}
            
      4、集合連線運算子
        這裡所說的集合連線運算時將兩個集合連線成一個新的集合,連線集合的運算子是+,例如
        <#list ["星期一"," 星期二","星期三"]+["星期四","星期五"] as x>
           ${x}
        </#list>
        
      5、Map連線運算子
             Map物件的連線運算也是將兩個Map物件連線成一個新的Map物件,Map物件的連線運算子是+。如果兩個Map物件具有相同的 key,則後加入Map裡的key所
         對應的value替代原來key所對應的value
         
      6、算術運算子
         FreeMarker表示式中完全支援算術運算,FreeMarker支援的算術運算子包括: +,-,*,/,%
         看如下程式碼示範
           <#assign x = 5 />
           ${x* -100}
           ${x/2}
           ${12%10}
         在表示式中使用算術運算時要注意以下幾點。
         A、運算子兩邊的運算數必須是數字,因此下面的程式碼是錯誤的:
           ${3*"5"}
         B、使用+(既可以作為加號,也可以作為字串連線運算子)運算時,如果一邊是數字,一邊是字串,就會自動將數字轉化為字串。例如
            ${3+"5"}
            輸出結果:35
         C、使用內建的int函式可對數值取整。例如
            <#assign x = 5>
            ${(x/2)?int}
            ${1.1?int}
            ${1.999?int}
            ${-1.9999?int}
            ${-1.1?int}
       
       7、比較運算子
           表示式中支援的比較運算子有如下幾個
           a、=(或者==):判斷兩個值是否相等.
           b、!=:判斷兩個值是否不相等
           c、 >(或者gt):判斷座標值是否大於右邊值
           d、 >=(或者gte):判斷座標值是否大於等於右邊值
           e、 <(或者lt):判斷左邊值是否小於右邊值
           f、 <=(或者lte):判斷左邊值是否小於等於右邊值          
                
            
       8、邏輯運算子
          邏輯運算子有如下幾個
          a、邏輯與:&&
          b、邏輯或:||
          c、邏輯非:!
          邏輯運算子只能作用於布林值,否則將產生錯誤。
          
       9、內建函式
          FreeMarker還提供了一些內建函式來轉換輸出,可以在任何變數後緊跟?,?後緊跟內建函式,就可通過內建函式來轉換輸出變數
          下面是常用的內建的字串函式
          a、html:對字串進行HTML編碼
          b、cap_first:將字串第一個字母成大寫
          c、lower_case:將字串轉換成小寫
          d、upper_case:將字串轉換成大寫
          e、trim: 去掉字串前後的空白字元
          下面是集合的常用的內建函式
          a、size: 獲得序列中元素的數目
          
          下面是數字值的常用的內建函式
          a、int 取得數字的整數部分
          例如
          <#assign test="Tom & Jerry" />
          ${test?html}
          ${test?upper_case?html}
          
       10、空值處理運算子
          FreeMarker對空值的處理非常嚴格,FreeMarker的變數必須有值,沒有被賦值的變數就會丟擲異常。
          
          
       11、運算子優先順序
          
  三、FreeMarker 的常用指令
     1、if指令
        分支控制語句
        語法格式如下
       <#if condition>
            ....
       <#elseif condition2>
          ...
       <#elseif condition3>      
          ...
       <#else>
          ...
       </#if>
     
     2、switch、case、default、break指令
        <#switch value>
           <#case refValue>
              ...
              <#bread>
           <#case refValue>
              ...
              <#bread>
           <#default>
              ...
        </#switch>
        雖然FreeMarker提供了switch指令,但它並不推薦使用switch指令來控制也輸出,而是推薦使用FreeMarker的if..elseif..else 指令來替代它。
        
    3、list、break指令
    list指令時一個典型的迭代輸出指令,用於迭代輸出資料模型中的集合。list指令的語法格式如下:
     <#list sequence as item>
       ...
     </#list>
      除此之外,迭代集合物件時,還包括兩個特殊的迴圈變數:
      a、item_index:當前變數的索引值。
      b、item_has_next:是否存在下一個物件
      也可以使用<#break>指令跳出迭代
      <#list ["星期一","星期二","星期三","星期四","星期五"] as x>
          ${x_index +1}.${x} <#if x_has_next>,</#if>
          <#if x = "星期四"><#break></#if>
      </#list>
      
      4、include 指令
        include指令的作用類似於JSP的包含指令,用於包含指定頁,include指令的語法格式如下
         <#include filename [options]
          在上面的語法格式中,兩個引數的解釋如下
          a、filename:該引數指定被包含的模板檔案
          b、options:該引數可以省略,指定包含時的選項,包含encoding和parse兩個選項,encoding指定包含頁面時所使用的解碼集,而parse指定被
             包含是否作為FTL檔案來解析。如果省略了parse選項值,則該選項值預設是true
     5、 import指令
        該指令用於匯入FreeMarker模板中的所有變數,並將該變數放置在指定的Map物件中,import 指令的語法格式如下
        <#import path as mapObject>
        在上面的語法格式中,path指定要被匯入的模板檔案,而mapObject是一個Map物件名,通過這行程式碼,將導致path模板中的所有變數都被放置
        在mapObject中
        <#import "/lib/common.ftl" as com>
     
     6、noparse指令
         noparse指令指定FreeMarker不處理該指令裡包含的內容,該指令的語法格式如下:
         <#noparse>
            ...
         </#noparse>
         
     7、escape、noescape指令
       
       
     8、assign指令
        它用於為該模板頁面建立或替換一個頂層變數
        
     9、setting指令
        該指令用於設定FreeMarker的執行環境,該指令的語法格式如下:
        <#setting name = value>
        name 的取值範圍包括如下幾個
         locale :該選項指定該模板所用的國家/語言選項
         number_format:該選項指定格式化輸出數字的格式
         boolean_format:該選項指定兩個布林值的語法格式,預設值是"true、false"
         date_format,time_format,datetime_format:該選項指定格式化輸出日期的格式
         time_zone:  設定格式化輸出日期時所使用的時區
     10、macro、nested、return指令

參考資料:http://www.blogjava.net/kxbin/articles/366505.html