FreeMarker

最新推荐文章于 2024-03-15 13:44:31 发布

原创最新推荐文章于 2024-03-15 13:44:31 发布 · 461 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#freemarker

JavaWeb 专栏收录该内容

5 篇文章

订阅专栏

本文介绍了FreeMarker模板引擎的特点和用途，包括其在MVC架构中的角色、与容器的独立性以及如何生成多种类型的文本输出。同时，文章还详细解释了FreeMarker的基本语法，如变量表达式、条件语句、循环操作、宏定义等，并提供了多个示例说明如何在实际项目中运用这些功能。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、FreeMarker技术概述
1.FreeMarker是一个用Java语言编写的模板引擎，它基于模板来生成文本输出。
特点：
（1）Freemarker适合被设计用来生成HTML WEb页面，特别是基于MVC模式的应用程序。
（2）虽然Freemarker具有一些编程能力，但通常由java程序准备要显示的数据，由freemarker生成页面，通过模板显示准备的数据。
（3）freemarker不是一个web应用框架，而适合作为web应用框架的一个组件。
（4）freemarker与容器无关，即在web运行时，它并不知道servlet或http。
（5）freemarker更适合作为model2框架（如：Struts）的视图组件，你也可以在模板中使用jsp标记库。
（6）freemarker是免费开源的。
2.FreeMarker通用目标
（1）可以生成各种文本：HTML、XML、RTF、java源码等。
（2）易于嵌入到你的产品中，轻量级，不需要servlet环境。
（3）插件模式载入器，可以从任何源载入模板，如本地文件、数据库等。
（4）可以按所需生成文本：保存到本地文件作为，作为email发送或从web应用程序发送它返回给web浏览器
3.数据模型+模板=输出

二、FreeMarker基本语法
1.FreeMarker标记
（1） $:$ {expression} Freemarker会在输出时用实际值进行替代。如：${stockNum?default(‘’)}
（2）#: 标准的FTL标记。大部分Freemarker指令都是以#开始，注释也是：<#—->,可以明显与HTML标记区分。如：

（3）@：作为用户定义指令使用宏变量时，使用@替代FTL标记中的#。
2.标准的FTL标记指令
1)if, else, elseif
语法：

<#if condition>
  ...
<#elseif condition2>
  ...
<#elseif condition3>
      ......
<#else>
 </#if>

2)switch, case, default, break

<#switch being.size>
   <#case "small"> 
      This will be processed if it is small 
      <#break> 
   <#case "medium"> 
      This will be processed if it is medium  
     <#break> 
   <#case "large">
      This will be processed if it is large
      <#break>
  <#default>
     This will be processed if it is neither
 </#switch>

3)list, break

<#list sequence as item>
    ...x
    <#if item="spring"><#break></#if>...
</#list>

关键字item_index:是list当前值的下标item_has_next:判断list是否还有值
例子：

<#assign seq = ["winter", "spring", "summer", "autumn"]>
<#list seq as x> 
     ${x_index + 1}. ${x}<#if x_has_next>,</#if>
</#list>

输出 1. winter, 2. spring, 3. summer, 4. autumn
4)include
语法：

<#include filename>
or<#include filename options>

options包含两个属性encoding=”GBK” 编码格式parse=true 是否作为ftl语法解析,默认是true，false就是以文本方式引入.注意在ftl文件里布尔值都是直接赋值的如parse=true,而不是parse=”true”
用例:
/common/copyright.ftl包含内容
Copyright 2001-2002 ${me}
All rights reserved.
模板文件

 <#assign me = "Juila Smith">
   <h1>Some test</h1><p>Yeah.<hr>
 <#include "/common/copyright.ftl"  encoding=”GBK”>

输出结果

<h1>Some test</h1><p>Yeah.<hr>
Copyright 2001-2002 Juila SmithAll rights reserved

5)import
语法:

<#import path as hash>

类似于java里的import,它导入文件，然后就可以在当前文件里使用被导入文件里的宏组件
用例:
假设mylib.ftl里定义了宏copyright那么我们在其他模板页面里可以这样使用

<#import "/libs/mylib.ftl" as my>
   <@my.copyright date="1999-2002"/>
"my"在freemarker里被称作namespace

