freemarker的中文文档.docx

《freemarker的中文文档.docx》由会员分享，可在线阅读，更多相关《freemarker的中文文档.docx（59页珍藏版）》请在冰豆网上搜索。

freemarker的中文文档

FreeMarker概述

●        FreeMarker是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写

●        FreeMarker被设计用来生成HTMLWeb页面，特别是基于MVC模式的应用程序

●        虽然FreeMarker具有一些编程的能力，但通常由Java程序准备要显示的数据，由FreeMarker生成页面，通过模板显示准备的数据（如下图）

●        FreeMarker不是一个Web应用框架，而适合作为Web应用框架一个组件

●        FreeMarker与容器无关，因为它并不知道HTTP或Servlet；FreeMarker同样可以应用于非Web应用程序环境

●        FreeMarker更适合作为Model2框架（如Struts）的视图组件，你也可以在模板中使用JSP标记库

●        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转义）的结构

●        能够集成到Model2Web应用框架中作为JSP的替代

●        支持JSP标记库

●        为MVC模式设计：

分离可视化设计和应用程序逻辑；分离页面设计员和程序员

5、智能的国际化和本地化

●        字符集智能化（内部使用UNICODE）

●        数字格式本地化敏感

●        日期和时间格式本地化敏感

●        非US字符集可以用作标识（如变量名）

●        多种不同语言的相同模板

6、强大的XML处理能力

●        <#recurse>和<#visit>指令（2.3版本）用于递归遍历XML树

●        在模板中清楚和直觉的访问XML对象模型

FreeMarker设计指南

（1）

1、快速入门

（1）模板+数据模型=输出

●        FreeMarker基于设计者和程序员是具有不同专业技能的不同个体的观念

●        他们是分工劳动的：

设计者专注于表示——创建HTML文件、图片、Web页面的其它可视化方面；程序员创建系统，生成设计页面要显示的数据

●        经常会遇到的问题是：

在Web页面（或其它类型的文档）中显示的信息在设计页面时是无效的，是基于动态数据的

●        在这里，你可以在HTML（或其它要输出的文本）中加入一些特定指令，FreeMarker会在输出页面给最终用户时，用适当的数据替代这些代码

●        下面是一个例子：

Welcome${user}!

Ourlatestproduct:

${latestProduct.name}!

●        这个例子是在简单的HTML中加入了一些由${…}包围的特定代码，这些特定代码是FreeMarker的指令，而包含FreeMarker的指令的文件就称为模板（Template）

●        至于user、latestProduct.url和latestProduct.name来自于数据模型（datamodel）

●        数据模型由程序员编程来创建，向模板提供变化的信息，这些信息来自于数据库、文件，甚至于在程序中直接生成

●        模板设计者不关心数据从那儿来，只知道使用已经建立的数据模型

●        下面是一个可能的数据模型：

（root）

|

+-user="BigJoe"

|

+-latestProduct

|

+-url="products/greenmouse.html"

|

+-name="greenmouse"

●        数据模型类似于计算机的文件系统，latestProduct可以看作是目录，而user、url和name看作是文件，url和name文件位于latestProduct目录中（这只是一个比喻，实际并不存在）

●        当FreeMarker将上面的数据模型合并到模板中，就创建了下面的输出：

WelcomeBigJoe!

Ourlatestproduct:

greenmouse!

（2）数据模型

●        典型的数据模型是树型结构，可以任意复杂和深层次，如下面的例子：

（root）

|

+-animals

||

|+-mouse

|||

||+-size="small"

|||

||+-price=50

||

|+-elephant

|||

||+-size="large"

|||

||+-price=5000

||

|+-python

||

|+-size="medium"

||

|+-price=4999

|

+-test="Itisatest"

|

+-whatnot

|

+-because="don'tknow"

●        类似于目录的变量称为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

（3）模板

●        在FreeMarker模板中可以包括下面三种特定部分：

Ø        ${…}：

称为interpolations，FreeMarker会在输出时用实际值进行替代

Ø        FTL标记（FreeMarker模板语言标记）：

类似于HTML标记，为了与HTML标记区分，用#开始（有些以@开始，在后面叙述）

Ø        注释：

包含在<#--和-->（而不是

--和-->）之间

●        下面是一些使用指令的例子：

Ø        if指令

<#ifanimals.python.price

Pythonsarecheaperthanelephantstoday.

<#else>

Pythonsarenotcheaperthanelephantstoday.

Ø        list指令

Wehavetheseanimals:

NamePrice

<#listanimalsasbeing>

${being.name}${being.price}Euros

输出为：

Wehavetheseanimals:

NamePrice

mouse50Euros

elephant5000Euros

python4999Euros

Ø        include指令

Testpage

Blahblah...

<#include"/copyright_footer.html">

Ø        一起使用指令

W