FreeMarker

FreeMarker概述

FreeMarker是一个模板引擎,一个基于模板生成文本输出的通用工具,使用纯Java编写
FreeMarker被设计用来生成HTML Web页面,特别是基于MVC模式的应用程序
虽然FreeMarker具有一些编程的能力,但通常由Java程序准备要显示的数据,由FreeMarker生成页面,通过模板显示准备的数据(如下图)
这里写图片描述
FreeMarker不是一个Web应用框架,而适合作为Web应用框架一个组件
FreeMarker与容器无关,因为它并不知道HTTP或Servlet;FreeMarker同样可以应用于非Web应用程序环境
FreeMarker更适合作为Model2框架(如Struts)的视图组件,你也可以在模板中使用JSP标记库
FreeMarker是免费的

FreeMarker特性

  1. 通用目标
    能够生成各种文本:HTML、XML、RTF、Java源代码等等
    易于嵌入到你的产品中:轻量级;不需要Servlet环境
    插件式模板载入器:可以从任何源载入模板,如本地文件、数据库等等
    你可以按你所需生成文本:保存到本地文件;作为Email发送;从Web应用程序发送它返回给Web浏览器

  2. 强大的模板语言
    所有常用的指令:include、if/elseif/else、循环结构
    在模板中创建和改变变量
    几乎在任何地方都可以使用复杂表达式来指定值
    命名的宏,可以具有位置参数和嵌套内容
    名字空间有助于建立和维护可重用的宏库,或者将一个大工程分成模块,而不必担心名字冲突
    输出转换块:在嵌套模板片段生成输出时,转换HTML转义、压缩、语法高亮等等;你可以定义自己的转换

  3. 通用数据模型
    FreeMarker不是直接反射到Java对象,Java对象通过插件式对象封装,以变量方式在模板中显示
    你可以使用抽象(接口)方式表示对象(JavaBean、XML文档、SQL查询结果集等等),告诉模板开发者使用方法,使其不受技术细节的打扰

  4. 为Web准备
    在模板语言中内建处理典型Web相关任务(如HTML转义)的结构
    能够集成到Model2 Web应用框架中作为JSP的替代
    支持JSP标记库
    为MVC模式设计:分离可视化设计和应用程序逻辑;分离页面设计员和程序员

  5. 智能的国际化和本地化
    字符集智能化(内部使用UNICODE)
    数字格式本地化敏感
    日期和时间格式本地化敏感
    非US字符集可以用作标识(如变量名)
    多种不同语言的相同模板

  6. 强大的XML处理能力
    <#recurse> 和<#visit>指令(2.3版本)用于递归遍历XML树
    在模板中清楚和直觉的访问XML对象模型

FreeMarker vs. Velocity

概述
Velocity是一个简单而且更加轻量级的工具,但是它没有达到FreeMarker能够做的许多任务,而且它的模板语言不是很强大。
我们认为对于大多数应用程序,FreeMarker比Velocity工作更简单,因为:
使用Velocity,你需要寻找特定工具或各种工作环境来一次次的解决典型的模板创作任务,结果会浪费更多时间
工作环境经常意味着在Velocity模板中直接使用Java对象的方法,这违反了简单、无编程HTML设计的观念
或者将表示任务移到控制器代码中,这违反了MVC模式

使用FreeMarker,可以以out-of-the-box的方式实现Velocity所能做的。

