BlogJava-kxbin-文章分类-FreeMarker

FreeMarker的数据模型

kxbin — Fri, 16 Dec 2011 03:04:00 GMT

基础

在快速入门中介绍了在模板中使用的三种基本对象类型：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

brown

Scalar变量

Scalar变量存储单值，可以是：

字符串：简单文本，在模板中使用引号（单引号或双引号）括起

数字：在模板中直接使用数字值

日期：存储日期/时间相关的数据，可以是日期、时间或日期-时间（Timestamp）；通常情况，日期值由程序员加到数据模型中，设计者只需要显示它们

布尔值：true或false，通常在<#if …>标记中使用

hashes 、sequences和集合

有些变量不包含任何可显示的内容，而是作为容器包含其它变量，者有两种类型：

hashes：具有一个唯一的查询名字和它包含的每个变量相关联

sequences：使用数字和它包含的每个变量相关联，索引值从0开始

集合变量通常类似sequences，除非无法访问它的大小和不能使用索引来获得它的子变量；集合可以看作只能由<#list …>指令使用的受限sequences

方法

方法变量通常是基于给出的参数计算值。

下面的例子假设程序员已经将方法变量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)}

宏和变换器

宏和变换器变量是用户自定义指令（自定义FTL标记），会在后面讲述这些高级特性

节点

节点变量表示为树型结构中的一个节点，通常在XML处理中使用

kxbin 2011-12-16 11:04 发表评论

FreeMarker基本语法

kxbin — Fri, 16 Dec 2011 03:02:00 GMT

<# ... > 中存放所有freemaker的内容，之外的内容全部原样输出。

<@ ... /> 是函数调用

两个定界符内的内容中，第一个符号表示指令或者函数名，其后的跟随参数。freemaker提供的控制包括如下：

<#if condition><#elseif condition><#else> 条件判断

<#list hash_or_seq as var> 遍历hash表或者collection（freemaker称作sequence）的成员

<#macro name param1 param2 ... ><#nested param> 宏，无返回参数

<#function name param1 param2><#return val>函数，有返回参数

var?member_function(...) 用函数对var进行转换，freemaker称为build-ins。实际内部实现类似member_function(var, ...)

stringA[M .. N] 取子字符串，类似substring(stringA, M, N)

{key:value, key2:value2 ...} 直接定义一个hash表

[item0, item1, item2 ...] 直接定义一个序列

hash0[key0] 存取hash表中key对应的元素

seq0[5] 存取序列指定下标的元素

<@function1 param0 param1 ... /> 调用函数function1

<@macro0 param0 param1 ; nest_param0 nest_param1 ...> nest_body 调用宏，并处理宏的嵌套

<#assign var = value > 定义变量并初始化

<#local var = value> 在 macro 或者 function 中定义局部变量并初始化

<#global var = value > 定义全局变量并初始化

${var} 输出并替换为表达式的值

<#visit xmlnode> 调用macro匹配xmlnode本身及其子节点

<#recurse xmlnode> 调用macro匹配xmlnode的子节点

kxbin 2011-12-16 11:02 发表评论

FreeMarker介绍

kxbin — Fri, 16 Dec 2011 03:00:00 GMT

FreeMarker是一个模版引擎，一个基于文本的模板输出工具（生成任意的HTML表单代码）。它是一个Java包，面向Java程序员的类库。它本身并不是针对最终用户的应用，而是允许程序员将其嵌入到他们的产品中。

FreeMarker被设计用来生成HTML Web页面，特别是基于MVC模式的应用程序。使用 MVC 模式作为动态的WEB页面的想法，是为了分隔页面设计者 (HTML 设计者) 和程序员。.每个人做自己擅长的那一部分。设计者可以不通过程序员的改变或修改代码来改变网页的样子，因为应用逻辑(Java程序)和页面设计（FreeMarker 模版）是分开的。模板不会被复杂繁琐的程序框架所破坏。即使当一个项目的程序员和HIMTL页面的制作者是同一个人时，这种分隔也是很有用，因为这样有助于保持应用的清晰并易于维护。

尽管FreeMarker有一些编程的能力，但它并不是一个象PHP那样的成熟的编程语言。与Java不同的是，Java程序准备用来显示的数据，而Freemarker仅是生成文本页，这个文本页显示用于模板的预备数据。

FreeMarker 不是一个Web 应用框架，而更适合充当 Web 应用框架里的一个组件的角色，但 FreeMarker 引擎本身对 HTTP 或 servlets 并不关心，它仅仅是生成文本。在非 Web 应用环境中它同样能够展示完美的用途。然而值得注意的是：我们为使用 FreeMarker 提供了方便的解决方案，作为 Model2 框架（如 Struts ）的视图组件，你也可以在模版中使用JSP标签。

源码概要

授权协议： BSD

开发语言： Java

操作系统：跨平台

软件用途:模板引擎

FreeMarker特点

能够生成各种文本：HTML、XML、RTF、Java源代码等等
易于嵌入到你的产品中：轻量级；不需要Servlet环境
插件式模板载入器：可以从任何源载入模板，如本地文件、数据库等等
你可以按你所需生成文本：保存到本地文件；作为Email发送；从Web应用程序发送它返回给Web浏览器
强大的模板语言
通用数据模型
智能的国际化和本地化
强大的XML处理能力

kxbin 2011-12-16 11:00 发表评论