6)assign
生成变量,并且给变量赋值
常用的语法形式:

<#assign name=value>
Or
<#assign name1=value1 name2=value2 ...nameN=valueN>
Or
<#assign name> capture this</#assign>
Or
<#assign name in namespacehash>
    capture this
</#assign>

7) macro, nested, return

语法：

<#macro name param1 param2 ...paramN>
        ...
    <#nested loopvar1, loopvar2, ..., loopvarN>
        ...
     <#return>
        ...
</#macro>

用例

<#macro test foo bar="Bar“  baaz=-1>  
  Test text, and the params: ${foo}, ${bar},${baaz}
</#macro>
<@test foo="a" bar="b" baaz=5*5-2/>
<@test foo="a" bar="b"/>
<@test foo="a" baaz=5*5-2/>
 <@test foo="a"/>

输出

  Test text, and the params: a, b, 23 
  Test text, and the params: a, b, -1  
  Test text, and the params: a, Bar, 23   
  Test text, and the params: a, Bar, -1

三、FreeMarker开发问题总结
1:特殊字符的显示
如果包含特殊字符需要转义，如下面的例子

输出结果：

有一类特殊的字符串称为raw字符串，被认为是纯文本:

输出结果：

2:使用过程当中容易出错的地方
下面的代码是错误的

<#if ${isBig}>Wow!</#if>
<#if "${isBig}">Wow!</#if>

应该写成下面这样
<#if isBig>Wow!</#if>
FreeMarker对null值有严格的校验，它将其视为missing
variable，报错！。为了防止错误发生我们可以为其设置当表
达式为null时的默认值：stockNum?default(”)
&&(and)、||(or)、!(not)，只能用于布尔值，否则
会产生错误
3.问题小结：
（1）Freemarker区分大小写
（2）FTL标记不能位于另一个FTL标记内部，如：<#if <#include ‘foo’>=’bar’>…
（3） ${…}只能在文本中使用（4）多余空白字符会在模板输出时去除（5）如果使用的指令不存在，会产生一个错误消息 4.FTL内置的处理函数用法类似访问对象的子变量，只是使用”?”替代”.”，例如：$ {user?upper_case}
【对于字符串】
html－对字符串进行HTML编码
cap_first－使字符串第一个字母大写
lower_case－将字符串转换成小写
trim－去掉字符串前后的空白字符
length –取得字符串长度
js_string—包含的特殊字符(如回车、\”),转化成变量可以接收的值
例：

<#assign beanName = ‘The “foo” bean.’>
var BEAN_NAME = “${beanName?j_string}”;
结果:
String BEAN_NAME = “The \”foo\” bean.”;

【对于Sequences】
size－获得序列中元素的数目
【对于数字】
int－取得数字的整数部分（如-1.9?int的结果是-1 )
其它处理】
xml—xml安全处理
if_exists、exists:
判断对象是不是null列：
<#if mouse?exists>
Mouse found
<#else>
也可以直接${mouse?if_exists})输出布尔形
keys—返回hash里的所有keys, 返回结果类型sequence
values—返回hash里的所有value, 返回结果类型sequence
string—string(‘#’)、string(‘是’,’否’)、string(‘#.00’)、string(‘yyyy-MM-dd hh:mm:ss’)、string(‘#.##’)、string(‘0.##’)、string.currency:指定数值以￥42.00 显示
5: sequence 序列(对应java里的list、数组等非键值对的集合)与hash键值对的集合
主要是针对 hash结构怎样展示

<#list yourMap?keys as key>
    ${key} = ${ yourMap [key]}; 
</#list>

Xx代表集合,判定集合是否为空

<#if (xx.empty)>

</#if> 
 Set xx = new HashSet();

对于Set这种集合以上的判定FTL会
报错，应该转化之后
ArrayList xx = new ArrayList(new HashSet()) 再存入数据模型当中

6:模板中的变量的使用范围及命名空间
变更的使用范围:
plain(全局)变量：可以在模板的任何地方访问，包括使用include指令插入的模板，使用assign指令创建和替换
局部变量：在macro中有效，使用local指令创建和替换
循环变量：只能存在于指令的嵌套内容，由指令(如list)自动创建；宏的参数是局部变量，而不是循环变量。