特性比较清单
下面是一个使用FreeMarker能够实现,而Velocity不能实现的不太全面的特性清单:

  1. 数字和日期支持
    可以对任何数字类型进行算术运算和比较,包括精度类型
    可以比较和显示(格式化)日期/时间值
  2. 国际化
    根据各种内建和定制的数字格式,格式化本地敏感的数字
    根据各种内建和定制的日期格式,格式化本地敏感和时区敏感的日期
    标识(变量名)可以包含非英语字符,如重音字符、阿拉伯字符、中文字符等
  3. 循环处理
    可以跳出循环
    可以在循环外访问循环体内的控制变量
    可以测试是否达到最后一次循环
  4. 模板级别的数组处理
    可以使用类似[i]语法的索引方式访问数组元素
    可以查询数组长度

  5. 宏可以有局部变量
    可以递归调用宏,同样可以在模板的后面定义要调用的宏
    调用宏时,可以按位置或名字的方式传递参数
    宏参数可以有缺省值,使得在调用时忽略参数也有效
    调用的宏可以有嵌套的体内容(<@myMacro>body
<html>
<head>
  <title>Welcome!</title>
</head>
<body>
  <h1>Welcome ${user}!</h1>
  <p>Our latest product:
  <a href="${latestProduct.url}">${latestProduct.name}</a>!
</body>
</html>

这个例子是在简单的HTML中加入了一些由${…}包围的特定代码,这些特定代码是FreeMarker的指令,而包含FreeMarker的指令的文件就称为模板(Template)
至于user、latestProduct.url和latestProduct.name来自于数据模型(data model)
数据模型由程序员编程来创建,向模板提供变化的信息,这些信息来自于数据库、文件,甚至于在程序中直接生成
模板设计者不关心数据从那儿来,只知道使用已经建立的数据模型
下面是一个可能的数据模型

(root)
  |
  +- user = "Big Joe"
  |
  +- latestProduct
      |
      +- url = "products/greenmouse.html"
      |
      +- name = "green mouse"

数据模型类似于计算机的文件系统,latestProduct可以看作是目录,而user、url和name看作是文件,url和name文件位于latestProduct目录中(这只是一个比喻,实际并不存在)
当FreeMarker将上面的数据模型合并到模板中,就创建了下面的输出:

<html>
<head>
  <title>Welcome!</title>
</head>
<body>
  <h1>Welcome Big Joe!</h1>
  <p>Our latest product:
  <a href="products/greenmouse.html">green mouse</a>!
</body>
</html>
  1. 数据模型
    典型的数据模型是树型结构,可以任意复杂和深层次,如下面的例子:
(root)
  |
  +- animals
  |   |
  |   +- mouse
  |   |   |
  |   |   +- size = "small"
  |   |   |
  |   |   +- price = 50
  |   |
  |   +- elephant
  |   |   |
  |   |   +- size = "large"
  |   |   |
  |   |   +- price = 5000
  |   |
  |   +- python
  |       |
  |       +- size = "medium"
  |       |
  |       +- price = 4999
  |
  +- test = "It is a test"
  |
  +- whatnot
      |
      +- because = "don't know"

类似于目录的变量称为hashes,包含保存下级变量的唯一的查询名字
类似于文件的变量称为scalars,保存单值
scalars保存的值有两种类型:字符串(用引号括起,可以是单引号或双引号)和数字(不要用引号将数字括起,这会作为字符串处理)
对scalars的访问从root开始,各部分用“.”分隔,如animals.mouse.price
另外一种变量是sequences,和hashes类似,只是不使用变量名字,而使用数字索引,如下面的例子:

(root)
  |
  +- animals
  |   |
  |   +- (1st)
  |   |   |
  |   |   +- name = "mouse"
  |   |   |
  |   |   +- size = "small"
  |   |   |
  |   |   +- price = 50
  |   |
  |   +- (2nd)
  |   |   |
  |   |   +- name = "elephant"
  |   |   |
  |   |   +- size = "large"
  |   |   |
  |   |   +- price = 5000
  |   |
  |   +- (3rd)
  |       |
  |       +- name = "python"
  |       |
  |       +- size = "medium"
  |       |
  |       +- price = 4999
  |
  +- whatnot
      |
      +- fruits
          |
          +- (1st) = "orange"
          |
          +- (2nd) = "banana"

这种对scalars的访问使用索引,如animals[0].name

  1. 模板
    在FreeMarker模板中可以包括下面三种特定部分:
    ${…}:称为interpolations,FreeMarker会在输出时用实际值进行替代
    FTL标记(FreeMarker模板语言标记):类似于HTML标记,为了HTML标记区分,用#开始(有些以@开始,在后面叙述)
    注释:包含在<#–和–>(而不是 )之间

下面是一些使用指令的例子:
if指令

<#if animals.python.price < animals.elephant.price>
  Pythons are cheaper than elephants today.
<#else>
  Pythons are not cheaper than elephants today.
</#if>

list指令

<p>We have these animals:
<table border=1>
  <tr><th>Name<th>Price
  <#list animals as being>
  <tr><td>${being.name}<td>${being.price} Euros
  </#list>
</table>

输出为:

<p>We have these animals:
<table border=1>
  <tr><th>Name<th>Price
  <tr><td>mouse<td>50 Euros
  <tr><td>elephant<td>5000 Euros
  <tr><td>python<td>4999 Euros
</table>

include指令

<html>
<head>
  <title>Test page</title>
</head>
<body>
  <h1>Test page</h1>
  <p>Blah blah...
<#include "/copyright_footer.html">
</body>
</html>

一起使用指令

<p>We have these animals:
<table border=1>
  <tr><th>Name<th>Price
  <#list animals as being>
  <tr>
    <td>
      <#if being.size = "large"><b></#if>
      ${being.name}
      <#if being.size = "large"></b></#if>
    <td>${being.price} Euros
  </#list>
</table>

FreeMarker设计指南2-数据模型

  1. 基础
    在快速入门中介绍了在模板中使用的三种基本对象类型:scalars、hashes 和sequences,其实还可以有其它更多的能力:
    scalars:存储单值
    hashes:充当其它对象的容器,每个都关联一个唯一的查询名字
    sequences:充当其它对象的容器,按次序访问
    方法:通过传递的参数进行计算,以新对象返回结果
    用户自定义FTL标记:宏和变换器

通常每个变量只具有上述的一种能力,但一个变量可以具有多个上述能力,如下面的例子:

(root)
  |
  +- mouse = "Yerri"
     |
     +- age = 12
     |
     +- color = "brown"

mouse既是scalars又是hashes,将上面的数据模型合并到下面的模板:

${mouse}       <#-- use mouse as scalar -->
${mouse.age}   <#-- use mouse as hash -->
${mouse.color} <#-- use mouse as hash -->

输出结果是:

Yerri
12
brown
  1. Scalar变量
    Scalar变量存储单值,可以是:
    字符串:简单文本,在模板中使用引号(单引号或双引号)括起
    数字:在模板中直接使用数字值
    日期:存储日期/时间相关的数据,可以是日期、时间或日期-时间(Timestamp);通常情况,日期值由程序员加到数据模型中,设计者只需要显示它们
    布尔值:true或false,通常在<#if …>标记中使用

  2. hashes 、sequences和集合
    有些变量不包含任何可显示的内容,而是作为容器包含其它变量,者有两种类型:
    hashes:具有一个唯一的查询名字和它包含的每个变量相关联
    sequences:使用数字和它包含的每个变量相关联,索引值从0开始
    集合变量通常类似sequences,除非无法访问它的大小和不能使用索引来获得它的子变量;集合可以看作只能由<#list …>指令使用的受限sequences

  3. 方法
    方法变量通常是基于给出的参数计算值
    下面的例子假设程序员已经将方法变量avg放到数据模型中,用来计算数字平均值:

The average of 3 and 5 is: ${avg(3, 5)}
The average of 6 and 10 and 20 is: ${avg(6, 10, 20)}
The average of the price of python and elephant is: ${avg(animals.python.price, animals.elephant.price)}
  1. 宏和变换器
    宏和变换器变量是用户自定义指令(自定义FTL标记),会在后面讲述这些高级特性

  2. 节点
    节点变量表示为树型结构中的一个节点,通常在XML处理中使用,会在后面的专门章节中讲述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值