# FreeMarker 手册

## 什么是 FreeMarker?

FreeMarker 是一款 模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。 它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言， 不是 像PHP那样成熟的编程语言。 那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算， 之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据， 而在模板之外可以专注于要展示什么数据。

这种方式通常被称为 MVC (模型 视图 控制器) 模式，对于动态网页来说，是一种特别流行的模式。 它帮助从开发人员(Java 程序员)中分离出网页设计师(HTML设计师)。设计师无需面对模板中的复杂逻辑， 在没有程序员来修改或重新编译代码时，也可以修改页面的样式。

而FreeMarker最初的设计，是被用来在MVC模式的Web开发框架中生成HTML页面的，它没有被绑定到 Servlet或HTML或任意Web相关的东西上。它也可以用于非Web应用环境中。

FreeMarker 是 免费的， 基于Apache许可证2.0版本发布。

如果你发现 任何错误 (包括 语法错误, 错别字, 排版错误) 或者是在文档中找到 误导或混淆 ，或有其他建议，请联系原作者! Email: ddekany at users.sourceforge.net

文档翻译的任何问题（包括语法错误，错别字）或中文技术交流，可以联系译者：nanlei1987 at gmail.com， 或在FreeMarker的Github上Fork一份，修改之后提交Pull Request。我们共同研究，共同进步。

英文版文档的作者(也是FreeMarker项目的维护者)是匈牙利人，其母语非英语，那么在这种情况下， 翻译过程难免会有错误存在，译者结合自身多年对FreeMarker的实践力争精准，译文力求信达雅。 但因个人才疏学浅，水平有限，恳请广大读者批评指正。最好的方式就是使用Github了

手册的更新根据原作者更新，大家的反馈随时进行。但只在有阶段性成果时才会提交发布修正版本。

本翻译是免费的，您可以自由下载和传播，但不可用于任何商业行为。文档版权归译者本人所有， 原版归FreeMarker项目组所有，您可以引用其中的描述，但必须指明出处。如需用于商业行为， 您必须和原作者取得联系。

## 模板开发指南

### 入门

本章内容只是对 FreeMarker 进行简略的介绍，在后续章节中将会详细展开讲述。 不过没有关系，在阅读了本章节的内容后，就能够编写简单，但却很有用的FreeMarker模板程序了。

#### 模板 + 数据模型 = 输出

假设在一个在线商店的应用系统中需要一个HTML页面，和下面这个页面类似：

    <html>
    <head>
      <title>Welcome!</title>
    </head>
    <body>
      <h1>Welcome John Doe!</h1>
      <p>Our latest product:
      <a href="products/greenmouse.html">green mouse</a>!
    </body>
    </html>

这里的用户名(上面的"Big Joe")，应该是登录这个网页的访问者的名字， 并且最新产品的数据应该来自于数据库，这样它才能随时更新。那么不能直接在HTML页面中输入它们， 不能使用静态的HTML代码。此时，可以使用要求输出的 模板。 模板和静态HTML是相同的，只是它会包含一些 FreeMarker 将它们变成动态内容的指令：

    <html>
    <head>
      <title>Welcome!</title>
    </head>
    <body>
      <h1>Welcome ${user}!</h1>
      <p>Our latest product:
      <a href="${latestProduct.url}">${latestProduct.name}</a>!
    </body>
    </html>

模板文件存放在Web服务器上，就像通常存放静态HTML页面那样。当有人来访问这个页面， FreeMarker将会介入执行，然后动态转换模板，用最新的数据内容替换模板中 `${`...`}` 的部分， 之后将结果发送到访问者的Web浏览器中。访问者的Web浏览器就会接收到例如第一个HTML示例那样的内容 (也就是没有FreeMarker指令的HTML代码)，访问者也不会察觉到服务器端使用的FreeMarker。 (当然，存储在Web服务器端的模板文件是不会被修改的；替换也仅仅出现在Web服务器的响应中。)

请注意，模板并没有包含程序逻辑来查找当前的访问者是谁，或者去查询数据库获取最新的产品。 显示的数据是在 FreeMarker 之外准备的，通常是一些 真正的 编程语言(比如Java) 所编写的代码。模板作者无需知道这些值是如何计算出的。事实上，这些值的计算方式可以完全被修改， 而模板可以保持不变，而且页面的样式也可以完全被修改而无需改动模板。 当模板作者(设计师)和程序员不是同一人时，显示逻辑和业务逻辑相分离的做法是非常有用的， 即便模板作者和程序员是一个人，这么来做也会帮助管理应用程序的复杂性。 保证模板专注于显示问题(视觉设计，布局和格式化)是高效使用模板引擎的关键。

为模板准备的数据整体被称作为 数据模型。 模板作者要关心的是，数据模型是树形结构(就像硬盘上的文件夹和文件)，在视觉效果上， 数据模型可以是：

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

上面只是一个形象化显示；数据模型不是文本格式，它来自于Java对象。 对于Java程序员来说，root就像一个有 `getUser()` 和 `getLatestProduct()` 方法的Java对象， 也可以有 `"user"` 和 `"latestProducts"` 键值的Java `Map`对象。相似地，`latestProduct` 就像是有 `getUrl()` 和 `getName()` 方法的Java对象。

早期版本中，可以从数据模型中选取这些值，使用 `user` 和 `latestProduct.name` 表达式即可。如果我们继续类推， 数据模型就像一个文件系统，那么 (root) 和 `latestProduct` 就对应着目录(文件夹)，而 `user`, `url` 和 `name` 就是这些目录中的文件。

总的来说，模板和数据模型是FreeMarker来生成输出(比如第一个展示的HTML)所必须的：

模板 + 数据模型 = 输出

#### 数据模型一览

正如已经看到的，数据模型的基本结构是树状的。 这棵树可以很复杂，并且可以有很大的深度，比如：

    (root)
      |
      +- animals
      |   |
      |   +- mouse
      |   |   |
      |   |   +- size = "small"
      |   |   |
      |   |   +- price = 50
      |   |
      |   +- elephant
      |   |   |
      |   |   +- size = "large"
      |   |   |
      |   |   +- price = 5000
      |   |
      |   +- python
      |       |
      |       +- size = "medium"
      |       |
      |       +- price = 4999
      |
      +- message = "It is a test"
      |
      +- misc
          |
          +- foo = "Something"

上图中的变量扮演目录的角色(比如 root, `animals`, `mouse`, `elephant`, `python`, `misc`) 被称为 hashes (哈希表或哈希，译者注)。哈希表存储其他变量(被称为 子变量)， 它们可以通过名称来查找(比如 animals, mouse 或 price)。

存储单值的变量 (`size`, `price`, `message` 和 `foo`) 称为 scalars (标量，译者注)。

如果要在模板中使用子变量， 那应该从根root开始指定它的路径，每级之间用点来分隔开。要访问 `mouse` 的 `price` ，要从root开始，首先进入到 `animals` ，之后访问 `mouse` ，最后访问 `price` 。就可以这样来写 `animals.mouse.price`。

另外一种很重要的变量是 sequences (序列，译者注)。 它们像哈希表那样存储子变量，但是子变量没有名字，它们只是列表中的项。 比如，在下面这个数据模型中， `animals` 和 `misc.fruits` 就是序列：

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

要访问序列的子变量，可以使用方括号形式的数字索引下标。 索引下标从0开始(从0开始也是程序员的传统)，那么第一项的索引就是0， 第二项的索引就是1等等。要得到第一个动物的名称的话，可以这么来写代码 `animals[0].name`。要得到 `misc.fruits` 中的第二项(字符串`"banana"`)可以这么来写 `misc.fruits[1]`。(实践中，通常按顺序遍历序列，而不用关心索引， 这点会在 后续介绍。)

标量类型可以分为如下的类别：

- 字符串：就是文本，也就是任意的字符序列，比如上面提到的 ''m'', ''o'', ''u'', ''s'', ''e''。比如 `name` 和 `size` 也是字符串。

- 数字：这是数值类型，就像上面的 `price`。 在FreeMarker中，字符串 `"50"` 和数字 `50` 是两种完全不同的东西。前者是两个字符的序列 (这恰好是人们可以读的一个数字)，而后者则是可以在数学运算中直接被使用的数值。

- 日期/时间: 可以是日期-时间格式(存储某一天的日期和时间)， 或者是日期(只有日期，没有时间)，或者是时间(只有时间，没有日期)。

- 布尔值：对应着对/错(是/否，开/关等值)类似的值。 比如动物可以有一个 `protected` (受保护的，译者注) 的子变量， 该变量存储这个动物是否被保护起来的值。

总结：

- 数据模型可以被看成是树形结构。

- 标量用于存储单一的值。这种类型的值可以是字符串，数字，日期/时间或者是布尔值。

- 哈希表是一种存储变量及其相关且有唯一标识名称的容器。

- 序列是存储有序变量的容器。存储的变量可以通过数字索引来检索，索引通常从0开始。

还有一些其它更为高级的类型，在这里我们并没有涉及到，比如方法和指令。

#### 模板一览

最简单的模板通常是普通的HTML文件(或者是其他任何文本文件； FreeMarker本身不属于HTML)。当客户端访问某个页面时， FreeMarker要发送HTML代码至客户端浏览器中去显示。如果想要页面动起来 (这里指动态网页技术，译者注)，那么就要在HTML中放置能被FreeMarker所解析的特殊代码片段：

- `${`...`}`： FreeMarker将会输出真实的值来替换大括号内的表达式，这样的表达式被称为 interpolation(插值，译者注)。

- FTL 标签 (FreeMarker模板的语言标签)： FTL标签和HTML标签有一些相似之处，但是它们是FreeMarker的指令，是不会在输出中打印的。 这些标签的名字以 `#` 开头。(用户自定义的FTL标签则需要使用 `@` 来代替 `#`，但这属于更高级的话题了。)

- 注释： 注释和HTML的注释也很相似， 但是它们使用 `<#--` and `-->` 来标识。 不像HTML注释那样，FTL注释不会出现在输出中(不出现在访问者的页面中)， 因为 FreeMarker会跳过它们。

其他任何不是FTL标签，插值或注释的内容将被视为静态文本， 这些东西不会被FreeMarker所解析；会被按照原样输出出来。

FTL标签也被称为 指令。 这些指令在HTML的标签 (比如： `<table>` 和 `</table>`) 和HTML元素 (比如： `table` 元素) 中的关系是相同的。(如果现在还没有感觉到它们的不同， 那么把“FTL标签”和“指令”看做是同义词即可。)

可以在 http://freemarker-online.kenshoo.com/ 上很方便的尝试编写模板

##### 基本指令

这里我们仅仅来看一些非常常用的指令，当然 (指令还有很多)。

###### if 指令

使用 `if` 指令可以有条件地跳过模板的一些片段。 比如，假设在 最初的示例 中， 想向你的老板Big Joe特别地问好，可其他人不同：

    <html>
    <head>
      <title>Welcome!</title>
    </head>
    <body>
      <h1>
        Welcome ${user}<#if user == "Big Joe">, our beloved leader</#if>!
      </h1>
      <p>Our latest product:
      <a href="${latestProduct.url}">${latestProduct.name}</a>!
    </body>
    </html>

此时，告诉 FreeMarker，当和 `"Big Joe"` 相同时 , our beloved leader (我们最尊敬的领导，译者注) 才是if条件中那唯一的 `user` 变量的值。 通常来讲，如果 ``condition`` 是false(布尔值)，那么介于 `<#if `condition`>` 和 `</#if>` 标签中的内容会被略过。

我们来详细说说 ``condition`` 的使用： `==` 是用来判断它两侧的值是否相等的操作符， 比较的结果是布尔值，也就是true或者false。在 `==` 的左侧，是 被引用的变量， 我们很熟悉这样的语法结构；最终它会被变量的值所替代。通常来说， 在指令或插值中没有被引号标注的内容都被视为变量的引用。右侧则是指定的字符串， 在模板中的字符串 只能 放在引号内。

当价格为0时，就会打印出 Pythons are free today!：

    <#if animals.python.price == 0>
      Pythons are free today!
    </#if>

和之前示例中，字符串被直接指定相似， 但这里则是数字(`0`)被直接指定了。 请注意，这里的数字 没有 放在引号内。 如果将(`"0"`)放在引号中， 那么FreeMarker就会将其误判为字符串了(也就是字符串0，译者注)。

当价格不为0时，则会打印出"Pythons are not free today!"：

    <#if animals.python.price != 0>
      Pythons are not free today!
    </#if>

你也许就会猜测了， `!=` 就是不等于。

同时，也可以这样编来写代码(使用 数据模型来描述哈希表)：

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

使用 `<#else>` 标签可以指定当条件为false时程序所要执行的内容。比如：

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

这个示例中，如果蟒蛇的价格比大象的价格低的话， 程序将会打印出 Pythons are cheaper than elephants today.。 否则会打印 Pythons are not cheaper than elephants today.。 后面也可以使用 `elseif` 来完善它：

    <#if animals.python.price < animals.elephant.price>
      Pythons are cheaper than elephants today.
    <#elseif animals.elephant.price < animals.python.price>
      Elephants are cheaper than pythons today.
    <#else>
      Elephants and pythons cost the same today.
    </#if>

如果变量本身就是布尔值(true/false)，则可以直接让其作为 `if` 的 ``condition`` (判断条件，译者注)：

    <#if animals.python.protected>
      Pythons are protected animals!
    </#if>

###### list 指令

当需要列表显示内容时，list指令是必须的。比如： 如果合并该模板到 前面描述序列的数据模型 中:

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

那么输出结果将会是这样的：

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

`list` 指令的一般格式为： `<#list `sequence` as `loopVariable`>`repeatThis`</#list>`。 ``repeatThis`` 部分将会在给定的 ``sequence`` 遍历时在每一项中重复， 从第一项开始，一个接着一个。在所有的重复中， ``loopVariable`` 将持有当前遍历项的值。 这个变量仅存在于 `<#list `...`>` 和 `</#list>` 标签内。

``sequence`` 可以是任意表达式， 比如我们可以列表显示示例数据模型中的水果，就像这样：

    <ul>
    <#list misc.fruits as fruit>
      <li>${fruit}
    </#list>
    </ul>

你应该很熟悉表达式 `misc.fruits` 了； 它 引用了数据模型中的变量。

上面示例中的一个问题是如果我们有0个水果，它仍然会输出一个空的 `<ul></ul>`，而不是什么都没有。 要避免这样的情况，可以这么来使用 `list`：

    <#list misc.fruits>
      <ul>
        <#items as fruit>
          <li>${fruit}
        </#items>
      </ul>
    </#list>

此时， `list` 指令将列表视为一个整体， 在 `items` 指令中的部分才会为每个水果重复。 如果我们有0个水果，那么在 `list` 中的所有东西都被略过了， 因此就不会有 `ul` 标签了。

另一个列表相关的常见任务是：使用一些分隔符来列出水果，比如逗号：

    <p>Fruits: <#list misc.fruits as fruit>${fruit}<#sep>, </#list>

    <p>Fruits: orange, banana

被 `sep` 覆盖的部分(我们也可以这么来写： ``...`<#sep>, </#sep></#list>`) 只有当还有下一项时才会被执行。 因此最后一个水果后面不会有逗号。

再次回到这个话题，如果我们有0个水果，会怎么样？只是打印 Fruits: 也没有什么不方便。 `list` 指令，也像 `if` 指令那样，可以有 `else` 部分，如果列表中有0个元素时就会被执行：

    <p>Fruits: <#list misc.fruits as fruit>${fruit}<#sep>, <#else>None</#list>

事实上，这个过于简单的示例可以这么来写， 但是它使用了本主题中没有介绍的语言特性：

    <p>Fruits: ${fruits?join(", ", "None")}

所有的这些指令(`list`, `items`, `sep`, `else`)可以联合起来使用：

    <#list misc.fruits>
      <p>Fruits:
      <ul>
        <#items as fruit>
          <li>${fruit}<#sep> and</#sep>
        </#items>
      </ul>
    <#else>
      <p>We have no fruits.
    </#list>

在 指令参考 中， 可以获取到更多关于这些指令的内容。

###### include 指令

使用 `include` 指令， 我们可以在模板中插入其他文件的内容。

假设要在一些页面中显示版权声明的信息。那么可以创建一个文件来单独包含这些版权声明， 之后在需要它的地方插入即可。比方说，我们可以将版权信息单独存放在页面文件 `copyright_footer.html` 中：

    <hr>
    <i>
    Copyright (c) 2000 <a href="http://www.acmee.com">Acmee Inc</a>,
    <br>
    All Rights Reserved.
    </i>

当需要用到这个文件时，可以使用 `include` 指令来插入：

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

此时，输出的内容为：

    <html>
    <head>
      <title>Test page</title>
    </head>
    <body>
      <h1>Test page</h1>
      <p>Blah blah...
    <hr>
    <i>
    Copyright (c) 2000 <a href="http://www.acmee.com">Acmee Inc</a>,
    <br>
    All Rights Reserved.
    </i>
    </body>
    </html>

当修改了 `copyright_footer.html` 文件， 那么访问者在所有页面都会看到版权声明的新内容。

重用代码片段的一个更有力的方式是使用宏，但是只是更为高级的话题了， 将会在 后续讨论。

##### 联合使用指令

在页面上也可以多次使用指令，而且指令间也可以很容易地相互嵌套。 比如，在 `list` 指令中嵌套 `if` 指令：

    <#list animals as animal>
          <div<#if animal.protected> class="protected"</#if>>
            ${animal.name} for ${animal.price} Euros
          </div>
    </#list>

请注意，FreeMarker并不解析FTL标签以外的文本、插值和注释， 上面示例在HTML属性中使用FTL标签也不会有问题。

##### 使用内建函数

内建函数很像子变量(如果了解Java术语的话，也可以说像方法)， 它们并不是数据模型中的东西，是 FreeMarker 在数值上添加的。 为了清晰子变量是哪部分，使用 `?`(问号)代替 `.`(点)来访问它们。常用内建函数的示例：

- `user?html` 给出 `user` 的HTML转义版本， 比如 `&` 会由 `&amp;` 来代替。

- `user?upper_case` 给出 `user` 值的大写版本 (比如 JOHN DOE 来替代 John Doe)

- `animal.name?cap_first` 给出 `animal.name` 的首字母大写版本(比如 Mouse 来替代 mouse)

- `user?length` 给出 `user` 值中 字符的数量(对于 John Doe 来说就是8)

- `animals?size` 给出 `animals` 序列中 项目 的个数(我们示例数据模型中是3个)

- 如果在 `<#list animals as animal>` 和对应的 `</#list>` 标签中：

  - `animal?index` 给出了在 `animals` 中基于0开始的 `animal`的索引值

  - `animal?counter` 也像 `index`， 但是给出的是基于1的索引值

  - `animal?item_parity` 基于当前计数的奇偶性，给出字符串 odd 或 even。在给不同行着色时非常有用，比如在 `<td class="${animal?item_parity}Row">`中。

一些内建函数需要参数来指定行为，比如：

- `animal.protected?string("Y", "N")` 基于 `animal.protected` 的布尔值来返回字符串 Y 或 N。

- `animal?item_cycle('lightRow','darkRow')` 是之前介绍的 `item_parity` 更为常用的变体形式。

- `fruits?join(", ")` 通过连接所有项，将列表转换为字符串， 在每个项之间插入参数分隔符(比如 orange,banana)

- `user?starts_with("J")` 根据 `user` 的首字母是否是 J 返回布尔值true或false。

内建函数应用可以链式操作，比如`user?upper_case?html` 会先转换用户名到大写形式，之后再进行HTML转义。(这就像可以链式使用 `.`(点)一样)

可以阅读 全部内建函数参考。

##### 处理不存在的变量

数据模型中经常会有可选的变量(也就是说有时并不存在)。 除了一些典型的人为原因导致失误外，FreeMarker 绝不能容忍引用不存在的变量， 除非明确地告诉它当变量不存在时如何处理。这里来介绍两种典型的处理方法。

这部分对程序员而言: 一个不存在的变量和一个是 `null` 值的变量， 对于FreeMarker来说是一样的，所以这里所指的"丢失"包含这两种情况。

不论在哪里引用变量，都可以指定一个默认值来避免变量丢失这种情况， 通过在变量名后面跟着一个 `!`(叹号，译者注)和默认值。 就像下面的这个例子，当 `user` 不存在于数据模型时, 模板将会将 `user` 的值表示为字符串 `"visitor"`。(当 `user` 存在时， 模板就会表现出 `${user}` 的值)：

    <h1>Welcome ${user!"visitor"}!</h1>

也可以在变量名后面通过放置 `??` 来询问一个变量是否存在。将它和 `if` 指令合并， 那么如果 `user` 变量不存在的话将会忽略整个问候的代码段：

    <#if user??><h1>Welcome ${user}!</h1></#if>

关于多级访问的变量，比如 `animals.python.price`， 书写代码：`animals.python.price!0` 当且仅当 `animals.python` 永远存在， 而仅仅最后一个子变量 `price` 可能不存在时是正确的 (这种情况下我们假设价格是 `0`)。 如果 `animals` 或 `python` 不存在， 那么模板处理过程将会以"未定义的变量"错误而停止。为了防止这种情况的发生， 可以如下这样来编写代码 `(animals.python.price)!0`。 这种情况就是说 `animals` 或 `python` 不存在时， 表达式的结果是 `0`。对于 `??` 也是同样用来的处理这种逻辑的; 将 `animals.python.price??` 对比 `(animals.python.price)??`来看。

### 数值，类型

#### 基本内容

这里假设你已经阅读完 dgui_quickstart 章节的内容了。

理解数值和类型的概念是理解数据模型的关键和基础。 但数值和类型的概念并不局限于数据模型，下面你就会看到了。

##### 什么是数值？

这部分对于程序员来说可以直接跳过的。

正如你知道的，来自于每天所使用的数字，比如16，0.5等这些用语就是 数值 的示例，也就是数字。在计算机语言中， 这些用语有着更广泛的含义，比如数值并不一定是数字类型值，比如面这个数据模型：

    (root)
     |
     +- user = "Big Joe"
     |
     +- today = Jul 6, 2007
     |
     +- todayHoliday = false
     |
     +- lotteryNumbers
     |   |
     |   +- (1st) = 20
     |   |
     |   +- (2st) = 14
     |   |
     |   +- (3rd) = 42
     |   |
     |   +- (4th) = 8
     |   |
     |   +- (5th) = 15
     |
     +- cargo
         |
         +- name = "coal"
         |
         +- weight = 40

变量 `user` 的 value 是"Big Joe"(字符串), `today` 的 value 是 Jul 6, 2007 (日期)，`todayHoliday` 的 value 是false(布尔值，比如yes/no等值)。 `lotteryNumbers` 的 value 是包含20,14, 42, 8, 15的序列。当然在这种意义上， `lotteryNumbers` 是多值类型。它 包含 多个值(比如，其中的第二项的 value 是14)，但是 `lotteryNumbers` 本身还是单值。它就像一个装有其它很多东西的盒子 (或称之为容器，译者注)，但盒子作为整体还是视作单独的。最后还有一个数值 `cargo`，它的 value 是一个哈希表 (也是类似盒子一样的东西)。所以说，数值就是存储在变量中的(比如，在 `user` 或 `cargo` 或 `cargo.name` 中)的那个东西。但是， 不需要存储于变量之中的数值也可以称之为数值，比如下面的数字100：

    <#if cargo.weight < 100>Light cargo</#if>

当模板被执行时，计算出的临时结果也称为数值，比如这里的20和120(它会打印120)：

    ${cargo.weight / 2 + 100}

这里针对最后一种表示进行解释：有两个数，40(货物的重量)和2， 相除的结果是20，这是一个新计算出来的数值。然后，把它和100相加， 那么120就计算出来了，接着就打印出来。 (`${`...`}`)，之后模板继续向下执行， 直到所有结果都计算出来。

现在你应该能体会到数值这个词的含义了。

##### 什么是类型？

数值中非常重要的一个概念就是类型。比方说，变量 `user` 的类型是字符串，变量 `lotteryNumbers` 的类型是序列。数值的类型这个概念非常的重要，因为它决定了这些数值可以在哪里使用的最大限度。 比如说，使用 `${user / 2}` 就是错误的，但是使用 `${cargo.weight / 2}` 就能计算出结果，为20， 因为算术中的除法仅对数字类型的值有效，而不能用于字符串。 仅当 `cargo` 是一个哈希表变量时，表达式 `cargo.name` 才可以使用点。也可以用 `<#list `...`>` 指令来遍历序列。而 `<#if ...>` 指令的条件只能是布尔值等。

这里说一点点的术语：称 "布尔" 或 "布尔值" 或 "布尔类型" 都是相同的含义。

数值同时也可以含有多种类型，尽管很少这么使用。看一下下面这个数据模型 `mouse` 它本身就又是字符串，又是哈希表：

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

如果用上面的数据模型合并到下面的模板中：

    ${mouse}       <#-- uses mouse as a string -->
    ${mouse.age}   <#-- uses mouse as a hash -->
    ${mouse.color} <#-- uses mouse as a hash -->

将会输出：

    Yerri
    12
    brown

##### 数据模型是哈希表

注意观察每个数据模型的例子你也许能发现：被"(root)"所标识的内容就是哈希表类型的值。 当编写如 `user` 这样的代码时，那就意味着要把"user"变量存储在哈希表的根上。 就像编写 `root.user`一样，这里但并没有名"root"为的变量， 那么这就起不到任何作用了。

某些人也许会被这种数据模型的例子所困惑，也就是说，根哈希表包含更多的哈希表或序列 (`lotteryNumbers` and `cargo`)。其它就没有更特殊的内容了。 哈希表包含其他变量，那些变量包含其它值，这些数值可以是字符串，数字等变量， 当然也可以是哈希表或序列变量。最初我们解释过的，就像字符串和数字， 序列或哈希表也是一种值的表示形式。

#### 类型

支持的类型有：

- 标量：

  - 字符串

  - 数字

  - 布尔值

  - 日期/时间 (日期，时间或日期时间)

- 容器：

  - 哈希表

  - 序列

  - 集合

- 子程序：

  - 方法和函数

  - 用户自定义指令

- 其它/很少使用：

  - 结点

##### 标量

标量是最基本，最简单的数值类型，它们可以是：

- 字符串：表示简单的文本，例如：产品的名称。

  如果想在模板中直接给出字符串值，而不是使用数据模型中的变量， 那么将文本内容写在引号内即可，比如 `"green mouse"` 或 `'green mouse'`。(关于语法的更多细节可以在 后续章节中找到。)

- 数值：比如说，产品的价格。 整数和非整数是不区分的；只有单一的数字类型。比如使用了计算器， 计算3/2的结果是1.5而不是1。

  如果要在模板中直接给出数字的值，那么可以这么来写： `150` 或 `-90.05` 或 `0.001`。(关于语法的更多细节可以在 后续章节中找到。)

- 布尔值：布尔值代表了逻辑上的对或错(是或否)。比如：用户是否登录了。 典型的应用是使用布尔值作为 `if` 指令的条件， 比如 `<#if loggedIn >`...`</#if>` 或者 `<#if price == 0>`...`</#if>`； 后面这个 `price == 0` 部分的结果就是布尔值。

  在模板中可以使用保留字 `true` 和 `false` 来指定布尔值。

- 日期：日期变量可以存储和日期/时间相关的数据。 一共有三种变化：

  - 日期：精确到天的日期，没有时间部分。比如April 4, 2003。

  - 时间:精确到毫秒，没有日期部分。比如10:19:18 PM。

  - 日期-时间(有时也被称为"时间戳")，比如April 4,2003 10:19:18 PM。 有日期和时间两部分，时间部分的存储精确到毫秒。

  不幸的是，受到Java平台的限制，FreeMarker 有时是不能决定日期的部哪分被使用 (也就是说，是日期-时间格式，日期格式还是时间格式)。 这个问题的解决方法是一个的高级话题，将会在 后续章节讨论。

  模板中直接定义日期数值是可以的，但这也是高级话题，将会在 后续章节 中进行解释。

要记住，FreeMarker区别字符串，数字，布尔值和日期类型的值。比如， 字符串 `"150"` 看起来很像数字 `150`， 字符串只是字符的任意序列，不能将它用于计算目的，也不能和其它数字进行比较等等。

##### 容器

这些值存在的目的是为了包含其他变量；它们只是容器。 它们包含的变量通常视为 subvariables (子变量，译者注)。容器的类型有：

- 哈希表：每个子变量都可以通过一个唯一的名称来查找。 这个名称是不受限制的字符串。哈希表 并不确定其中子变量的顺序。 也就是说没有第一个子变量，第二个子变量这样的说法等；变量仅仅是通过名称来访问的。 (就像Java语言中的HashMap一样，是实现了Hash算法的Map，不记录内部元素的顺序， 仅仅通过名称来访问。译者注)

- 序列：每个子变量通过一个整数来标识。第一个子变量的标识符是0， 第二个是1，第三个是2，这样来类推，而且子变量是有顺序的。这些数次通常被称为 indexes(索引，译者注)。序列通常比较密集，也就是所有的索引， 包括最后一个子变量的，它们和子变量都是相关联的，但不是绝对必要的。 子变量的类型也并不需要完全一致。

- 集合：从模板设计者角度来看，集合是有限制的序列。不能获取集合的大小， 也不能通过索引取出集合中的子变量，但是它们仍然可以通过 `list` 指令来遍历。

请注意，一个值也可有多种类型 一个值也可有多种类型， 对于一个值可能同时存在哈希表和序列这两种类型，这时， 该变量就支持索引和名称两种访问方式。 不过容器基本是当作哈希表或者序列来使用的，而不是两者同时使用。

尽管存储在哈希表，序列(集合)中的变量可以是任意类型的， 这些变量也可以是哈希表，序列(或集合)。这样就可以构建任意深度的数据结构。

数据模型本身(最好说成是它的根root)也是哈希表。

##### 子程序

###### 方法和函数

当一个值是方法或函数的时候，那么它就可以计算其他值，结果取决于传递给它的参数。

这部分是对程序员来说的：方法/函数是一等类型值， 就像函数化的编程语言。也就是说函数/方法也可以是其他函数/方法的参数或者返回值， 并可以把它们定义成变量等。

假设程序员在数据模型中放置了一个方法变量 `avg`， 该变量用来计算数字的平均值。如果给定3和5作为参数，访问 `avg` 时就能得到结果4。

方法的使用将会在 后续章节 中进行解释， 下面这个示例会帮助我们理解方法的使用：

    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 a python and an elephant is:
    ${avg(animals.python.price, animals.elephant.price)}

将会输出：

    The average of 3 and 5 is: 4
    The average of 6 and 10 and 20 is: 12
    The average of the price of a python and an elephant is:
    4999.5

那么方法和函数有什么区别呢？这是模板作者所关心的， 它们没有关系，但也不是一点关系都没有。 方法是来自于数据模型 (它们反射了Java对象的方法) 而函数是定义在模板内的 (使用 `function` 指令 -- 也是高级话题)，但二者可以用同一种方式来使用。

###### 用户自定义指令

这种类型的值可以作为用户自定义指令(换句话说，就是FreeMarker的标签) 用户自定义指令是一种子程序，一种可以复用的模板代码段。但这也是一个高级话题， 将会在 后续章节 中进行解释。

这部分是对程序员来说的： 用户自定义指令(比如宏)也是一等值类型，就像函数/方法一样。

这里仅仅对用户自定义指令有一个认识即可(如果现在还不能理解可以先忽略它)。 假设现在有一个变量 `box`，它的值是用户自定义的指令， 用来打印一些特定的HTML信息，包含标题和一条信息。那么， `box` 变量就可以在模板中使用(示例如下)：

    <@box title="Attention!">
      Too much copy-pasting may leads to
      maintenance headaches.
    </@box>

###### 函数/方法和用户自定义指令的比较

这部分内容也是对高级用户来说的(如果还不能理解可以先忽略它)。 如果要使用函数/方法或自定义指令去实现一些东西的时候， 二者之间的选择是两难的。按经验来说，如果能够实现需求， 请先用自定义指令而不要用函数/方法。如果：

- ... 输出(返回值)的是标记(HTML,XML等)。 主要原因是函数的返回结果可以自动进行XML转义(这是因为 `${`...`}` 的特性)， 而用户自定义指令的输出则不是 (这是因为 `<@`...`>` 的特性所致; 它的输出假定是标记，因此已经转义过了)。

- ... 副作用也是很重要的一点，它没有返回值。 例如一个指令的目的是往服务器日志中添加一条。 (事实上不能得到自定义指令的返回值， 但有些反馈的类型是有可能设置非本地变量的。)

- ... 会进行流程的控制(就像 `list` 或 `if` 指令那样)。但是不能在函数/方法上这么做。

在模板中，FreeMarker不知道的Java对象的方法通常是可以作为方法来使用的， 而不用考虑Java对象方法本身的特性，因为在这里没有其他的选择。

##### 其它

###### 结点

结点变量代表了树状结构中的一个结点，而且通常是配合 XML 处理的，这是专业而且更高级的话题。

这里我们仅对 高级用户 进行一个概要说明： 结点和存储在其他结点中的序列很相似，通常也被当作为子结点。结点存储它所在的容器结点的引用， 也就是父结点。结点的主要作用是拓扑信息；其它数据必须通过使用多类型的值来存储。 就像一个值可以同时是一个结点和一个数字，这样它存储的数字可以作为如支付额来使用。 除了拓扑信息，结点也可以存储一些元信息(即metadata，译者注)：如结点名称，它的类型(字符串), 命名空间(字符串)。若一个结点象征XHTML文档中的 `h1` 元素， 那么它的名字可以是 `"h1"`，类型可以是 `"element"`， 命名空间可以是 `"http://www.w3.org/1999/xhtml"`。但对于数据模型设计者来说， 这些元信息，还有如何来使用它们又有什么意义呢。检索拓扑信息和元信息的方法将会在 后续章节 中来说明(这里可以先不用理解它们)。

### 模板

这里假设你已经阅读完 dgui_quickstart 和 dgui_datamodel 章节了。

#### 总体结构

实际上用程序语言编写的程序就是模板。
FTL (代表FreeMarker模板语言)。 这是为编写模板设计的非常简单的编程语言。

模板(FTL编程)是由如下部分混合而成的：

- 文本
  ：文本会照着原样来输出。

- 插值
  ：这部分的输出会被计算的值来替换。插值由 `${` and `}` 所分隔(或者 `#{` and `}`，这种风格已经不建议再使用了；点击查看更多)。

- FTL 标签
  ：FTL标签和HTML标签很相似，但是它们却是给FreeMarker的指示， 而且不会打印在输出内容中。

- 注释
  ：注释和HTML的注释也很相似，但它们是由 `<#--` 和 `-->`来分隔的。注释会被FreeMarker直接忽略， 更不会在输出内容中显示。

我们来看一个具体的模板。其中的内容已经用颜色来标记了： 文本， 插值， FTL 标签， 注释。为了看到可见的 换行符， 这里使用了 [BR]。

    <html>[BR]
    <head>[BR]
      <title>Welcome!</title>[BR]
    </head>[BR]
    <body>[BR]
      <#-- Greet the user with his/her name -->[BR]
      <h1>Welcome ${user}!</h1>[BR]
      <p>We have these animals:[BR]
      <ul>[BR]
      <#list animals as animal>[BR]
        <li>${animal.name} for ${animal.price} Euros[BR]
      </#list>[BR]
      </ul>[BR]
    </body>[BR]
    </html>

FTL是区分大小写的。 `list` 是指令的名称而 `List` 就不是。类似地 `${name}` 和 `${Name}` 或 `${NAME}` 也是不同的。

请注意非常重要的一点： 插值 仅仅可以在 文本 中使用。 (也可以是字符串表达式；请参考 后续内容)

FTL 标签 不可以在其他 FTL 标签 和 插值中使用。比如， 这样做是 错误 的： `<#if <#include 'foo'>='bar'>...</#if>`

注释 可以放在 FTL 标签 和 插值中。比如：

    <h1>Welcome ${user <#-- The name of user -->}!</h1>[BR]
    <p>We have these animals:[BR]
    <ul>[BR]
    <#list <#-- some comment... --> animals as <#-- again... --> animal>[BR]
    ...

如果您已经自行尝试测试上面所有示例的话：那么也许会注意到，一些空格、 制表符和换行符从模板的输出中都不见了，尽管我们之前已经说了 文本 是按照原样输出的。 现在不用为此而计较，这是由于FreeMarker的"空格剥离"特性在起作用， 它当然会自动去除一些多余的空格，制表符和换行符了。 这个特性在 后续内容 中会解释到。

#### 指令

使用 FTL标签来调用 指令。 在示例中已经调用了 `list` 指令。在语法上我们使用了两个标签： `<#list animals as animal>` 和 `</#list>`。

FTL 标签分为两种：

- 开始标签： `<#`directivename` `parameters`>`

- 结束标签： `</#`directivename`>`

除了标签以 `#` 开头外，其他都和HTML，XML的语法很相似。 如果标签没有嵌套内容(在开始标签和结束标签之间的内容)，那么可以只使用开始标签。 例如 `<#if `something`>`...`</#if>`， 而FreeMarker知道 `<#include `something`>` 中的 `include` 指令没有可嵌套的内容。

``parameters`` 的格式由 ``directivename``来决定。

事实上，指令有两种类型： 预定义指令 和 用户自定义指令。 对于用户自定义的指令使用 `@` 来代替 `#`，比如，`<@mydirective `parameters`>`...`</@mydirective>`。 更深的区别在于如果指令没有嵌套内容，那么必须这么使用 `<@mydirective `parameters` />`，这和XML语法很相似 (例如 `<img `...` />`)。 但用户自定义指令是更高级的话题，将会在 后续章节 中继续讨论。

像HTML标签一样，FTL标签也必须正确地嵌套使用。下面这段示例代码就是错的， 因为 `if` 指令在 `list` 指令嵌套内容的内外都有：

    <ul>
    <#list animals as animal>
      <li>${animal.name} for ${animal.price} Euros
      <#if user == "Big Joe">
         (except for you)
    </#list> <#-- WRONG! The "if" has to be closed first. -->
    </#if>
    </ul>

请注意，FreeMarker 仅仅关心FTL标签的嵌套而不关心HTML标签的嵌套。 它只会把HTML看做是文本，不会来解释HTML。

如果你尝试使用一个不存在的指令(比如，输错了指令的名称)， FreeMarker 就会拒绝执行模板，同时抛出错误信息。

FreeMarker会忽略FTL标签中多余的 空白标记，所以也可以这么来写代码：

    <#list[BR]
      animals       as[BR]
         animal[BR]
    >[BR]
    ${animal.name} for ${animal.price} Euros[BR]
    </#list    >

当然，也不能在 `<`，`</` 和指令名中间入空白标记。

所有指令的详细介绍可以在 ref_directives 中找到(但是建议您先看表达式章节)。

通过配置，FreeMarker 可以在FTL标签和FTL注释中， 使用 `[` 和 `]` 来代替 `<` 和 `>`，就像 `[#if user == "Big Joe"]`...`[/#if]`。 要获取更多信息，请参考：dgui_misc_alternativesyntax。

通过配置，FreeMarker 可以不需要 `#` 来理解预定义指令(比如 `<if user == "Big Joe">`...`</if>`)。 而我们不建议这样来使用。要获取更多信息，请参考：ref_depr_oldsyntax。

#### 表达式

当需要给插值或者指令参数提供值时，可以使用变量或其他复杂的表达式。 例如，我们设x为8，y为5，那么 `(x + y)/2` 的值就会被处理成数字类型的值6.5。

在我们展开细节之前，先来看一些具体的例子：

- 当给插值提供值时：插值的使用方式为 `${`expression`}`， 把它放到你想输出文本的位置上，然后给值就可以打印出来了。 即 `${(5 + 8)/2}` 会打印出 ''6.5'' 来 (如果输出的语言不是美国英语，也可能打印出''6,5''来)。

- 当给指令参数提供值时：在入门章节我们已经看到 `if` 指令的使用了。这个指令的语法是：`<#if `expression`>`...`</#if>`。 这里的表达式计算结果必须是布尔类型的。比如 `<#if 2 < 3>` 中的 `2 <3` (2小于3)是结果为 `true` 的布尔表达式。

##### 快速浏览(备忘单)

这里给已经了解 FreeMarker 的人或有经验的程序员的提个醒：

- 直接指定值

  - 字符串： `"Foo"` 或者 `'Foo'` 或者 `"It's \"quoted\""` 或者 `'It\'s "quoted"'` 或者 `r"C:\raw\string"`

  - 数字： `123.45`

  - 布尔值： `true`， `false`

  - 序列： `["foo", "bar", 123.45]`； 值域： `0..9`, `0..<10` (或 `0..!10`), `0..`

  - 哈希表： `{"name":"green mouse", "price":150}`

- 检索变量

  - 顶层变量： `user`

  - 从哈希表中检索数据： `user.name`， `user["name"]`

  - 从序列中检索数据： `products[5]`

  - 特殊变量： `.main`

- 字符串操作

  - 插值(或连接)： `"Hello ${user}!"` (或 `"Hello " + user + "!"`)

  - 获取一个字符： `name[0]`

  - 字符串切分： 包含结尾： `name[0..4]`，不包含结尾： `name[0..<5]`，基于长度(宽容处理)： `name[0..*5]`，去除开头： `name[5..]`

- 序列操作

  - 连接： `users + ["guest"]`

  - 序列切分：包含结尾： `products[20..29]`， 不包含结尾： `products[20..<30]`，基于长度(宽容处理)： `products[20..*10]`，去除开头： `products[20..]`

- 哈希表操作

  - 连接： `passwords + { "joe": "secret42" }`

- 算术运算： `(x * 1.5 + 10) / 2 - y % 100`

- 比较运算： `x == y`， `x != y`， `x < y`， `x > y`， `x >= y`， `x <= y`， `x lt y`， `x lte y`， `x gt y`， `x gte y`， 等等。。。。。。

- 逻辑操作： `!registered && (firstVisit || fromEurope)`

- 内建函数： `name?upper_case`, `path?ensure_starts_with('/')`

- 方法调用： `repeat("What", 3)`

- 处理不存在的值：

  - 默认值： `name!"unknown"` 或者 `(user.name)!"unknown"` 或者 `name!` 或者 `(user.name)!`

  - 检测不存在的值： `name??` 或者 `(user.name)??`

- 赋值操作： `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `++`, `--`

请参考： 运算符优先级

##### 直接确定值

通常我们喜欢是使用直接确定的值而不是计算的结果。

###### 字符串

在文本中确定字符串值的方法是看双引号，比如： `"some text"`，或单引号，比如： `'some text'`。这两种形式是等同的。 如果文本自身包含用于字符引用的引号 ( `"` 或 `'`)或反斜杠时， 应该在它们的前面再加一个反斜杠；这就是转义。 转义允许直接在文本中输入任何字符， 也包括换行。例如：

    ${"It's \"quoted\" and
    this is a backslash: \\"}

    ${'It\'s "quoted" and
    this is a backslash: \\'}

将会输出：

    It's "quoted" and
    this is a backslash: \

    It's "quoted" and
    this is a backslash: \

这里当然可以直接在模板中输入文本而不需要 `${`...`}`。 但是我们在这里用它只是为了示例来说明表达式的使用。

下面的表格是FreeMarker支持的所有转义字符。 在字符串使用反斜杠的其他所有情况都是错误的，运行这样的模板都会失败。

转义序列 | 含义
--- | ---
`\"` | 引号 (u0022)
`\'` | 单引号(又称为撇号) (u0027)
`\{` | 起始花括号：`{`
`\\` | 反斜杠 (u005C)
`\n` | 换行符 (u000A)
`\r` | 回车 (u000D)
`\t` | 水平制表符(又称为tab) (u0009)
`\b` | 退格 (u0008)
`\f` | 换页 (u000C)
`\l` | 小于号：`<`
`\g` | 大于号：`>`
`\a` | &符：`&`
`\x`Code`` | 字符的16进制 Unicode 码 (UCS 码)

在 `\x` 之后的 ``Code`` 是1-4位的16进制码。下面这个示例中都是在字符串中放置版权符号： `"\xA9 1999-2001"`， `"\x0A9 1999-2001"`， `"\x00A9 1999-2001"`。 如果紧跟16进制码后一位的字符也能解释成16进制码时， 就必须把4位补全，否则FreeMarker就会误解你的意图。

请注意，字符序列 `${` (和 `#{`) 有特殊的含义，它们被用做插入表达式的数值(典型的应用是变量的值： `"Hello ${user}!"`)。这将在 后续章节中解释。 如果想要打印 `${` 或 `#{`， 就要使用下面所说的原生字符串，或者进行转义。就像 `"foo $\{bar}"`中的 `{`。

原生字符串是一种特殊的字符串。在原生字符串中， 反斜杠和 `${` 没有特殊含义， 它们被视为普通的字符。为了表明字符串是原生字符串， 在开始的引号或单引号之前放置字母`r`，例如：

    ${r"${foo}"}
    ${r"C:\foo\bar"}

将会输出：

    ${foo}
    C:\foo\bar

###### 数字

输入不带引号的数字就可以直接指定一个数字， 必须使用点作为小数的分隔符而不能是其他的分组分隔符。 可以使用 `-` 或 `+` 来表明符号 (`+` 是多余的)。 科学记数法暂不支持使用 (`1E3` 就是错误的)， 而且也不能在小数点之前不写0(`.5` 也是错误的)。

下面的数字都是合法的：`0.08`， `-5.013`，`8`， `008`，`11`， `+11`

请注意，像 `08`、 `+8`、 `8.00` 和 `8` 这样的数值是完全等同的，它们都是数字8。 所以， `${08}`、`${+8}`、 `${8.00}` 和 `${8}` 的输出都是一样的。

###### 布尔值

直接写 `true` 或者 `false` 就表示一个布尔值了，不需使用引号。

###### 序列

指定一个文字的序列，使用逗号来分隔其中的每个 子变量， 然后把整个列表放到方括号中。例如：

    <#list ["foo", "bar", "baz"] as x>
    ${x}
    </#list>

将会输出：

    foo
    bar
    baz

列表中的项目是表达式，那么也可以这样做： `[2 + 2, [1, 2, 3, 4], "foo"]`。 其中第一个子变量是数字4，第二个子变量是一个序列， 第三个子变量是字符串"foo"。

###### 值域

值域也是序列，但它们由指定包含的数字范围所创建， 而不需指定序列中每一项。比如： `0..<m`，这里假定 `m` 变量的值是5，那么这个序列就包含 `[0, 1, 2, 3, 4]`。值域的主要作用有：使用 `<#list`...`>` 来迭代一定范围内的数字，序列切分 和 字符串切分。

值域表达式的通用形式是( ``start`` 和 ``end`` 可以是任意的结果为数字表达式)：

- ``start`..`end``： 包含结尾的值域。比如 `1..4` 就是 `[1, 2, 3, 4]`， 而 `4..1` 就是 `[4, 3, 2, 1]`。当心一点， 包含结尾的值域不会是一个空序列，所以 `0..length-1` 就是 错误的，因为当长度是 `0` 时， 序列就成了 `[0, -1]`。

- ``start`..<`end`` 或 ``start`..!`end``： 不包含结尾的值域。比如 `1..<4` 就是 `[1, 2, 3]`，`4..<1` 就是 `[4, 3, 2]`, 而 `1..<1` 表示 `[]`。请注意最后一个示例； 结果可以是空序列，和 `..<` 和 `..!` 没有区别; 最后这种形式在应用程序中使用了 `<` 字符而引发问题(如HTML编辑器等)。

- ``start`..*`length``： 限定长度的值域，比如 `10..*4` 就是 `[10, 11, 12, 13]`，`10..*-4` 就是 `[10, 9, 8, 7]`，而 `10..*0` 表示 `[]`。当这些值域被用来切分时， 如果切分后的序列或者字符串结尾在指定值域长度之前，则切分不会有问题；请参考 序列切分 来获取更多信息。

  限定长度的值域是在 FreeMarker 2.3.21版本中引入的。

- ``start`..`： 无右边界值域。这和限制长度的值域很像，只是长度是无限的。 比如 `1..` 就是 `[1, 2, 3, 4, 5, 6, ... ]`，直到无穷大。 但是处理(比如列表显示)这种值域时要万分小心，处理所有项时， 会花费很长时间，直到内存溢出应用程序崩溃。 和限定长度的值域一样，当它们被切分时， 遇到切分后的序列或字符串结尾时，切分就结束了。

  无右边界值域在 FreeMarker 2.3.21 版本以前只能用于切分， 若用于其它用途，它就像空序列一样了。要使用新的特性， 使用 FreeMarker 2.3.21 版本是不够的，程序员要设置 `incompatible_improvements` 至少到2.3.21版本。

值域的进一步注意事项：

- 值域表达式本身并没有方括号，比如这样编写代码 `<#assign myRange = 0..<x>`， 而不是 `<#assign myRange = [0..<x]>`。 后者会创建一个包含值域的序列。方括号是切分语法的一部分，就像 ``seq`[`myRange`]`。

- 可以在 `..` 的两侧编写算术表达式而不需要圆括号， 就像 `n + 1 ..< m / 2 - 1`。

- `..`，`..<`， `..!` 和 `..*` 是运算符， 所以它们中间不能有空格。就像 `n .. <m` 这样是错误的，但是 `n ..< m` 这样就可以。

- 无右边界值域的定义大小是2147483647 (如果 `incompatible_improvements` 低于2.3.21版本，那么就是0)， 这是由于技术上的限制(32位)。但当列表显示它们的时候，实际的长度是无穷大。

- 值域并不存储它们包含的数字，那么对于 `0..1` 和 `0..100000000` 来说，创建速度都是一样的， 并且占用的内存也是一样的。

###### 哈希表

在模板中指定一个哈希表，就可以遍历用逗号分隔开的"键/值"对， 把列表放到花括号内即可。键和值成对出现并以冒号分隔。比如： `{ "name": "green mouse", "price": 150 }`。 请注意名和值都是表达式，但是用来检索的名称就必须是字符串类型， 而值可以是任意类型。

##### 检索变量

###### 顶层变量

访问顶层的变量，可以简单地使用变量名。例如， 用表达式 `user` 就可以在根上获取以 user 为名存储的变量值。然后打印出存储在里面的内容：

    ${user}

如果没有顶层变量，那么 FreeMarker 在处理表达式时就会发生错误， 进而终止模板的执行(除非程序员事先配置了 FreeMarker)。

在这种表达式中，变量名只可以包含字母(也可以是非拉丁文)， 数字(也可以是非拉丁数字)，下划线 (`_`)， 美元符号 (`$`)，at符号 (`@`)。 此外，第一个字符不可以是ASCII码数字(`0`-`9`)。 从 FreeMarker 2.3.22 版本开始，变量名在任何位置也可以包含负号 (`-`)，点(`.`)和冒号(`:`)， 但这些必须使用前置的反斜杠(`\`)来转义， 否则它们将被解释成操作符。比如，读取名为data-id的变量， 表达式为 `data\-id`，因为 `data-id` 将被解释成 data minus id。 (请注意，这些转义仅在标识符中起作用，而不是字符串中。)

###### 从哈希表中检索数据

如果有一个表达式的结果是哈希表， 那么我们可以使用点和子变量的名字得到它的值， 假设我们有如下的数据模型：

    (root)
     |
     +- book
     |   |
     |   +- title = "Breeding green mouses"
     |   |
     |   +- author
     |       |
     |       +- name = "Julia Smith"
     |       |
     |       +- info = "Biologist, 1923-1985, Canada"
     |
     +- test = "title"

现在，就可以通过`book.title` 来读取 `title`，book表达式将返回一个哈希表 (就像上一章中解释的那样)。按这种逻辑进一步来说，我们可以使用表达式 `book.author.name` 来读取到auther的name。

如果我们想指定同一个表达式的子变量，那么还有另外一种语法格式： `book["title"]`。在方括号中可以给出任意长度字符串的表达式。 在上面这个数据模型示例中还可以这么来获取title： `book[test]`。 下面这些示例它们含义都是相等的： `book.author.name`， `book["author"].name`， `book.author.["name"]`， `book["author"]["name"]`。

当使用点式语法时，顶层变量名的命名也有相同的限制 (命名时只能使用字母，数字，`_`，`$`， `@`，但是不能使用 `0`-`9`开头， 同时，从2.3.22版本开始，也可以使用 `\-`，`\.` 和 `\:`)。当使用方括号语法时，则没有这样的限制， 因为名称可以是任意表达式的结果。(请注意，对于FreeMarker的XML支持来说， 如果子变量名称是 `*` (星号) 或者 `**`，那么就不要使用方括号语法。)

对于顶层变量来说，如果尝试访问一个不存在的变量也会引起错误导致解析执行模板中断 (除非程序员事先配置过FreeMarker)。

###### 从序列中检索数据

这和从哈希表中检索是相同的，但是只能使用方括号语法形式来进行， 而且方括号内的表达式最终必须是一个数字而不是字符串。比如，要从 示例数据模型 中获取第一个动物的名字 (记住第一项数字索引是0而不是1)，可以这么来写: `animals[0].name`

###### 特殊变量

特殊变量是由FreeMarker引擎本身定义的。 使用它们，可以按照如下语法形式来进行： `.`variable_name``。.

通常情况下是不需使用特殊变量，而对专业用户来说可能用到。 所有特殊变量的说明可以参见 参考手册。

##### 字符串操作

###### 插值 (或连接)

如果要在字符串中插入表达式的值，可以在字符串的文字中使用 `${`...`}` (已经废弃的 `#{`...`}`)。 `${`...`}` 在字符串中的作用和在 文本 区是相同的 (它遵守相同的 本地化敏感 的数字和日期/时间格式)， 而不是 自动转义。

示例 (假设user是 ''Big Joe'')：

    <#assign s = "Hello ${user}!">
    ${s} <#-- Just to see what the value of s is -->

将会输出：

    Hello Big Joe!

用户所犯的一个常见错误是将插值放在了不需要/不应该使用的地方。 插值 仅 在 文本 区 中有效。(比如， `<h1>Hello ${name}!</h1>`) 还有在字符串值中 (比如， `<#include "/footer/${company}.html">`)。 典型的 错误 使用是 `<#if ${big}>...</#if>`， 这会导致语法错误。简单写为 `<#if big>...</#if>`即可。 而且， `<#if "${big}">...</#if>` 也是 错误的， 因为它将参数值转换为字符串，但是 `if` 指令只接受布尔值， 那么这将导致运行时错误。

另外，也可以使用 `+` 号来达到类似的效果：

    <#assign s = "Hello " + user + "!">

这样的效果和使用 `${`...`}` 是一样的。

因为 `+` 和使用 `${`...`}` 的规则相同，附加的字符串受到 `locale`， `number_format`，`date_format`， `time_format`，`datetime_format` 和 `boolean_format` 等等设置的影响， 这是对人来说的，而不是通常机器的解析。默认情况下，这会导致数字出问题， 因为很多地区使用分组(千分位分隔符)，那么 `"someUrl?id=" + id` 就可能会是 `"someUrl?id=1 234"`。 要预防这种事情的发生，请使用 `?c` (对计算机来说)内建函数，那么在 `"someUrl?id=" + id?c` 或 `"someUrl?id=${id?c}"`中， 就会得到如 `"someUrl?id=1234"` 这样的输出， 而不管本地化和格式的设置是什么。

###### 获取字符

在给定索引值时可以获取字符串中的一个字符，这和 序列的子变量是相似的， 比如 `user[0]`。这个操作执行的结果是一个长度为1的字符串， FTL并没有独立的字符类型。和序列中的子变量一样，这个索引也必须是数字， 范围是从0到字符串的长度，否则模板的执行将会发生错误并终止。

由于序列的子变量语法和字符的getter语法冲突， 那么只能在变量不是序列时使用字符的getter语法(因为FTL支持多类型值，所以它是可能的)， 这种情况下使用序列方式就比较多。(为了变通，可以使用 内建函数 `string` ，比如 `user?string[0]`。不必担心你不理解这是什么意思， 内建函数将会在后续章节中讨论。)

示例(假设 user 是 Big Joe):

    ${user[0]}
    ${user[4]}

将会输出(请注意第一个字符的索引是0)：

    B
    J

###### 字符串切分 (子串)

可以按照 切分序列 (请参看)的相同方式来切分字符串，这就是使用字符来代替序列。不同的是：

- 降序域不允许进行字符串切分。 (因为不像序列那样，很少情况下会想反转字符串。 如果真要这样做了，那就是疏忽。)

- 如果变量的值既是字符串又是序列(多类型值)， 那么切分将会对序列进行，而不是字符串。当处理XML时， 这样的值就是普通的了。此时，可以使用 ``someXMLnode`?string[`range`]`。

- 一个遗留的bug：值域 包含 结尾时， 结尾小于开始索引并且是是非负的(就像在 `"abc"[1..0]` 中)， 会返回空字符串而不是错误。(在降序域中这应该是个错误。) 现在这个bug已经向后兼容，但是不应该使用它，否在就会埋下一个错误。

示例：

    <#assign s = "ABCDEF">
    ${s[2..3]}
    ${s[2..<4]}
    ${s[2..*3]}
    ${s[2..*100]}
    ${s[2..]}

将会输出：

    CD
    CD
    CDE
    CDEF
    CDEF

下面包括了一些使用内建函数来方便字符串切分的典型用例： `remove_beginning`， `remove_ending`， `keep_before`， `keep_after`， `keep_before_last`， `keep_after_last`

##### 序列操作

###### 连接

序列的连接可以按照字符串那样使用 `+` 号来进行，例如：

    <#list ["Joe", "Fred"] + ["Julia", "Kate"] as user>
    - ${user}
    </#list>

将会输出：

    - Joe
    - Fred
    - Julia
    - Kate

请注意，不要在很多重复连接时使用序列连接操作， 比如在循环中往序列上追加项目，而这样的使用是可以的： `<#list users + admins as person>`。 尽管序列连接的速度很快，而且速度是和被连接序列的大小相独立的， 但是最终的结果序列的读取却比原先的两个序列慢那么一点。 通过这种方式进行的许多重复连接最终产生的序列读取的速度会慢。

###### 序列切分

使用 ``seq`[`range`]`， 这里 ``range`` 是一个值域 此处有说明， 就可以得到序列的一个切分。结果序列会包含原序列 (``seq``)中的项， 而且索引在值域中。例如：

    <#assert seq = ["A", "B", "C", "D", "E"]>
    <#list seq[1..3] as i>${i}</#list>

将会输出：

    BCD

此外，切分后序列中的项会和值域的顺序相同。 那么上面的示例中，如果值域是 `3..1` 将会输出 `DCB`。

值域中的数字必须是序列可使用的合法索引， 否则模板的处理将会终止并报错。像上面的示例那样， `seq[-1..0]` 就会出错， 而 `seq[-1]` 就是合法的。 `seq[1..5]` 也不对， 因为 `seq[5]` 是非法的。 (请注意，尽管100已经越界，但是 `seq[100..<100]` 或 `seq[100..*0]` 是合法的，因为那些值域都是空。)

限制长度的值域 (``start`..*`length``) 和无右边界值域 (``start`..`) 适用于切分后序列的长度。它们会切分可用项中尽可能多的部分：

    <#assign seq = ["A", "B", "C"]>

    Slicing with length limited ranges:
    - <#list seq[0..*2] as i>${i}</#list>
    - <#list seq[1..*2] as i>${i}</#list>
    - <#list seq[2..*2] as i>${i}</#list> <#-- Not an error -->
    - <#list seq[3..*2] as i>${i}</#list> <#-- Not an error -->

    Slicing with right-unlimited ranges:
    - <#list seq[0..] as i>${i}</#list>
    - <#list seq[1..] as i>${i}</#list>
    - <#list seq[2..] as i>${i}</#list>
    - <#list seq[3..] as i>${i}</#list>

将会输出：

    Slicing with length limited ranges:
    - AB
    - BC
    - C
    -

    Slicing with right-unlimited ranges:
    - ABC
    - BC
    - C
    -

请注意，上面的有限长度切分和无右边界切分都允许开始索引超过最后项 一个 (但不能再多了)。

要对序列进行给定大小的切分，就应该使用内建函数 `chunk`。

##### 哈希表操作

###### 连接

像连接字符串那样，也可以使用 `+` 号的方式来连接哈希表。如果两个哈希表含有键相同的项，那么在 `+` 号右侧的哈希表中的项优先。例如：

    <#assign ages = {"Joe":23, "Fred":25} + {"Joe":30, "Julia":18}>
    - Joe is ${ages.Joe}
    - Fred is ${ages.Fred}
    - Julia is ${ages.Julia}

将会输出：

    - Joe is 30
    - Fred is 25
    - Julia is 18

请注意，很多项连接时不要使用哈希表连接， 比如在循环时往哈希表中添加新项。这和序列连接 的情况是一致的。

##### 算数运算

算数运算包含基本的四则运算和求模运算，运算符有：

- 加法： `+`

- 减法： `-`

- 乘法： `*`

- 除法： `/`

- 求模 (求余)： `%`

示例：

    ${100 - x * x}
    ${x / 2}
    ${12 % 10}

假设 `x` 是 5，将会输出：

    75
    2.5
    2

要保证两个操作数都是结果为数字的表达式。 下面的这个例子在运行时，FreeMarker就会发生错误， 因为是字符串 `"5"` 而不是数字5：

    ${3 * "5"} <#-- WRONG! -->

但这种情况也有一个例外，就是 `+` 号，它是用来 连接字符串的。 如果 `+` 号的一端是字符串，`+` 号的另外一端是数字，那么数字就会自动转换为字符串类型(使用当前页面语言的适当格式)， 之后使用 `+` 号作为字符串连接操作符。示例如下：

    ${3 + "5"}

将会输出：

    35

通常来说，FreeMarker不会自动将字符串转换为数字，反之会自动进行。

有时我们只想获取除法计算(或其它运算)的整数部分， 这可以使用内建函数 `int` 来解决。(关于内建函数 后续章节会来解释)：

    ${(x/2)?int}
    ${1.1?int}
    ${1.999?int}
    ${-1.1?int}
    ${-1.999?int}

假设 `x` 是 5，将会输出：

    2
    1
    1
    -1
    -1

##### 比较运算

有时我们需要知道两个值是否相等，或者哪个值更大一点。

为了演示具体的例子，我们在这里使用 `if` 指令。 `if` 指令的用法是： `<#if `expression`>...</#if>`， 其中的表达式的值必须是布尔类型，否则将会出错，模板执行中断。 如果表达式的结果是 `true` ， 那么在开始和结束标记内的内容将会被执行，否则就会被跳过。

测试两个值相等使用 `=` (或者采用Java和C语言中的 `==` ；二者是完全等同的。) 测试两个值不等使用 `!=`。比如， 假设 `user` 是 ''Big Joe''：

    <#if user == "Big Joe">
      It is Big Joe
    </#if>
    <#if user != "Big Joe">
      It is not Big Joe
    </#if>

`<#if ...>` 中的表达式 `user = "Big Joe"` 就是布尔值 `true`，面的代码将会输出 ''It is Big Joe''。

`=` 或 `!=` 两边的表达式的结果都必须是标量，而且两个标量都必须是相同类型 (也就是说字符串只能和字符串来比较，数字只能和数字来比较等)否则将会出错， 模板执行中断。例如 `<#if 1 = "1">` 就会导致错误。 请注意FreeMarker进行的是精确的比较，所以字符串在比较时要注意大小写和空格： `"x"` 和 `"x "` 和 `"X"` 是不同的值。

对数字和日期类型的比较，也可以使用 `<`， `<=`，`>=` 和 `>`。不能把它们当作字符串来比较。比如：

    <#if x <= 12>
      x is less or equivalent with 12
    </#if>

使用 `>=` 和 `>` 的时候有一点小问题。FreeMarker解释 `>` 的时候可以把它当作FTL标签的结束符。为了避免这种问题，可以使用 `lt` 代替 `<`， `lte` 代替 `<=`， `gt` 代替 `>` 还有 `gte` 代替 `>=`， 例如 `<#if x gt y>`。另外一个技巧是将表达式放到 圆括号 中， 尽管这么写并不优雅，例如 `<#if (x > y)>`。

FreeMarker 也支持一些其它的选择，但是这些已经废弃了：

- 在可能出问题的关系标记处使用 `&gt;` 和 `&lt;` ，就像： `<#if x &gt; y>` 或 `<#if x &gt;= y>`。 请注意通常FTL不支持标签中的实体引用(如 `&`...`；` 这些东西)； 做算术比较时就会有异常。

- `\lt`， `\lte`， `\gt` 和 `\gte` 使用他们时， 不带反斜杠的效果一样。

##### 逻辑操作

常用的逻辑操作符：

- 逻辑 或： `||`

- 逻辑 与： `&&`

- 逻辑 非： `!`

逻辑操作符仅仅在布尔值之间有效，若用在其他类型将会产生错误导致模板执行中止。

例如：

    <#if x < 12 && color == "green">
      We have less than 12 things, and they are green.
    </#if>
    <#if !hot> <#-- here hot must be a boolean -->
      It's not hot.
    </#if>

##### 内建函数

内建函数就像FreeMarker在对象中添加的方法一样。 要防止和实际方法和其它子变量的命名冲突，则不能使用点 (`.`)，这里使用问号 (`?`)来和父对象分隔开。 比如，想要保证 `path` 有起始的 `/` ，那么可以这么来写： `path?ensure_starts_with('/')`。 `path` 后的Java对象(通常就是 `String`) 并没有这样的方法，这是FreeMarker添加的。为了简洁，如果方法没有参数， 那么就可以忽略 `()`，比如想要获取 `path` 的长度，就可以写作：`path?length`， 而不是 `path?length()`。

内建函数关键性的另外一个原因是常见的(尽管它依赖于配置的设置)， FreeMarker不会暴露对象的Java API。那么尽管Java的 `String` 类有 `length()` 方法，但在模板中却是不可见的， 就 不得不 使用 `path?length` 来代替。 这里的优点是模板不依赖下层Java对象的精确类型。(比如某些场景中， `path` 也可能是 `java.nio.Path` 类型， 如果程序员配置了FreeMarker去暴露 `Path` 对象作为FTL字符串类型，那么模板就不会在意了，使用 `?length` 也是可以的， 即便 `java.nio.Path` 没有类似的方法。)

可以找到一些 此处提及的常用内建函数，还有 完整的内建函数参考。 现在，我们只需了解一些重要的内建函数就行了：

比如：

    ${testString?upper_case}
    ${testString?html}
    ${testString?upper_case?html}

    ${testSequence?size}
    ${testSequence?join(", ")}

假设 `testString` 中存储了字符串 ''Tom & Jerry'', 而testSequnce中存储了字符串 foo， bar 和 baz， 将会输出：

    TOM & JERRY
    Tom &amp; Jerry
    TOM &amp; JERRY

    3
    foo, bar, baz

请注意：上面的 `testString?upper_case?html`。因为 `test?upper_case` 的结果是字符串，那么就可以在它的上面 使用内建函数 `html`。

很自然可以看到，内建函数的左侧可以是任意的表达式，而不仅仅是变量名：

    ${testSeqence[1]?cap_first}
    ${"horse"?cap_first}
    ${(testString + " & Duck")?html}

    Bar
    Horse
    Tom &amp; Jerry &amp; Duck

##### 方法调用

如果有一个方法，那么可以使用方法调用操作。 方法调用操作是使用逗号来分割在括号内的表达式而形成参数列表，这些值就是参数。 方法调用操作将这些值传递给方法，然后返回一个结果。 这个结果就是整个方法调用表达式的值。

假设程序员定义了一个可供调用的方法 `repeat`。 第一个参数是字符串类型，第二个参数是数字类型。方法的返回值是字符串类型， 而方法要完成的操作是将第一个参数重复显示，显示的次数是第二个参数设定的值。

    ${repeat("Foo", 3)}

将会输出：

    FooFooFoo

这里的 `repeat` 就是方法变量(根据如何 访问顶层变量)， `("What", 3)` 就调用了该方法。

这里需要强调方法调用也是普通表达式，和其它都是一样的，所以：

    ${repeat(repeat("x", 2), 3) + repeat("Foo", 4)?upper_case}

将会输出：

    xxxxxxFOOFOOFOOFOO

##### 处理不存在的值

这些操作符是从 FreeMarker 2.3.7 版本开始引入的(用来代替内建函数 `default`， `exists` 和 `if_exists` )。

正如我们前面解释的那样，当试图访问一个不存在的变量时， FreeMarker 将会报错而导致模板执行中断。 通常我们可以使用两个特殊操作符来压制这个错误，控制这种错误情况。 被控制的变量可以是顶层变量，哈希表或序列的子变量。 此外这些操作符还能处理方法调用的返回值不存在的情况 (这点对Java程序员来说： 返回值是 `null` 或者返回值为 `void` 类型)，通常来说，我们应该使用这些操作符来控制可能不存在的值， 而不仅仅是不存在的变量。

对于知道Java中 `null` 的人来说，FreeMarker 2.3.`x` 版本把它们视为不存在的变量。单地说，模板语言中没有 `null` 这个概念。比如有一个bean，bean中有一个 `maidenName` 属性， 对于模板而言(假设没有配置FreeMarker来使用一些极端的对象包装)， 该属性的值是 `null`，和不存在这个属性的情况是一致的。 调用方法的返回值如果是 `null` 的话 FreeMarker 也会把它当作不存在的变量来处理 (假定只使用了普通的对象包装)。可以在 FAQ 中了解更多内容。

如果想知道为什么 FreeMarker 对不存在的变量如此挑剔， 请阅读 FAQ 部分。

###### 默认值操作符

使用形式： ``unsafe_expr`!`default_expr`` 或 ``unsafe_expr`!` or `(`unsafe_expr`)!`default_expr`` 或 `(`unsafe_expr`)!`

这个操作符允许你为可能不存在的变量指定一个默认值。

例如，假设下面展示的代码中没有名为 `mouse` 的变量：

    ${mouse!"No mouse."}
    <#assign mouse="Jerry">
    ${mouse!"No mouse."}

将会输出：

    No mouse.
    Jerry

默认值可以是任何类型的表达式，也可以不必是字符串。 也可以这么写：`hits!0` 或 `colors!["red", "green", "blue"]`。 默认值表达式的复杂程度没有严格限制，还可以这么来写： `cargo.weight!(item.weight * itemCount + 10)`。

如果在 `!`后面有复合表达式， 如 `1 + x`，通常 使用括号，如 `${x!(1 + y)}` 或 `${(x!1) + y)}`，这样就根据你的意图来确定优先级。 由于FreeMarker 2.3.x 版本的源码中的小失误所以必须这么来做。 `!` (作为默认值操作) 右侧的优先级非常低。 这就意味着 `${x!1 + y}` 会被 FreeMarker 误解为 `${x!(1 + y)}`，而真实的意义是 `${(x!1) + y}`。 这个源码错误在FreeMarker 2.4中会得到修正。 在编程中注意这个错误，要么就使用FreeMarker 2.4！

如果默认值被省略了，那么结果将会是空串，空序列或空哈希表。 (这是 FreeMarker 允许多类型值的体现)请注意，如果想让默认值为 `0` 或 `false`，则不能省略它。例如：

    (${mouse!})
    <#assign mouse = "Jerry">
    (${mouse!})

将会输出：

    ()
    (Jerry)

因为语法的含糊 `<@something a=x! b=y />` 将会解释为 `<@something a=x!(b=y) />`，那就是说 `b=y` 将会被视为是比较运算，然后结果作为 `x`的默认值，而不是想要的参数 `b`。 为了避免这种情况，如下编写代码即可： `<@something a=(x!) b=y />`

用于非顶层变量时，默认值操作符可以有两种使用方式：

    product.color!"red"

如果是这样的写法，那么在 `product` 中， 当 `color` 不存在时(返回 `"red"` )， 将会被处理，但是如果连 `product` 都不存在时将不会处理。 也就是说这样写时变量 `product` 必须存在，否则模板就会报错。

    (product.color)!"red"

这时，如果当 `product.color` 不存在时也会被处理， 那就是说，如果 `product` 不存在或者 `product` 存在而 `color` 不存在，都能显示默认值 `"red"` 而不会报错。 本例和上例写法的重要区别在于用括号时， 就允许其中表达式的任意部分可以未定义。而没有括号时， 仅允许表达式的最后部分可以不被定义。

当然，默认值操作也可以作用于序列子变量，比如：

    <#assign seq = ['a', 'b']>
    ${seq[0]!'-'}
    ${seq[1]!'-'}
    ${seq[2]!'-'}
    ${seq[3]!'-'}

将会输出：

    a
    b
    -
    -

如果序列索引是负数(比如 `seq[-1]!'-'`) 也会发生错误，不能使用该运算符或者其它运算符去压制它。

###### 不存在值检测操作符

使用形式： ``unsafe_expr`??` 或 `(`unsafe_expr`)??`

这个操作符告诉我们一个值是否存在。基于这种情况， 结果是 `true` 或 `false`。

示例如下，假设并没有名为 `mouse` 的变量：

    <#if mouse??>
      Mouse found
    <#else>
      No mouse found
    </#if>
    Creating mouse...
    <#assign mouse = "Jerry">
    <#if mouse??>
      Mouse found
    <#else>
      No mouse found
    </#if>

将会输出：

      No mouse found
    Creating mouse...
      Mouse found

访问非顶层变量的使用规则和默认值操作符也是一样的， 也就是说，可以写 `product.color??` 和 `(product.color)??`。

##### 赋值操作符

这些并不是表达式，只是复制指令语法的一部分，比如 `assign`, `local` 和 `global`。 照这样，它们不能任意被使用。

`<#assign x += y>` 是 `<#assign x = x + y>` 的简写，`<#assign x *= y>` 是 `<#assign x = x * y>`的简写等等。。。

`<#assign x++>` 和 `<#assign x += 1>` (或 `<#assign x = x + 1>`)不同，它只做算术加法运算 (如果变量不是数字的话就会失败)，而其它的是进行字符串，序列连接和哈希表连接的重载。 `<#assign x-->` 是 `<#assign x -= 1>` 的简写。

##### 括号

括号可以用来给任意表达式分组。示例如下：

                                   <#-- Output will be: -->
    ${3 * 2 + 2}                   <#-- 8 -->
    ${3 * (2 + 2)}                 <#-- 12 -->
    ${3 * ((2 + 2) * (1 / 2))}     <#-- 6 -->
    ${"green " + "mouse"?upper_case}    <#-- green MOUSE -->
    ${("green " + "mouse")?upper_case}  <#-- GREEN MOUSE -->
    <#if !(color == "red" || color == "green")>
      The color is nor red nor green
    </#if>

请注意，方法调用表达式 使用的括号和给表达式分组的括号含义是完全不同的。

##### 表达式中的空格

FTL 忽略表达式中的多余的 空格。下面的表示是相同的：

    ${x + ":" + book.title?upper_case}

和

    ${x+":"+book.title?upper_case}

和

    ${
       x
     + ":"   +  book   .   title
       ?   upper_case
          }

##### 操作符的优先级

下面的表格显示了已定义操作符的优先级。 表格中的运算符按照优先程度降序排列：上面的操作符优先级高于它下面的。 高优先级的运算符执行要先于优先级比它低的。表格同一行上的两个操作符优先级相同。 当有相同优先级的二元运算符(运算符有两个''参数''，比如 `+`和`-`)挨着出现时，它们按照从左到右的原则运算。

运算符组 | 运算符
--- | ---
最高优先级运算符 | `[`subvarName`] [`subStringRange`] . ? (`methodParams`) `expr`! `expr`??`
一元前缀运算符 | `+`expr` -`expr` !expr`
乘除法，求模运算符 | `* / %`
加减法运算符 | `+ -`
数字值域 | `..` `..<` `..!` `..*`
关系运算符 | `< > <= >=` (and equivalents: `gt`, `lt`, etc.)
相等，不等运算符 | `== !=` (and equivalents: `=`)
逻辑 与 运算符 | `&&`
逻辑 或 运算符 | `||`

如果你熟悉C语言，Java语言或JavaScript语言， 请注意 FreeMarker 中的优先级规则和它们是相同的， 除了那些只有FTL本身含有的操作符。

因为编程的失误，默认值操作符 (``exp`!`exp``) 不在上面的表格中，按照向后兼容的原则，在 FreeMarker 2.4 版本中将会修正它。 而且它将是最高优先级的运算符，但是在 FreeMarker 2.3.x 版本中它右边的优先级由于失误就非常低。 所以在默认值操作符的右边中使用复杂表达式时可以使用括号， 可以是 `x!(y + 1)` 或者是 `(x!y) + 1`。 而不能是 `x!y + 1`。

#### 插值

##### 概览

插值的使用格式是： `${`expression`}`，这里的 ``expression`` 可以是所有种类的表达式(比如 `${100 + x}`)。

插值是用来给 ``表达式`` 插入具体值然后转换为文本(字符串)。插值仅仅可以在两种位置使用：在 文本 区 (比如 `<h1>Hello ${name}!</h1>`) 和 字符串表达式 (比如 `<#include "/footer/${company}.html">`)中。

表达式的结果必须是字符串，数字或者日期/时间/日期-时间值， 因为(默认是这样)仅仅这些值可以被插值自动转换为字符串。其它类型的值 (比如布尔值，序列)必须 手动地 转换成字符串(后续会有一些建议)， 否则就会发生错误，中止模板执行。

一个常犯的错误是在不能使用插值的地方使用了它。 插值 仅仅 在 文本 区 (比如 `<h1>Hello ${name}!</h1>`) 和 字符串 (比如 `<#include "/footer/${company}.html">`)中起作用。 典型的 错误 使用是 `<#if ${big}>...</#if>`，这是语法上的错误。 只要简单写为 `<#if big>...</#if>`即可。 而且 `<#if "${big}">...</#if>` 也是 错误的，因为这样参数就是字符串类型了， 但是 `if` 指令的参数要求是布尔值，所以就会发生运行时错误。

##### 字符串插入指南：不要忘了转义！

如果插值在 文本 区 (也就是说，不在 字符串表达式 中)，如果 `escape` 指令 起作用了，那么将被插入的字符串会被自动转义。如果要生成HTML， 那么强烈建议你利用它来阻止跨站脚本攻击和非格式良好的HTML页面。这里有一个示例：

    <#escape x as x?html>
      ...
      <p>Title: ${book.title}</p>
      <p>Description: <#noescape>${book.description}</#noescape></p>
      <h2>Comments:</h2>
      <#list comments as comment>
        <div class="comment">
          ${comment}
        </div>
      </#list>
      ...
    </#escape>

这个示例展示了当生成HTML时，最好将完整的模板放入到 `escape` 指令中。那么，如果 `book.title` 包含 `&`， 在输出中它就会被替换成 `&amp;`， 而页面还会保持为格式良好的HTML。如果用户注释包含如 `<iframe>`(或其它元素)的标记，那么就会被转义成 `&lt;iframe&gt;` 的样子，使他们没有任何有害点。 但有时在数据模型中真的需要HTML，我们假设上面的 `book.description` 在数据库中的存储是HTML格式的， 那么此时不得不使用 `noescape` 来抵消 `escape` 的转义，不包含 `escape`， 模板就会像这样了：

      ...
      <p>Title: ${book.title?html}</p>
      <p>Description: ${book.description}</p>
      <h2>Comments:</h2>
      <#list comments as comment>
        <div class="comment">
          ${comment?html}
        </div>
      </#list>
      ...

这和之前示例的效果是一样的， 但是这里可能会忘记 `?html` 等内建函数，那么这就会有安全上的问题了。 在之前的示例中，你可能忘记 `noescape` 等内建函数， 也会造成不良的输出，但是起码是没有安全隐患的。

##### 数字插入指南

如果表达式是数字类型，那么根据数字的默认格式， 数值将会转换成字符串。这也许会包含最大的小数， 数字分组和相似处理的问题。通常程序员应该设置默认的数字格式； 而模板设计者不需要处理它(但是可以使用 `number_format` 来设置；详情请参考 `setting` 指令部分的文档)。 可以使用 内建函数 `string` 为一个插值来重写默认数值格式。

小数的分隔符通常(其他类似的符号也是这样，如分组符号) 是根据所在地的标准(语言，国家)来确定的，这也需要程序员来设置。例如这个模板：

    ${1.5}

如果当前本地化设置为英语时，将会输出：

    1.5

而当前地区为德国时，将会输出：

    1,5

这是因为德国人使用逗号作为小数点。

可以看出，插值的打印都是给用户看的(至少是这样的)， 而不是给''计算机''的。有时候这样并不好，比如要打印数据库记录的主键， 用来作为URL中的一部分或HTML表单的隐藏域来作为提交内容， 或者要打印CSS/JavaScript中的数字，因为这些值都是给计算机程序去识别的而不是给用户看的。 很多程序对数字格式的要求非常严格，它们只能理解一部分简单的美式数字格式。那样的话， 可以使用内建函数`c` （代表''计算机''）来解决这个问题，比如：

    <a href="/shop/productdetails?id=${product.id?c}">Details...</a>

##### 日期/时间插入指南

如果表达式的值是时间日期类型，那么日期中的数字将会按照默认格式来转换成文本。 通常程序员应该设置默认格式，而页面设计者无需处理这一点。(如果需要的话， 可以参考 `date_format`， `time_format` 和 `datetime_format` 的 `setting` 指令设置)。当然，也可以使用 内建函数`string` 来覆盖单独插值的默认格式。

为了将日期显示成文本，FreeMarker 必须知道日期中的哪一部分在使用，也就是说， 如果仅仅日期部分(年，月，日)使用或仅仅时间部分(时，分，秒，毫秒)使用或两部分都用。 不幸的是，由于Java平台技术的限制，自动探测一些变量是不现实的。 这时可以找程序员对数据模型中可能出问题的变量进行处理。 如果找出时间日期变量的哪部分在使用是不太可能的话，就必须帮助 FreeMarker 使用内建函数 `date`， `time` 和 `datetime` 来识别 (比如 `${lastUpdated?datetime}` )，否则就会出现错误停止执行。

##### 布尔值插入指南

若要使用插值方式来打印布尔值会引起错误，中止模板的执行。 例如： `${a == 2}` 就会引起错误， 它不会打印''true''或其他内容。这是因为没有全局来表示布尔值的好方法 (有时想输出yes/no，但有时是想要enabled/disabled,on/off等等)。

我们可以使用内建函数 `?string` 来将布尔值转换为字符串形式。比如输出变量"married"的值(假设它是一个布尔值)， 那么可以这么来写: `${married?string("yes", "no")}`。

可以使用设置参数 `boolean_format` 来为 FreeMarker 配置默认的布尔值格式。那么，直接编写 `${married}` 这样的代码就不会有问题了。但在很多应用程序中， 这样的做法是不推荐使用的，因为布尔值在不同的地方就应该呈现出不同的格式， 同时将格式留作默认值也可以认为是疏忽，因为这可能导致错误产生。

当想生成JavaScript或其它计算机语言代码部分时，那么可以考虑使用 `${someBoolean?c}`(c 代表计算机)来输出布尔值true/false。 (请记住 `?c` 也可以用来输出给计算机看的数字。)

##### 精确的转换规则

对于有兴趣研究的人，表达式的值转换为字符串(仍受限于转义) 精确的规则就是下面这些，以这个顺序进行：

1. 如果这个值是数字，那么它会按照指定的 `number_format` 设置规则来转换为字符串。所以这些转换通常是对用户进行的，而不是对计算机。

2. 如果这个值是日期，时间或时间日期类型的一种，那么它们会按照指定的 `date_format`， `time_format` 或者 `datetime_format` 设置规则来转换为字符串。 如果它不能被探测出来是哪种日期类型(日期或时间或日期时间)时，就会发生错误了。

3. 如果值本来就是字符串类型的，不需要转换。

4. 如果 FreeMarker 引擎在传统兼容模式下：

   1. 如果值是布尔类型，true值就转换成"true"，false值将会转换为空字符串。

   2. 如果表达式未被定义(`null` 或者变量未定义)， 那么就转换为空字符串。

   3. 否则就会发生错误中止模板执行。

5. 否则就会发生错误中止模板执行。

### 其它

#### 自定义指令

自定义指令可以使用 `macro` 指令来定义， 这是模板设计者所关心的内容。 Java程序员若不想在模板中实现定义指令，而是在Java语言中实现指令的定义， 这时可以使用 `freemarker.template.TemplateDirectiveModel` 类来扩展 (请参考 后续章节)。

##### 基本内容

宏是有一个变量名的模板片段。可以在模板中使用宏作为自定义指令， 这样就能进行重复性的工作。例如，创建一个宏变量来输出大字号的''Hello Joe!''：

    <#macro greet>
      <font size="+2">Hello Joe!</font>
    </#macro>

`macro` 指令自身不输出任何内容， 它只是用来创建宏变量，所以就会有一个名为 `greet` 的变量。在 `<#macro greet>` 和 `</#macro>` 之间的内容 (称为 宏定义体) 将会在使用该变量作为指令时执行。可以在FTL标记中通过 `@`代替`#`来使用自定义指令。 使用变量名作为指令名。而且，自定义指令的 结束标记 也是需要的。那么， 就可以这样来使用 `greet`：

    <@greet></@greet>

因为 `<`anything`></`anything`>` 和 `<`anything`/>` 是相同的， 也可以使用单标记形式(如果你了解 XML，那么就应该很熟悉了)：

    <@greet/>

将会输出：

      <font size="+2">Hello Joe!</font>

宏能做的事情还有很多，因为在 `<#macro `...`>` 和 `</#macro>` 之间的东西是模板片段，也就是说它可以包含插值 (`${`...`}`) 和FTL标签 (如 `<#if `...`>`...`</#if>`)。

程序员通常将使用 `<@`...`>` 这称为 宏 调用。

##### 参数

我们来改进 `greet` 宏使之可以使用任意的名字， 而不仅仅是''Joe''。为了实现这个目的，就要使用到 参数。在 `macro` 指令中，宏名称的后面位置是用来定义参数的。这里我们仅在 `greet` 宏中定义一个参数，`person`：

    <#macro greet person>
      <font size="+2">Hello ${person}!</font>
    </#macro>

那么就可以这样来使用这个宏：

    <@greet person="Fred"/> and <@greet person="Batman"/>

这和HTML的语法是很相似的，将会输出：

      <font size="+2">Hello Fred!</font>
     and   <font size="+2">Hello Batman!</font>

那么我们就看到了，宏参数的真实值是可以作为变量 (`person`)放在宏定义体中的。使用 预定义指令时，参数的值 (`=`号后边的值)可以是 FTL 表达式。 那么，不像HTML，`"Fred"` 和 `"Batman"` 引号就可以不用要了。 `<@greet person=Fred/>` 也意味着使用变量的值 `Fred` 作为 `person` 参数， 而不是字符串`"Fred"`。当然参数值并不一定是字符串类型， 也可以是数字，布尔值，哈希表，序列等。也可以在 `=` 号左边使用复杂表达式(比如 `someParam=(price + 50)*1.25`)。

自定义指令可以有多个参数。如下所示，再添加一个新的参数 `color`：

    <#macro greet person color>
      <font size="+2" color="${color}">Hello ${person}!</font>
    </#macro>

那么，这个宏就可以这样来使用：

    <@greet person="Fred" color="black"/>

参数的顺序不重要，下面的这个和上面的含义也是相同的：

    <@greet color="black" person="Fred"/>

当调用这个宏的时候，只能使用在 `macro` 指令中定义的参数(本例中是：`person` 和 `color`)。 那么当你尝试 `<@greet person="Fred" color="black" background="green"/>` 的时候就会发生错误，因为并没有在 `<#macro`...`>` 中提及参数 `background`。

同时也必须给出在宏中定义所有参数的值。如果尝试 `<@greet person="Fred"/>` 时也会发生错误， 因为忘记指定 `color`的值了。 很多情况下需要给一个参数指定一个相同的值，所以我们仅仅想在这个值发生变化后重新赋给变量。 那么要达到这个目的，在`macro`指令中必须这么来指定变量： ``param_name`=`usual_value``。 例如，当没有特定值的时候，我们想要给 `color` 赋值为 `"black"`，那么 `greet` 指令就要这么来写：

    <#macro greet person color="black">
      <font size="+2" color="${color}">Hello ${person}!</font>
    </#macro>

现在，我们这么使用宏就可以了： `<@greet person="Fred"/>`，因为它和 `<@greet person="Fred" color="black"/>` 是相等的， 这样参数 `color` 的值就是已知的了。 如果想给 `color` 设置为 `"red"`， 那么就写成： `<@greet person="Fred" color="red"/>`， 这时 `macro` 指令就会使用这个值来覆盖之前设置的通用值， 参数 `color` 的值就会是 `"red"` 了。

根据已知的 FTL 表达式规则， 明白下面这一点是至关重要的。`someParam=foo` 和 `someParam="${foo}"` 是不同的。第一种情况， 是把变量 `foo` 的值作为参数的值来使用。第二种情况则是使用 插值形式的字符串， 那么参数值就是字符串了，这个时候， `foo` 的值呈现为文本， 而不管 `foo` 是什么类型的(数字，日期等)。看下面这个例子： `someParam=3/4` 和 `someParam="${3/4}"` 是不同的。 如果指令需要 `someParam` 是一个数字值， 那么就不要用第二种方式。切记不要改变这些。

宏参数的另外一个重要的方面是它们是局部变量。 更多局部变量的信息可以阅读：dgui_misc_var

##### 嵌套内容

自定义指令可以嵌套内容，和预定义指令相似：`<#if `...`>`nested content`</#if>`。 例如，下面这个例子中是创建了一个可以为嵌套的内容画出边框的宏：

    <#macro border>
      <table border=4 cellspacing=0 cellpadding=4><tr><td>
        <#nested>
      </tr></td></table>
    </#macro>

`<#nested>` 指令执行位于开始和结束标记指令之间的模板代码段。 如果这样写：

    <@border>The bordered text</@border>

将会输出：

      <table border=4 cellspacing=0 cellpadding=4><tr><td>
        The bordered text
      </td></tr></table>

`nested` 指令也可以多次被调用，例如：

    <#macro do_thrice>
      <#nested>
      <#nested>
      <#nested>
    </#macro>
    <@do_thrice>
      Anything.
    </@do_thrice>

将会输出：

      Anything.
      Anything.
      Anything.

如果不使用 `nested` 指令， 那么嵌套的内容就不会被执行，如果不小心将 `greet` 指令写成了这样：

    <@greet person="Joe">
      Anything.
    </@greet>

FreeMarker 不会把它视为错误，只是输出：

    <font size="+2">Hello Joe!</font>

嵌套的内容被忽略了，因为 `greet` 宏没有使用 `nested` 指令。

嵌套的内容可以是任意有效的FTL，包含其他的用户自定义指令，这样也是对的：

    <@border>
      <ul>
      <@do_thrice>
        <li><@greet person="Joe"/>
      </@do_thrice>
      </ul>
    </@border>

将会输出：

      <table border=4 cellspacing=0 cellpadding=4><tr><td>
          <ul>
        <li><font size="+2">Hello Joe!</font>

        <li><font size="+2">Hello Joe!</font>

        <li><font size="+2">Hello Joe!</font>

      </ul>

      </tr></td></table>

在嵌套的内容中，宏的 局部变量 是不可见的。为了说明这点，我们来看：

    <#macro repeat count>
      <#local y = "test">
      <#list 1..count as x>
        ${y} ${count}/${x}: <#nested>
      </#list>
    </#macro>
    <@repeat count=3>${y!"?"} ${x!"?"} ${count!"?"}</@repeat>

将会输出：

        test 3/1: ? ? ?
        test 3/2: ? ? ?
        test 3/3: ? ? ?

因为 `y`， `x` 和 `count` 是宏的局部(私有)变量，从宏外部定义是不可见的。 此外不同的局部变量的设置是为每个宏自己调用的，所以不会导致混乱：

    <#macro test foo>${foo} (<#nested>) ${foo}</#macro>
    <@test foo="A"><@test foo="B"><@test foo="C"/></@test></@test>

将会输出：

    A (B (C () C) B) A

##### 宏和循环变量

像 `list`这样的预定义指令可以使用循环变量； 可以阅读 dgui_misc_var 来理解循环变量。

自定义指令也可以有循环变量。比如我们来扩展先前例子中的 `do_thrice` 指令，就可以拿到当前的循环变量的值。 而对于预定义指令(如`list`)，当调用指令时，循环变量的 name是给定的(比如 `<#list foos as foo>`...`</#list>` 中的 `foo`)，变量 value 的设置是由指令本身完成的。

    <#macro do_thrice>
      <#nested 1>
      <#nested 2>
      <#nested 3>
    </#macro>
    <@do_thrice ; x> <#-- user-defined directive uses ";" instead of "as" -->
      ${x} Anything.
    </@do_thrice>

将会输出：

      1 Anything.
      2 Anything.
      3 Anything.

语法规则是给确定"循环"的循环变量传递真实值(比如重复嵌套内容)来作为 `nested` 指令的参数(当然参数可以是任意的表达式)。 循环变量的名称是在自定义指令的开始标记(`<@...>`) 的参数后面通过分号确定的。

一个宏可以使用多个循环变量(变量的顺序是很重要的)：

    <#macro repeat count>
      <#list 1..count as x>
        <#nested x, x/2, x==count>
      </#list>
    </#macro>
    <@repeat count=4 ; c, halfc, last>
      ${c}. ${halfc}<#if last> Last!</#if>
    </@repeat>

将会输出：

      1. 0.5
      2. 1
      3. 1.5
      4. 2 Last!

在自定义指令的开始标签(分号之后)为循环变量指定不同的数字是没有问题的， 而不能在 `nested` 指令上使用。如果在分号之后指定的循环变量少， 那么就看不到 `nested`指令提供的最后的值， 因为没有循环变量来存储这些值，下面的这些都是可以的：

    <@repeat count=4 ; c, halfc, last>
      ${c}. ${halfc}<#if last> Last!</#if>
    </@repeat>
    <@repeat count=4 ; c, halfc>
      ${c}. ${halfc}
    </@repeat>
    <@repeat count=4>
      Just repeat it...
    </@repeat>

如果在分号后面指定了比 `nested` 指令还多的变量， 那么最后的循环变量将不会被创建(在嵌套内容中不会被定义)。

##### 自定义指令和宏进阶

现在你也许已经阅读过 FreeMarker 参考手册的相关部分了：

- 调用自定义指令

- `macro` 指令

也可以在FTL中定义方法，参见 `function` 指令。

也许你对命名空间感兴趣： dgui_misc_namespace。 命名空间可以帮助你组织和重用经常使用的宏。

#### 在模板中定义变量

正如我们已经描述过的，模板可以使用在数据模型中定义的变量。 在数据模型之外，模板本身也可以定义变量来使用。 这些临时变量可以使用FTL指令来创建和替换。请注意每一次的 模板执行 工作都维护它自己的私有变量， 同时来渲染页面。变量的初始值是空，当模板执行工作结束这些变量便被销毁了。

可以访问一个在模板里定义的变量，就像是访问数据模型根root上的变量一样。 这个变量比定义在数据模型中的同名参数有更高的优先级，也就是说， 如果恰巧定义了一个名为''foo''的变量，而在数据模型中也有一个名为''foo''的变量， 那么模板中的变量就会将数据模型根上的变量隐藏(而不是覆盖！)。 例如，`${foo}` 将会输出在模板中定义的变量。

在模板中可以定义三种类型的变量：

- ''简单''变量： 它能从模板中的任何位置来访问，或者从使用 `include` 指令引入的模板访问。可以使用 `assign` 指令来创建或替换这些变量。因为宏和方法只是变量，那么 `macro` 指令 和 `function` 指令 也可以用来设置变量，就像 `assign` 那样。

- 局部变量：它们只能被设置在 宏定义体内， 而且只在宏内可见。一个局部变量的生命周期只是宏的调用过程。可以使用 `local`指令 在宏定义体内创建或替换局部变量。

- 循环变量：循环变量是由如 `list` 指令自动创建的，而且它们只在指令的开始和结束标记内有效。宏 的参数是局部变量而不是循环变量。

- 全局变量：这是一个高级话题了， 并且这种变量最好别用。即便它们属于不同的命名空间， 全局变量也被所有模板共享，因为它们是被 `import`进来的， 不同于 `include` 进来的。那么它们的可见度就像数据模型那样。 全局变量通过 `global`指令来定义。

示例：使用 `assign` 创建和替换变量：

    <#assign x = 1>  <#-- create variable x -->
    ${x}
    <#assign x = x + 3> <#-- replace variable x -->
    ${x}

输出为：

    1
    4

局部变量也会隐藏(不是覆盖)同名的''简单''变量。 循环变量也会隐藏(不是覆盖)同名的''简单''变量。例如：

    <#assign x = "plain">
    1. ${x}  <#-- we see the plain var. here -->
    <@test/>
    6. ${x}  <#-- the value of plain var. was not changed -->
    <#list ["loop"] as x>
        7. ${x}  <#-- now the loop var. hides the plain var. -->
        <#assign x = "plain2"> <#-- replace the plain var, hiding does not mater here -->
        8. ${x}  <#-- it still hides the plain var. -->
    </#list>
    9. ${x}  <#-- the new value of plain var. -->

    <#macro test>
      2. ${x}  <#-- we still see the plain var. here -->
      <#local x = "local">
      3. ${x}  <#-- now the local var. hides it -->
      <#list ["loop"] as x>
        4. ${x}  <#-- now the loop var. hides the local var. -->
      </#list>
      5. ${x}  <#-- now we see the local var. again -->
    </#macro>

输出为：

    1. plain
      2. plain
      3. local
        4. loop
      5. local
    6. plain
        7. loop
        8. loop
    9. plain2

内部循环变量可以隐藏外部循环变量：

    <#list ["loop 1"] as x>
      ${x}
      <#list ["loop 2"] as x>
        ${x}
        <#list ["loop 3"] as x>
          ${x}
        </#list>
        ${x}
      </#list>
      ${x}
    </#list>

输出为：

      loop 1
        loop 2
          loop 3
        loop 2
      loop 1

请注意，循环变量的设置是通过指令调用时创建的(本例中的 `<list `...`>` 标签)。 没有其他的方式去改变循环变量的值(也就是说，不能使用定义指令来改变它的值)。 从上面的示例来看，也可以使用一个循环变量来暂时隐藏另外一个。

有时会发生一个变量隐藏数据模型中的同名变量， 但是如果想访问数据模型中的变量，此时就可以使用 特殊变量 `globals`。例如，假设我们在数据模型中有一个名为 `user` 的变量，值为''Big Joe''：

    <#assign user = "Joe Hider">
    ${user}          <#-- prints: Joe Hider -->
    ${.globals.user} <#-- prints: Big Joe -->

通过 `global`指令 设置的变量可以隐藏数据模型中的同名变量。通常，全局变量的设置会有精确的目的。 但仍然可以使用如下方式来访问数据模型变量：`.data_model.user`。

想了解更多的变量使用语法，请阅读： dgui_template_exp

#### 命名空间

当运行FTL模板时，就会有使用 `assign` 和 `macro` 指令创建的变量的集合(可能是空的)， 可以从 前一章 来看如何使用它们。 像这样的变量集合被称为 命名空间。 简单的情况下可以只使用一个命名空间，称之为 主命名空间。因为通常只使用该命名空间， 所以就没有意识到这点。

如果想创建可以重复使用的宏，函数和其他变量的集合， 通常用术语来说就是引用 库。 使用多个命名空间是必然的。只要考虑你在一些项目中， 或者想和他人共享使用的时候，你是否有一个很大的宏的集合。 但要确保库中没有宏（或其他变量）名和数据模型中变量同名， 而且也不能和模板中引用其他库中的变量同名是不可能的。 通常来说，变量因为名称冲突时也会相互冲突。 所以要为每个库中的变量使用不同的命名空间。

##### 创建一个库

我们来建立一个简单的库。假设你需要通用的变量 `copyright` 和 `mail` (在你有疑问之前，宏 当作是 变量)：

    <#macro copyright date>
      <p>Copyright (C) ${date} Julia Smith. All rights reserved.</p>
    </#macro>

    <#assign mail = "jsmith@acme.com">

把上面的这些定义存储在文件 `lib/my_test.ftl` 中 (目录是存放模板的位置)。假设想在 `aWebPage.ftl` 中使用这个模板。如果在 `aWebPage.ftl` 中使用 `<#include "/lib/my_test.ftl">`， 那么就会在主命名空间中创建两个变量，这样就不是很好， 因为想让它们只在同一个命名空间''My Test Library''中。所以就不得不使用 `import`指令 来代替 `include` 了。乍一看，这个指令和 `include` 很相似，但是它会为 `lib/my_test.ftl` 创建一个空的命名空间，然后在那里执行。`lib/my_test.ftl` 会发现它自己在一个新的环境中，那里只有数据模型的变量可以找到 (因为它们在哪儿都是可见的)，然后会在这个环境中创建两个变量。现在来看这很不错， 但是如果想访问 `aWebPage.ftl` 中的两个变量， 而它们使用的是主命名空间，就不能看到其他命名空间中的变量。 解决方法是 `import` 指令不仅仅创建命名空间，而且要通过 `import` 的调用者(本例中的主命名空间)创建一个新的哈希表变量， 这就成为进入新的命名空间的大门。那么 `aWebPage.ftl` 就像下面这样：

    <#import "/lib/my_test.ftl" as my> <#-- the hash called "my" will be the "gate" -->
    <@my.copyright date="1999-2002"/>
    ${my.mail}

要注意它是怎么访问为 `/lib/my_test.ftl` 创建的命名空间中的变量的，使用新创建的命名空间访问哈希表， `my`。将会输出：

      <p>Copyright (C) 1999-2002 Julia Smith. All rights reserved.</p>
    jsmith@acme.com

如果在主命名空间中有一个变量，名为 `mail` 或 `copyright`，那么就不会引起混乱了， 因为两个模板使用了不同的命名空间。例如，在 `lib/my_test.ftl` 中修改 `copyright` 成如下这样：

    <#macro copyright date>
      <p>Copyright (C) ${date} Julia Smith. All rights reserved.
      <br>Email: ${mail}</p>
    </#macro>

然后替换 `aWebPage.ftl` 中的内容：

    <#import "/lib/my_test.ftl" as my>
    <#assign mail="fred@acme.com">
    <@my.copyright date="1999-2002"/>
    ${my.mail}
    ${mail}

将会输出：

      <p>Copyright (C) 1999-2002 Julia Smith. All rights reserved.
      <br>Email: jsmith@acme.com</p>
    jsmith@acme.com
    fred@acme.com

当调用了 `copyright` 宏之后，输出和上面的是相似的， 因为 FreeMarker 已经暂时转向由 `import` 指令为 `/lib/my_test.ftl` 生成的命名空间了。因此， `copyright` 宏看到这里存在的变量 `mail`， 而不是主命名空间中存在的其它 `mail`

##### 在引入的命名空间中编写变量

偶尔想要在一个被包含的命名空间上创建或替换一个变量。 那么可以使用 `assign` 指令， 如果用到了它的 `namespace` 变量，例如下面这样：

    <#import "/lib/my_test.ftl" as my>
    ${my.mail}
    <#assign mail="jsmith@other.com" in my>
    ${my.mail}

将会输出：

    jsmith@acme.com
    jsmith@other.com

##### 命名空间和数据模型

数据模型中的变量在任何位置都是可见的。例如， 如果在数据模型中有一个名为 `user` 的变量，那么 `lib/my_test.ftl` 也能访问它， `aWebPage.ftl` 当然也能：

    <#macro copyright date>
      <p>Copyright (C) ${date} ${user}. All rights reserved.</p>
    </#macro>

    <#assign mail = "${user}@acme.com">

如果 `user` 是 ''Fred''的话，下面这个例子：

    <#import "/lib/my_test.ftl" as my>
    <@my.copyright date="1999-2002"/>
    ${my.mail}

将会输出：

      <p>Copyright (C) 1999-2002 Fred. All rights reserved.</p>
    Fred@acme.com

不要忘了在模板的命名空间（可以使用 `assign` 或 `macro` 指令来创建的变量） 中的变量有着比数据模型中的变量更高的优先级。因此， 数据模型的内容不会干涉到由库创建的变量。

在一些不寻常的应用中，也许想在模板中创建所有命名空间都可见的变量， 就像数据模型中的变量一样。但是你不能在模板中改变数据模型， 却可以通过 `global` 指令来达到相似的效果， 可以阅读 参考手册 来获得更多信息。

##### 命名空间的生命周期

命名空间由使用 `import` 指令中所写的路径来识别。 如果想多次 `import` 这个路径，那么只会为第一次 `import` 引用创建命名空间并执行模板。后面相同路径的 `import` 只是创建一个哈希表当作访问相同命名空间的“门”。 例如，在 `aWebPage.ftl` 中：

    <#import "/lib/my_test.ftl" as my>
    <#import "/lib/my_test.ftl" as foo>
    <#import "/lib/my_test.ftl" as bar>
    ${my.mail}, ${foo.mail}, ${bar.mail}
    <#assign mail="jsmith@other.com" in my>
    ${my.mail}, ${foo.mail}, ${bar.mail}

将会输出：

    jsmith@acme.com, jsmith@acme.com, jsmith@acme.com
    jsmith@other.com, jsmith@other.com, jsmith@other.com

这里可以看到通过 `my`， `foo` 和 `bar` 访问相同的命名空间。

请注意，命名空间是不分层次的，它们相互之间是独立存在的。 那么，如果在命名空间N1中 `import` 命名空间N2， 那N2也不在N1中，N1只是可以通过哈希表来访问N2。这和在主命名空间中 `import` N2，然后直接访问命名空间N2是一样的过程。

每一次 模板的执行过程， 它都有一个私有的命名空间的集合。每一次模板执行工作都是一个分离且有序的过程， 它们仅仅存在一段很短的时间，同时页面用以渲染内容， 然后就和所有填充过的命名空间一起消失了。因此，无论何时我们说第一次调用 `import`，一个单一模板执行工作的内容都是这样。

##### 为他人编写库

如果你已经为其他人员编写一个有用的，高质量的库，你也许想把它放在网络上 (就像 https://freemarker.apache.org/libraries.html)。 为了防止和其他作者使用库的命名相冲突，而且引入其他库时要书写简单， 这有一个事实上的标准，那就是指定库路径的格式。这个标准是： 库的路径必须对模板和其他库可用(可引用)，就像这样：

`/lib/`yourcompany.com`/`your_library`.ftl`

如果你为Example公司工作，它们拥有www.example.com网的主页， 你的工作是开发一个部件库，那么要引入你所写的FTL的路径应该是：

`/lib/example.com/widget.ftl`

请注意，www已经被省略了。第三次路径分割后的部分可以包含子目录，可以像下面这样写：

`/lib/example.com/commons/string.ftl`

一个重要的规则就是路径不应该包含大写字母，为了分隔词语， 使用下划线 `_`，就像 `wml_form` (而不是 `wmlForm` )。

请注意，如果你的工作不是为公司或组织开发库，你应该使用项目主页的URL，比如 `/lib/example.sourceforge.net/example.ftl`，或 `/lib/geocities.com/jsmith/example.ftl`。

#### 空白处理

在运行中，模板中的 空白 处理在某种程度上来说是纠缠所有模板引擎的一个问题。

我们来看这个模板。我已经用颜色标记了模板中的组件： 文本， 插值， FTL 标签.。 使用 [BR] 来想象 换行。

    <p>List of users:[BR]
    <#assign users = [{"name":"Joe",        "hidden":false},[BR]
                      {"name":"James Bond", "hidden":true},[BR]
                      {"name":"Julia",      "hidden":false}]>[BR]
    <ul>[BR]
    <#list users as user>[BR]
      <#if !user.hidden>[BR]
      <li>${user.name}[BR]
      </#if>[BR]
    </#list>[BR]
    </ul>[BR]
    <p>That's all.

如果 FreeMarker 能按照规则输出所有的 文本，那将会输出：

    <p>List of users:[BR]
    [BR]
    <ul>[BR]
    [BR]
      [BR]
      <li>Joe[BR]
      [BR]
    [BR]
      [BR]
    [BR]
      [BR]
      <li>Julia[BR]
      [BR]
    [BR]
    </ul>[BR]
    <p>That's all.

这里有太多的不想要的空格和换行了。幸运的是，HTML和XML对空白都不是敏感的， 但是这么多多余的空白是很令人头疼的，而且处理后的HTML文件大小增加也是没必要的。 当然，对于空白敏感方式的输出这依旧是个大问题。

FreeMarker 提供下面的工具来处理这个问题：

- 忽略某些模板文件的空白的工具 (解析阶段空白就被移除了)：

  - 剥离空白：这个特性会自动忽略在FTL标签周围多余的空白。 这个特性可以通过模板来随时启用和禁用。

  - 微调指令：`t`，`rt`， `lt`。使用这些指令可以明确地告诉 FreeMarker 去忽略某些空白。 可以阅读 参考手册 来获取更多信息。

  - `ftl` 参数 `strip_text`：这将从模板中删除所有顶级文本。 对于只包含定义宏的模板来说很有用(还有其它一些没有输出的指令)， 因为它可以移除宏定义和其他顶级指令中的换行符， 这样可以提高模板的可读性。

- 从输出中移除空白的工具 (移除临近的空白)：

  - `compress` 指令。

##### 剥离空白

如果对模板开启这个特性，那么它就会自动忽略 (也就是不在输出中打印出来)两种典型的多余空白：

- 缩进空白和在行末尾的尾部空白(包括换行符)在只包含FTL标签的行中会被忽略 (比如 `<@myMacro/>`, `<#if `...`>`)和FTL注释(如 `<#-- blah -->`)， 除了被忽略的空白本身。例如，如果一行只包含一个`<#if `...`>`， 那么在标签前面的缩进和标签后面的换行符将会被忽略。 但是，如果这行上包含`<#if `...`>x`， 那么空白就不会被忽略，因为这个`x`不是FTL标签。请注意，根据这些规则， 一行上包含`<#if `...`><#list `...`>`，空白就会被忽略， 而一行上有`<#if `...`> <#list `...`>`这样的就不会， 因为在两个FTL标签之间的空白是嵌入的空白，而不是缩进的或尾部空白。

- 加在下面这些指令之间的空白会被忽略：`macro`， `function`，`assign`， `global`，`local`， `ftl`， `import`， 但也是指令之间仅仅只有一个空白或FTL注释。实际应用中， 它意味着你可以在宏定义和参数定义之间放置空行，因为行间距是为了更好的可读性， 不包括在输出中打印不必要的空行(换行符)。

使用了剥离空白后，上面那个例子中的输出就会是：

    <p>List of users:[BR]
    <ul>[BR]
      <li>Joe[BR]
      <li>Julia[BR]
    </ul>[BR]
    <p>That's all.

这是因为在剥离之后，模板就变成这样了，被忽略的文本没有被标色：

    <p>List of users:[BR]
    <#assign users = [{"name":"Joe",        "hidden":false},[BR]
                      {"name":"James Bond", "hidden":true},[BR]
                      {"name":"Julia",      "hidden":false}]>[BR]
    <ul>[BR]
    <#list users as user>[BR]
      <#if !user.hidden>[BR]
      <li>${user.name}[BR]
      </#if>[BR]
    </#list>[BR]
    </ul>[BR]
    <p>That's all.

剥离空白功能可以通过 `ftl` 指令 在模板中开启或关闭。如果你没有通过 `ftl` 指令来指定， 那么剥离空白功能是开启还是关闭就依据程序员是如何设置 FreeMarker 的了。 默认的情况下剥离空白是开启的，程序员可以留着不管(建议这样做)。请注意开启剥离空白时 不会 降低模板执行的效率，剥离空白的操作在模板加载时就已经完成了。

剥离空白可以为单独的一行关闭，就是使用`nt` 指令(对没有去掉空白的行来说)。

##### 使用compress指令

另外一种方法就是使用`compress` 指令。和剥离空白相反，这个工作是直接基于生成的输出内容， 而不是对于模板进行。也就是说，它会动态地检查输出内容， 而不会检查生成输出FTL的程序。它会很强势地移除缩进， 空行和重复的空格/制表符(可以阅读参考手册 部分来获取更多信息)。所以对于下面这段代码：

    <#compress>
    <#assign users = [{"name":"Joe",        "hidden":false},
                      {"name":"James Bond", "hidden":true},
                      {"name":"Julia",      "hidden":false}]>
    List of users:
    <#list users as user>
      <#if !user.hidden>
      - ${user.name}
      </#if>
    </#list>
    That's all.
    </#compress>

将会输出：

    List of users:
    - Joe
    - Julia
    That's all.

请注意 `compress` 是完全独立于剥离空白特性的。 所以它剥离模板中的空白是可能的，那么之后输出的内容就是被 `压缩` 过的。

此外，在默认情况下，名为 `compress` 的用户自定义指令是可以在数据模型中存在的(由于向下兼容特性)。 这和指令是相同的，除了可以选择设置 `single_line` 参数， 这将会移除所有的介于其中的换行符。在最后那个例子中，如果使用`<@compress single_line=true>`...`</@compress>` 来代替`<#compress>`...`</#compress>`， 那么就会得到如下输出：

    List of users: - Joe - Julia That's all.

#### 替换(方括号)语法

这个特性从 FreeMarker 2.3.4 版本后才存在。

FreeMarker支持一个替换的语法。就是在FreeMarker的指令和注释中用 `[` 和 `]` 来代替 `<` 和 `>`，例如下面这个例子：

- 调用预定义指令：`[#list animals as animal]`...`[/#list]`

- 调用自定义指令：`[@myMacro /]`

- 注释：`[#-- the comment --]`

为了使用这种语法从而代替默认语法，从模板开始，使用 `ftl` 指令 都要使用这用语法。 如果你不知道什么是 `ftl` 指令，那么就用 `[#ftl]` 来开始模板，要记住这个要放在文件的最前面(除了white-space可以在它前面)。 例如，下面的示例是 入门 章节的最后一个例子使用这种替换语法的样子(假设这是一个完整的模板，而不是一个片段)：

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

这种替换语法(方括号)和默认语法(尖括号)在一个模板中是相互排斥的。 那就是说，整个模板要么全部使用替换语法，要么全部使用默认语法。 如果模板使用了替换语法，那么如 `<#if `...`>` 这样的部分就会被算作是静态文本，而不是FTL标签了。类似地，如果模板使用默认语法， 那么如 `[#if `...`]` 这样的也会被算作是静态文本， 而不是FTL标签。

如果你以`[#ftl `...`]` (``...`` 代表可选的参数列表， 当然仅用 `[#ftl]` 也行)来开始文件，那文件就会使用替换(方括号)语法。 如果使用 `<#ftl `...`>` 来开始， 那么文件就会使用正常(尖括号)语法。如果文件中没有 `ftl` 指令， 那么程序员可以通过配置FreeMarker (程序员可以参看 javadoc API 文档中的 `Configuration.setTagSyntax(int)`) 来决定使用哪种语法。 但是大多数情况，程序员可能使用默认配置。FreeMarker 2.3.x 版本默认配置使用常规语法。 而2.4版本中的默认配置将会自动检测，也就是说第一个FreeMarker标签决定了语法形式 (它可以是任意的，而不仅仅是`ftl`)。

## 程序开发指南

### 入门

如果你还是使用FreeMarker的新手，在开始本章之前， 你应该先阅读 dgui_quickstart_basics。

#### 创建 Configuration 实例

首先，你应该创建一个 `freemarker.template.Configuration` 实例， 然后调整它的设置。`Configuration` 实例是存储 FreeMarker 应用级设置的核心部分。同时，它也处理创建和 缓存 预解析模板(比如 `Template` 对象)的工作。

也许你只在应用(可能是servlet)生命周期的开始执行一次：

    // Create your Configuration instance, and specify if up to what FreeMarker
    // version (here 2.3.22) do you want to apply the fixes that are not 100%
    // backward-compatible. See the Configuration JavaDoc for details.
    Configuration cfg = new Configuration(Configuration.VERSION_2_3_22);

    // Specify the source where the template files come from. Here I set a
    // plain directory for it, but non-file-system sources are possible too:
    cfg.setDirectoryForTemplateLoading(new File("/where/you/store/templates"));

    // Set the preferred charset template files are stored in. UTF-8 is
    // a good choice in most applications:
    cfg.setDefaultEncoding("UTF-8");

    // Sets how errors will appear.
    // During web page *development* TemplateExceptionHandler.HTML_DEBUG_HANDLER is better.
    cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);

从现在开始，应该使用 单 实例配置(也就是说，它是单例的)。 请注意不管一个系统有多少独立的组件来使用 FreeMarker， 它们都会使用他们自己私有的 `Configuration` 实例。

不需要重复创建 `Configuration` 实例； 它的代价很高，尤其是会丢失缓存。`Configuration` 实例就是应用级别的单例。

当使用多线程应用程序(比如Web网站)，`Configuration` 实例中的设置就不能被修改。它们可以被视作为 有效的不可改变的 对象， 也可以继续使用 安全发布 技术 (参考 JSR 133 和相关的文献)来保证实例对其它线程也可用。比如， 通过final或volatile字段来声明实例，或者通过线程安全的IoC容器，但不能作为普通字段。 (`Configuration` 中不处理修改设置的方法是线程安全的。)

#### 创建数据模型

在简单的示例中你可以使用 `java.lang` 和 `java.util` 包中的类， 还有用户自定义的Java Bean来构建数据对象：

- 使用 `java.lang.String` 来构建字符串。

- 使用 `java.lang.Number` 来派生数字类型。

- 使用 `java.lang.Boolean` 来构建布尔值。

- 使用 `java.util.List` 或Java数组来构建序列。

- 使用 `java.util.Map` 来构建哈希表。

- 使用自定义的bean类来构建哈希表，bean中的项和bean的属性对应。比如， `product` 的 `price` 属性 (`getProperty()`)可以通过 `product.price` 获取。(bean的action也可以通过这种方式拿到； 要了解更多可以参看 这里)

我们为 模板开发指南部分演示的第一个例子 来构建数据模型。为了方便说明，这里再展示一次示例：

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

下面是构建这个数据模型的Java代码片段：

    // Create the root hash
    Map<String, Object> root = new HashMap<>();
    // Put string ``user'' into the root
    root.put("user", "Big Joe");
    // Create the hash for ``latestProduct''
    Map<String, Object> latest = new HashMap<>();
    // and put it into the root
    root.put("latestProduct", latest);
    // put ``url'' and ``name'' into latest
    latest.put("url", "products/greenmouse.html");
    latest.put("name", "green mouse");

在真实应用系统中，通常会使用应用程序指定的类来代替 `Map`， 它会有JavaBean规范规定的 `get`Xxx``/`is`Xxx`` 方法。比如有一个和下面类似的类：

    public class Product {

        private String url;
        private String name;
        ...

        // As per the JavaBeans spec., this defines the "url" bean property
        public String getUrl() {
            return url;
        }

        // As per the JavaBean spec., this defines the "name" bean property
        public String getName() {
            return name;
        }

        ...

    }

将它的实例放入数据模型中，就像下面这样：

    Product latestProducts = getLatestProductFromDatabaseOrSomething();
    root.put("latestProduct", latestProduct);

如果`latestProduct` 是 `Map`类型， 模板就可以是相同的，比如 `${latestProduct.name}` 在两种情况下都好用。

根root本身也无需是 `Map`，只要是有 `getUser()` 和 `getLastestProduct()` 方法的对象即可。

如果配置设置项 `object_wrapper` 的值是用于所有真实步骤， 这里描述的行为才好用。任何由 `ObjectWrapper` 包装成的哈希表 可以用作根root，也可以在模板中和点、 `[]` 操作符使用。 如果不是包装成哈希表的对象不能作为根root，也不能像那样在模板中使用。

#### 获取模板

模板代表了 `freemarker.template.Template` 实例。典型的做法是从 `Configuration` 实例中获取一个 `Template` 实例。无论什么时候你需要一个模板实例， 都可以使用它的 `getTemplate` 方法来获取。在 之前 设置的目录中的 `test.ftl` 文件中存储 示例模板，那么就可以这样来做：

    Template temp = cfg.getTemplate("test.ftl");

当调用这个方法的时候，将会创建一个 `test.ftl` 的 `Template` 实例，通过读取 ``/where/you/store/templates/`test.ftl` 文件，之后解析(编译)它。`Template` 实例以解析后的形式存储模板， 而不是以源文件的文本形式。

`Configuration` 缓存 `Template` 实例，当再次获得 `test.ftl` 的时候，它可能再读取和解析模板文件了， 而只是返回第一次的 `Template` 实例。

#### 合并模板和数据模型

我们已经知道，数据模型+模板=输出，我们有了一个数据模型 (`root`) 和一个模板 (`temp`)， 为了得到输出就需要合并它们。这是由模板的 `process` 方法完成的。它用数据模型root和 `Writer` 对象作为参数，然后向 `Writer` 对象写入产生的内容。 为简单起见，这里我们只做标准的输出：

    Writer out = new OutputStreamWriter(System.out);
    temp.process(root, out);

这会向你的终端输出你在模板开发指南部分的 第一个示例 中看到的内容。

Java I/O 相关注意事项：基于 `out` 对象，必须保证 `out.close()` 最后被调用。当 `out` 对象被打开并将模板的输出写入文件时，这是很电影的做法。其它时候， 比如典型的Web应用程序，那就 不能 关闭 `out` 对象。FreeMarker 会在模板执行成功后 (也可以在 `Configuration` 中禁用) 调用 `out.flush()`，所以不必为此担心。

请注意，一旦获得了 `Template` 实例， 就能将它和不同的数据模型进行不限次数 (`Template`实例是无状态的)的合并。此外， 当 `Template` 实例创建之后 `test.ftl` 文件才能访问，而不是在调用处理方法时。

#### 将代码放在一起

这是一个由之前的代码片段组合在一起的源程序文件。 千万不要忘了将 `freemarker.jar` 放到 `CLASSPATH` 中。

    import freemarker.template.*;
    import java.util.*;
    import java.io.*;

    public class Test {

        public static void main(String[] args) throws Exception {

            /* ------------------------------------------------------------------------ */
            /* You should do this ONLY ONCE in the whole application life-cycle:        */

            /* Create and adjust the configuration singleton */
            Configuration cfg = new Configuration(Configuration.VERSION_2_3_22);
            cfg.setDirectoryForTemplateLoading(new File("/where/you/store/templates"));
            cfg.setDefaultEncoding("UTF-8");
            cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW);

            /* ------------------------------------------------------------------------ */
            /* You usually do these for MULTIPLE TIMES in the application life-cycle:   */

            /* Create a data-model */
            Map root = new HashMap();
            root.put("user", "Big Joe");
            Map latest = new HashMap();
            root.put("latestProduct", latest);
            latest.put("url", "products/greenmouse.html");
            latest.put("name", "green mouse");

            /* Get the template (uses cache internally) */
            Template temp = cfg.getTemplate("test.ftl");

            /* Merge data-model with template */
            Writer out = new OutputStreamWriter(System.out);
            temp.process(root, out);
            // Note: Depending on what `out` is, you may need to call `out.close()`.
            // This is usually the case for file output, but not for servlet output.
        }
    }

为了简单起见，这里压制了异常(在方法签名中声明了异常，译者注)， 而在正式运行的产品中不要这样做。

### 数据模型

这只是一个介绍性的说明，可以查看 FreeMarker Java API文档 获取更多信息。

#### 基本内容

在 入门 章节中， 我们已经知道如何使用基本的Java类(`Map`, `String`,等)来构建数据模型了。在内部，模板中可用的变量都是实现了 `freemarker.template.TemplateModel` 接口的Java对象。 但在数据模型中，可以使用基本的Java集合类作为变量，因为这些变量会在内部被替换为适当的 `TemplateModel` 类型。这种功能特性被称作是 对象包装。对象包装功能可以透明地把 任何 类型的对象转换为实现了 `TemplateModel` 接口类型的实例。这就使得下面的转换成为可能，如在模板中把 `java.sql.ResultSet` 转换为序列变量， 把 `javax.servlet.ServletRequest` 对象转换成包含请求属性的哈希表变量， 甚至可以遍历XML文档作为FTL变量(参考这里)。包装(转换)这些对象， 需要使用合适的，也就是所谓的 `对象包装器` 实现(可能是自定义的实现)； 这将在后面讨论。 现在的要点是想从模板访问任何对象，它们早晚都要转换为实现了 `TemplateModel` 接口的对象。那么首先你应该熟悉来写 `TemplateModel` 接口的实现类。

有一个粗略的 `freemarker.template.TemplateModel` 子接口对应每种基本变量类型(`TemplateHashModel` 对应哈希表， `TemplateSequenceModel` 对应序列， `TemplateNumberModel` 对应数字等等)。比如，想为模板使用 `java.sql.ResultSet` 变量作为一个序列，那么就需要编写一个 `TemplateSequenceModel` 的实现类，这个类要能够读取 `java.sql.ResultSet` 中的内容。我们常这么说，使用 `TemplateModel` 的实现类 包装 了 `java.sql.ResultSet`，基本上只是封装 `java.sql.ResultSet` 来提供使用普通的 `TemplateSequenceModel` 接口访问它。请注意一个类可以实现多个 `TemplateModel` 接口；这就是为什么FTL变量可以有多种类型 (参看 dgui_datamodel_basics)

请注意，这些接口的一个细小的实现是和 `freemarker.template` 包一起提供的。 例如，将一个 `String` 转换成FTL的字符串变量， 可以使用 `SimpleScalar`，将 `java.util.Map` 转换成FTL的哈希表变量，可以使用 `SimpleHash` 等等。

如果想尝试自己的 `TemplateModel` 实现， 一个简单的方式是创建它的实例，然后将这个实例放入数据模型中 (也就是把它 `放到` 哈希表的根root上)。 对象包装器将会给模板提供它的原状，因为它已经实现了 `TemplateModel` 接口，所以没有转换(包装)的需要。 (这个技巧当你不想用对象包装器来包装(转换)某些对象时仍然有用。)

#### 标量

有4种类型的标量：

- 布尔值

- 数字

- 字符串

- 日期类型(子类型： 日期(没有时间部分)，时间或者日期-时间)

每一种标量类型都是 `Template`Type`Model` 接口的实现，这里的 ``Type`` 就是类型的名称。这些接口只定义了一个方法： ``type` getAs`Type`();`。 它返回变量的Java类型(`boolean`， `Number`， `String` 和 `Date` 各自代表的值)。

由于历史遗留的原因，字符串标量的接口是 `TemplateScalarModel`，而不是 `TemplateStringModel`。 (因为早期的 FreeMarker 字符串就是标量。)

这些接口的一个细小的实现和 `Simple`Type`` 类名在 `freemarker.template` 包中是可用的。 但是却没有 `SimpleBooleanModel` 类型；为了代表布尔值， 可以使用 `TemplateBooleanModel.TRUE` 和 `TemplateBooleanModel.FALSE` 来单独使用。

由于历史遗留的原因，字符串标量的实现类是 `SimpleScalar`，而不是 `SimpleString`。

在FTL中标量是一成不变的。当在模板中设置变量的值时， 使用其他的实例来替换 `Template`Type`Model` 实例时， 是不用改变原来实例中存储的值的。

##### 日期 类型的难点

对于日期类型来说，有一些难题，因为Java API通常不区别 `java.util.Date` 只存储日期部分(April 4, 2003)， 时间部分(10:19：18 PM)，或两者都存(April 4, 2003 10:19:18 PM)。 为了用本文正确显示值(或者进行其它确定的操作)，FreeMarker必须知道 `java.util.Date` 的哪个部分存储了有意义上的信息， 哪部分没有被使用(通常是标记为0的)。不幸的是， 通常该信息只是当值从数据库中取得时可用， 因为大多数数据库有独立的日期，时间和日期-时间(又叫做时间戳)类型， `java.sql` 有3个对应的 `java.util.Date` 子类和它们相匹配。

`TemplateDateModel` 接口有两个方法：分别是 `java.util.Date getAsDate()` 和 `int getDateType()`。 该接口典型的实现是存储一个 `java.util.Date` 对象， 加上一个整数来辨别子类型。这个整数的值也必须是 `TemplateDateModel` 接口中的常量之一：`DATE`， `TIME`， `DATETIME` 和 `UNKNOWN`。

关于 `UNKNOWN`: `java.lang` 和 `java.util` 下的类通常被自动转换成 `TemplateModel` 的实现类，就是所谓的 `对象包装器ObjectWrapper`(请参考之前的对象包装介绍)。 如果对象包装器要包装 `java.util.Date` 类， 它不是 `java.sql` 日期类的实例，那就不能决定子类型是什么， 所以使用 `UNKNOWN`。之后，如果模板需要使用这个变量， 而且操作也需要子类型，那就会停止执行并抛出错误。为了避免这种情况的发生， 对于那些可能有问题的变量，模板开发人员必须明确地指定子类型，使用内建函数 `date`， `time` 或 `datetime` (比如 `lastUpdated?datetime`)。请注意， 如果和格式化参数一起使用内建函数 `string`， 比如foo?string("MM/dd/yyyy")，那么 FreeMarker 就不必知道子类型了。

#### 容器

容器包括哈希表，序列和集合三种类型。

##### 哈希表

哈希表是实现了 `TemplateHashModel` 接口的Java对象。`TemplateHashModel` 有两个方法： `TemplateModel get(String key)`，这个方法根据给定的名称返回子变量， `boolean isEmpty()`，这个方法表明哈希表是否含有子变量。 `get` 方法当在给定的名称没有找到子变量时返回null。

`TemplateHashModelEx` 接口扩展了 `TemplateHashModel`。它增加了更多的方法，使得可以使用内建函数 values 和 keys 来枚举哈希表中的子变量。

经常使用的实现类是 `SimpleHash`，该类实现了 `TemplateHashModelEx` 接口。从内部来说，它使用一个 `java.util.Hash` 类型的对象存储子变量。 `SimpleHash` 类的方法可以添加和移除子变量。 这些方法应该用来在变量被创建之后直接初始化。

在FTL中，容器是一成不变的。那就是说你不能添加，替换和移除容器中的子变量。

##### 序列

序列是实现了 `TemplateSequenceModel` 接口的Java对象。它包含两个方法：`TemplateModel get(int index)` 和 `int size()`。

经常使用的实现类是 `SimpleSequence`。该类内部使用一个 `java.util.List` 类型的对象存储它的子变量。 `SimpleSequence` 有添加子元素的方法。 在序列创建之后应该使用这些方法来填充序列。

##### 集合

集合是实现了 `TemplateCollectionModel` 接口的Java对象。这个接口定义了一个方法： `TemplateModelIterator iterator()`。 `TemplateModelIterator` 接口和 `java.util.Iterator` 相似，但是它返回 `TemplateModels` 而不是 `Object`， 而且它能抛出 `TemplateModelException` 异常。

通常使用的实现类是 `SimpleCollection`。

#### 方法

方法变量在存于实现了 `TemplateMethodModel` 接口的模板中。这个接口包含一个方法： `TemplateModel exec(java.util.List arguments)`。 当使用 方法调用表达式 调用方法时，`exec` 方法将会被调用。 形参将会包含FTL方法调用形参的值。`exec` 方法的返回值给出了FTL方法调用表达式的返回值。

`TemplateMethodModelEx` 接口扩展了 `TemplateMethodModel` 接口。它没有添加任何新方法。 事实上这个对象实现这个 标记 接口是给FTL引擎暗示， 形式参数应该直接以 `TemplateModel` 的形式放进 `java.util.List`。否则将会以 `String` 形式放入list。

出于这些很明显的原因，这些接口没有默认的实现。

例如：下面这个方法，返回第一个字符串在第二个字符串第一次出现时的索引位置， 如果第二个字符串中不包含第一个字符串，则返回-1：

    public class IndexOfMethod implements TemplateMethodModel {

        public TemplateModel exec(List args) throws TemplateModelException {
            if (args.size() != 2) {
                throw new TemplateModelException("Wrong arguments");
            }
            return new SimpleNumber(
                ((String) args.get(1)).indexOf((String) args.get(0)));
        }
    }

如果将一个实例放入根数据模型中，像这样：

    root.put("indexOf", new IndexOfMethod());

那么就可以在模板中调用：

    <#assign x = "something">
    ${indexOf("met", x)}
    ${indexOf("foo", x)}

将会输出：

    2
    -1

如果需要访问FTL运行时环境(读/写变量，获取本地化信息等)，则可以使用 `Environment.getCurrentEnvironment()` 来获取。

#### 指令

Java程序员可以使用 `TemplateDirectiveModel` 接口在Java代码中实现自定义指令。详情可以参加API文档。

`TemplateDirectiveModel` 在 FreeMarker 2.3.11 版本时才加入， 来代替快被废弃的 `TemplateTransformModel`。

##### 示例 1

我们要实现一个指令， 这个指令可以将在它开始标签和结束标签之内的字符都转换为大写形式。 就像这个模板：

    foo
    <@upper>
      bar
      <#-- All kind of FTL is allowed here -->
      <#list ["red", "green", "blue"] as color>
        ${color}
      </#list>
      baaz
    </@upper>
    wombat

将会输出：

    foo
      BAR
        RED
        GREEN
        BLUE
      BAAZ
    wombat

下面是指令类的源代码:

    package com.example;
    import java.io.IOException;
    import java.io.Writer;
    import java.util.Map;

    import freemarker.core.Environment;
    import freemarker.template.TemplateDirectiveBody;
    import freemarker.template.TemplateDirectiveModel;
    import freemarker.template.TemplateException;
    import freemarker.template.TemplateModel;
    import freemarker.template.TemplateModelException;

    /**
     *  FreeMarker user-defined directive that progressively transforms
     *  the output of its nested content to upper-case.
     *
     *
     *  <p><b>Directive info</b></p>
     *
     *  <p>Directive parameters: None
     *  <p>Loop variables: None
     *  <p>Directive nested content: Yes
     */
    public class UpperDirective implements TemplateDirectiveModel {

        public void execute(Environment env,
                Map params, TemplateModel[] loopVars,
                TemplateDirectiveBody body)
                throws TemplateException, IOException {
            // Check if no parameters were given:
            if (!params.isEmpty()) {
                throw new TemplateModelException(
                        "This directive doesn't allow parameters.");
            }
            if (loopVars.length != 0) {
                    throw new TemplateModelException(
                        "This directive doesn't allow loop variables.");
            }

            // If there is non-empty nested content:
            if (body != null) {
                // Executes the nested body. Same as <#nested> in FTL, except
                // that we use our own writer instead of the current output writer.
                body.render(new UpperCaseFilterWriter(env.getOut()));
            } else {
                throw new RuntimeException("missing body");
            }
        }

        /**
         * A {@link Writer} that transforms the character stream to upper case
         * and forwards it to another {@link Writer}.
         */
        private static class UpperCaseFilterWriter extends Writer {

            private final Writer out;

            UpperCaseFilterWriter (Writer out) {
                this.out = out;
            }

            public void write(char[] cbuf, int off, int len)
                    throws IOException {
                char[] transformedCbuf = new char[len];
                for (int i = 0; i < len; i++) {
                    transformedCbuf[i] = Character.toUpperCase(cbuf[i + off]);
                }
                out.write(transformedCbuf);
            }

            public void flush() throws IOException {
                out.flush();
            }

            public void close() throws IOException {
                out.close();
            }
        }

    }

现在我们需要创建这个类的实例， 然后让这个指令在模板中可以通过名称"upper"来访问 (或者是其它我们想用的名字)。一个可行的方案是把这个指令放到数据模型中：

    root.put("upper", new com.example.UpperDirective());

但更好的做法是将常用的指令作为 共享变量 放到 `Configuration` 中。

当然也可以使用 内建函数`new` 将指令放到一个FTL库(宏的集合，就像在模板中， 使用 `include` 或 `import` )中：

    <#-- Maybe you have directives that you have implemented in FTL -->
    <#macro something>
      ...
    </#macro>

    <#-- Now you can't use <#macro upper>, but instead you can: -->
    <#assign upper = "com.example.UpperDirective"?new()>

##### 示例 2

我们来创建一个指令，这个指令可以一次又一次地执行其中的嵌套内容， 这个次数由指定的数字来确定(就像 `list` 指令)， 可以使用`<hr>`将输出的重复内容分开。 这个指令我们命名为"repeat"。示例模板如下：

    <#assign x = 1>

    <@repeat count=4>
      Test ${x}
      <#assign x++>
    </@repeat>

    <@repeat count=3 hr=true>
      Test
    </@repeat>

    <@repeat count=3; cnt>
      ${cnt}. Test
    </@repeat>

输出为：

      Test 1
      Test 2
      Test 3
      Test 4

      Test
    <hr>  Test
    <hr>  Test

      1. Test
      2. Test
      3. Test

指令的实现类为：

    package com.example;
    import java.io.IOException;
    import java.io.Writer;
    import java.util.Iterator;
    import java.util.Map;

    import freemarker.core.Environment;
    import freemarker.template.SimpleNumber;
    import freemarker.template.TemplateBooleanModel;
    import freemarker.template.TemplateDirectiveBody;
    import freemarker.template.TemplateDirectiveModel;
    import freemarker.template.TemplateException;
    import freemarker.template.TemplateModel;
    import freemarker.template.TemplateModelException;
    import freemarker.template.TemplateNumberModel;

    /**
     * FreeMarker user-defined directive for repeating a section of a template,
     * optionally with separating the output of the repetations with
     * <tt>&lt;hr></tt>-s.
     *
     *
     * <p><b>Directive info</b></p>
     *
     * <p>Parameters:
     * <ul>
     *   <li><code>count</code>: The number of repetations. Required!
     *       Must be a non-negative number. If it is not a whole number then it will
     *       be rounded <em>down</em>.
     *   <li><code>hr</code>: Tells if a HTML "hr" element could be printed between
     *       repetations. Boolean. Optional, defaults to <code>false</code>.
     * </ul>
     *
     * <p>Loop variables: One, optional. It gives the number of the current
     *    repetation, starting from 1.
     *
     * <p>Nested content: Yes
     */
    public class RepeatDirective implements TemplateDirectiveModel {

        private static final String PARAM_NAME_COUNT = "count";
        private static final String PARAM_NAME_HR = "hr";

        public void execute(Environment env,
                Map params, TemplateModel[] loopVars,
                TemplateDirectiveBody body)
                throws TemplateException, IOException {

            // ---------------------------------------------------------------------
            // Processing the parameters:

            int countParam = 0;
            boolean countParamSet = false;
            boolean hrParam = false;

            Iterator paramIter = params.entrySet().iterator();
            while (paramIter.hasNext()) {
                Map.Entry ent = (Map.Entry) paramIter.next();

                String paramName = (String) ent.getKey();
                TemplateModel paramValue = (TemplateModel) ent.getValue();

                if (paramName.equals(PARAM_NAME_COUNT)) {
                    if (!(paramValue instanceof TemplateNumberModel)) {
                        throw new TemplateModelException(
                                "The \"" + PARAM_NAME_HR + "\" parameter "
                                + "must be a number.");
                    }
                    countParam = ((TemplateNumberModel) paramValue)
                            .getAsNumber().intValue();
                    countParamSet = true;
                    if (countParam < 0) {
                        throw new TemplateModelException(
                                "The \"" + PARAM_NAME_HR + "\" parameter "
                                + "can't be negative.");
                    }
                } else if (paramName.equals(PARAM_NAME_HR)) {
                    if (!(paramValue instanceof TemplateBooleanModel)) {
                        throw new TemplateModelException(
                                "The \"" + PARAM_NAME_HR + "\" parameter "
                                + "must be a boolean.");
                    }
                    hrParam = ((TemplateBooleanModel) paramValue)
                            .getAsBoolean();
                } else {
                    throw new TemplateModelException(
                            "Unsupported parameter: " + paramName);
                }
            }
            if (!countParamSet) {
                    throw new TemplateModelException(
                            "The required \"" + PARAM_NAME_COUNT + "\" paramter"
                            + "is missing.");
            }

            if (loopVars.length > 1) {
                    throw new TemplateModelException(
                            "At most one loop variable is allowed.");
            }

            // Yeah, it was long and boring...

            // ---------------------------------------------------------------------
            // Do the actual directive execution:

            Writer out = env.getOut();
            if (body != null) {
                for (int i = 0; i < countParam; i++) {
                    // Prints a <hr> between all repetations if the "hr" parameter
                    // was true:
                    if (hrParam && i != 0) {
                        out.write("<hr>");
                    }

                    // Set the loop variable, if there is one:
                    if (loopVars.length > 0) {
                        loopVars[0] = new SimpleNumber(i + 1);
                    }

                    // Executes the nested body (same as <#nested> in FTL). In this
                    // case we don't provide a special writer as the parameter:
                    body.render(env.getOut());
                }
            }
        }

    }

##### 注意

`TemplateDirectiveModel` 对象通常不应该是有状态的，这一点非常重要。 一个经常犯的错误是存储指令的状态然后在对象的属性中调用执行。 想一下相同指令的嵌入调用，或者指令对象被用作共享变量， 并通过多线程同时访问。

不幸的是， `TemplateDirectiveModel` 不支持传递参数的位置(而不是参数名称)。从 FreeMarker 2.4 版本开始，它将被修正。

#### 结点变量

结点变量体现了树形结构中的结点。结点变量的引入是为了帮助用户 在数据模型中处理XML文档， 但是它们也可以用于构建树状模型。如需要有关从模板语言角度考虑的结点信息， 那么可以 阅读之前章节。

结点变量有下列属性，它们都由 `TemplateNodeModel` 接口的方法提供：

- 基本属性：

  - `TemplateSequenceModel getChildNodes()`： 一个结点的子结点序列(除非这个结点是叶子结点，这时方法返回一个空序列或者是null)。 子结点本身应该也是结点变量。

  - `TemplateNodeModel getParentNode()`： 一个结点只有一个父结点(除非这个结点是结点树的根结点， 这时方法返回`null`)。

- 可选属性。如果一个属性在具体的使用中没有意义， 那对应的方法应该返回`null`：

  - `String getNodeName()`： 结点名称也是宏的名称，当使用 `recurse` 和 `visit`指令时， 它用来控制结点。因此，如果想通过结点使用这些指令， 那么结点的名称是 必须的。

  - `String getNodeType()`：在XML中： `"element"`，`"text"`， `"comment"`等。如果这些信息可用， 就是通过 `recurse` 和 `visit` 指令来查找结点的默认处理宏。而且，它对其他有具体用途的应用程序也是有用的。

  - `String getNamespaceURI()`： 这个结点所属的命名空间(和用于库的FTL命名空间无关)。例如，在XML中， 这就是元素和属性所属XML命名空间的URI。这个信息如果可用，就是通过 `recurse` 和 `visit` 指令来查找存储控制宏的FTL命名空间。

在FTL里，结点属性的直接使用可以通过 内建函数 node完成， 还有 `visit` 和 `recurse` 宏。

在很多用例中，实现了 `TemplateNodeModel` 接口和其它接口的变量，因为结点变量属性仅仅提供基本的结点间导航的方法。 需要具体的例子，请参考 FreeMarker如何处理XML 部分。

#### 对象包装

对象包装器是实现了 `freemarker.template.ObjectWrapper` 接口的类。它的目标是实现Java对象(应用程序中特定类等，比如 `String`， `Map`，`List` 实例)和FTL类型系统之间的映射。换句话说， 它指定了模板如何在数据模型(包含从模板中调用的Java方法的返回值)中发现Java对象。 对象包装器作为插件放入 `Configuration` 中，可以使用 `object_wrapper` 属性设置 (或者使用`Configuration.setObjectWrapper`)。

从技术角度来说，FTL类型系统由之前介绍过的 `TemplateModel` 子接口 (`TemplateScalarModel`，`TemplateHashMode`， `TemplateSequenceModel`等)来表示。要映射Java对象到FTL类型系统中， 对象包装器的 `TemplateModel wrap(java.lang.Object obj)` 方法会被调用。

有时FreeMarker需要撤回映射，此时 `对象包装器ObjectWrapper` 的 `Object unwrap(TemplateModel)` 方法就被调用了 (或其他的变化，请参考API文档来获取详细内容)。最后的操作是在 `ObjectWrapperAndUnwrapper` 中，它是 `ObjectWrapper` 的子接口。很多实际的包装器会实现 `ObjectWrapperAndUnwrapper` 接口。

我们来看一下包装Java对象并包含其他对象 (比如 `Map`，`List`，数组， 或者有JavaBean属性的对象)是如何进行的。可以这么说，对象包装器将 `Object[]` 数组包装成 `TemplateSquenceModel` 接口的一些实现。当FreeMarker需要FTL序列中项的时候，它会调用 `TemplateSquenceModel.get(int index)` 方法。该方法的返回值是 `TemplateModel`，也就是说，`TemplateSquenceModel` 实现不仅仅可以从给定的数组序列获取 `对象`， 也可以负责在返回它之前包装该值。为了解决这个问题，典型的 `TemplateSquenceModel` 实现将会存储它创建的 `ObjectWrapper`，之后再调用该 `ObjectWrapper` 来包装包含的值。相同的逻辑代表了 `TemplateHashModel` 或其他的 `TemplateModel`，它是其它 `TemplateModel` 的容器。 因此，通常不论值的层次结构有多深，所有值都会被同一个 `ObjectWrapper` 包装。(要创建 `TemplateModel` 的实现类，请遵循这个原则，可以使用 `freemarker.template.WrappingTemplateModel` 作为基类。)

数据模型本身(root变量)是 `TemplateHashModel`。 在 `Template.process` 中指定的root对象将会被在 `object_wrapper` 配置中设置的对象包装器所包装，并产生一个 `TemplateHashModel`。从此，被包含值的包装遵循之前描述的逻辑 (比如，容器负责包装它的子实例)。

行为良好的对象包装器都会绕过已经实现 `TemplateModel` 接口的对象。如果将已经实现 `TemplateModel` 的对象放到数据模型中 (或者从模板中调用的Java方法返回这个对象)，那么就可以避免实际的对象包装。 当特别是通过模板访问创建的值时，通常会这么做。因此，要避免更多上面对象包装的性能问题， 但也可以精确控制模板可以看到的内容(不是基于当前对象包装器的映射策略)。 常见的应用程序使用该手法是使用 `freemarker.template.SimpleHash` 作为数据模型的根root(而不是`Map`)，当使用 `SimpleHash` 的 `put` 方法来填充(这点很重要，它不会复制已经填充并存在的 `Map`)。这会加快顶层数据模型变量的访问速度。

##### 默认对象包装器

`object_wrapper` `Configuration` 的默认设置是 `freemarker.template.DefaultObjectWrapper` 实例。除非有特别的需求，那么建议使用这个对象包装器，或者是自定义的 `DefaultObjectWrapper` 的子类。

它会识别大部分基本的Java类型，比如 `String`， `Number`，`Boolean`， `Date`，`List` (通常还有全部的 `java.util.Collection` 类型)， 数组，`Map`等。并把它们自然地包装成匹配 `TemplateModel` 接口的对象。它也会使用 `freemarker.ext.dom.NodeModel` 来包装W3C DOM结点， 所以可以很方便地处理XML， 在XML章节会有描述)。 对于Jython对象，会代理到 `freemarker.ext.jython.JythonWrapper` 上。 而对于其它所有对象，则会调用 `BeansWrapper.wrap`(超类的方法)， 暴露出对象的JavaBean属性作为哈希表项 (比如FTL中的 `myObj.foo` 会在后面调用 `getFoo()`)， 也会暴露出对象(比如FTL中的 `myObj.bar(1, 2)` 就会调用方法) 的公有方法(JavaBean action)。(关于对象包装器的更多信息，请参阅 该章节。)

关于 `DefaultObjectWrapper` 更多值得注意的细节：

- 不用经常使用它的构造方法，而是使用 `DefaultObjectWrapperBuilder` 来创建它。 这就允许 FreeMarker 使用单例。

- `DefaultObjectWrapper` 有 `incompatibleImprovements` 属性， 这在 2.3.22 或更高版本中是极力推荐的(参看该效果的 API文档)。如何来设置：

  - 如果已经在 2.3.22 或更高版本的 `Configuration` 中设置了 `incompatible_improvements` 选项， 而没有设置 `object_wrapper` 选项(那么它就保留默认值)， 我们就什么都做不了了，因为它已经使用了同等 `incompatibleImprovements` 属性值的 `DefaultObjectWrapper` 单例。

  - 另外也可以在 `Configuration` 中独立设置 `incompatibleImprovements`。基于如何创建/设置 `ObjectWrapper`，可以通过这样完成 (假设想要 `incompatibleImprovements` 2.3.22)：

    - 如果使用了构建器API：

          ... = new DefaultObjectWrapperBuilder(Configuration.VERSION_2_3_22).build()

    - 或者使用构造方法：

          ... = new DefaultObjectWrapper(Configuration.VERSION_2_3_22)

    - 或者使用 `object_wrapper` 属性 (`*.properties` 文件或 `java.util.Properties` 对象)：

          object_wrapper=DefaultObjectWrapper(2.3.21)

    - 或者通过 `FreemarkerServlet` 配置 `object_wrapper` 和在 `web.xml` 中的 `init-param` 属性来配置：

          <init-param>
              <param-name>object_wrapper</param-name>
              <param-value>DefaultObjectWrapper(2.3.21)</param-value>
          </init-param>

- 在新的或测试覆盖良好的项目中，也建议设置 `forceLegacyNonListCollections` 属性为 `false`。 如果使用 `.properties` 或 `FreemarkerServlet` 初始化参数，就会像 `DefaultObjectWrapper(2.3.22, forceLegacyNonListCollections=false)`， 同时，使用Java API可以在 `DefaultObjectWrapperBuilder` 对象调用 `build()` 之前调用 `setForceLegacyNonListCollections(false)`。

- 自定义 `DefaultObjectWrapper` 的最常用方法是覆盖 `handleUnknownType` 方法。

##### 自定义对象包装示例

我们假定有一个应用程序特定的类，像下面这样：

    package com.example.myapp;

    public class Tupple<E1, E2> {
        public Tupple(E1 e1, E2 e2) { ... }
        public E1 getE1() { ... }
        public E2 getE2() { ... }
    }

若想让模板将它视作长度为2的序列，那么就可以这么来调用 `someTupple[1]`， `<#list someTupple `...`>`, 或者 `someTupple?size`。需要创建一个 `TemplateSequenceModel` 实现来适配 `Tupple` 到 `TempateSequenceMoldel` 接口：

    package com.example.myapp.freemarker;

    ...

    public class TuppleAdapter extends WrappingTemplateModel implements TemplateSequenceModel,
            AdapterTemplateModel {

        private final Tupple<?, ?> tupple;

        public TuppleAdapter(Tupple<?, ?> tupple, ObjectWrapper ow) {
            super(ow);  // coming from WrappingTemplateModel
            this.tupple = tupple;
        }

        @Override  // coming from TemplateSequenceModel
        public int size() throws TemplateModelException {
            return 2;
        }

        @Override  // coming from TemplateSequenceModel
        public TemplateModel get(int index) throws TemplateModelException {
            switch (index) {
            case 0: return wrap(tupple.getE1());
            case 1: return wrap(tupple.getE2());
            default: return null;
            }
        }

        @Override  // coming from AdapterTemplateModel
        public Object getAdaptedObject(Class hint) {
            return tupple;
        }

    }

关于类和接口：

- `TemplateSequenceModel`： 这就是为什么模板将它视为序列

- `WrappingTemplateModel`： 只是一个方便使用的类，用于 `TemplateModel` 对象进行自身包装。通常仅对包含其它对象的对象需要。 参考上面的 `wrap(`...`)` 调用。

- `AdapterTemplateModel`： 表明模板模型适配一个已经存在的对象到 `TemplateModel` 接口， 那么去掉包装就会给出原有对象。

最后，我们告诉 FreeMarker 用 `TuppleAdapter` (或者，可以在将它们传递到FreeMarker之前手动包装它们) 包装 `Tupple`。那样的话，首先创建一个自定义的对象包装器：

    package com.example.myapp.freemarker;

    ...

    public class MyAppObjectWrapper extends DefaultObjectWrapper {

        public MyAppObjectWrapper(Version incompatibleImprovements) {
            super(incompatibleImprovements);
        }

        @Override
        protected TemplateModel handleUnknownType(final Object obj) throws TemplateModelException {
            if (obj instanceof Tupple) {
                return new TuppleAdapter((Tupple<?, ?>) obj, this);
            }

            return super.handleUnknownType(obj);
        }

    }

那么当配置 FreeMarker (关于配置，参考这里...) 将我们的对象包装器插在：

    // Where you initialize the cfg *singleton* (happens just once in the application life-cycle):
    cfg = new Configuration(Configuration.VERSION_2_3_22);
    ...
    cfg.setObjectWrapper(new MyAppObjectWrapper(cfg.getIncompatibleImprovements()));

或者使用 `java.util.Properties` 来代替配置 FreeMarker (也就是 `.properties` 文件)：

    object_wrapper=com.example.myapp.freemarker.MyAppObjectWrapper(2.3.22)

### 配置(Configuration)

这里仅仅是一个概览，若要了解更多请阅读 FreeMarker Java API 文档。

#### 基本内容

首先，确保你已经阅读了 入门 章节。

配置(configuration)就是 `freemarker.template.Configuration` 对象， 它存储了常用(全局，应用程序级)的设置，定义了想要在所有模板中可用的变量(称为共享变量)。 而且，它会处理 `Template` 实例的新建和缓存。

应用程序典型的用法是使用一个独立的共享 `Configuration` 实例。更精确来说， 典型的做法是每一个独立开发的组件(比如项目，模块等)都有一个 `Configuration` 实例，它在内部使用FreeMarker， 每一个都创建它自己的实例。

运行中的模板会受配置设置的影响，每个 `Template` 实例通过对应 `Template` 构造方法参数，都有和它相关联的 `Configuration` 实例。通常可以使用 `Configuration.getTemplate` (而不是直接调用 `Template` 的构造方法)来获得 `Template` 实例，此时，关联的 `Configuration` 实例就是调用 `getTemplate` 方法的。

#### 共享变量

Shared variables (共享变量)是为所有模板定义的变量。可以使用 `setSharedVariable` 方法向配置中添加共享变量：

    Configuration cfg = new Configuration(Configuration.VERSION_2_3_22);
    ...
    cfg.setSharedVariable("warp", new WarpDirective());
    cfg.setSharedVariable("company", "Foo Inc.");

在所有使用这个配置的模板中，名为 `wrap` 的用户自定义指令和一个名为 `company` 的字符串将会在数据模型的根root上可见， 那就不用在根哈希表上一次又一次的添加它们。在传递给 `Template.process` 的 根root对象里的变量将会隐藏同名的共享变量。

如果配置对象在多线程环境中使用，不要使用 `TemplateModel` 实现类来作为共享变量， 因为它是不是线程安全的！ 这也是基于Servlet应用程序的典型情形。

出于向后兼容的特性，共享变量的集合初始化时 (就是对于新的 `Configuration` 实例来说)不能为空。 它包含下列用户自定义指令(用户自定义指令使用时需要用 `@` 来代替`#`)：

名称 | 类
--- | ---
`capture_output` | `freemarker.template.utility.CaptureOutput`
`compress` | `freemarker.template.utility.StandardCompress`
`html_escape` | `freemarker.template.utility.HtmlEscape`
`normalize_newlines` | `freemarker.template.utility.NormalizeNewlines`
`xml_escape` | `freemarker.template.utility.XmlEscape`

#### 配置设置

Settings(配置设置) 是影响FreeMarker行为的已被命名的值。配置设置有很多， 例如：`locale`，`number_format`， `default_encoding`， `template_exception_handler`。可以参考 `Configuration.setSetting(...)`的Java API 文档 来查看配置设置的完整列表。

配置设置存储在 `Configuration` 实例中，可以在 `Template` 实例中被覆盖。比如，在配置中给 `locale` 设置为 `"en_US"`， 那么使用该配置的所有模板中的 `locale` 都使用 `"en_US"`， 除非在模板中locale被明确地设置成其它不同的值(参见 localization)。 因此，在 `Configuration` 中的值充当默认值， 这些值在每个模板中也可以被覆盖。在 `Configuration` 或 `Template` 实例中的值也可以在单独调用 `Template.process` 方法后被覆盖。 对于每个调用了 `freemarker.core.Environment` 对象的值在内部创建时就持有模板执行的运行时环境，也包括了那个级别被覆盖了的设置信息。 在模板执行时，那里存储的值也可以被改变，所以模板本身也可以设置配置信息， 比如在输出中途来变换 `locale` 设置。

配置信息可以被想象成3层(`Configuration`， `Template`，`Environment`)， 最高层包含特定的值，它为设置信息提供最有效的值。 比如(设置信息A到F仅仅是为这个示例而构想的)：

| Setting A | Setting B | Setting C | Setting D | Setting E | Setting F
--- | --- | --- | --- | --- | --- | ---
Layer 3: `Environment` | 1 | - | - | 1 | - | -
Layer 2: `Template` | 2 | 2 | - | - | 2 | -
Layer 1: `Configuration` | 3 | 3 | 3 | 3 | - | -

配置信息的有效值为：A=1，B=2，C=3，D=1，E=2。 而F的设置则是 `null`，或者在你获取它的时候将抛出异常。

我们看看如何准确设置配置信息：

- `Configuration` 层： 原则上设置配置信息时使用 `Configuration` 对象的setter方法，例如：

      Configuration myCfg = new Configuration(Configuration.VERSION_2_3_23);
      myCfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
      myCfg.setDefaultEncoding("UTF-8");

  在真正使用 `Configuration` 对象 (通常在初始化应用程序时)之前来配置它，后面必须将其视为只读的对象。

  在实践中，比如很多Web应用框架中，就应该使用这种框架特定的配置方式来进行配置， 比如使用成对的 `String` 来配置(像在 `.properties` 属性配置文件中那样)。 在这种情况下，框架的作者大多数使用 `Configuration` 对象的 `setSetting(String name, String value)` 方法。 这可以参考`setSetting`的API文档 部分来获取可用的设置名和参数的格式的信息。 而在Spring框架中，我们可以这样进行：

      <bean id="freemarkerConfig"
          class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
        <property name="freemarkerSettings">
          <props>
            <prop key="incompatible_improvements">2.3.23</prop>
            <prop key="template_exception_handler">rethrow</prop>
            <prop key="default_encoding">UTF-8</prop>
          </props>
        </property>
      </bean>

  请注意，这种形式的配置( `String` 键-值对) 和直接使用 `Configuration` 的API相比， 很不幸地被限制了。

- `Template` 层：对于被请求的本地化信息，模板的 `locale` 设置由 `Configuration.getTemplate(...)` 来设置。 否则，就不能在这里进行设置，除非想控制 `Template` 对象来代替 `freemarker.cache.TemplateCache`，这样的话， 应该在 `Template` 对象第一次被使用前就设置配置信息， 然后就将 `Template` 对象视为是只读的。

- `Environment` 层：这里有两种配置方法：

  - 使用Java API：使用 `Environment` 对象的setter方法。当然想要在模板执行之前来做，然后当调用 `myTemplate.process(...)` 时会遇到问题， 因为在内部创建 `Environment` 对象后立即就执行模板了， 导致没有机会来进行设置。这个问题的解决可以用下面两个步骤进行：

        Environment env = myTemplate.createProcessingEnvironment(root, out);
        env.setLocale(java.util.Locale.ITALY);
        env.setNumberFormat("0.####");
        env.process();  // process the template

  - 在模板中(通常这被认为是不好的做法)直接使用 `setting` 指令，例如：

        <#setting locale="it_IT">
        <#setting number_format="0.####">

  在这层，当什么时候改变配置信息，是没有限制的。

要知道 FreeMarker 支持什么样的配置信息还有它们的意义， 可以先看看FreeMarker Java API文档中的下面这部分内容：

- 在三层中 `freemarker.core.Configurable` 的setter方法来配置。

- 只在 `Configuration` 层可用的 `freemarker.template.Configuration` 的setter方法来配置。

- 在三层中可用 `String` 键-值对书写的 `freemarker.core.Configurable.setSetting(String,String)` 配置。

- 只在 `Configuration` 层中可用 `String` 键-值对书写的 `freemarker.template.Configuration.setSetting(String, String)` 配置。

#### 模板加载

##### 模板加载器

模板加载器是加载基于抽象模板路径下，比如 `"index.ftl"` 或 `"products/catalog.ftl"` 的原生文本数据对象。 这由具体的模板加载器对象来确定它们取得请求数据时使用了什么样的数据来源 (文件夹中的文件，数据等等)。当调用 `cfg.getTemplate` (这里的 `cfg` 就是 `Configuration` 实例)时， FreeMarker询问模板加载器是否已经为 `cfg` 建立返回给定模板路径的文本，之后 FreeMarker 解析文本生成模板。

###### 内建模板加载器

在 `Configuration` 中可以使用下面的方法来方便建立三种模板加载。 (每种方法都会在其内部新建一个模板加载器对象，然后创建 `Configuration` 实例来使用它。)

    void setDirectoryForTemplateLoading(File dir);

或

    void setClassForTemplateLoading(Class cl, String prefix);

或

    void setServletContextForTemplateLoading(Object servletContext, String path);

上述的第一种方法在磁盘的文件系统上设置了一个明确的目录， 它确定了从哪里加载模板。不要说可能，`File` 参数肯定是一个存在的目录。否则，将会抛出异常。

第二种调用方法使用了一个 `Class` 类型的参数和一个前缀。这是让你来指定什么时候通过相同的机制来加载模板， 不过是用Java的 `ClassLoader` 来加载类。 这就意味着传入的class参数会被 `Class.getResource()` 用来调用方法来找到模板。参数 `prefix` 是给模板的名称来加前缀的。在实际运行的环境中， 类加载机制是首选用来加载模板的方法，通常情况下，从类路径下加载文件的这种机制， 要比从文件系统的特定目录位置加载安全而且简单。在最终的应用程序中， 所有代码都使用 `.jar` 文件打包也是不错的， 这样用户就可以直接执行包含所有资源的 `.jar` 文件了。

第三种调用方式需要Web应用的上下文和一个基路径作为参数， 这个基路径是Web应用根路径(`WEB-INF`目录的上级目录)的相对路径。 那么加载器将会从Web应用目录开始加载模板。尽管加载方法对没有打包的 `.war` 文件起作用，因为它使用了 `ServletContext.getResource()` 方法来访问模板， 注意这里我们指的是“目录”。如果忽略了第二个参数（或使用了`""`）， 那么就可以混合存储静态文件（`.html`，`.jpg`等） 和 `.ftl` 文件，只是 `.ftl` 文件可以被送到客户端执行。 当然必须在 `WEB-INF/web.xml` 中配置一个Servlet来处理URI格式为 `*.ftl` 的用户请求，否则客户端无法获取到模板， 因此你将会看到Web服务器给出的秘密提示内容。在站点中不能使用空路径，这是一个问题， 你应该在 `WEB-INF` 目录下的某个位置存储模板文件， 这样模板源文件就不会偶然地被执行到，这种机制对servlet应用程序来加载模板来说， 是非常好用的方式，而且模板可以自动更新而不需重启Web应用程序， 但是对于类加载机制，这样就行不通了。

###### 从多个位置加载模板

如果需要从多个位置加载模板，那就不得不为每个位置都实例化模板加载器对象， 将它们包装到一个称为 `MultiTemplateLoader` 的特殊模板加载器， 最终将这个加载器传递给 `Configuration` 对象的 `setTemplateLoader(TemplateLoader loader)`方法。 下面给出一个使用类加载器从两个不同位置加载模板的示例：

    import freemarker.cache.*; // template loaders live in this package

    ...

    FileTemplateLoader ftl1 = new FileTemplateLoader(new File("/tmp/templates"));
    FileTemplateLoader ftl2 = new FileTemplateLoader(new File("/usr/data/templates"));
    ClassTemplateLoader ctl = new ClassTemplateLoader(getClass(), "");
    TemplateLoader[] loaders = new TemplateLoader[] { ftl1, ftl2, ctl };
    MultiTemplateLoader mtl = new MultiTemplateLoader(loaders);

    cfg.setTemplateLoader(mtl);

现在，FreeMarker将会尝试从 `/tmp/templates` 目录加载模板，如果在这个目录下没有发现请求的模板，它就会继续尝试从 `/usr/data/templates` 目录下加载，如果还是没有发现请求的模板， 那么它就会使用类加载器来加载模板。

###### 从其他资源加载模板

如果内建的类加载器都不适合使用，那么就需要来编写自己的类加载器了， 这个类需要实现 `freemarker.cache.TemplateLoader` 接口， 然后将它传递给 `Configuration` 对象的 `setTemplateLoader(TemplateLoader loader)`方法。 可以阅读API JavaDoc文档获取更多信息。

如果模板需要通过URL访问其他模板，那么就不需要实现 `TemplateLoader` 接口了，可以选择子接口 `freemarker.cache.URLTemplateLoader` 来替代， 只需实现 `URL getURL(String templateName)` 方法即可。

###### 模板名称(模板路径)

解析模板的名称(也就是模板路径)是由模板解析器来决定的。 但是要和其它对路径的格式要求很严格的组件一起使用。通常来说， 强烈建议模板加载器使用URL风格的路径。 在URL路径(或在UN*X路径)中符号有其它含义时，那么路径中不要使用 `/`(路径分隔符)字符，`.` (同目录符号)和`..`(父目录符号)。字符 `*`(星号)是被保留的， 它用于FreeMarker的 模板获取 特性。

`://`(或者使用 `template_name_format` 配置设置到 `DEFAULT_2_4_0`，`:` (冒号) 字符)是被保留用来指定体系部分的，和URI中的相似。比如 `someModule://foo/bar.ftl` 使用 `someModule`，或者假定 `DEFAULT_2_4_0` 格式，`classpath:foo/bar.ftl` 使用 `classpath` 体系。解释体系部分完全由 `TemplateLoader` 决定。 (FreeMarker核心仅仅知道体系的想法，否则它不能正常处理相对模板名称。)

FreeMarker通常在将路径传递到 `TemplateLoader` 之前把它们正常化，所以路径中不会包含 `/../` 这样的内容， 路径会相对于虚构的模板根路径(也就是它们不会以 `/` 开头)。 其中也不会包含 `*`，因为模板获取发生在很早的阶段。 此外，将 `template_name_format` 设置为 `DEFAULT_2_4_0`，多个连续的 `/` 将会被处理成单独的 `/` (除非它们是 `://` 模式分隔符的一部分)。

请注意，不管主机运行的操作系统是什么， FreeMarker 模板加载时经常使用斜线(而不是反斜线)。

##### 模板缓存

FreeMarker 是会缓存模板的(假设使用 `Configuration` 对象的方法来创建 `Template` 对象)。这就是说当调用 `getTemplate`方法时，FreeMarker不但返回了 `Template` 对象，而且还会将它存储在缓存中， 当下一次再以相同(或相等)路径调用 `getTemplate` 方法时， 那么它只返回缓存的 `Template` 实例， 而不会再次加载和解析模板文件了。

如果更改了模板文件，当下次调用模板时，FreeMarker 将会自动重新载入和解析模板。 然而，要检查模板文件是否改变内容了是需要时间的，有一个 `Configuration` 级别的设置被称作"更新延迟"，它可以用来配置这个时间。 这个时间就是从上次对某个模板检查更新后，FreeMarker再次检查模板所要间隔的时间。 其默认值是5秒。如果想要看到模板立即更新的效果，那么就要把它设置为0。 要注意某些模板加载器也许在模板更新时可能会有问题。 例如，典型的例子就是在基于类加载器的模板加载器就不会注意到模板文件内容的改变。

当调用了 `getTemplate` 方法时， 与此同时FreeMarker意识到这个模板文件已经被移除了，所以这个模板也会从缓存中移除。 如果Java虚拟机认为会有内存溢出时，默认情况它会从缓存中移除任意模板。 此外，你还可以使用 `Configuration` 对象的 `clearTemplateCache` 方法手动清空缓存。

何时将一个被缓存了的模板清除的实际应用策略是由配置的属性 `cache_storage` 来确定的，通过这个属性可以配置任何 `CacheStorage` 的实现。对于大多数用户来说， 使用 `freemarker.cache.MruCacheStorage` 就足够了。 这个缓存存储实现了二级最近使用的缓存。在第一级缓存中， 组件都被强烈引用到特定的最大数目(引用次数最多的组件不会被Java虚拟机抛弃， 而引用次数很少的组件则相反)。当超过最大数量时， 最近最少使用的组件将被送至二级缓存中，在那里它们被很少引用， 直到达到另一个最大的数目。引用强度的大小可以由构造方法来指定。 例如，设置强烈部分为20，轻微部分为250：

    cfg.setCacheStorage(new freemarker.cache.MruCacheStorage(20, 250))

或者，使用 `MruCacheStorage` 缓存， 它是默认的缓存存储实现：

    cfg.setSetting(Configuration.CACHE_STORAGE_KEY, "strong:20, soft:250");

当创建了一个新的 `Configuration` 对象时， 它使用一个 `strongSizeLimit` 值为0的 `MruCacheStorage` 缓存来初始化， `softSizeLimit` 的值是 `Integer.MAX_VALUE` (也就是在实际中，是无限大的)。但是使用非0的 `strongSizeLimit` 对于高负载的服务器来说也许是一个更好的策略，对于少量引用的组件来说， 如果资源消耗已经很高的话，Java虚拟机往往会引发更高的资源消耗， 因为它不断从缓存中抛出经常使用的模板，这些模板还不得不再次加载和解析。

#### 错误控制

##### 可能的异常

关于 FreeMarker 发生的异常，可以分为如下几类：

- 当配置 FreeMarker 时发生异常：典型地情况，就是在应用程序初始化时， 仅仅配置了一次 FreeMarker。在这个过程中，异常就会发生， 从 FreeMarker 的API中，我们可以很清楚的看到这一点...

- 当加载和解析模板时发生异常：调用了 `Configuration.getTemplate(`...`)` 方法， FreeMarker就要把模板文件加载到内存中然后来解析它 (除非模板已经在 `Configuration` 对象中被 缓存 了)。 在这期间，有两种异常可能发生：

  - 因模板文件没有找到而发生的 `IOException` 异常， 或在读取文件时发生其他的I/O问题。比如没有读取文件的权限，或者是磁盘错误。 这些错误的发出者是 `TemplateLoader` 对象，可以将它作为插件设置到 `Configuration`对象中。(为了正确起见：这里所说的”文件”， 是简化形式。例如，模板也可以存储在关系型数据库的表中。这是 `TemplateLoader`所要做的事。)

  - 根据FTL语言的规则，模板文件发生语法错误时会导致 `freemarker.core.ParseException`异常。当获得 `Template`对象 (`Configuration.getTemplate(`...`)`)时， 这种错误就会发生，而不是当执行 (`Template.process(`...`)`)模板的时候。 这种异常是 `IOException` 的一个子类。

- 当执行(处理)模板时发生的异常，也就是当调用了 `Template.process(`...`)` 方法时会发生的两种异常：

  - 当试图写入输出对象时发生错误而导致的 `IOException` 异常。

  - 当执行模板时发生的其它问题而导致的 `freemarker.template.TemplatException` 异常。 比如，一个频繁发生的错误，就是当模板引用一个不存在的变量。 默认情况下，当 `TemplatException` 异常发生时， FreeMarker会用普通文本格式在输出中打印出FTL的错误信息和堆栈跟踪信息， 然后再次抛出 `TemplatException` 异常而中止模板的执行， 就可以捕捉到 `Template.process(`...`)` 方法抛出的异常了。而这种行为是可以定制的。FreeMarker也会经常写 `TemplatException` 异常的 日志。

##### 根据TemplateException来自定义处理方式

`TemplateException` 异常在模板处理期间的抛出是由 `freemarker.template.TemplateExceptionHandler` 对象控制的，这个对象可以使用 `setTemplateExceptionHandler(`...`)` 方法配置到 `Configuration` 对象中。 `TemplateExceptionHandler` 对象只包含一个方法：

    void handleTemplateException(TemplateException te, Environment env, Writer out)
            throws TemplateException;

无论 `TemplateException` 异常什么时候发生，这个方法都会被调用。 异常处理是传递的 `te` 参数控制的， 模板处理的运行时(Runtime，译者注)环境可以访问 `env` 变量， 处理器可以使用 `out` 变量来打印输出信息。 如果方法抛出异常(通常是重复抛出 `te`)，那么模板的执行就会中止， 而且 `Template.process(`...`)` 方法也会抛出同样的异常。如果 `handleTemplateException` 对象不抛出异常，那么模板将会继续执行，就好像什么也没有发生过一样， 但是引发异常的语句将会被跳过(后面会详细说)。 当然，控制器仍然可以在输出中打印错误提示信息。

任何一种情况下，当 `TemplateExceptionHandler` 被调用前， FreeMarker 将会记录异常日志。

我们用实例来看一下，当错误控制器不抛出异常时， FreeMarker是如何跳过出错''语句''的。假设我们已经使用了如下模板异常控制器：

    class MyTemplateExceptionHandler implements TemplateExceptionHandler {
        public void handleTemplateException(TemplateException te, Environment env, java.io.Writer out)
                throws TemplateException {
            try {
                out.write("[ERROR: " + te.getMessage() + "]");
            } catch (IOException e) {
                throw new TemplateException("Failed to print error message. Cause: " + e, env);
            }
        }
    }

    ...

    cfg.setTemplateExceptionHandler(new MyTemplateExceptionHandler());

如果错误发生在非FTL标记(没有被包含在 `<#`...`>` 或 `<@`...`>`之间)的插值中， 那么整个插值将会被跳过。那么下面这个模板 (假设 `badVar` 在数据模型中不存在)：

    a${badVar}b

如果我们使用了 `MyTemplateExceptionHandler`，就会打印：

    a[ERROR: Expression badVar is undefined on line 1, column 4 in test.ftl.]b

而下面这个模板也会打印相同信息(除了报错的列数位置会不同...)：

    a${"moo" + badVar}b

因为像这样来写时，只要插值内发生任何错误，整个插值都会被跳过。

如果错误发生在指令调用中参数的计算时，或者是指令参数列表发生问题时， 或在`<@`exp` `...`>`中计算 ``exp``时发生错误，或者 ``exp``不是用户自定义的指令， 那么整个指令调用都会被跳过。例如：

    a<#if badVar>Foo</#if>b

将会输出：

    a[ERROR: Expression badVar is undefined on line 1, column 7 in test.ftl.]b

请注意，错误发生在 `if` 指令的开始标签 (`<#if badVar>`)中，但是整个指令的调用都被跳过了。 从逻辑上说，嵌套的内容(`Foo`)也被跳过了， 因为嵌套的内容是受被包含的指令(`if`)控制(打印)的。

下面这个的输出也是相同的（除了报错的列数会不同...)：

    a<#if "foo${badVar}" == "foobar">Foo</#if>b

因为，正如这样来写，在参数处理时发生任何一个错误， 整个指令的调用都将会被跳过。

如果错误发生在已经开始执行的指令之后，那么指令调用将不会被跳过。 也就是说，如果在嵌套的内容中发生任何错误：

    a
    <#if true>
      Foo
      ${badVar}
      Bar
    </#if>
    c

或者在一个宏定义体内：

    a
    <@test />
    b
    <#macro test>
      Foo
      ${badVar}
      Bar
    </#macro>

那么输出将会是：

    a
      Foo
      [ERROR: Expression badVar is undefined on line 4, column 5 in test.ftl.]
      Bar
    c

FreeMarker 本身带有这些预先编写的错误控制器：

- `TemplateExceptionHandler.DEBUG_HANDLER`： 打印堆栈跟踪信息(包括FTL错误信息和FTL堆栈跟踪信息)和重新抛出的异常。 这是默认的异常控制器(也就是说，在所有新的 `Configuration` 对象中，它是初始化好的)。

- `TemplateExceptionHandler.HTML_DEBUG_HANDLER`： 和 `DEBUG_HANDLER` 相同，但是它可以格式化堆栈跟踪信息， 那么就可以在Web浏览器中来阅读错误信息。 当你在制作HTML页面时，建议使用它而不是 `DEBUG_HANDLER`。

- `TemplateExceptionHandler.IGNORE_HANDLER`： 简单地压制所有异常(但是要记住，FreeMarker 仍然会写日志)。 它对处理异常没有任何作用，也不会重新抛出异常。

- `TemplateExceptionHandler.RETHROW_HANDLER`： 简单重新抛出所有异常而不会做其它的事情。 这个控制器对Web应用程序(假设你在发生异常之后不想继续执行模板)来说非常好， 因为它在生成的页面发生错误的情况下，给了你很多对Web应用程序的控制权 (因为FreeMarker不向输出中打印任何关于该错误的信息)。 要获得更多在Web应用程序中处理错误的信息，可以 参见FAQ。

##### 在模板中明确地处理错误

尽管它和 FreeMarker 的配置(本章的主题)无关，但是为了说明的完整性， 在这里提及一下，你可以在模板中直接控制错误。 通常这不是一个好习惯(尽量保持模板简单，技术含量不要太高)，但有时仍然需要：

- 处理不存在/为空的变量： dgui_template_exp_missing

- 在发生障碍的"porlets"中留存下来，还可以扩展参考： ref_directive_attempt

#### "不兼容改进"设置

##### 它要做什么

该设置指定了 FreeMarker 的版本号，那么就不会100%向后兼容bug修复和改进 你想要启用 已经实现的内容。 通常来说，默认把它留在2.3.0(最大向后兼容版本)是一个坏主意。

在新项目中，应该将它设置为实际使用的FreeMarker版本号。 而在老项目中，那么最好也将它设置的高一些，最好检查一下哪些修改是激活状态(可以在 `Configuration(Version)` 构造方法的API JavaDoc文档 中找到它们)，至少不仅仅是 不兼容改进 第三版本号(小版本)设置提高。通常来讲， 只要为该设置增加最后的版本号，那么这些修改的风险就会小很多。

Bug修复和改进是完全向后兼容的，同样，它们也是重要的安全更新， 不管 不兼容改进 如何设置都是启用的。

该设置的一个重要结果是应用程序可以检查声明的 FreeMarker 最小版本需求是否达到。 比如你设置了2.3.22，但是应用程序却意外部署到了 FreeMarker 2.3.21， 那么FreeMarker就会出问题，告诉你需要一个更高的版本。 最后，请求的修复/改进不会作用于低版本。

##### 如何设置

这个不兼容改进的设置在 `Configuration` 级别。 它可以在多种方式下设置(假设我们想将它设置为2.3.22)：

- 创建 `freemarker.template.Configuration` 对象，比如：

      ... = new Configuration(Configuration.VERSION_2_3_22)

- 或者，使用初始化设置来更改 `Configuration` 单例，比如：

      cfg.setIncompatibleImprovements(Configuration.VERSION_2_3_22)

- 或者，如果使用properties文件来配置FreeMarker (`*.properties` 文件或者 `java.util.Properties` 对象)，添加：

      incompatible_improvements=2.3.22

- 或者，如果通过 `FreemarkerServlet` 来配置FreeMarker，那么将 `init-param` 添加到 `web.xml` 中：

      <init-param>
          <param-name>incompatible_improvements</param-name>
          <param-value>2.3.22</param-value>
      </init-param>

但是， 在应用程序中 如果设置了 `object_wrapper` (也就是 `Configuration.setObjectWrapper(ObjectWrapper)`)， 那么要知道很重要的一点，`BeansWrapper` 和它的子类(最重要的是， `DefaultObjectWrapper`) 有它们自己独立的 `incompatibleImprovements` 属性，还有一些修复/改进会被它激活， 而不是通过 `Configuration` 的相似设置。 如果你没有在任何地方设置过 `object_wrapper`，那么不需要知道这点， 因为，和 `Configuration` 一样， 默认的 `object_wrapper` 也有相同的 不兼容改进。 但是，如果设置了 `object_wrapper`， 那么就不要忘了设置 `ObjectWrapper` 自己的 `incompatibleImprovements` 属性，此外还有 `Configuration`。(请注意，对于 `Configuration` 来说， 有不同的 不兼容改进 也是可以的，而对于 `ObjectWrapper`， 则有它自己的选择。) 至于 `DefaultObjectWrapper` (对于 `BeansWrapper` 也是一样的，只是不同的类名而已) 参看这里如何来设置它。

### 其它

这只是一个介绍性的导引，可以查看 FreeMarker Java API 文档 获取详细信息。

#### 变量，范围

本章介绍当模板在访问变量时发生了什么事情，还有变量是如何存储的。

当调用 `Template.process` 方法时，它会在方法内部创建一个 `Environment` 对象，在 `process` 返回之前一直使用。 该对象存储模板执行时的运行状态信息。除了这些，它还存储由模板中指令，如 `assign`， `macro`， `local` 或 `global` 创建的变量。 它不会尝试修改传递给 `process` 的数据模型对象， 也不会创建或替换存储在配置中的共享变量。

当你想要读取一个变量时，FreeMarker 将会以这种顺序来查找， 直到发现了完全匹配的的变量名称才会停下来：

1. 在 Environment 中：

   1. 如果在循环中，在循环变量的集合中。 循环变量是由如 `list` 等指令来创建的。

   2. 如果在宏中，在宏的局部变量集合中。 局部变量可以由 `local` 指令创建。 而且，宏的参数也是局部变量。

   3. 在当前的 命名空间 中。 可以使用 `assign` 指令将变量放到一个命名空间中。

   4. 在由 `global` 指令创建的变量集合中。 FTL将它们视为数据模型的普通成员变量一样来控制它们。 也就是说，它们在所有的命名空间中都可见， 你也可以像访问一个数据模型中的数据一样来访问它们。

2. 在传递给 `process` 方法的数据模型对象中。

3. 在 `Configuration` 对象存储的共享变量集合中。

在实际操作中，来自模板设计者的观点是这6种情况应该只有4种， 因为从那种观点来看，后面3种(由 `global` 创建的变量， 真实的数据模型对象，共享变量)共同构成了全局变量的集合。

请注意，在FTL中可以从一个特定层面获取 特定变量。

#### 字符集问题

像其它大多数的Java应用程序一样，FreeMarker使用 "UNICODE 文本"(UTF-16)来工作。 不过，也有必须处理 字符集 的情况， 因为它不得不和外界交换数据，这就会使用到很多字符集。

##### 输入的字符集

当 FreeMarker 要加载模板文件(或没有解析的文本文件)时， 那就必须要知道文件使用的字符集，因为文件的存储是原生的字节序列。 可以使用 `encoding` 配置 来确定字符集。 这个配置项只在 FreeMarker 使用 `Configuration` 对象的 `getTemplate` 方法加载模板(解析过的或没有解析过的)时起作用。请注意 `include` 指令 在内部也使用了这个方法，所以 `encoding` 的值对一个已经加载的模板，而且如果这个模板包含 `include` 指令的调用来说很重要。

`encoding` 配置的getter和setter方法在第一个(配置)层面很特殊。 getter方法猜想返回值是基于 `Locale`(本地化，译者注)传递的参数； 它在地图区域编码表(称为编码地图)中查询编码，如果没有找到该区域，就返回默认编码。 可以使用配置对象的 `setEncoding(Locale locale, String encoding)` 方法来填充编码表；编码表初始化时是空的。默认的初始编码是系统属性 `file.encoding` 的值，但是可以通过 `setDefaultEncoding` 方法来设置一个不同的默认值，而不是依赖它。 对于新项目来说，默认的编码设置就是 `utf-8`。

也可以在模板层或运行环境层(当指定编码值作为 `getTemplate` 方法的参数时，应该在模板层覆盖 `encoding` 设置)直接给定值来覆盖 `encoding` 的设置。如果不覆盖它，那么 `locale` 设置的有效值将会是 `configuration.getEncoding(Locale)` 方法的返回值。

而且，代替这种基于字符集猜测的机制，也可以在模板文件中使用 `ftl` 指令, 比如 `<#ftl encoding="utf-8">` 来指定特定的字符集。

请注意，模板使用的字符集和模板生成的输出内容的字符集是独立的 (除非包含 FreeMarker 的软件故意将设置输出内容的字符集和模板字符集设置成相同的)。

##### 输出的字符集

`output_encoding` 设置/参数和 内建函数`url` 从FreeMarker 2.3.1版本开始才可以使用，而在2.3以前的版本中是不存在的。

原则上，FreeMarker 不处理输出内容的字符集问题， 因为 FreeMarker 将输出内容都写入了 `java.io.Writer` 对象中。而 `Writer` 对象是由封装了 FreeMarker(比如Web应用框架) 的软件生成的， 那么输出内容的字符集就是由封装软件来控制的。而FreeMarker有一个称为 `output_encoding`(开始于 FreeMarker 2.3.1 版本之后)的设置。 封装软件应该使用这个设置(`Writer`对象使用的字符集) 来通知 FreeMarker 在输出中(否则 FreeMarker 不能找到它)使用哪种字符集。 有一些新的特性，如内建函数`url`，特殊变量`output_encoding` 也利用这个信息。因此，如果封装软件没有设置字符集这个信息， 那么 FreeMarker 需要知道输出字符集的特性就不能被利用了。

如果你使用 FreeMarker 来编写软件， 你也许想知道在输出内容中到底选择了哪种字符集。 当然这取决于运行 FreeMarker 输出内容的计算机本身， 但是如果用户对这个问题可以变通， 那么通用的实践是使用模板文件的字符集作为输出的字符集，或者使用UTF-8。 通常使用UTF-8是最佳的实践，因为任意的文本可能来自数据模型， 那就可能包含不能被模板字符集所编码的字符。

如果使用了 `Template.createProcessingEnvironment(`...`)` 和 `Environment.process(`...`)` 方法来代替 `Template.process(`...`)` 方法， FreeMarker 的设置可以对任意独立执行的模板进行。 因此，你可以对每个独立执行的模板设置 `output_encoding` 信息：

    Writer w = new OutputStreamWriter(out, outputCharset);
    Environment env = template.createProcessingEnvironment(dataModel, w);
    env.setOutputEncoding(outputCharset);
    env.process();

#### 多线程

在多线程运行环境中， `Configuration` 实例， `Template` 实例和数据模型应该是永远不能改变(只读)的对象。 也就是说，创建和初始化它们(如使用 `set`...`` 方法)之后，就不能再修改它们了(比如不能再次调用 `set`...`` 方法)。 这就允许我们在多线程环境中避免代价很大的同步锁问题。要小心 `Template` 实例； 当使用了 `Configuration.getTemplate` 方法获得 `Template` 一个实例时，也许得到的是从模板缓存中缓存的实例， 这些实例都已经被其他线程使用了，所以不要调用它们的 `set`...`` 方法 (当然调用 `process` 方法还是不错的)。

如果只从 同一个 独立线程中访问所有对象， 那么上面所述的限制将不会起作用。

使用FTL来修改数据模型对象或者 共享变量 是不太可能的， 除非将方法(或其他对象)放到数据模型中来做。 我们不鼓励你编写修改数据模型对象或共享变量的方法。多试试使用存储在环境对象 (这个对象是为独立的 `Template.process` 调用而创建的， 用来存储模板处理的运行状态)中的变量，所以最好不要修改那些由多线程使用的数据。 要获取更多信息，请阅读：pgui_misc_var

#### Bean的包装

直接使用 `BeansWrapper` 是不推荐的。 而可以使用它的子类 `DefaultObjectWrapper` 来代替，要确保它的 `incompatibleImprovements` 属性至少是2.3.22。`DefaultObjectWrapper` 给出了干净的数据模型(很少的容易混淆的多类型的FTL值)而且通常速度很快。关于更多 DefaultObjectWrapper 可以参看这里...

`freemarker.ext.beans.BeansWrapper` 是一个对象包装器， 最初加到FreeMarker中是为了将任意的POJO(Plan Old Java Objects，普通的Java对象) 包装成 `TemplateModel` 接口类型。 这样它就可以以正常的方式来进行处理，事实上 `DefaultObjectWrapper` 本身是 `BeansWrapper` 的扩展类。 这里描述的所有东西对 `DefaultObjectWrapper` 都是适用的， 除了 `DefaultObjectWrapper` 会用到 `freemarker.template.Simple`Xxx`` 类包装的`String`，`Number`， `Date`，`array`， `Collection`(如`List`)， `Map`，`Boolean` 和 `Iterator`对象，会用 `freemarker.ext.dom.NodeModel` 来包装W3C的DOM结点(更多关于包装的W3C DOM 可以参考这里...)， 所以上述这些描述的规则不适用。

当出现下面这些情况时， 你会想使用 `BeansWrapper` 包装器来代替 `DefaultObjectWrapper`：

- 在模板执行期间，数据模型中的 `Collection` 和 `Map` 应该被允许修改。 (`DefaultObjectWrapper` 会阻止这样做， 因为当它包装对象时创建了数据集合的拷贝，而这些拷贝都是只读的。)

- 如果 `array`，`Collection` 和 `Map` 对象的标识符当在模板中被传递到被包装对象的方法时， 必须被保留下来。也就是说，那些方法必须得到之前包装好的同类对象。

- 如果在之前列出的Java API中的类(如 `String`， `Map`，`List` 等)应该在模板中可见。 还有 `BeansWrapper`，默认情况下它们是不可见的， 但是可以设置获取的可见程度(后面将会介绍)。请注意这是一个不好的实践， 尽量去使用 内建函数 (如`foo?size`，`foo?upper_case`， `foo?replace('_', '-')` 等）来代替Java API的使用。

下面是对 `BeansWrapper` 创建的 `TemplateModel` 对象进行的总结。为了后续的讨论， 这里我们假设在包装之前对象都称为 `obj`， 而包装的后称为 `model`。

##### 模板哈希表模型功能(TemplateHashModel functionality)

所有的对象都将被包装成 `TemplateHashModel` 类型， 进而可以获取出JavaBean对象中的属性和方法。这样， 就可以在模板中使用 `model.foo` 的形式来调用 `obj.getFoo()` 方法或 `obj.isFoo()` 方法了。 (要注意公有的属性直接是不可见的，必须为它们编写getter方法才行) 公有方法通过哈希表模型来取得，就像模板方法模型那样， 因此可以使用 `model.doBar()` 来调用 `object.doBar()`。下面我们来更多讨论一下方法模型功能。

如果请求的键值不能映射到一个bean的属性或方法时， 那么框架将试图定位到"通用的get方法"，这个方法的签名是 public ``any-return-type` get(String)` 或 public ``any-return-type` get(Object)`， 使用请求键值来调用它们。请注意，这样就使得访问 `java.util.Map` 和其他类似类型的键值对非常便利。只要map的键是 `String` 类型的， 属性和方法名可以在映射中查到。(有一种解决方法可以用来避免在映射中遮挡名称，请继续来阅读。) 要而且注意 `java.util.ResourceBundle` 对象的方法使用 `getObject(String)` 方法作为通用的get方法。

如果在 `BeansWrapper` 实例中调用了 `setExposeFields(true)` 方法，那么它仍然会暴露出类的公有的， 非静态的变量，用它们作为哈希表的键和值。即如果 `foo` 是类 `Bar` 的一个公有的，非静态的变量，而 `bar` 是一个包装了 `Bar` 实例模板变量， 那么表达式 `bar.foo` 的值将会作为 `bar` 对象中 `foo` 变量的值。所有这个类的超类中公有变量都会被暴露出来。

##### 说一点安全性

默认情况下，一些方法不能访问，它们被认为是模板中不安全的。 比如，不能使用同步方法(`wait`，`notify`， `notifyAll`)，线程和线程组的管理方法(`stop`， `suspend`，`resume`，`setDaemon`， `setPriority`)，反射相关方法（`Field`， `set`Xxx`` 方法， `Method.invoke`，`Constructor.newInstance`， `Class.newInstance`，`Class.getClassLoader`等)， `System` 和 `Runtime` 类中各种有危险性的方法 (`exec`，`exit`，`halt`， `load`等)。`BeansWrapper` 也有一些安全级别 (被称作"方法暴露的级别"），默认的级别被称作为 `EXPOSE_SAFE`， 它可能对大多数应用程序来说是适用的。没有安全保证的级别称作是 `EXPOSE_ALL`，它允许你调用上述的不安全的方法。一个严格的级别是 `EXPOSE_PROPERTIES_ONLY`，它只会暴露出bean属性的getters方法。 最后，一个称作是 `EXPOSE_NOTHING` 的级别，它不会暴露任何属性和方法。 这种情况下，你可以通过哈希表模型接口访问的那些数据只是map和资源包中的项， 还有，可以从通用 `get(Object)` 方法和 `get(String)` 方法调用返回的对象，所提供的受影响的对象就有这样的方法。

##### 模板标量模型功能(TemplateScalarModel functionality)

对于 `java.lang.String` 对象的模型会实现 `TemplateScalarModel` 接口，这个接口中的 `getAsString()` 方法简单代替了 `toString()` 方法。 要注意把 `String` 对象包装到Bean包装器中， 要提供比它们作为标量时更多的功能：因为哈希表接口描述了上述所需功能， 那么包装 `String` 的模型也会提供访问所有 `String` 的方法(`indexOf`， `substring` 等)，尽管它们中很多都有内部的FreeMarker相同的实现， 最好使用它们(`s?index_of(n)`，`s[start..<end]` 等)。

##### 模板数字模型功能(TemplateNumberModel functionality)

对于是 `java.lang.Number` 的实例对象的模型包装器， 它们实现了 `TemplateNumberModel` 接口，接口中的 `getAsNumber()` 方法返回被包装的数字对象。 请注意把 `Number` 对象包装到Bean包装器中， 要提供比它们作为数字时更多的功能：因为哈希表接口描述了上述所需功能， 那么包装 `Number` 的模型也会提供访问所有他们的方法。

##### 模板集合模型功能(TemplateCollectionModel functionality)

对于本地的Java数组和其他所有实现了 `java.util.Collection` 接口的类的模型包装器，都实现了 `TemplateCollectionModel` 接口， 因此也增强了使用 `list` 指令的附加功能。

##### 模板序列模型功能(TemplateSequenceModel functionality)

对于本地的Java数组和其他所有实现了 `java.util.List` 接口的类的模型包装器，都实现了 `TemplateSequenceModel` 接口， 这样，它们之中的元素就可以使用 `model[i]` 这样的语法通过索引来访问了。 你也可以使用内建函数 `model?size` 来查询数组的长度和列表的大小。

而且，所有的方法都可指定的一个单独的参数，从 `java.lang.Integer`(即`int`, `long`, `float`, `double`，`java.lang.Object`， `java.lang.Number`，`java.lang.Integer`) 中通过反射方法调用，这些类也实现了这个接口。 这就意味着你可以通过很方便的方式来访问被索引的bean属性： `model.foo[i]` 将会翻译为 `obj.getFoo(i)`。

##### 模板方法模型功能(TemplateMethodModel functionality)

一个对象的所有方法作为 `TemplateMethodModelEx` 对象的表述， 它们在对象模型的方法名中使用哈希表的键来访问。当使用 `model.`method`(`arg1`, `arg2`, `...`)` 来调用方法时，形参被作为模板模型传递给方法。 方法首先不会包装它们，后面我们会说到解包的详细内容。 这些不被包装的参数之后被实际方法来调用。以防止方法被重载， 许多特定的方法将会被选择使用相同的规则，也就是Java编译器从一些重载的方法中选择一个方法。 以防止没有方法签名匹配传递的参数，或者没有方法可以被无歧义地选择， 将会抛出 `TemplateModelException` 异常。

返回值类型为 `void` 的方法返回 `TemplateModel.NOTHING`，那么它们就可以使用 `${obj.method(args)}` 形式的语法被安全地调用。

`java.util.Map` 实例的模型仍然实现了 `TemplateMethodModelEx` 接口，作为调用它们 `get()` 方法的一种方式。正如前面所讨论的那样， 你可以使用哈希表功能来访问"get"方法，但是它有一些缺点： 因为第一个属性和方法名会被键名来检查，所以执行过慢； 属性，方法名相冲突的键将会被隐藏；最终这种方法中你只可使用 `String` 类型的键。对比一下，调用 `model(key)` 方法，将直接翻译为 `model.get(key)`：因为没有属性和方法名的查找， 速度会很快；不容易被隐藏；最终对非字符串的键也能正常处理， 因为参数没有被包装，只是被普通的方法调用。实际上， `Map` 中的 `model(key)` 和 `model.get(key)` 是相等的，只是写起来很短罢了。

`java.util.ResourceBundle` 类的模型也实现了 `TemplateMethodModelEx` 接口， 作为一种访问资源和信息格式化的方便形式。对资源包的单参数调用， 将会取回名称和未包装参数的 `toString()` 方法返回值一致的资源。 对资源包的多参数调用的情况和单参数一样，但是它会将参数作为格式化的模式传递给 `java.text.MessageFormat`，在第二个和后面的作为格式化的参数中使用未包装的值。 `MessageFormat` 对象将会使用它们原本的本地化资源包来初始化。

##### 解包规则

当从模板中调用Java方法时，它的参数需要从模板模型转换回Java对象。 假设目标类型(方法常规参数被声明的类型)是用来 `T` 代表的， 下面的规则将会按下述的顺序进行依次尝试：

- 对包装器来说，如果模型是空模型， 就返回Java中的 `null`。

- 如果模型实现了 `AdapterTemplateModel` 接口， 如果它是 `T` 的实例， 或者它是一个数字而且可以使用下面第三点描述的数字强制转换成 `T`， 那么 `model.getAdaptedObject(T)` 的结果会返回。 由BeansWrapper创建的所有方法是AdapterTemplateModel的实现， 所以由BeansWrapper为基本的Java对象创建的展开模型通常不如初始的Java对象。

- 如果模型实现了已经废弃的 `WrapperTemplateModel` 接口， 如果它是 `T` 的实例， 或者它是一个数字而且可以使用下面第二点描述的数字强制转换成 `T` ，那么 `model.getWrappedObject()` 方法的结果会返回。

- 如果 `T` 是 `java.lang.String` 类型， 那么如果模型实现了 `TemplateScalarModel` 接口，它的字符串值将会返回。 请注意，如果模型没有实现接口， 我们不能尝试使用String.valueOf(model)方法自动转换模型到String类型。 这里不得不使用内建函数?string明确地用字符串来处理非标量。

- 如果 `T` 是原始的数字类型或者是可由 `T` 指定的 `java.lang.Number` 类型，还有模型实现了 `TemplateNumberModel` 接口， 如果它是 `T` 的实例或者是它的装箱类型 (如果 `T` 是原始类型)，那么它的数字值会返回。 否则，如果 `T` 是一个Java内建的数字类型 (原始类型或是 `java.lang.Number` 的标准子类， 包括 `BigInteger` 和 `BigDecimal`)， 类型 `T` 的一个新对象或是它的装箱类型会由数字模型的适当强制的值来生成。

- 如果 `T` 是 `boolean` 值或 `java.lang.Boolean` 类型，模型实现了 `TemplateBooleanModel` 接口，那么布尔值将会返回。

- 如果 `T` 是 `java.util.Map` 类型，模型实现了 `TemplateHashModel` 接口， 那么一个哈希表模型的特殊Map表示对象将会返回。

- 如果 `T` 是 `java.util.List` 类型，模型实现了 `TemplateSequenceModel` 接口， 那么一个序列模型的特殊List表示对象将会返回。

- 如果 `T` 是 `java.util.Set` 类型，模型实现了 `TemplateCollectionModel` 接口， 那么集合模型的一个特殊Set表示对象将会返回。

- 如果 `T` 是 `java.util.Collection` 或 `java.lang.Iterable` 类型，模型实现了 `TemplateCollectionModel` 或 `TemplateSequenceModel` 接口， 那么集合或序列模型(各自地)一个特殊的Set或List表示对象将会返回。

- 如果 `T` 是Java数组类型，模型实现了 `TemplateSequenceModel` 接口， 那么一个新的指定类型的数组将会创建， 它其中的元素使用数组的组件类型作为 `T`， 递归展开到数组中。

- 如果 `T` 是 `char` 或 `java.lang.Character` 类型，模型实现了 `TemplateScalarModel` 接口， 它的字符串表示中包含精确的一个字符，那么一个 `java.lang.Character` 类型的值将会返回。

- 如果 `T` 定义的是 `java.util.Date` 类型，模型实现了 `TemplateDateModel` 接口， 而且它的日期值是 `T` 的实例， 那么这个日期值将会返回。

- 如果模型是数字模型，而且它的数字值是 `T` 的实例，那么数字值就会返回。 你可以得到一个实现了自定义接口的 java.lang.Number类型的自定义子类，也许T就是那个接口。(*)

- 如果模型是日期类型，而且它的日期值是 `T` 的实例， 那么日期值将会返回。类似的考虑为(*)

- 如果模型是标量类型，而且 `T` 可以从 `java.lang.String` 类型来定义， 那么字符串值将会返回。 这种情况涵盖T是java.lang.Object, java.lang.Comparable和java.io.Serializable类型。(**)

- 如果模型是布尔类型，而且 `T` 可以从 `java.lang.Boolean` 类型来定义， 那么布尔值将会返回。 和(**)是相同的

- 如果模型是哈希表类型，而且 `T` 可以从 `freemarker.ext.beans.HashAdapter` 类型来定义， 那么一个哈希表适配器将会返回。 和(**)是相同的

- 如果模型是序列类型，而且 `T` 可以从 `freemarker.ext.beans.SequenceAdapter` 类型来定义， 那么一个序列适配器将会返回。 和(**)是相同的

- 如果模型是集合类型，而且 `T` 可以从 `freemarker.ext.beans.SetAdapter` 类型来定义， 那么集合的set适配器将会返回。 和(**)是相同的

- 如果模型是 `T` 的实例，那么模型本身将会返回。 这种情况涵盖方法明确地声明一个 FreeMarker 特定模型接口， 而且允许返回指令，当java.lang.Object被请求时允许返回方法和转换的模型。

- 意味着没有可能转换的异常被抛出。

##### 访问静态方法

从 `BeansWrapper.getStaticModels()` 方法返回的 `TemplateHashModel` 可以用来创建哈希表模型来访问任意类的静态方法和字段。

    BeansWrapper wrapper = BeansWrapper.getDefaultInstance();
    TemplateHashModel staticModels = wrapper.getStaticModels();
    TemplateHashModel fileStatics =
        (TemplateHashModel) staticModels.get("java.io.File");

之后就可以得到模板的哈希表模型，它会暴露所有 `java.lang.System` 类的静态方法和静态字段 (final类型和非final类型)作为哈希表的键。 设想你已经将之前的模型放到根root模型中了：

    root.put("File", fileStatics);

从现在开始，你可以在模板中使用 `${File.SEPARATOR}` 来插入文件分隔符，或者你可以列出所有文件系统中的根元素，通过：

    <#list File.listRoots() as fileSystemRoot>...</#list>

当然，你必须小心这个模型所带来的潜在的安全问题。

你可以给模板作者完全的自由， 不管它们通过将静态方法的哈希表放到模板的根模型中， 来使用哪种类的静态方法，如用如下方式：

    root.put("statics", BeansWrapper.getDefaultInstance().getStaticModels());

如果它被用作是以类名为键的哈希表， 这个对象暴露的只是任意类的静态方法。那么你可以在模板中使用如 `${statics["java.lang.System"].currentTimeMillis()}` 这样的表达式。请注意，这样会有更多的安全隐患，比如， 如果方法暴露级别对 `EXPOSE_ALL` 是很弱的， 那么某些人可以使用这个模型调用 `System.exit()` 方法。

请注意，在上述的示例中，我们通常使用默认的 `BeansWrapper` 实例。这是一个方便使用的静态包装器实例， 你可以在很多情况下使用。特别是你想修改一些属性 (比如模型缓存，安全级别，或者是空模型对象表示)时， 你也可以自由地来创建自己的 `BeansWrapper` 实例， 然后用它们来代替默认包装器。

##### 访问枚举类型

在JRE 1.5版本之后，从方法 `BeansWrapper.getEnumModels()` 返回的 `TemplateHashModel` 可以被用作创建访问枚举类型值的哈希表模型。 (试图在之前JRE中调用这个方法会导致 `UnsupportedOperationException` 异常。)

    BeansWrapper wrapper = BeansWrapper.getDefaultInstance();
    TemplateHashModel enumModels = wrapper.getEnumModels();
    TemplateHashModel roundingModeEnums =
        (TemplateHashModel) enumModels.get("java.math.RoundingMode");

这样你就可以得到模板哈希表模型，它暴露了 `java.math.RoundingMode` 类所有枚举类型的值， 并把它们作为哈希表的键。设想你将之前的模型已经放入root模型中了：

    root.put("RoundingMode", roundingModeEnums);

现在开始，你可以在模板中使用表达式 `RoundingMode.UP` 来引用枚举值 `UP`。

你可以给模板作者完全的自由，不管它们使用哪种枚举类， 将枚举模型的哈希表放到模板的root模型中，可以这样来做：

    root.put("enums", BeansWrapper.getDefaultInstance().getEnumModels());

如果它被用作是类名作为键的哈希表，这个对象暴露了任意的枚举类。 那么可以在模板中使用如 `${enums["java.math.RoundingMode"].UP}` 的表达式。

被暴露的枚举值可以被用作是标量(它们会委派它们的 `toString()` 方法)，也可以用在相同或不同的比较中。

请注意，在上述的例子中，我们通常使用默认的 `BeansWrapper` 实例。这是一个方便使用的静态包装器实例， 你可以在很多情况下使用。特别是你想修改一些属性 (比如模型缓存，安全级别，或者是空模型对象表示)时， 你也可以自由地来创建自己的 `BeansWrapper` 实例， 然后用它们来代替默认包装器。

#### 日志

##### 日志库选择

简而言之，在现代(比如2015年)的应用程序中， 记录日志推荐使用SLF4J API。 要让 FreeMarker 2.3.x. 使用SLF4J，在项目中加入依赖 `org.slf4j:log4j-over-slf4j` 即可， 要确保 `log4j:log4j` 不能存在。(从 FreeMarker 2.4.x 开始，尽管没有什么害处， 但也不再需要 `log4j-over-slf4j` 了。)

如果你对这些细节好奇，或者不能使用SLF4J，那么就继续阅读吧...

FreeMarker 整合了如下的日志包：SLF4J，Apache Commons Logging，Log4J 1.x，Avalon LogKit 和 `java.util.logging`。默认情况下， FreeMarker(在2.3.x版本下)会按如下顺序来查找日志包， 而且会自动使用第一个发现的包：
LOG4J(从2.3.22开始，如果正确安装了`log4j-over-slf4j`，则会使用SLF4J来代替)， Apache Avalon LogKit, `java.util.logging`。 正如你所见，Log4j有最高的优先级。`org.apache.log4j.Logger` 类会检测Log4j的存在，那么也就是说，像`log4j-over-slf4j` 或 `log4j-1.2-api`，Log4j重定向也会有最高优先级。

在 FreeMarker 2.4 版本之前，因为向后兼容性的限制， SLF4J和Apache Commons Logging不会被自动搜索。但是如果你正确安装了 `org.slf4j:log4j-over-slf4j`(也就意味着， 在类路径下没有真实的Log4j，SLF4J有一个像 `logback-classic` 的支持实现)，那么FreeMarker会直接使用SLF4J API来代替Log4j API (从FreeMarker 2.3.22版本开始)。

请注意，应用Log4j2日志有个相似的技巧：如果 `org.apache.logging.log4j:log4j-1.2-api` 可用， FreeMarker 2.3.x会使用它，因为它看起来就像Log4j， 但是所有的消息都会自动到Log4j2中。

如果自动检测没有给出你想要的结果，那么你可以设置系统属性 `org.freemarker.loggerLibrary` 来明确选择 (从2.3.22版本开始)一个日志库，比如：

    java ... -Dorg.freemarker.loggerLibrary=SLF4J

系统属性支持的值有： `SLF4J`， `CommonsLogging`， `JUL` (即 `java.util.logging`)， `Avalon`， `auto` (默认行为)， `none` (关闭日志)。

请注意，为了可靠的运行，系统属性应该在JVM启动时(向上面那样)就该设置好， 而不是在Java代码之后。

推荐使用SLF4J，因为它在 FreeMarker 中运行的更好， 也是因为从 FreeMarker 2.4 版本开始它有自动检测的最高优先级。

##### 日志分类

由FreeMarker产生的所有日志信息会被记录到名称由 `freemarker.`开头的日志记录器中。 现在被使用的记录器是：

日志分类名称 | 目标
--- | ---
`freemarker.beans` | 记录Beans包装器模块的日志信息。
`freemarker.cache` | 记录模板加载和缓存相关的日志信息。
`freemarker.runtime` | 记录在模板执行期间的和特定分类无关的相关信息。 更重要的是，它会记录模板异常并在模板处理期间抛出 (但它却应该在现行的应用程序中禁用；稍后将会解释)。
`freemarker.runtime.attempt` | 记录在模板执行期间抛出的模板异常日志信息， 但是是开启DEBUG严重级别，并由 `attempt`/`recover` 指令捕捉。 请注意，该异常也会被记录到正常的日志记录器中 (比如`freemarker.runtime`)。
`freemarker.servlet` | 记录来自 `FreemarkerServlet` 类的消息。
`freemarker.jsp` | 记录FreeMarker JSP 支持的消息。

FreeMarker 会在模板执行期间使用 `freemarker.runtime` 记录异常，即便异常继续增加，最终由 `Template.process` 或 `Environment.process` 抛出。 (那些都是从应用程序或框架中调用模板时的API调用。) 良好的应用程序会记录它们抛出的异常，极少数情况下是处理它们而不去记录日志。 但是FreeMarker已经记录了异常，那么就会得到比期望的多一条日志记录。 要修复这个问题(从2.3.22版本开始)，可以设置 `log_template_exceptions` (`Configurable.setLogTemplateExceptions(boolean)`) 为 `false`。

#### 在Servlet中使用FreeMarker

作为基础了解，在web应用程序范畴内使用 FreeMarker 和其它并没有什么不同； FreeMarker将它的输出写入传递给 `Template.process` 方法的 `Writer` 对象，它不关心 `Writer` 将输出写入控制台，文件或是 `HttpServletResponse` 的输出流。 FreeMarker 并不知道什么是servlet和web；它仅仅是使用模板文件来合并Java对象， 之后从它们中间生成输出文本。从这里可知，如何创建一个Web应用程序都随你的习惯来。

但是，你可能想在已经存在的Web应用框架中使用FreeMarker。 许多框架都是基于"Model 2"架构的，JSP页面来控制显示。 如果你使用了这样的框架(比如Apache Struts)， 那么可以继续阅读本文。对于其他框架请参考它们的文档。

##### 在"Model 2"中使用FreeMarker

许多框架依照HTTP请求转发给用户自定义的"action"类， 将数据作为属性放在 `ServletContext`， `HttpSession` 和 `HttpServletRequest` 对象中， 之后请求被框架派发到一个JSP页面中(视图层)，使用属性传递过来的数据来生成HTML页面， 这样的策略通常就是所指的Model 2模型。

使用这样的框架，你就可以非常容易地用FTL文件来代替JSP文件。 但是，因为你的Servlet容器(Web应用程序服务器)，不像JSP文件， 它可能并不知道如何处理FTL文件，那么就需要对Web应用程序进行一些额外的配置：

1. 复制 `freemarker.jar` (从FreeMarker发布包的`lib`目录中) 到Web应用程序的 `WEB-INF/lib` 目录下。

2. 将下面的部分添加到Web应用程序的 `WEB-INF/web.xml` 文件中 (调整部分内容是否需要)：

    <servlet>
      <servlet-name>freemarker</servlet-name>
      <servlet-class>freemarker.ext.servlet.FreemarkerServlet</servlet-class>

      <!-- FreemarkerServlet settings: -->
      <init-param>
        <param-name>TemplatePath</param-name>
        <param-value>/</param-value>
      </init-param>
      <init-param>
        <param-name>NoCache</param-name>
        <param-value>true</param-value>
      </init-param>
      <init-param>
        <param-name>ContentType</param-name>
        <param-value>text/html; charset=UTF-8</param-value> <!-- Forces UTF-8 output encoding! -->
      </init-param>

      <!-- FreeMarker settings: -->
      <init-param>
        <param-name>incompatible_improvements</param-name>
        <param-value>2.3.22</param-value>
        <!-- Recommended to set to a high value. For the details, see the Java API docs of
             freemarker.template.Configuration#Configuration(Version). -->
      </init-param>
      <init-param>
        <param-name>template_exception_handler</param-name>
        <!-- Use "html_debug" instead during development! -->
        <param-value>rethrow</param-value>
      </init-param>
      <init-param>
        <param-name>template_update_delay</param-name>
        <!-- ATTENTION, 0 is for development only! Use higher value otherwise. -->
        <param-value>0</param-value>
      </init-param>
      <init-param>
        <param-name>default_encoding</param-name>
        <!-- The encoding of the template files. -->
        <param-value>UTF-8</param-value>
      </init-param>
      <init-param>
        <param-name>locale</param-name>
        <!-- Influences number and date/time formatting, etc. -->
        <param-value>en_US</param-value>
      </init-param>
      <init-param>
        <param-name>number_format</param-name>
        <param-value>0.##########</param-value>
      </init-param>

      <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
      <servlet-name>freemarker</servlet-name>
      <url-pattern>*.ftl</url-pattern>
    </servlet-mapping>

    ...

    <!--
      Prevent the visiting of MVC Views from outside the servlet container.
      RequestDispatcher.forward/include should, and will still work.
      Removing this may open security holes!
    -->
    <security-constraint>
      <web-resource-collection>
        <web-resource-name>FreeMarker MVC Views</web-resource-name>
        <url-pattern>*.ftl</url-pattern>
      </web-resource-collection>
      <auth-constraint>
        <!-- Nobody is allowed to visit these directly. -->
      </auth-constraint>
    </security-constraint>

在这之后，你可以像使用JSP(`*.jsp`) 文件那样使用FTL文件(`*.ftl`)了。 (当然你可以选择除 `ftl` 之外的扩展名；这只是惯例)

它是怎么工作的？让我们先来看看JSP是怎么工作的。 许多servlet容器处理JSP时使用一个映射为 `*.jsp` 的servlet请求URL格式。这样servlet就会接收所有URL是以 `.jsp` 结尾的请求，查找请求URL地址中的JSP文件， 内部编译后生成 `Servlet`，然后调用生成好的serlvet来生成页面。 这里为URL类型是 `*.ftl` 映射的 `FreemarkerServlet` 也是相同功能，只是FTL文件不会编译成 `Servlet`，而是给 `Template` 对象， 之后 `Template` 对象的 `process` 方法就会被调用来生成页面。

比如，代替这个JSP页面 (注意它使用了Struts标签库来保存设计，而不是嵌入可怕的Java代码)：

    <%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
    <%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %>

    <html>
    <head><title>Acmee Products International</title>
    <body>
      <h1>Hello <bean:write name="user"/>!</h1>
      <p>These are our latest offers:
      <ul>
        <logic:iterate name="latestProducts" id="prod">
          <li><bean:write name="prod" property="name"/>
            for <bean:write name="prod" property="price"/> Credits.
        </logic:iterate>
      </ul>
    </body>
    </html>

你可以使用这个FTL文件(使用 `ftl` 扩展名而不是 `jsp`)：

    <html>
    <head><title>Acmee Products International</title>
    <body>
      <h1>Hello ${user}!</h1>
      <p>These are our latest offers:
      <ul>
        <#list latestProducts as prod>
          <li>${prod.name} for ${prod.price} Credits.
        </#list>
      </ul>
    </body>
    </html>

在 FreeMarker 中，`<html:form action="/query">`...`</html:form>` 仅仅被视为是静态文本，所以它会按照原本输出出来了，就像其他XML或HTML标记一样。 JSP标签也仅仅是FreeMarker的指令，没有什么特殊之处，所以你可以 使用FreeMarker语法 形式来调用它们，而不是JSP语法： `<@html.form action="/query">`...`</@html.form>`。 注意在FreeMarker语法中 不能像JSP那样在参数中使用 `${`...`}`， 而且不能给参数值加引号。 所以这样是错误的：

    <#-- WRONG: -->
    <@my.jspTag color="${aVariable}" name="aStringLiteral"
                width="100" height=${a+b} />

但下面这样是正确的：

    <#-- Good: -->
    <@my.jspTag color=aVariable name="aStringLiteral"
                width=100 height=a+b />

在这两个模板中，当你要引用 `user` 和 `latestProduct` 时，首先它会尝试去查找已经在模板中创建的同名变量 (比如 `prod`；如果你使用JSP：这是一个page范围内的属性)。 如果那样做不行，它会尝试在 `HttpServletRequest` 对象中查找那个名字的属性， 如果没有找到就在 `HttpSession` 中找，如果还没有找到那就在 `ServletContext` 中找。FTL按这种情况工作是因为 `FreemarkerServlet` 创建数据模型由上面提到的3个对象中的属性而来。 那也就是说，这种情况下根哈希表root不是 `java.util.Map` (正如本手册中的一些例子那样)，而是 `ServletContext`+`HttpSession`+`HttpServletRequest` ；FreeMarker 在处理数据模型类型的时候非常灵活。所以如果你想将变量 `"name"` 放到数据模型中，那么你可以调用 `servletRequest.setAttribute("name", "Fred")`；这是模型2的逻辑， 而 FreeMarker 将会适应它。

`FreemarkerServlet` 也会在数据模型中放置3个哈希表， 这样你就可以直接访问3个对象中的属性了。这些哈希表变量是：`Request`， `Session`，`Application` (和`ServletContext`对应)。它还会暴露另外一个名为 `RequestParameters` 的哈希表，这个哈希表提供访问HTTP请求中的参数。

`FreemarkerServlet` 也有很多初始参数。 它可以被设置从任意路径来加载模板，从类路径下，或相对于Web应用程序的目录。 你可以设置模板使用的字符集。你还可以设置想使用的对象包装器等等。

通过子类别，`FreemarkerServlet` 易于定制特殊需要。 那就是说，如果你需要对所有模板添加一个额外的可用变量，使用servlet的子类， 覆盖 `preTemplateProcess()` 方法，在模板被执行前， 将你需要的额外数据放到模型中。或者在servlet的子类中，在 `Configuration` 中设置这些全局的变量作为 共享变量。

要获取更多信息，可以阅读该类的Java API文档。

##### 包含其它Web应用程序资源中的内容

你可以使用由 `FreemarkerServlet` (2.3.15版本之后) 提供的客户化标签`<@include_page path="..."/>` 来包含另一个Web应用资源的内容到输出内容中；这对于整合JSP页面 (在同一Web服务器中生活在FreeMarker模板旁边) 的输出到FreeMarker模板的输出中非常有用。使用：

    <@include_page path="path/to/some.jsp"/>

和在JSP中使用该标签是相同的：

    <jsp:include page="path/to/some.jsp">

`<@include_page ...>` 不能和 `<#include ...>`搞混， 后者是为了包含FreeMarker模板而不会牵涉到Servlet容器。 使用 `<#include ...>` 包含的模板和包含它的模板共享模板处理状态， 比如数据模型和模板语言变量，而 `<@include_page ...>` 开始一个独立的HTTP请求处理。

一些Web应用框架为此提供它们自己的解决方案， 这种情况下你就可以使用它们来替代。 而一些Web应用框架不使用 `FreemarkerServlet`， 所以 `include_page` 是不可用的。

路径可以是相对的，也可以是绝对的。相对路径被解释成相对于当前HTTP请求 (一个可以触发模板执行的请求)的URL，而绝对路径在当前的servlet上下文 (当前的Web应用)中是绝对的。你不能从当前Web应用的外部包含页面。 注意你可以包含任意页面，而不仅仅是JSP页面； 我们仅仅使用以 `.jsp` 结尾的页面作为说明。

除了参数 `path` 之外，你也可以用布尔值 (当不指定时默认是true)指定一个名为 `inherit_params` 可选的参数来指定被包含的页面对当前的请求是否可见HTTP请求中的参数。

最后，你可以指定一个名为 `params` 的可选参数， 来指定被包含页面可见的新请求参数。如果也传递继承的参数， 那么指定参数的值将会得到前缀名称相同的继承参数的值。`params` 的值必须是一个哈希表类型，它其中的每个值可以是字符串， 或者是字符串序列(如果你需要多值参数)。这里给出一个完整的示例：

    <@include_page path="path/to/some.jsp" inherit_params=true params={"foo": "99", "bar": ["a", "b"]}/>

这会包含 `path/to/some.jsp` 页面， 传递它的所有的当前请求的参数，除了"foo"和"bar"， 这两个会被分别设置为"99"和多值序列"a"，"b"。 如果原来请求中已经有这些参数的值了，那么新值会添加到原来存在的值中。 那就是说，如果"foo"有值"111"和"123"，那么现在它会有"99"，"111"，"123"。

事实上使用 `params` 给参数传递非字符串值是可能的。这样的一个值首先会被转换为适合的Java对象 (数字，布尔值，日期等)，之后调用它们Java对象的 `toString()` 方法来得到字符串值。最好不要依赖这种机制，作为替代， 明确参数值在模板级别不能转换成字符串类型之后， 在使用到它的地方可以使用内建函数 `?string` 和 `?c`。

##### 在FTL中使用自定义JSP标签

`FreemarkerServlet` 将一个哈希表类型的 `JspTaglibs` 放到数据模型中，就可以使用它来访问JSP标签库了。 自定义JSP标签库将被视为普通用户自定义指令来访问，自定义EL函数 (从 FreeMarker 2.3.22 版本开始)视为方法。例如，这个JSP文件：

    <%@ page contentType="text/html;charset=ISO-8859-2" language="java"%>
    <%@ taglib prefix="e" uri="/WEB-INF/example.tld" %>
    <%@ taglib prefix="oe" uri="/WEB-INF/other-example.tld" %>
    <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
    <%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>

    <%-- Custom JSP tags and functions: --%>

    <e:someTag numParam="123" boolParam="true" strParam="Example" anotherParam="${someVar}">
      ...
    </e:someTag>

    <oe:otherTag />

    ${e:someELFunction(1, 2)}

    <%-- JSTL: --%>

    <c:if test="${foo}">
      Do this
    </c:if>

    <c:choose>
      <c:when test="${x == 1}">
          Do this
      </c:when>
      <c:otherwise>
          Do that
      </c:otherwise>
    </c:choose>

    <c:forEach var="person" items="${persons}">
      ${person.name}
    </c:forEach>

    ${fn:trim(bar)}

基本一致的FTL是：

    <#assign e=JspTaglibs["/WEB-INF/example.tld"]>
    <#assign oe=JspTaglibs["/WEB-INF/other-example.tld"]>

    <#-- Custom JSP tags and functions: --#>

    <@e.someTag numParam=123 boolParam=true strParam="Example" anotherParam=someVar>
      ...
    </@e.someTag>

    <@oe.otherTag />

    ${e.someELFunction(1, 2)}

    <#-- JSTL - Instead, use native FTL constructs: -->

    <#if foo>
      Do this
    </#if>

    <#if x == 1>
      Do this
    <#else>
      Do that
    </#if>

    <#list persons as person>
      ${person.name}
    </#list>

    ${bar?trim}

参数值没有使用引号，而且 `"${`...`}"` 和JSP中使用的一样。 后面会详细解释。

`JspTaglibs` 不是 FreeMarker 的核心特性； 它只存在于通过 `FreemarkerServlet` 调用的模板。 这是因为JSP 标签/函数 假定一个servlet环境(FreeMarker不会)， 加上一些Servlet概念被模仿成 `FreemarkerServlet` 创建的特定Freemarker数据模型。很多现代开发框架以纯净的方式使用FreeMarker， 而不是通过 `FreemarkerServlet`。

因为自定义JSP标签是在JSP环境中来书写操作的，它们假设变量 (在JSP中常被指代"beans")被存储在4个范围中：page范围，request范围， session范围和application范围。FTL没有这样的表示法(4种范围)，但是 `FreemarkerServlet`给自定义标签提供仿真的环境， 这样就可以维持JSP范围中的"beans"和FTL变量之间的对应关系。 对于自定义的JSP标签，请求request，会话session和应用application是和真实JSP相同的： `javax.servlet.ServletContext`，`HttpSession` 和 `ServletRequest` 对象中的属性。从FTL的角度来看， 这三种范围都在数据模型中，这点前面已经解释了。page范围和FTL全局变量(参见`global`指令)是对应的。 那也就是，如果你使用 `global` 指令创建一个变量，通过仿真的JSP环境， 它会作为page范围变量对自定义标签可见。而且，如果一个JSP标签创建了一个新的page范围变量， 那么结果和用 `global` 指令创建的是相同的。 要注意在数据模型中的变量作为page范围的属性对JSP标签是不可见的，尽管它们在全局是可见的， 因为数据模型和请求，会话，应用范围是对应的，而不是page范围。

在JSP页面中，你可以对所有属性值加引号，这和参数类型是字符串， 布尔值或数字没有关系。但是因为在FTL模板中自定义标签可以被用户自定义FTL指令访问到， 你将不得不在自定义标签中使用FTL语法规则，而不是JSP语法。所以当你指定一个"属性"的值时， 那么在 `=` 的右边是一个 FTL 表达式。因此， 你不能对布尔值和数字值的参数加引号 (比如：`<@tiles.insert page="/layout.ftl" flush=true/>`)， 否则它们将被解释为字符串值，当FreeMarker试图传递值到期望非字符串值的自定义标记中时， 这就会引起类型不匹配错误。而且还要注意，这很自然，你可以使用任意FTL表达式作为属性的值， 比如变量，计算的结果值等。(比如：`<@tiles.insert page=layoutName flush=foo && bar/>`)

Servlet容器运行过程中，因为它实现了自身的轻量级JSP运行时环境， 它用到JSP标签库，而 FreeMarker 并不依赖于JSP支持。这是一个很小但值得注意的地方： 在它们的TLD文件中，开启 FreeMarker 的JSP运行时环境来分发事件到JSP标签库中注册时间监听器， 你应该将下面的内容添加到Web应用下的 `WEB-INF/web.xml` 文件中：

    <listener>
      <listener-class>freemarker.ext.jsp.EventForwarding</listener-class>
    </listener>

请注意，尽管servlet容器没有本地的JSP支持，你也可以在 FreeMarker 中使用JSP标签库。 只是确保对JSP 1.2版本(或更新)的 `javax.servlet.jsp.*` 包在Web应用程序中可用就行。如果你的servlet容器只对JSP 1.1支持， 那么你不得不将下面六个类(比如你可以从Tomcat 5.x或Tomcat 4.x的jar包中提取)复制到Web应用的 `WEB-INF/classes/`...``目录下： `javax.servlet.jsp.tagext.IterationTag`， `javax.servlet.jsp.tagext.TryCatchFinally`， `javax.servlet.ServletContextListener`， `javax.servlet.ServletContextAttributeListener`， `javax.servlet.http.HttpSessionAttributeListener`， `javax.servlet.http.HttpSessionListener`。但是要注意， 因为容器只支持JSP 1.1，通常是使用较早的Servlet 2.3之前的版本， 事件监听器可能就不支持，因此JSP 1.2标签库来注册事件监听器会正常工作。

在撰写本文档时，JSP已经升级到2.1了，许多特性也已经实现了， 除了JSP 2(也就是说JSP自定义标记在JSP语言中实现了)的"标签文件"特性。 标签文件需要被编译成Java类文件，在 FreeMarker 下才会有用。

`JspTaglibs[`uri`]` 会去找到URI指定的TLD，就像JSP的 `@taglib` 指令所做的。 它实现了JSP规范中所描述的TLD发现机制。这里可以阅读更多，但简而言之， 它会在 `WEB-INF/web.xml` `taglib` 元素中， 在 `WEB-INF/**/*.tld` 文件中，还有 `WEB-INF/lib/*.{jar,zip}/META-INF/**/*.tld` 文件中寻找TLD。 此外，当设置了 `FreemarkerServlet` 的初始化参数(从 2.3.22版本开始) `MetaInfTldSources` 和/或 `ClasspathTlds`， 即便是在WAR结构之外，它也会发现对于类加载器可见的TLD。参考 `FreemarkerServlet` 的Java API文档来获取更多描述。 它也可以从Java系统属性中来设置，当你想在Eclipse运行配置中来修改而不去修改 `web.xml`时，就可以随手完成；再强调一点，请参考 `FreemarkerServlet` API 文档。 `FreemarkerServlet` 也会识别 `org.eclipse.jetty.server.webapp.ContainerIncludeJarPattern` servlet 上下文属性，并且将它中间的配置项添加到 `MetaInfTldSources`。

##### 在JSP页面中嵌入FTL

有一个标签库允许你将FTL片段放到JSP页面中。 嵌入的FTL片段可以访问JSP 的4种范围内的属性(Beans)。 你可以在 FreeMarker 发布包中找到一个可用的示例和这个标签库。

#### 为FreeMarker配置安全策略

当 FreeMarker 运行在装有安全管理器的Java虚拟机中时， 你不得不再授与一些权限，确保运行良好。最值得注意的是， 你需要为对 `freemarker.jar` 的安全策略文件添加这些条目：

    grant codeBase "file:/path/to/freemarker.jar"
    {
      permission java.util.PropertyPermission "file.encoding", "read";
      permission java.util.PropertyPermission "freemarker.*", "read";
    }

另外，如果从一个目录中加载模板， 你还需要给 FreeMarker 授权来从那个目录下读取文件， 使用如下的授权：

    grant codeBase "file:/path/to/freemarker.jar"
    {
      ...
      permission java.io.FilePermission "/path/to/templates/-", "read";
    }

最终，如果你使用默认的模板加载机制，也就是从当前文件夹下加载模板， 那么需要指定这些授权内容：(请注意，表达式 `${user.dir}` 将会在运行时被策略解释器处理，几乎它就是一个 FreeMarker 模板)

    grant codeBase "file:/path/to/freemarker.jar"
    {
      ...
      permission java.util.PropertyPermission "user.dir", "read";
      permission java.io.FilePermission "${user.dir}/-", "read";
    }

很自然地，如果你在Windows下运行， 使用两个反斜杠来代替一个斜杠来分隔路径中的目录间隔。

#### 遗留的XML包装实现

遗留的XML包装已经废弃了。 FreeMarker 2.3 已经引入了对新的XML处理模型的支持。要支持它， 新的XML包装包已经引入了，就是 `freemarker.ext.dom`。 对于新用法，我们鼓励你使用。它会在xgui中来说明。

`freemarker.ext.xml.NodeListModel` 类提供了来包装XML文档展示为结点树模板模型。 每个结点列表可以包含零个或多个XML结点 (文档类型，元素类型，文本类型，处理指令，注释，实体引用，CDATA段等)。 结点列表实现了下面模板的语义模型接口：

##### 模板标量模型(TemplateScalarModel)

当使用一个标量时，结点列表将会呈现XML片段，表示其包含的结点。 这使得使用XML到XML转换模板很方便。

##### 模板集合模型(TemplateCollectionModel)

当用 `list` 指令来使用一个集合时， 它会简单枚举它的结点。每个结点将会被当作一个新的单一结点组的结点列表返回。

##### 模板序列模型(TemplateSequenceModel)

当被用作是序列时，它会返回第i个结点作为一个新的结点列表， 包含单独的被请求的结点。也就是说，要返回 `<book>` 元素的第三个 `<chapter>` 元素，你可以使用下面的代码 (结点索引是从零开始的)：

    <#assign thirdChapter = xmldoc.book.chapter[2]>

##### 模板哈希表模型(TemplateHashModel)

当被用作是哈希表时，它基本上是用来遍历子结点。也就是说， 如果你有个名为 `book` 的结点列表， 并包装了一个有很多chapter的元素结点，那么 `book.chapter` 将会产生一个book元素的所有chapter元素的结点列表。@符号常被用来指代属性： `book.@title` 产生一个有单独属性的结点列表， 也就是book元素的title属性。

意识到下面这样的结果是很重要的，比如，如果 `book` 没有 `chapter`-s，那么 `book.chapter` 就是一个空序列，所以 `xmldoc.book.chapter??` 就 不会 是 `false`，它会一直是 `true`！相似地， `xmldoc.book.somethingTotallyNonsense??` 也不会是`false`。为了检查是否发现子结点，可以使用 `xmldoc.book.chapter?size == 0`。

哈希表定义了一些"魔力键"。所有的这些键以下划线开头。 最值得注意的是`_text`，可以得到结点的文本内容： `${book.@title._text}` 将会给模板交出属性的值。 相似地，`_name`将会取得元素或属性的名字。 `*` 或 `_allChildren` 返回所有结点列表元素中的直接子元素，而 `@*` 或 `_allAttributes` 返回结点列表中元素的所有属性。 还有很多这样的键；下面给出哈希表键的详细总结：

键名 | 结果为
--- | ---
`*` 或 `_children` | 所有当前结点(非递归)的直接子元素。适用于元素和文档结点。
`@*` 或 `_attributes` | 当前结点的所有属性。仅适用于元素。
`@`attributeName`` | 当前结点的命名属性。适用于元素，声明和处理指令。 在声明中它支持属性 `publicId`，`systemId` 和 `elementName`。在处理指令中，它支持属性 `target` 和 `data`，还有数据中以 `name="value"` 对出现的其他属性名。 对于声明和处理指令的属性结点是合成的，因此它们没有父结点。 要注意，`@*` 不能在声明或处理指令上进行操作。
`_ancestor` | 当前结点的所有祖先，直到根元素(递归)。 适用于类型和 `_parent` 相同的结点类型。
`_ancestorOrSelf` | 当前结点和它的所有祖先结点。 适用于和 `_parent` 相同的结点类型。
`_cname` | 当前结点(命名空间URI+本地名称)的标准名称， 每个结点(非递归)一个字符串值。适用于元素和属性。
`_content` | 当前结点的全部内容，包括子元素，文本， 实体引用和处理指令(非递归)。适用于元素和文档。
`_descendant` | 当前结点的所有递归的子孙元素。适用于文档和元素结点。
`_descendantOrSelf` | 当前结点和它的所有递归的子孙元素。适用于文档和元素结点。
`_document` | 当前结点所属的所有文档类型。适用于所有除文本的结点。
`_doctype` | 当前结点的声明。仅仅适用于文档类型结点。
`_filterType` | 这是一种按类型过滤的模板方法模型。当被调用时， 它会产生一个结点列表，仅仅包含它们当前结点， 这些结点的类型和传递给它们参数的一种类型相匹配。 你应该传递任意数量的字符串给这个方法， 其中包含来保持类型的名字。合法的类型名称是："attribute"， "cdata"，"comment"，"document"，"documentType"， "element"，"entity"，"entityReference"， "processingInstruction"，"text"。
`_name` | 当前结点的名称。每个结点(非递归)一个字符串值。 适用于元素和属性(返回它们的本地名称)，实体， 处理指令(返回它的目标)，声明(返回它的public ID)。
`_nsprefix` | 当前结点的命名空间前缀，每个结点(非递归)一个字符串值。 适用于元素和属性。
`_nsuri` | 当前结点的命名空间URI，每个结点(非递归)一个字符串值。 适用于元素和属性。
`_parent` | 当前结点的父结点。适用于元素，属性，注释，实体，处理指令。
`_qname` | 当前结点在 `[namespacePrefix:]localName` 形式的限定名，每个结点(非递归)一个字符串值。适用于元素和属性。
`_registerNamespace(prefix, uri)` | 注册一个对当前结点列表和从当前结点列表派生出的所有结点列表有指定前缀和URI的XML命名空间。 注册之后，你可以使用`nodelist["prefix:localname"]` 或 `nodelist["@prefix:localname"]` 语法来访问元素和属性， 它们的名字是命名空间范围内的。 注意命名空间的前缀需要不能和当前XML文档它自己使用的前缀相匹配， 因为命名空间纯粹是由URI来比较的。
`_text` | 当前结点的文本内容，每个结点(非递归)一个字符串值。 适用于元素，属性，注释，处理指令(返回它的数据)和CDATA段。 保留的XML字符('<'和'&')不能被转义。
`_type` | 返回描述结点类型的结点列表，每个结点包含一个字符串值。 可能的结点名称是：合法的结点名称是："attribute"，"cdata"，"comment"， "document"，"documentType"，"element"，"entity"，"entityReference"， "processingInstruction"，"text"。如果结点类型是未知的，就返回"unknown"。
`_unique` | 当前结点的一个拷贝，仅仅保留每个结点第一次的出现，消除重复。 重复可以通过应用对树的向上遍历出现在结点列表中，如`_parent`， `_ancestor`，`_ancestorOrSelf` 和 `_document`，也就是说，`foo._children._parent` 会返回一个结点列表，它包含foo中重复的结点，每个结点会包含出现的次数， 和它子结点数目相等。这些情况下，使用 `foo._children._parent._unique` 来消除重复。适用于所有结点类型。
其它键 | 当前结点的子元素的名称和键相匹配。这允许以 `book.chapter.title` 这种风格语法进行方便的子元素遍历。 请注意，在技术上 `nodeset.childname` 和 `nodeset("childname")` 相同，但是两者写法都很短， 处理也很迅速。适用于文档和元素结点。

##### 模板方法模型(TemplateMethodModel)

当被用作方法模型，它返回一个结点列表， 这个列表是处理结点列表中当前内容的XPath表达式的结果。 为了使这种特性能够工作，你必须将 `Jaxen` 类库放到类路径下。比如：

    <#assign firstChapter=xmldoc("//chapter[first()]")>

##### 命名空间处理

为了遍历有命名空间范围内名称的子元素这个目的， 你可以使用结点列表注册命名空间前缀。 你可以在Java代码中来做，调用：

    public void registerNamespace(String prefix, String uri);

方法，或者在模板中使用

    ${nodelist._registerNamespace(prefix, uri)}

语法。从那里开始， 你可以在命名空间通过特定的URI来标记引用子元素，用这种语法

    nodelist["prefix:localName"]

和

    nodelist["@prefix:localName"]

和在 XPath 表达式中使用这些命名空间前缀一样。 命名空间使用一个结点列表来注册并传播到所有结点列表， 这些结点列表来自于原来的结点列表。要注意命名空间只可使用URI来进行匹配， 所以你可以在你的模板中安全地使用命名空间的前缀，这和在实际XML中的不同， 在模板和XML文档中，一个前缀只是一个对URI的本地别名。

#### 和Ant一起使用FreeMarker

我们现在知道有两种"FreeMarker Ant tasks"：

- `FreemarkerXmlTask`：它来自于FreeMarker的发布包， 打包到 `freemarker.jar` 中。 这是使用FreeMarker模板转换XML文档的轻量级的，易于使用的Ant任务。 它的入口源文件(输入文件)是XML文件，和生成的输出文件对应， 这是通过单独模板实现的。也就是说，对于每个XML文件， 模板会被执行(在数据模型中的XML文档)， 模板的输出会被写入到一个和原XML文件名相似名称的文件中。 因此，模板文件扮演了一个和XSLT样式表相似的角色，但它是FTL，而不是XSLT。

- FMPP：这是一个重量级的，以很少的XML为中心， 第三方Ant任务(和独立的命令行工具)。 它主要的目的是用作为模板文件的源文件(输入文件)生成它们自己对应的输出文件， 但它也对以XML为源文件的 `FreemarkerXmlTask` 进行支持。 而且，相比于`FreemarkerXmlTask`，它还有额外的特性。 那么它的缺点是什么？它太复杂太一般化了，不容易掌握和使用。

这一部分介绍了 `FreemarkerXmlTask`， 要了解FMPP更多的信息，可以访问它的主页：http://fmpp.sourceforge.net/。

为了使用 `FreemarkerXmlTask`， 首先必须在你的Ant构建文件中定义 `freemarker.ext.ant.FreemarkerXmlTask`，然后调用任务。 假设你想使用假定的"xml2html.ftl"模板转换一些XML文档到HTML， XML文档在目录"xml"中而HTML文档生成到目录"html"中，你应该这样来写：

    <taskdef name="freemarker" classname="freemarker.ext.ant.FreemarkerXmlTask">
      <classpath>
        <pathelement location="freemarker.jar" />
      </classpath>
    </taskdef>
    <mkdir dir="html" />
    <freemarker basedir="xml" destdir="html" includes="**/*.xml" template="xml2html.ftl" />

这个任务将会对每个XML文档调用模板。每个文档将会被解析成DOM树， 然后包装成FreeMarker结点变量。当模板开始执行时， 特殊变量 `.node` 被设置成XML文档结点的根root。

请注意，如果你正使用遗留的(FreeMarker 2.2.x 和以前版本)XML适配器实现， 也同样可以进行，而且XML树的根结点被放置在数据模型中， 作为变量 `document`。它包含了遗留的 `freemarker.ext.xml.NodeListModel` 类的实例。

请注意，所有通过构建文件定义的属性将会作为名为"properties"的哈希表模型来用。 一些其他方法也会可用；对模板中什么样的可用变量的详细描述， 还有什么样的属性可以被任务接受，参见 `freemarker.ext.ant.FreemarkerXmlTask` 的JavaDoc文档。

#### Jython包装器

`freemarker.ext.jython` 包包含了启用任意Jython对象的模型， 并被用作是`TemplateModel`。在一个基础的示例中， 你可以使用如下调用：

    public TemplateModel wrap(Object obj);

`freemarker.ext.jython.JythonWrapper` 类的方法。 这个方法会包装传递的对象，包装成合适的 `TemplateModel`。 下面是一个对返回对象包装器的属性的总结。为了下面的讨论， 我们假设在模板模型根中，对对象 `obj` 调用 `JythonWrapper` 后模型名为 `model`。

##### 模板哈希表模型功能(TemplateHashModel functionality)

`PyDictionary` 和 `PyStringMap` 将会被包装成一个哈希表模型。 键的查找映射到 `__finditem__` 方法；如果一个项没有被找到， 那么就返回一个为 `None` 的模型。

##### 模板标量模型功能(TemplateScalarModel functionality)

每一个python对象会实现 `TemplateScalarModel` 接口， 其中的 `getAsString()` 方法会委派给 `toString()` 方法。

##### 模板布尔值模型功能(TemplateBooleanModel functionality)

每一个python对象会实现 `TemplateBooleanModel` 接口， 其中的 `getAsBoolean()` 方法会指派给 `__nonzero__()` 方法， 符合Python语义的true/false。

##### 模板数字模型功能(TemplateNumberModel functionality)

对`PyInteger`，`PyLong` 和 `PyFloat` 对象的模型包装器实现了 `TemplateNumberModel` 接口，其中的 `getAsNumber()` 方法返回 `__tojava__(java.lang.Number.class)`。

##### 模板序列模型功能(TemplateSequenceModel functionality)

对所有扩展了 `PySequence` 的类的模型包装器会实现 `TemplateSequenceModel` 接口， 因此它们中的元素可以通过使用 `model[i]` 语法形式的序列来访问， 这会指派给`__finditem__(i)`。你也可以使用内建函数 `model?size` 查询数组的长度或者list的大小， 它会指派给 `__len__()`。

## 模板语言参考

### 内建函数参考

#### 字母顺序索引

在 FreeMarker 2.3.23 中，指令名可以使用驼峰样式来代替蛇形样式， 比如 `startsWith` 代替 `starts_with`。 但是要知道，在相同模版内，FreeMarker 会强制对模板语言部分的所有标识符使用驼峰样式 (用户自定义名称不会受影响)。

- abs

- ancestors

- api

- boolean

- byte

- c for strings, for booleans

- cap_first

- capitalize

- ceiling

- children

- chop_linebreak

- chunk

- contains

- counter

- date for dates, for strings

- date_if_unknown

- datetime for dates, for strings

- datetime_if_unknown

- double

- ends_with

- ensure_ends_with

- ensure_starts_with

- eval

- first

- floor

- groups

- float

- has_api

- has_content

- has_next

- html

- index

- index_of

- int

- interpret

- item_cycle

- item_parity

- item_parity_cap

- is_even_item

- is_first

- is_infinite

- is_last

- is_nan

- is_odd_item

- is_`type`

- iso, iso_...

- j_string

- join

- js_string

- keep_after

- keep_after_last

- keep_before

- keep_before_last

- keys

- last

- last_index_of

- left_pad

- length

- long

- lower_abc

- lower_case

- matches

- namespace

- new

- node_namespace

- node_name

- node_type

- number

- number_to_date, number_to_datetime, number_to_time

- parent

- replace

- remove_beginning

- remove_ending

- reverse

- right_pad

- round

- root

- rtf

- short

- size

- sort

- seq_contains

- seq_index_of

- seq_last_index_of

- sort_by

- split

- starts_with

- string: for strings, for numbers, for booleans, for date/time/date-time

- substring (deprecated)

- switch

- then

- time for date/time/date-time, for strings

- time_if_unknown

- trim

- uncap_first

- upper_abc

- upper_case

- url

- values

- word_list

- xhtml

- xml

点击 这里 参考按照表达式左侧值类型分类的内建函数。

如果在这里没有发现模板中的内建函数，那么可能会在这里找到：ref_deprecated

#### 字符串内建函数

这些内建函数作用于表达式左侧的字符串值。 如果左侧值是数字或日期/时间/日期-时间或布尔类型(从 2.3.20 版本开始)， 根据当前的number-, date/time/date-time- 和 boolean-format设置， 那么它会自动被转成字符串值(当使用`${`...`}` 插入这些值时，应用的都是一样的格式程序)。

##### boolean

字符串转为布尔值。字符串必须是 `true` 或 `false` (大小写敏感！)，或者必须是由 `boolean_format` 设置的特定格式。

如果字符串不是适当的格式，那么当访问该内建函数时， 就会发成错误终止模板处理。

##### cap_first

字符串中的首单词的首字母大写。 关于"单词"的准确意义，可以参考 word_list 内建函数。 例如：

    ${"  green mouse"?cap_first}
    ${"GreEN mouse"?cap_first}
    ${"- green mouse"?cap_first}

将会输出：

      Green mouse
    GreEN mouse
    - green mouse

In the case of `"- green mouse"`, the first word is the `-`.

##### capitalize

字符串中所有单词的首字母大写。 关于"单词"的准确意义，可以参考 word_list 内建函数。例如：

    ${"  green  mouse"?capitalize}
    ${"GreEN mouse"?capitalize}

将会输出：

      Green Mouse
    Green Mouse

##### chop_linebreak

在末尾没有 换行符 的字符串， 那么可以换行，否则不改变字符串。

##### contains

这个内建函数从 FreeMarker 2.3.1 版本开始可用。 在2.3版本中是没有的。

如果函数中的参数指定的子串出现在源字符串中， 那么返回true。比如：

    <#if "piceous"?contains("ice")>It contains "ice"</#if>

将会输出

    It contains "ice"

##### date, time, datetime

字符串转换成日期值，时间或日期-时间值。需要一个由 `date_format`， `time_format` 和 `datetime_format` 设置指定的格式。 如果字符串不是适当的格式，那么当访问该内建函数时， 就会发生错误中止模板的处理。

    <#-- The date_format, time_format and datetime_format settings must match this format! -->
    <#assign someDate = "Oct 25, 1995"?date>
    <#assign someTime = "3:05:30 PM"?time>
    <#assign someDatetime = "Oct 25, 1995 03:05:00 PM"?datetime>

    <#-- Changing the setting value changes the expected format: -->
    <#setting datetime_format="iso">
    <#assign someDatetime = "1995-10-25T15:05"?datetime>

也可以指定明确的格式，比如 `?datetime.`format`` 或 `?datetime["`format`"]` (由于历史原因，也可以是 `?datetime("`format`")`)， 它们与 `?date` 和 `?time`是相同的。 对于格式化值的语法和意义，可以参考 `date_format`, `time_format` 和 `datetime_format` 设置 的可能的值。 比如：

    <#-- Parsing XML Schema xs:date, xs:time and xs:dateTime values: -->
    <#assign someDate = "1995-10-25"?date.xs>
    <#assign someTime = "15:05:30"?time.xs>
    <#assign someDatetime = "1995-10-25T15:05:00"?datetime.xs>

    <#-- Parsing ISO 8601 (both extended and basic formats): -->
    <#assign someDatetime = "1995-10-25T15:05"?datetime.iso>
    <#assign someDatetime = "19951025T1505"?datetime.iso>

    <#-- Parsing with SimpleDateFormat patterns: -->
    <#assign someDate = "10/25/1995"?date("MM/dd/yyyy")>
    <#assign someTime = "15:05:30"?time("HH:mm:ss")>
    <#assign someDatetime = "1995-10-25 03:05 PM"?datetime("yyyy-MM-dd hh:mm a")>

避免误解，左侧值无需是字符串文本。比如，当从XML结点 (此处的所有值都是未被解析的字符串)读取数据，那么就需要这样来做 `order.confirmDate?date.xs`，将字符串转化成真实的日期。

当然，格式也可以是一个变量，比如： `"`...`"?datetime[myFormat]`。

##### ends_with

返回是否这个字符串以参数中指定的子串结尾。 比如 `"ahead"?ends_with("head")` 返回布尔值 `true`。`"head"?ends_with("head")` 也返回 `true`。

##### ensure_ends_with

该内建函数从 FreeMarker 2.3.21 版本开始可用

如果字符串没有以第一个参数指定的子串结尾， 那么就会将它加到字符串后面，否则返回原字符串。比如， `"foo"?ensure_ends_with("/")` 和 `"foo/"?ensure_ends_with("/")` 返回 `"foo/"`。

##### ensure_starts_with

该内建函数从 FreeMarker 2.3.21 版本开始可用

如果字符串没有以第一个参数指定的子串开头， 那么就会将它加到字符串开头，否则返回原字符串。比如， `"foo"?ensure_starts_with("/")` 和 `"/foo"?ensure_starts_with("/")` 返回 `"/foo"`。

如果指定两个参数，那么第一个参数就被解释成Java正则表达式， 如果它不匹配字符串的开头，那么第二个参数指定的字符串就会添加到字符串开头。 比如 `someURL?ensure_starts_with("[a-zA-Z]+://", "http://")` 就会检查如果字符串是否以 `"[a-zA-Z]+://"` 开头 (请注意，不需要 `^`)，如果不是的话，就添加 `"http://"`。

该方法也接受第三个标志位参数。因为调用两个参数暗指 `"r"`(也就是正则表达式模式)，那么就需要第三个参数了。 值得注意的一点是当不需要第一参数被解释成正则表达式，而只是普通文本， 但是又想让比较是大小写敏感的，那么此时就需要使用 `"i"` 作为第三个参数。

##### groups

这个函数只作用于内建函数 `matches` 的结果。请参考 这里...。

##### html

字符串按照HTML标记输出。也就是说，下面字符串将会被替代：

- `<` 替换为 `&lt;`

- `>` 替换为 `&gt;`

- `&` 替换为 `&amp;`

- `"` 替换为 `&quot;`

- 如果程序员设置了FreeMarker(将 `incompatible_improvements` 设置为 `2.3.20` 或更高；更多内容请参考 这里)，那么 `'` 被替换为 `&#39;`。

请注意，如果想安全地插入一个属性， 必须在HTML模板中使用引号标记(是 `"`，而不是 `'`)为属性值加引号：

    <input type=text name=user value="${user?html}">

请注意，在HTML页面中，通常想对所有插值使用这个内建函数。 所以可以使用 `escape` 指令 来节约很多输入，减少偶然错误的机会。

##### index_of

返回第一次字符串中出现子串时的索引位置。 例如 `"abcabc"?index_of("bc")` 将会返回1 (不要忘了第一个字符的索引是0)。而且，你可以指定开始搜索的索引位置： `"abcabc"?index_of("bc", 2)` 将会返回4。 这对第二个参数的数值没有限制：如果它是负数，那就和是0是相同效果了， 如果它比字符串的长度还大，那么就和它是字符串长度那个数值是一个效果。 小数会被切成整数。

如果第一个参数作为子串没有在该字符串中出现时 (如果你使用了第二个参数，那么就从给定的序列开始)，那么就返回-1。

##### j_string

根据Java语言字符串转义规则来转义字符串， 所以它很安全的将值插入到字符串类型中。要注意它 不会 在被插入的值的两侧添加引号； 你需要在字符串值 内部 来使用。

所有 UCS 编码下指向0x20的字符会被转义。 当它们在Java语言中(比如`\n`，`\t`等) 没有专门的转义序列时，将会被用UNICODE进行转义替换 (`\u`XXXX``)。

例如：

    <#assign beanName = 'The "foo" bean.'>
    String BEAN_NAME = "${beanName?j_string}";

将会输出：

    String BEAN_NAME = "The \"foo\" bean.";

##### js_string

根据JavaScript语言字符串转义规则来转义字符串， 所以它很安全的将值插入到字符串类型中。要注意， 它不会在被插入的值两侧添加引号； 你需要在字符串值 内部 来使用。

引号(`"`)和单引号(`'`)要被转义。 从 FreeMarker 2.3.1 开始，也要将 `>` 转义为 `\>`(为了避免 `</script>`)。

所有在 UCS 编码下指向0x20的字符将会被转义。 当它们在JavaScript中没有专用的转义序列时 (比如 `\n`，`\t` 等)， 它们会被UNICODE字符代替(`\u`XXXX``)。

例如：

    <#assign user = "Big Joe's \"right hand\"">
    <script>
      alert("Welcome ${user?js_string}!");
    </script>

将会输出：

    <script>
      alert("Welcome Big Joe\'s \"right hand\"!");
    </script>

##### json_string

根据JSON语言的字符串规则来转义字符串， 所以在字符串中插入值是安全的。 要注意它 不会 在被插入的值两侧添加引号； 你需要在字符串值 内部 来使用。

这不会转义 `'` 字符，因为JSON字符串必须使用 `"` 来括起来。它会在 `<` 之后直接出现的 `/`(斜杠)字符转义为 `\/`， 来避免 `</script>` 等。 它也会在 `]]` 之后转义 `>` 字符为 `\u003E`，来避免退出XML的 `CDATA` 段。

所有在 UCS 编码下指向0x20的字符会被转义。 当在JSON中没有专用的转义序列时 (比如 `\n`，`\t` 等)， 它们会被UNICODE字符代替(`\u`XXXX``)。

##### keep_after

该内建函数从 FreeMarker 2.3.21 版本开始可用。

移除字符串中的一部分内容，该部分是给定子串第一次出现之前的部分。 比如：

    ${"abcdefgh"?keep_after("de")}

将会输出

    fgh

如果参数字符串没有找到，它会返回空串。如果参数是长度为0的字符串， 它会返回源字符串，不会改变。

该方法接受可选的 标志位参数，作为它的第二个参数：

    ${"foo : bar"?keep_after(r"\s*:\s*", "r")}

将会输出

    bar

##### keep_after_last

该内建函数从 FreeMarker 2.3.22 版本开始可用。

和 `keep_after` 相同， 但是它会保留参数最后一次出现后的部分，而不是第一次。比如：

    ${"foo.bar.txt"?keep_after_last(".")}

将会输出

    txt

若使用 `keep_after` 则会得到 `bar.txt`。

##### keep_before

该内建函数从 FreeMarker 2.3.21 版本开始可用。

移除字符串的一部分，该部分是从给定子串开始的部分。 比如：

    ${"abcdef"?keep_before("de")}

将会输出

    abc

如果参数字符串没有找到，它会返回源字符串，不会改变。 如果参数是长度为0的字符串，它会返回空串。

该方法接受可选的 标志位参数，作为它的第二个参数：

    ${"foo : bar"?keep_before(r"\s*:\s*", "r")}

将会输出

    foo

##### keep_before_last

该内建函数从 FreeMarker 2.3.22 版本开始可用。

和 `keep_before` 相同， 但是保留参数最后一次出现之前的部分，而不是第一次出现之前。比如：

    ${"foo.bar.txt"?keep_before_last(".")}

将会输出

    foo.bar

若使用 `keep_before` 则会得到 `foo`。

##### last_index_of

返回最后一次(最右边)字符串中出现子串时的索引位置。 它返回子串第一个(最左边)字符所在位置的索引。例如： `"abcabc"?last_index_of("ab")`：将会返回3。 而且可以指定开始搜索的索引。例如， `"abcabc"?last_index_of("ab", 2)`，将会返回0。 要注意第二个参数暗示了子串开始的最大索引。对第二个参数的数值没有限制： 如果它是负数，那么效果和是零的一样，如果它比字符串的长度还大， 那么就和它是字符串长度那个数值是一个效果。小数会被切成整数。

如果第一个参数作为子串没有在该字符串中出现时 (如果你使用了第二个参数，那么就从给定的序列开始)，那么就返回-1。

##### left_pad

该内建函数从 FreeMarker 2.3.1 版本开始可用。

如果它仅仅用1个参数，那么它将在字符串的开始插入空白， 直到整个串的长度达到参数指定的值。 如果字符串的长度达到指定数值或者比指定的长度还长， 那么就什么都不做了。比如这样：

    [${""?left_pad(5)}]
    [${"a"?left_pad(5)}]
    [${"ab"?left_pad(5)}]
    [${"abc"?left_pad(5)}]
    [${"abcd"?left_pad(5)}]
    [${"abcde"?left_pad(5)}]
    [${"abcdef"?left_pad(5)}]
    [${"abcdefg"?left_pad(5)}]
    [${"abcdefgh"?left_pad(5)}]

将会输出：

    [     ]
    [    a]
    [   ab]
    [  abc]
    [ abcd]
    [abcde]
    [abcdef]
    [abcdefg]
    [abcdefgh]

如果使用了两个参数，那么第一个参数表示的含义和你使用一个参数时的相同， 第二个参数指定用什么东西来代替空白字符。比如：

    [${""?left_pad(5, "-")}]
    [${"a"?left_pad(5, "-")}]
    [${"ab"?left_pad(5, "-")}]
    [${"abc"?left_pad(5, "-")}]
    [${"abcd"?left_pad(5, "-")}]
    [${"abcde"?left_pad(5, "-")}]

将会输出：

    [-----]
    [----a]
    [---ab]
    [--abc]
    [-abcd]
    [abcde]

第二个参数也可以是个长度比1大的字符串。 那么这个字符串会周期性的插入，比如：

    [${""?left_pad(8, ".oO")}]
    [${"a"?left_pad(8, ".oO")}]
    [${"ab"?left_pad(8, ".oO")}]
    [${"abc"?left_pad(8, ".oO")}]
    [${"abcd"?left_pad(8, ".oO")}]

将会输出：

    [.oO.oO.o]
    [.oO.oO.a]
    [.oO.oOab]
    [.oO.oabc]
    [.oO.abcd]

第二个参数必须是个字符串值，而且至少有一个字符。

##### length

字符串中字符的数量。

##### lower_case

字符串的小写形式。比如 `"GrEeN MoUsE"?lower_case` 将会是 `"green mouse"`。

##### matches

这是一个"超级用户"函数。如果不懂 正则表达式，就忽略它吧。

该内建函数决定了字符串是否精确匹配模式。而且，它会返回匹配子串的列表。 返回值是多类型值：

- 布尔值：如果字符串整体匹配了模式，就是 `true`， 否则就是 `false`。比如：`"fooo"?matches('fo*')` 就是 `true`，但是 `"fooo bar"?matches('fo*')` 是 `false`。

- 序列：字符串匹配的子串的列表。很有可能是长度为0的序列。

比如：

    <#if "fxo"?matches("f.?o")>Matches.<#else>Does not match.</#if>

    <#assign res = "foo bar fyo"?matches("f.?o")>
    <#if res>Matches.<#else>Does not match.</#if>
    Matching sub-strings:
    <#list res as m>
    - ${m}
    </#list>

将会输出：

    Matches.

    Does not match.
    Matching sub-strings:
    - foo
    - fyo

如果正则表达式包含分组(圆括号)，那么可以使用 `groups` 内建函数来访问它们：

    <#-- Entire input match -->
    <#assign res = "John Doe"?matches(r"(\w+) (\w+)")>
    <#if res> <#-- Must not try to access groups if there was no match! -->
      First name: ${res?groups[1]}
      Second name: ${res?groups[2]}
    </#if>

    <#-- Subtring matches -->
    <#assign res = "aa/rx; ab/r;"?matches("(.+?)/*(.+?);")>
    <#list res as m>
      - "${m}" is "${m?groups[1]}" per "${m?groups[2]}"
    </#list>

将会输出：

      First name: John
      Second name: Doe

      - "aa/rx;" is "a" per "a/rx"
      - " ab/r;" is " " per "ab/r"

请注意，上面的 `groups` 对子串匹配和整个字符串匹配的结果都起作用。

`matches` 接受可选的第二参数， 标志位。请注意， 它不支持标志 `f`，也会忽略 `r` 标志。

##### number

字符串转化为数字格式。这个数字必须是 计算机语言 格式。也就是说， 它必须是本地化独立的形式，小数的分隔符就是一个点，没有分组。

该内建函数识别FreeMarker模板语言使用的数字格式。此外， 它也识别科学记数法(比如 `"1.23E6"`，`"1.5e-8"`) 从 FreeMarker 2.3.21 版本开始，它也识别所有XML Schema数字格式，比如 `NaN`，`INF`，`-INF`， 还有Java本地格式`Infinity` 和 `-Infinity`。

如果字符串不是适当的格式，当尝试访问该内建函数时就会发生错误， 并中止模板执行。

实际上，字符串是由当前 `arithmetic_engine` 的 `toNumber` 方法解析的，这是可以配置的设置项。不过该方法应该和上面描述的行为相似。

##### replace

在源字符串中，用另外一个字符串来替换原字符串中出现它的部分。 它不处理词的边界。比如：

    ${"this is a car acarus"?replace("car", "bulldozer")}

将会输出：

    this is a bulldozer abulldozerus

替换是从左向右执行的。这就意味着：

    ${"aaaaa"?replace("aaa", "X")}

将会输出：

    Xaa

如果第一个参数是空字符串，那么所有的空字符串将会被替换， 比如 `"foo"?replace("","|")`，就会得到 `"|f|o|o|"`。

`replace` 接受可选的 标志位参数，作为它的第三参数。

##### right_pad

该内建函数从 FreeMarker 2.3.1 版本开始可用。 在2.3版本中是没有的。

它和 `left_pad` 相同， 但是它从末尾开始插入字符而不是从开头。

比如：

    [${""?right_pad(5)}]
    [${"a"?right_pad(5)}]
    [${"ab"?right_pad(5)}]
    [${"abc"?right_pad(5)}]
    [${"abcd"?right_pad(5)}]
    [${"abcde"?right_pad(5)}]
    [${"abcdef"?right_pad(5)}]
    [${"abcdefg"?right_pad(5)}]
    [${"abcdefgh"?right_pad(5)}]

    [${""?right_pad(8, ".oO")}]
    [${"a"?right_pad(8, ".oO")}]
    [${"ab"?right_pad(8, ".oO")}]
    [${"abc"?right_pad(8, ".oO")}]
    [${"abcd"?right_pad(8, ".oO")}]

将会输出：

    [     ]
    [a    ]
    [ab   ]
    [abc  ]
    [abcd ]
    [abcde]
    [abcdef]
    [abcdefg]
    [abcdefgh]

    [.oO.oO.o]
    [aoO.oO.o]
    [abO.oO.o]
    [abc.oO.o]
    [abcdoO.o]

##### remove_beginning

该内建函数从 FreeMarker 2.3.21 版本开始可用。

从字符串的开头移除参数中的子串，如果它不以参数中的子串开头， 那么就或者返回原字符串。比如：

    ${"abcdef"?remove_beginning("abc")}
    ${"foobar"?remove_beginning("abc")}

将会输出：

    def
    foobar

##### remove_ending

该内建函数从 FreeMarker 2.3.21 版本开始可用。

从字符串的结尾移除参数中的子串，如果它不以参数中的子串结尾， 那么就或者返回原字符串。比如：

    ${"abcdef"?remove_ending("def")}
    ${"foobar"?remove_ending("def")}

将会输出：

    abc
    foobar

##### rtf

字符串作为富文本(RTF 文本)，也就是说，下列字符串：

- `\` 替换为 `\\`

- `{` 替换为 `\{`

- `}` 替换为 `\}`

##### split

它被用来根据另外一个字符串的出现将原字符串分割成字符串序列。 比如：

    <#list "someMOOtestMOOtext"?split("MOO") as x>
    - ${x}
    </#list>

将会输出：

    - some
    - test
    - text

请注意，假设所有的分隔符都在新项之前出现 (除了使用 `"r"` 标志 - 后面详细介绍) 因此：

    <#list "some,,test,text,"?split(",") as x>
    - "${x}"
    </#list>

将会输出：

    - "some"
    - ""
    - "test"
    - "text"
    - ""

`split` 接受可选的 标志位参数， 作为它的第二个参数。由于历史使用 `r` (正则表达式)标志的差错；它会从结果列表中移除空元素， 所以在最后示例中使用 `?split(",", "r")`， `""` 会从输出中消失。

要检查一个字符串是否以...结尾或者要附加它， 使用 `ensure_ends_with` 内建函数。

##### starts_with

如果字符串以指定的子字符串开头，那么返回`true`。 比如 `"redirect"?starts_with("red")` 返回布尔值 `true`，而且 `"red"?starts_with("red")` 也返回 `true`。

要检查一个字符串是否以...开头或者要在前面附加它， 使用 `ensure_starts_with` 内建函数。

##### string (当被用作是字符串值时)

什么也不做，仅仅返回和其内容一致的字符串。例外的是， 如果值是一个多类型的值(比如同时有字符串和序列两种)， 那么结果就只是一个简单的字符串，而不是多类型的值。 这可以被用来防止人为多输入。

##### substring (已废弃)

从 FreeMarker 2.3.21 版本开始，该内建函数被废弃，由 字符串切分 替代，比如 ``str`[`from`..<`toExclusive`]`， ``str`[`from`..]`, 和 ``str`[`from`..*`maxLength`]`。

如果处理XML那么有一点警示：因为分割表达式作用于序列和字符串， 而且XML结点通常既是序列又是字符串，那么相等的表达式是 ``someXmlNode`?string[`from`..<`toExclusive`]` 和 ``exp`?string[`from`..]`， 因为没有 `?string` 它会分割结点序列而不是结点的字符串值。

一些典型的字符串分割的用例已经由一些内建函数方便地实现： `remove_beginning`， `remove_ending`， `keep_before`， `keep_after`， `keep_before_last`， `keep_after_last`

概要： ``exp`?substring(`from`, `toExclusive`)`，也可以使用 ``exp`?substring(`from`)` 调用。

字符串的子串 ``from`` 是第一个字符的索引。 它必须是数字，最小是0并且小于或等于 ``toExclusive``， 否则就会发生错误并且中止模板处理。 ``toExclusive`` 是子串最后一个字符之后的字符位置索引，换句话说，它比最后一个字符的索引大1。 它必须是一个数字，最小是0并且小于或等于字符串的长度， 否则就会发生错误并且中止模板处理。如果 ``toExclusive`` 被忽略了， 那么默认就是字符串的长度。如果参数是数字但不是整数， 那么只有数字中的整数部分会被使用。

例如：

    - ${'abc'?substring(0)}
    - ${'abc'?substring(1)}
    - ${'abc'?substring(2)}
    - ${'abc'?substring(3)}

    - ${'abc'?substring(0, 0)}
    - ${'abc'?substring(0, 1)}
    - ${'abc'?substring(0, 2)}
    - ${'abc'?substring(0, 3)}

    - ${'abc'?substring(0, 1)}
    - ${'abc'?substring(1, 2)}
    - ${'abc'?substring(2, 3)}

将会输出：

    - abc
    - bc
    - c
    -

    -
    - a
    - ab
    - abc

    - a
    - b
    - c

##### trim

去掉字符串首尾的空格。例如：

    (${"  green mouse  "?trim})

将会输出：

    (green mouse)

##### uncap_first

和 `cap_first` 相反。 字符串中所有单词的首字母小写。

##### upper_case

字符串的大写形式。比如 `"GrEeN MoUsE"` 将会是 `"GREEN MOUSE"`.

##### url

该内建函数从 FreeMarker 2.3.1 版本开始可用。 在2.3版本中是没有的。

在URL之后的字符串进行转义。这意味着， 所有非US-ASCII的字符和保留的URL字符将会被 `%`XX`` 形式转义。例如：

    <#assign x = 'a/b c'>
    ${x?url}

将会输出(假设用来转义的字符集是US-ASCII兼容的字符集)：

    a%2Fb%20c

请注意，它会转义 所有 保留的URL字符 (`/`， `=`， `&`，等...)， 所以编码可以被用来对查询参数的值进行，比如：

    <a href="foo.cgi?x=${x?url}&y=${y?url}">Click here...</a>

上面的没有HTML编码(`?html`)是需要的， 因为URL转义所有保留的HTML编码。但是要小心：通常引用的属性值， 用普通引号(`"`)包括，而不是单引号 (`'`)，因为单引号是不被URL转义的。

为了进行URL转义，必须要选择 字符集，它被用来计算被转义的部分 (`%`XX``)。 如果你是HTML页面设计者，而且你不懂这个，不要担心： 程序员应该配置 FreeMarker，则它默认使用恰当的字符集 (程序员应该多看看下面的内容...)。 如果你是一个比较热衷于技术的人，那么你也许想知道被 `url_escaping_charset` 设置的指定字符集， 它可以在模板的执行时间设置(或者，更好的是，由程序员之前设置好)。例如：

    <#--
      This will use the charset specified by the programmers
      before the template execution has started.
    -->
    <a href="foo.cgi?x=${x?url}">foo</a>

    <#-- Use UTF-8 charset for URL escaping from now: -->
    <#setting url_escaping_charset="UTF-8">

    <#-- This will surely use UTF-8 charset -->
    <a href="bar.cgi?x=${x?url}">bar</a>

此外，你可以明确地指定一个为单独URL转义的字符集，作为内建函数的参数：

    <a href="foo.cgi?x=${x?url('ISO-8895-2')}">foo</a>

如果内建函数 `url` 没有参数， 那么它会使用由 `url_escaping_charset` 设置的字符集。 这个设置应该被软件设置，包括 FreeMarker(比如Web应用框架)， 因为它默认不会被设置(`null`)。 如果它没有被设置，那么 FreeMarker 退回使用 `output_encoding` 的设置，这个也会被默认设置，所以它也是又软件设置的。 如果 `output_encoding` 也没有被设置， 那么没有参数的内建函数 `url` 将不会被执行， 而且它会引起运行时错误。当然，有参数的 `url` 函数将会执行。

用 `setting` 指令在模板中设置 `url_escaping_charset` 是可能的。 至少在真实的MVC应用中，这是一个不好的实践行为。`output_encoding` 不能由 `setting` 指令来设置，所以它应该是软件的工作。 你可以阅读 这里... 来获取更多信息。

##### url_path

该内建函数从 FreeMarker 2.3.21 版本开始可用。

它和 `url` 内建函数 相同，只是它不转义斜杠 (`/`)字符。这就是意味着用来转义使用了斜杠(不是反斜杠！)的路径 (比如操作系统或一些内容仓库的路径)，转义之后它们可以插入到URL中。 需要该转义的常用原因是文件夹名称或文件名称可能含有非US-ASCII字母 (国家 标准符号)。

和 the `url` 内建函数 相似，希望的URL转义字符 (或者后退，输出编码)必须要在 FreeMarker的配置设置项中设置， 否则内建函数就会报错。或者可以指定字符集，比如 `somePath?url_path('utf-8')`。

##### word_list

包含字符串中所有单词的序列，顺序为出现在字符串中的顺序。 单词是不间断的字符序列，包含了任意字符，但是没有 空白。例如：

    <#assign words = "   a bcd, .   1-2-3"?word_list>
    <#list words as word>[${word}]</#list>

将会输出：

    [a][bcd,][.][1-2-3]

##### xhtml

字符串作为XHTML格式文本，下面这些：

- `<` 替换为 `&lt;`

- `>` 替换为 `&gt;`

- `&` 替换为 `&amp;`

- `"` 替换为 `&quot;`

- `'` 替换为 `&#39;`

该内建函数和 `xml` 内建函数的唯一不同是 `xhtml`内建函数转义 `'` 为 `&#39;`，而不是 `&apos;`， 因为一些老版本的浏览器不能正确解释 `&apos;`。

##### xml

字符串作为XML格式文本，下面这些：

- `<` 替换为 `&lt;`

- `>` 替换为 `&gt;`

- `&` 替换为 `&amp;`

- `"` 替换为 `&quot;`

- `'` 替换为 `&apos;`

##### 通用标志

很多字符串内建函数接受可选的字符串参数， 它们被称为"标志"。在这个字符串中，每个字母影响内建函数一个特定方面的行为。 比如，字母 `i` 说明内建函数不应该区别相同字母的小写和大写变化。 标志字符串中的字母顺序是不重要的。

下面是字母(标志)的完整列表：

- `i`：大小写敏感： 不区别相同字母的小写和大写变化。

- `f`：只是第一个。也就是说， 替换/查找/等...，只是第一个出现的地方。

- `r`：查找的子串是 正则表达式。 FreeMarker 使用的正则表达式变量可以在 http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html 中找到(请注意，一些模式规则特性的出现基于所使用的Java版本)。

- `m`：正则表达式的多行模式。在多行正则表达式 `^` 和 `$` 仅仅匹配之后或之前， 各自匹配行终止符或字符串结尾。默认情况下，这些表达式仅仅匹配完整字符串的开头和结尾。 请注意，`^` 和 `$` 不匹配换行符字符本身。

- `s`：开启正则表达式的dot-all模式 (和Perl的单行模式相同)。在dot-all模式下，表达式 `.` 匹配任意字符串，包含行终止符。 默认情况下，该表达式不匹配行终止符。

- `c`： 允许正则表达式中的空白和注释。

例如：

    <#assign s = 'foo bAr baar'>
    ${s?replace('ba', 'XY')}
    i: ${s?replace('ba', 'XY', 'i')}
    if: ${s?replace('ba', 'XY', 'if')}
    r: ${s?replace('ba*', 'XY', 'r')}
    ri: ${s?replace('ba*', 'XY', 'ri')}
    rif: ${s?replace('ba*', 'XY', 'rif')}

将会输出：

    foo bAr XYar
    i: foo XYr XYar
    if: foo XYr baar
    r: foo XYAr XYr
    ri: foo XYr XYr
    rif: foo XYr baar

下表是支持使用这些通用标志的内建函数：

内建函数 | `i` (忽略大小写) | `r` (正则表达式) | `m` (多行模式) | `s` (dot-all模式) | `c` (空白和注释) | `f` (仅第一个)
--- | --- | --- | --- | --- | --- | ---
`replace` | 是 | 是 | 仅 `r` | 仅 `r` | 仅 `r` | 是
`split` | 是 | 是 | 仅 `r` | 仅 `r` | 仅 `r` | 否
`matches` | 是 | 忽略 | 是 | 是 | 是 | 否
`keep_after` | 是 | 是 | 是 | 是 | 是 | 忽略
`keep_after_last` | 是 | 是 | 是 | 是 | 是 | 忽略
`keep_before` | 是 | 是 | 是 | 是 | 是 | 忽略
`keep_before_last` | 是 | 是 | 是 | 是 | 是 | 忽略
`ensure_starts_with` | 是 | 忽略 | 是 | 是 | 是 | 忽略

#### 数字内建函数

相关的FAQ：如果有和 1,000,000 或 1 000 000 而不是 1000000 类似的东西， 或者是 3.14 而不是 3,14 的东西，反之亦然，请参考这里 和 这里 FAQ中相关内容， 也要注意上述内容中的内建函数 `c`。

##### abs

该内建函数从 FreeMarker 2.3.20 版本开始存在。

给出数字的绝对值。比如 `x?abs` ，如果 `x` 是 -5，会得到5。

##### c (当被用作是数字值时)

该内建函数从 FreeMarker 2.3.3 版本开始存在。

该内建函数将 计算机语言 的数字转换成字符串， 这都是对计算机来说的，而不是对用户。也就是说， 它根据程序语言的用法来进行格式化， 这对于 FreeMarker 的所有本地数字格式化设置来说是独立的。 它通常使用点来作为小数分隔符，而且它从来不用分组分隔符(像3,000,000)， 指数形式(比如5E20)，多余的在开头或结尾的0(比如03或1.0)，还有+号(比如+1)。 它最多在小数点后打印16位，因此数值的绝对值小于1E-16将会显示为0。 该内建函数非常严格，因为作为默认(像 `${x}` 这样) 数字被本地(语言，国家)特定的数字格式转换为字符串，这是让用户来看的 (比如3000000可能会被打印为3,000,000)。当数字不对用户打印时 (比如，对于一个数据库记录ID，用作是URL的一部分，或者是HTML表单中的隐藏域， 或者打印CSS/JavaScript的数值文本)，该内建函数必须被用来打印数字 (也就是使用 `${x?c}` 来代替 `${x}`)， 否则输出可能由于当前数字格式设置，本地化 (比如在一些国家中，小数点不是点，而是逗号)和数值 (像大数可能被分组分隔符"损坏")而损坏。

如果 FreeMarker 配置设置项 `incompatible_imporvements` 为 2.3.21 (或更高)，该内建函数将会对正无穷/负无穷，IEEE非浮点数各自返回 `"INF"`， `"-INF"` 和 `"NaN"`。这是这些特殊值的XML Schema兼容性表现。 (之前它会返回US本地化下的 `java.text.DecimalFormat`， 不被任意(通用)计算机语言所理解。)

请注意，该内建函数 也对布尔值起作用。

##### is_infinite

该内建函数从 FreeMarker 2.3.20 版本开始存在。

辨别数字是否是无限浮点数(根据IEEE 754)。比如， 基于 `someNumber` 的值是否是无限， `someNumber?is_infinite` 结果是 `true` 或 `false`，当然， 如果该数不是浮点类型，那么将会返回 `false`。

##### is_nan

该内建函数从 FreeMarker 2.3.20 版本开始存在。

辨别数字是否是浮点数NaN(根据IEEE 754)。比如， 基于 `someNumber` 的值是否是 NaN， `someNumber?is_nan` 结果是 `true` 或 `false`，当然， 如果该数不是浮点类型，那么将会返回 `false`。

##### lower_abc

该内建函数从 FreeMarker 2.3.22 版本开始存在。

将 `1`， `2`， `3`，等...，转换为字符串 `"a"`， `"b"`， `"c"`，等... 当到达 `"z"`时，那么会继续转换成如 `"aa"`， `"ab"`，等... 这和电子表格应用程序(比如Excel或Calc) 的列标签有着相同的逻辑。数字的最小值是 `1`。 没有上限值。如果数字是 `0` 或更小或它不是整数， 那么模板处理将会中止并发生错误。

例如：

    <#list 1..30 as n>${n?lower_abc} </#list>

输出：

    a b c d e f g h i j k l m n o p q r s t u v w x y z aa ab ac ad

请参考： `upper_abc`

##### round, floor, ceiling

内建函数 round 从 FreeMarker 2.3.13 版本开始存在。

使用确定的舍入法则，转换一个数字到整数：

- `round`：返回最近的整数。 如果数字以.5结尾，那么它将进位(也就是向正无穷方向进位)

- `floor`：返回数字的舍掉小数后的整数 (也就是向负无穷舍弃)

- `ceiling`：返回数字小数进位后的整数 (也就是向正无穷进位)

例如：

    <#assign testlist=[
      0, 1, -1, 0.5, 1.5, -0.5,
      -1.5, 0.25, -0.25, 1.75, -1.75]>
    <#list testlist as result>
        ${result} ?floor=${result?floor} ?ceiling=${result?ceiling} ?round=${result?round}
    </#list>

输出：

        0 ?floor=0 ?ceiling=0 ?round=0
        1 ?floor=1 ?ceiling=1 ?round=1
        -1 ?floor=-1 ?ceiling=-1 ?round=-1
        0.5 ?floor=0 ?ceiling=1 ?round=1
        1.5 ?floor=1 ?ceiling=2 ?round=2
        -0.5 ?floor=-1 ?ceiling=0 ?round=0
        -1.5 ?floor=-2 ?ceiling=-1 ?round=-1
        0.25 ?floor=0 ?ceiling=1 ?round=0
        -0.25 ?floor=-1 ?ceiling=0 ?round=0
        1.75 ?floor=1 ?ceiling=2 ?round=2
        -1.75 ?floor=-2 ?ceiling=-1 ?round=-2

这些内建函数在分页处理时也许有用。如果你仅仅想 展示 数字的舍入形式，那么应该使用 `string` 内建函数 或者 `number_format` 设置。

##### string (当用作是数字类型时)

将一个数字转换成字符串。它使用程序员通过 `number_format` 和 `locale` 设置的默认格式。也可以明确地用这个内建函数再指定一个数字格式， 这在后面会展示。

有四种预定义的数字格式：`computer`， `currency`，`number` 和 `percent`。这些格式的明确含义是本地化(国家)指定的， 受Java平台安装环境所控制，而不是FreeMarker，除了 `computer`，用作和 `c` 内建函数是相同的格式。可以这样来使用预定义的格式：

    <#assign x=42>
    ${x}
    ${x?string}  <#-- the same as ${x} -->
    ${x?string.number}
    ${x?string.currency}
    ${x?string.percent}
    ${x?string.computer}

如果你本地是US English，将会输出：

    42
    42
    42
    $42.00
    4,200%
    42

前三个表达式的输出是相同的，因为前两个表达式是默认格式， 这里是"数字"。可以使用一个设置来改变默认设置：

    <#setting number_format="currency">
    <#assign x=42>
    ${x}
    ${x?string}  <#-- the same as ${x} -->
    ${x?string.number}
    ${x?string.currency}
    ${x?string.percent}

将会输出：

    $42.00
    $42.00
    42
    $42.00
    4,200%

因为默认的数字格式被设置成了"货币"。

除了这三种预定义格式，还可以使用 Java 数字格式语法 中的任意数字格式：

    <#assign x = 1.234>
    ${x?string["0"]}
    ${x?string["0.#"]}
    ${x?string["0.##"]}
    ${x?string["0.###"]}
    ${x?string["0.####"]}

    ${1?string["000.00"]}
    ${12.1?string["000.00"]}
    ${123.456?string["000.00"]}

    ${1.2?string["0"]}
    ${1.8?string["0"]}
    ${1.5?string["0"]} <-- 1.5, rounded towards even neighbor
    ${2.5?string["0"]} <-- 2.5, rounded towards even neighbor

    ${12345?string["0.##E0"]}

将会输出：

    1
    1.2
    1.23
    1.234
    1.234

    001.00
    012.10
    123.46

    1
    2
    2 <-- 1.5, rounded towards even neighbor
    2 <-- 2.5, rounded towards even neighbor

    1.23E4

请注意，在 FreeMarker 中，`foo.bar` 和 `foo["bar"]` 是相同的，也可以将 `x?string.currency` 写为 `x?string["currency"]`，当然实际中不这么用。 但是在上述示例中，我们不得不使用方括号语法，因为在语法上， 使用的字符(数字，点，`#`)不允许在点操作符之后。

由于历史原因，也可以编写如下代码 `x?string("0.#")`，它和 `x?string["0.#"]` 完全相同。

在金融和统计学实践中，四舍五入都是根据所谓的一半原则， 这就意味着对最近的"邻居"进行四舍五入，除非离两个邻居距离相等， 这种情况下，它四舍五入到偶数的邻居。如果你注意看1.5和2.5的四舍五入的话， 这在上面的示例中是可以看到的，两个都被四舍五入到2，因为2是偶数，但1和3是奇数。

正如之前展示的预定义格式，数字的默认格式可以在模板中设置：

    <#setting number_format="0.##">
    ${1.234}

将会输出：

    1.23

请注意，数字格式是本地化敏感的，本地化设置在格式化中起作用：

    <#setting number_format=",##0.00">
    <#setting locale="en_US">
    US people write:     ${12345678}
    <#setting locale="hu">
    German people write: ${12345678}

将会输出：

    US people write:     12,345,678.00
    German people write: 12.345.678,00

##### upper_abc

该内建函数从 FreeMarker 2.3.22 版本开始存在。

和 `lower_abc` 相同， 但是它转换成大写字母，比如 `"A"`， `"B"`， `"C"`，… ， `"AA"`， `"AB"`， 等...

#### 日期内建函数

##### date, time, datetime (当用于日期/时间/日期-时间值时)

这些内建函数用来指定日期变量中的哪些部分被使用：

- `date`：仅日期部分，没有一天当中的时间部分。

- `time`：仅一天当中的时间部分，没有日期部分。

- `datetime`：日期和时间都在

在最佳情况下，你不需要使用这些内建函数。不幸的是， 由于Java平台上的技术限制，FreeMarker 有时不能发现日期中的哪一部分在使用； 询问程序员哪些变量会有这个问题。如果 FreeMarker 不得不执行需要这些信息的操作 --比如用文本显示日期--但是它不知道哪一部分在使用，它会以错误来中止运行。 这就是你不得不使用这些内建函数的时候了。比如，假设 `openingTime` 是一个有这样问题的变量：

    <#assign x = openingTime> <#-- no problem can occur here -->
    ${openingTime?time} <#-- without ?time it would fail -->
    <#-- For the sake of better understanding, consider this: -->
    <#assign openingTime = openingTime?time>
    ${openingTime} <#-- this will work now -->

这些内建函数也可以用来将日期-时间值转换成日期或时间。例如：

    Last updated: ${lastUpdated} <#-- assume that lastUpdated is a date-time value -->
    Last updated date: ${lastUpdated?date}
    Last updated time: ${lastUpdated?time}

将会输出：

    Last updated: 04/25/2003 08:00:54 PM
    Last updated date: 04/25/2003
    Last updated time: 08:00:54 PM

如果 `?` 左边是字符串，那么这些内建函数 将字符串转换成日期/时间/日期时间。

##### date_if_unknown, time_if_unknown, datetime_if_unknown

该内建函数从 FreeMarker 2.3.21 版本开始存在

`date_if_unknown`， `time_if_unknown`， `datetime_if_unknown` 内建函数使用一些子类型来标记日期类型的值：日期没有时间，时间，或日期-时间。 如果变量值已经持有这些信息，那么内建函数就不会起作用。也就是说， 它不会转换变量值的子类型，如果它是未知的，则会添加子类型。

##### iso_...

这些内建函数从 FreeMarker 2.3.21 版本开始废弃， 因为 `date_format`，`time_format` 和 `datetime_format` 设置理解 `"iso"` (ISO 8601:2004 格式) 和 `"xs"` (XML Schema 格式)，此外还有 Java `SimpleDateFormat` 格式。因此默认格式可以设置为ISO 8601， 要使用一次ISO格式，可以使用 `myDate?string.iso`。 更多内容请参考...

这些内建函数转换日期，时间或日期-时间值为字符串，遵循 ISO 8601:2004 "扩展" 格式。

该内建函数有很多表现形式： `iso_utc`， `iso_local`， `iso_utc_nz`， `iso_local_nz`， `iso_utc_m`， `iso_utc_m_nz`，等。 名称的构成由下列单词顺序组成，每部分由一个 `_` 分隔开：

1. `iso` (必须的)

2. 是 `utc` 或 `local` 二者之一 (必须的(除了给定一个参数，这个后面再来说))： 来指定根据UTC或根据当前时区来打印日期/时间/日期-时间。 当前时区是根据 FreeMarker 的设置项 `time_zone` 来确定的，它通常是由程序员在模板外配置的(当然它也可以在模板内设置， 比如使用`<#setting time_zone="America/New_York">`)。 请注意，如果 FreeMarker 设置项 `sql_date_and_time_time_zone` 已经设置并且非 `null`，那么对于 `java.sql.Date` 和 `java.sql.Time` 值(也就是通过SQL从数据中获得的仅日期值和仅时间值) `local` 的时区值将会替代 `time_zone` 设置的值。

3. `h`，`m` 或 `ms`(可选的)：时间部分的精度。 当忽略的时候，就默认设置到秒的精度(比如`12:30:18`)。 `h` 表示小时的精度(比如 `12`)， `m` 表示分钟的精度(比如 `12:30`)， `ms` 就表示毫秒的精度(`12:30:18.25`，这里表示250毫秒)。 要注意当使用 `ms` 时，毫秒会显示为百分制的形式 (遵循标准)而且不会去尾到 `0` 秒。因此， 如果毫秒的部分变成 `0` 的话，整个的毫秒的部分就会被忽略掉了。 同时也要注意毫秒的部分是由一个点来分隔的，而不是逗号 (遵循Web约定和XML Schema的日期/时间格式)。

4. `nz` (可选的)： `nz` (比如在 `${foo?utc_local_nz}` 中) 代表 没有时区，也就意味着时区的偏移量 (比如 `+02:00` 或者 `-04:30` 或者 `Z`)不会显示出来。如果这部分被忽略了 (比如在 `${foo?utc_local}` 中) 那么时区就会显示出来， 除了两种情况：

   - 如果值是日期(没有时间部分)值(再说一次，ISO 8901 标准不允许)

   - 如果值是 `java.sql.Time` 而且 FreeMarker 配置设置项 `incompatible_improvements` (通常通过 Java代码 `Configuration` 的构造方法参数设置) 最小是2.3.21。 存储时间值是不分时区的，只是存储小时，分钟，秒和小数秒值， 所以显示时区就没什么意义。

   请注意，从 FreeMarker 2.3.19 版本开始，对于XML Schema 日期/时间/日期时间格式的兼容性，时区偏移量通常包含分钟。 (如果主要生成XML Schema格式，就使用 xs 格式。)

例如：

    <#assign aDateTime = .now>
    <#assign aDate = aDateTime?date>
    <#assign aTime = aDateTime?time>

    Basic formats:
    ${aDate?iso_utc}
    ${aTime?iso_utc}
    ${aDateTime?iso_utc}

    Different accuracies:
    ${aTime?iso_utc_ms}
    ${aDateTime?iso_utc_m}

    Local time zone:
    ${aDateTime?iso_local}

可能的输出(基于当前时间和时区)：

    Basic formats:
    2011-05-16
    21:32:13Z
    2011-05-16T21:32:13Z

    Different accuracies:
    21:32:13.868Z
    2011-05-16T21:32Z

    Local time zone:
    2011-05-16T23:32:13+02:00

还有另外一组 `iso_...` 内建函数形式， 你可从名称中以忽略掉 `local` 或 `utc`， 但是要指定时区作为内建函数的参数。例如：

    <#assign aDateTime = .now>
    ${aDateTime?iso("UTC")}
    ${aDateTime?iso("GMT-02:30")}
    ${aDateTime?iso("Europe/Rome")}

    The usual variations are supported:
    ${aDateTime?iso_m("GMT+02")}
    ${aDateTime?iso_m_nz("GMT+02")}
    ${aDateTime?iso_nz("GMT+02")}

可能的输出(基于当前时间和时区)：

    2011-05-16T21:43:58Z
    2011-05-16T19:13:58-02:30
    2011-05-16T23:43:58+02:00

    The usual variations are supported:
    2011-05-16T23:43+02:00
    2011-05-16T23:43
    2011-05-16T23:43:58

如果时区参数不能被解释，模板处理就会终止并发生错误。

参数可以是 `java.util.TimeZone` 对象(可能是Java方法的返回值， 或者在数据模型中)，而不能只是字符串。

##### string (当用于日期/时间/日期-时间值时)

这个内建函数以指定的格式转换日期类型到字符串类型。

应该很少使用这个内建函数，因为日期/时间/日期-时间值的默认格式可以全局指定 FreeMarker 的 `date_format`，`time_format` 和 `datetime_format` 设置。 该内建函数只在期望格式和常用格式不同的地方使用。在其它地方， 默认格式应该由程序员在模板之外合理地设置。

期望的格式可以由 `?string.`format`` 或 `?string["`format`"]` (或历史上等同的， `?string("`format`")`) 来指定。这些都是等同的，除了使用引号格式的，它可以在 ``format`` 中包含任意字符， 比如空格。``format`` 的语法和配置设置项 `date_format`，`time_format` 和 `datetime_format` 是一样的； 请参考这些可能值的文档。

例如：如果输出的本地化设置是美国英语，时区是美国太平洋时区，并且 `openingTime` 是 `java.sql.Time`， `nextDiscountDay` 是 `java.sql.Date` 而 `lastUpdated` 是 `java.sql.Timestamp` 或 `java.util.Date` 那么：

    ${openingTime?string.short}
    ${openingTime?string.medium}
    ${openingTime?string.long}
    ${openingTime?string.full}
    ${openingTime?string.xs}
    ${openingTime?string.iso}

    ${nextDiscountDay?string.short}
    ${nextDiscountDay?string.medium}
    ${nextDiscountDay?string.long}
    ${nextDiscountDay?string.full}
    ${nextDiscountDay?string.xs}
    ${nextDiscountDay?string.iso}

    ${lastUpdated?string.short}
    ${lastUpdated?string.medium}
    ${lastUpdated?string.long}
    ${lastUpdated?string.full}
    ${lastUpdated?string.medium_short} <#-- medium date, short time -->
    ${lastUpdated?string.xs}
    ${lastUpdated?string.iso}

    <#-- SimpleDateFormat patterns: -->
    ${lastUpdated?string["dd.MM.yyyy, HH:mm"]}
    ${lastUpdated?string["EEEE, MMMM dd, yyyy, hh:mm a '('zzz')'"]}
    ${lastUpdated?string["EEE, MMM d, ''yy"]}
    ${lastUpdated?string.yyyy} <#-- Same as ${lastUpdated?string["yyyy"]} -->

    <#-- Advanced ISO 8601-related formats: -->
    ${lastUpdated?string.iso_m_u}
    ${lastUpdated?string.xs_ms_nz}

将会输出：

    01:45 PM
    01:45:09 PM
    01:45:09 PM PST
    01:45:09 PM PST
    13:45:09-08:00
    13:45:09-08:00

    2/20/07
    Apr 20, 2007
    April 20, 2007
    Friday, April 20, 2007
    2007-02-20-08:00
    2007-02-20

    2/20/07 01:45 PM
    Feb 20, 2007 01:45:09 PM
    February 20, 2007 01:45:09 PM PST
    Friday, February 20, 2007 01:45:09 PM PST
    Feb 8, 2003 9:24 PM
    2007-02-20T13:45:09-08:00
    2007-02-20T13:45:09-08:00

    08.04.2003 21:24
    Tuesday, April 08, 2003, 09:24 PM (PDT)
    Tue, Apr 8, '03
    2003

    2007-02-20T21:45Z
    2007-02-20T13:45:09.000

不幸的是，由于Java平台的限制，在数据模型中可以有日期变量， 那里 FreeMarker 不能决定变量是否是日期(年，月，日)，还是时间 (时，分，秒，毫秒)，或者是日期-时间值。这种情况下，当你编写如 `${lastUpdated?string.short}` 或 `${lastUpdated?string.xs}` 时，FreeMarker 不知道如何来显示日期，也就是说，格式不指定精确的字段去显示， 或者如果只是简单使用 `${lastUpdated}`， 那么模板会中止执行并抛出错误。要阻止这些发生，可以使用 `?date`， `?time` 和 `?datetime` 内建函数 来帮助 FreeMarker。例如： `${lastUpdated?datetime?string.short}`。 要询问程序员数据模型中确定的变量是否有这个问题， 或通常使用内建函数 `?date`，`?time` 和 `?datetime` 来安全处理。

不需和格式模式使用 `?date`, `?time` 或 `?datetime`， 比如 `"yyyy.MM.dd HH:mm"`，因为使用这些模式， 就告诉 FreeMarker 来显示哪部分日期。那么，FreeMarker 将盲目地相信你， 如果你显示的部分不存在于变量中，则可以显示"干扰"。例如， `${openingTime?string["yyyy-MM-dd hh:mm:ss a"]}`, 而 `openingTime` 中只存储了时间，将会显示 `1970-01-01 09:24:44 PM`。

要避免误解，需要的格式不是字符串，它可以是变量或任意表达式，比如 `"`...`"?string[myFormat]`。

请参考： 日期的插入

#### 布尔值内建函数

##### c (当用于布尔值时)

该内建函数从 FreeMarker 2.3.20 版本开始存在

该内建函数将布尔值转换为字符串，针对 计算机语言 而不是用户。不管 `boolean_format` 的设置是什么， 结果是 `"true"` 或 `"false"`。 当生成JavaScript的时候，应该会用到它，否则修改 `boolean_format` 的话可以打断生成的计算机语言输出。

请注意，该内建函数 对字符串也起作用。

##### string (当用于布尔值时)

该内建函数的所有用法都已经废弃了；请继续阅读下面内容。

将布尔值转换为字符串。可以两种方式来使用：

- `foo?string("yes", "no")`： 从 FreeMarker 2.3.23 版本开始废弃：使用 `?then("yes", "no")` 来替代。如果布尔值是true， 这会返回第一个参数(此处是：`"yes"`)， 否则返回第二个参数(此处是：`"no"`)。 请注意，返回值总是一个字符串；如果参数是数字，那么首先会转换成字符串。 也请注意，两个参数是评估过的，不管只有一个会被用到； 如果参数不仅仅是文字的话，这也许会有负面影响。

- `foo?string`： 从 FreeMarker 2.3.20 版本开始废弃：使用 `?c` 来代替，或者设置 `boolean_format` 设置项，比如像 `"yes,no"`，之后转换会自动发生。 如果仍然需要知道，这会转换布尔值为字符串，使用默认字符串来显示 true 和 false 值。默认情况下，true 被呈现为 `"true"`， 而 false 被呈现为 `"false"`。 如果使用 FreeMarker 来生成代码，这是很有用的 (但是从 2.3.20 版本开始， 请使用 `?c`)，因为这些值不是非本地化(语言，国家)敏感的。 要修改这些默认设置，可以使用 `boolean_format` 设置。

  请注意，在很少有的情况下， 当值是多类型且同时是布尔值和和字符串时，那么将会返回字符串值，所以 `boolean_format` 设置没有效果。

##### then

该内建函数从 FreeMarker 2.3.23 版本开始存在。

使用于 ``booleanExp`?then(`whenTrue`, `whenFalse`)`，就像是类C语言中的三元运算符 (也就是说，``booleanExp` ? `whenTrue` : `whenFalse``)。如果 ``booleanExp`` 评估为布尔值 true， 那么就评估并返回第一个参数，而若 ``booleanExp`` 评估为布尔值 false，那么就评估并返回它的第二个参数。当然，三个表达式可以是任意复杂的。 参数表达式可以是任意类型，也可以是不同类型。

该内建函数的一个重要特殊属性是只有一个参数表达式会被评估。 这和普通的方法调用不同，它们会评估所有的参数表达式，而不管方法是否需要它们。 这也就以为着不需要的参数也可以用于不存在的变量而不会引发错误。 (当然它不能是非法的语法。)

例如：

    <#assign foo = true>
    ${foo?then('Y', 'N')}

    <#assign foo = false>
    ${foo?then('Y', 'N')}

    <#assign x = 10>
    <#assign y = 20>
    <#-- Prints 100 plus the maximum of x and y: -->
    ${100 + (x > y)?then(x, y)}

    Y

    N

    120

如果需要选择非布尔值，可以使用 `switch` 内建函数 来替代嵌套多个 `then`，比如 `priority?switch(1, "low", 2, "medium", 3, "high")`，或者是 `true?switch(priority <= 1, "low", priority == 2, "medium", priority >= 3, "high")`。

#### 序列内建函数

##### chunk

该内建函数从 FreeMarker 2.3.3 版本开始存在。

该内建函数将序列分隔为多个序列，长度为第一个参数给定的值 (比如 `mySeq?chunk(3)`)。结果是包含这些序列的一个序列。 最后一个序列可能比给定的长度要小，除非第二个参数也给定了 (比如 比如 `mySeq?chunk(3, '-')`)， 这就是用来填充最后一个序列，以达到给定的长度。例如：

    <#assign seq = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']>

    <#list seq?chunk(4) as row>
      <#list row as cell>${cell} </#list>
    </#list>

    <#list seq?chunk(4, '-') as row>
      <#list row as cell>${cell} </#list>
    </#list>

将会输出：

      a b c d
      e f g h
      i j

      a b c d
      e f g h
      i j - -

该内建函数通常在输出的序列中使用表格/柱状的格式。 当被用于HTML表格时，第二个参数通常是`"\xA0"` (也就是不换行的空格代码，也就是我们所知的"nbsp")， 所以空TD的边界就不会不丢失。

第一个参数必须是一个数字，而且至少是1。如果这个数字不是整数， 那么它会被静默地去掉小数部分(也就是说3.1和3.9都会被规整为3)。 第二个参数可以是任意类型的值。

##### first

序列的第一个子变量。如果序列为空，那么模板处理将会中止。

##### join

使用给定的分隔符来连接序列中的项为一个独立的字符串，例如：

    <#assign colors = ["red", "green", "blue"]>
    ${colors?join(", ")}

将会输出：

    red, green, blue

序列中不是字符串的项会被转换为字符串，使用 `${`...`}` 相同的转换规则 (当然这里不会应用自动转义)。

`?join(`...`)` 最多可以有3个参数：

1. 分隔符，是必须的:插入到每一项中间的字符串

2. 空值，默认是 `""` (空字符串)： 如果序列为空，使用该值。

3. 列表结尾，默认是 `""` (空字符串): 如果列表序列不为空，该值在最后一个值后面输出。

所以 (这里 `[]` 意味着空序列)：

    ${colors?join(", ", "-")}
    ${[]?join(", ", "-")}

    ${colors?join(", ", "-", ".")}
    ${[]?join(", ", "-", ".")}

将会输出：

    red, green, blue
    -

    red, green, blue.
    -

来自Java的序列可能会包含 `null` 值。那些值会被该内建函数忽略， 就像它们从列表中被移除了。

##### last

序列的最后一个子变量。如果序列为空，那么模板处理将会中止。

##### reverse

序列的反序形式。

##### seq_contains

该内建函数从 FreeMarker 2.3.1 版本开始可用。 而在 2.3 版本中不存在。

`seq_` 前缀在该内建函数名字中是需要的， 用来和 `contains` 内建函数 区分开。contains 用来在字符串中查找子串 (因为变量可以同时当作字符串和序列)。

辨别序列中是否包含指定值。它包含一个参数，就是来查找的值。比如：

    <#assign x = ["red", 16, "blue", "cyan"]>
    "blue": ${x?seq_contains("blue")?string("yes", "no")}
    "yellow": ${x?seq_contains("yellow")?string("yes", "no")}
    16: ${x?seq_contains(16)?string("yes", "no")}
    "16": ${x?seq_contains("16")?string("yes", "no")}

将会输出：

    "blue": yes
    "yellow": no
    16: yes
    "16": no

为了查找值，该内建函数使用了 FreeMarker 的比较规则 (就像使用 `==` 操作符)，除了比较两个不同类型的值，或 FreeMarker 不支持的类型来比较， 其他都不会引起错误，只是会评估两个值不相等。因此，你可以使用它来查找标量值 (也就是字符串，数字，布尔值，或日期/时间类型)。 对于其他类型结果通常都是 `false`。

对于容错性，该内建函数还对 collection 起作用。

##### seq_index_of

该内建函数从 FreeMarker 2.3.1 版本开始可用。 而在 2.3 版本中不存在。

`seq_` 前缀在该内建函数名字中是需要的， 用来和 `index_of` 内建函数 区分开。index_of 用来在字符串中查找子串 (因为变量可以同时当作字符串和序列)。

返回序列中第一次出现该值时的索引位置， 如果序列不包含指定的值时返回 `-1`。 要查找的值作为第一个参数。比如这个模板：

    <#assign colors = ["red", "green", "blue"]>
    ${colors?seq_index_of("blue")}
    ${colors?seq_index_of("red")}
    ${colors?seq_index_of("purple")}

将会输出：

    2
    0
    -1

为了查找值，该内建函数使用了FreeMarker 的比较规则 (就像使用了 `==` 操作符)，除了比较两个不同类型的值，或 FreeMarker 不支持的类型来比较， 其他都不会引起错误，只是会评估两个值不相等。因此，你可以使用它来查找标量值 (也就是字符串，数字，布尔值，或日期/时间类型)。 对于其他类型结果通常是 `-1`。

搜索开始的索引值可以由第二个可选参数来确定。 如果在同一个序列中相同的项可以多次出现时，这是很有用的。 第二个参数的数值没有什么限制：如果它是负数，那么就和它是零的效果一样， 而如果它是比序列长度还大的数，那么就和它是序列长度值的效果一样。 小数值会被切成整数。比如：

    <#assign names = ["Joe", "Fred", "Joe", "Susan"]>
    No 2nd param: ${names?seq_index_of("Joe")}
    -2: ${names?seq_index_of("Joe", -2)}
    -1: ${names?seq_index_of("Joe", -1)}
     0: ${names?seq_index_of("Joe", 0)}
     1: ${names?seq_index_of("Joe", 1)}
     2: ${names?seq_index_of("Joe", 2)}
     3: ${names?seq_index_of("Joe", 3)}
     4: ${names?seq_index_of("Joe", 4)}

将会输出：

    No 2nd param: 0
    -2: 0
    -1: 0
     0: 0
     1: 2
     2: 2
     3: -1
     4: -1

##### seq_last_index_of

该内建函数从 FreeMarker 2.3.1 版本开始可用。而在2.3版本中不存在。

`seq_` 前缀在该内建函数名字中是需要的， 用来和 `last_index_of` 内建函数 区分开。last_index_of 用来在字符串中查找子串 (因为变量可以同时当作字符串和序列)。

返回序列中最后一次出现值的索引位置， 如果序列不包含指定的值时返回 `-1`。也就是说，和 `seq_index_of` 相同， 只是在序列中从最后一项开始向前搜索。 它也支持可选的第二个参数来确定从哪里开始搜索的索引位置。比如：

    <#assign names = ["Joe", "Fred", "Joe", "Susan"]>
    No 2nd param: ${names?seq_last_index_of("Joe")}
    -2: ${names?seq_last_index_of("Joe", -2)}
    -1: ${names?seq_last_index_of("Joe", -1)}
     0: ${names?seq_last_index_of("Joe", 0)}
     1: ${names?seq_last_index_of("Joe", 1)}
     2: ${names?seq_last_index_of("Joe", 2)}
     3: ${names?seq_last_index_of("Joe", 3)}
     4: ${names?seq_last_index_of("Joe", 4)}

将会输出：

    No 2nd param: 2
    -2: -1
    -1: -1
     0: 0
     1: 0
     2: 2
     3: 2
     4: 2

##### size

序列中子变量的数量(作为数字值)。假设序列中至少有一个子变量， 那么序列 `s` 中最大的索引是 `s?size - 1` (因为第一个子变量的序列是0)。

##### sort

以升序方式返回序列。(要使用降序排列时，使用它之后使用 `reverse` 内建函数。) 这仅在子变量都是字符串时有效，或者子变量都是数字，或者子变量都是日期值 (日期，时间，或日期+时间)，或者所有子变量都是布尔值时(从2.3.17版本开始)。 如果子变量是字符串，它使用本地化(语言)的具体单词排序(通常是大小写不敏感的)。比如：

    <#assign ls = ["whale", "Barbara", "zeppelin", "aardvark", "beetroot"]?sort>
    <#list ls as i>${i} </#list>

将会输出(至少是US区域设置)：

    aardvark Barbara beetroot whale zeppelin

##### sort_by

返回由给定的哈希表子变量来升序排序的哈希表序列。 (要降序排列使用该内建函数后还要使用 `reverse` 内建函数。) 这个规则和 `sort` 内建函数 是一样的， 除了序列中的子变量必须是哈希表类型，而且你不得不给哈希变量的命名， 那会用来决定排序顺序。比如：

    <#assign ls = [
      {"name":"whale", "weight":2000},
      {"name":"Barbara", "weight":53},
      {"name":"zeppelin", "weight":-200},
      {"name":"aardvark", "weight":30},
      {"name":"beetroot", "weight":0.3}
    ]>
    Order by name:
    <#list ls?sort_by("name") as i>
    - ${i.name}: ${i.weight}
    </#list>

    Order by weight:
    <#list ls?sort_by("weight") as i>
    - ${i.name}: ${i.weight}
    </#list>

将会输出(至少是US区域设置)：

    Order by name:
    - aardvark: 30
    - Barbara: 53
    - beetroot: 0.3
    - whale: 2000
    - zeppelin: -200

    Order by weight:
    - zeppelin: -200
    - beetroot: 0.3
    - aardvark: 30
    - Barbara: 53
    - whale: 2000

如果你用来排序的子变量的层次很深 (也就是说，它是子变量的子变量的子变量，以此类推)， 那么你可以使用序列来作为参数，它指定了子变量的名字， 来向下引导所需的子变量。比如：

    <#assign members = [
        {"name": {"first": "Joe", "last": "Smith"}, "age": 40},
        {"name": {"first": "Fred", "last": "Crooger"}, "age": 35},
        {"name": {"first": "Amanda", "last": "Fox"}, "age": 25}]>
    Sorted by name.last:
    <#list members?sort_by(['name', 'last']) as m>
    - ${m.name.last}, ${m.name.first}: ${m.age} years old
    </#list>

将会输出(至少是US区域设置)：

    Sorted by name.last:
    - Crooger, Fred: 35 years old
    - Fox, Amanda: 25 years old
    - Smith, Joe: 40 years old

#### 哈希表内建函数

##### keys

一个包含哈希表中查找到的键的序列。 请注意，并不是所有的哈希表都支持这个 (询问程序员一个指定的哈希表是否允许这么操作)。

    <#assign h = {"name":"mouse", "price":50}>
    <#assign keys = h?keys>
    <#list keys as key>${key} = ${h[key]}; </#list>

将会输出：

    name = mouse; price = 50;

因为哈希表通常没有定义子变量的顺序，那么键名称的返回顺序就是任意的。 然而，一些哈希表维持一个有意义的顺序(询问程序员指定的哈希表是否是这样)。 比如，由上述 `{`...`}` 语法创建的哈希表保存了和你指定子变量相同的顺序。

##### values

一个包含哈希表中子变量的序列。 注意并不是所有的哈希表都支持这个 (询问程序员一个指定的哈希表是否允许这么操作)。

至于返回的值的顺序，和内建函数 `keys` 的应用是一样的；看看上面的叙述就行了。

#### 结点(对于XML)内建函数

请注意，由这些内建函数返回的变量是由用于结点变量的实现生成的。 意思就是返回的变量可以有更多的特性，附加于它这里的状态。 比如，由内建函数 `children` 返回的序列和 XML DOM 结点 也可以被用作是哈希表或字符串， 这在 XML 处理部分 中有描述。

##### ancestors

一个包含所有结点祖先结点的序列，以直接父结点开始，以根结点结束。 该内建函数的结果也是一个方法，你可以用它和元素的 完全限定名 来过滤结果。 比如以名称 `section` 用 `node?ancestors("section")` 来获得所有祖先结点的序列。

##### children

一个包含该结点所有子结点(也就是直接后继结点)的序列。

XML：这和特殊的哈希表的键 `*` 几乎是一样的。 除了它返回所有结点，而不但是元素。所以可能的子结点是元素结点， 文本结点，注释结点，处理指令结点等，但 不是 属性结点。属性结点排除在序列之外。

##### node_name

当被"访问"时，返回用来决定哪个自定义指令来调用控制这个结点的字符串。 可以参见 visit 和 recurse 指令。

XML：如果结点是元素或属性，那么字符串就会是元素或属性的本地 (没有前缀)名字。否则，名称通常在结点类型之后以 `@` 开始。 可以参见 该表格。 要注意这个结点名称与在DOM API中返回的结点名称不同； FreeMarker 结点名称的目标是给要处理结点的用户自定义指令命名。

##### node_namespace

返回结点命名空间的字符串。FreeMarker 没有为结点命名空间定义准确的含义； 它依赖于变量是怎么建模的。也可能结点没有定义任何结点命名空间。 这种情形下，该函数应该返回未定义的变量 (也就是 `node?`node_namespace`??` 的值是 `false`)，所以不能使用这个返回值。

XML：这种情况下的XML，就是XML命名空间的URI (比如 `"http://www.w3.org/1999/xhtml"`)。 如果一个元素或属性结点没有使用XML命名空间，那么这个函数就返回一个空字符串。 对于其他XML结点这个函数返回未定义的变量。

##### node_type

描述结点类型的字符串。FreeMarker 没有对结点类型定义准确的含义； 它依赖于变量是怎么建模的。也可能结点并不支持结点类型。 在这种情形下，该函数就返回未定义值，所以就不能使用返回值。 (可以用 ``node`?node_type??` 继续检查一个结点是否是支持类型属性。)

XML：可能的值是： `"attribute"`， `"text"`， `"comment"`， `"document_fragment"`， `"document"`， `"document_type"`， `"element"`， `"entity"`， `"entity_reference"`， `"notation"`， `"pi"`。 请注意，没有 `"cdata"` 类型，因为CDATA被认为是普通文本元素。

##### parent

在结点树中，返回该结点的直接父结点。根结点没有父结点， 所以对于根结点，表达式 ``node`?parent??` 的值就是 `false`。

XML：注意通过这个函数返回的值也是一个序列 (当编写 `someNode[".."]` 时，和XPath表达式 `..` 的结果是一样的)。也要注意属性结点， 它返回属性所属的元素结点，尽管属性结点不被算作是元素的子结点。

##### root

该结点所属结点树的根结点。

XML：根据W3C，XML文档的根结点不是最顶层的元素结点， 而是文档本身，是最高元素的父结点。例如， 如果想得到被称为是 `foo` 的XML (所谓的"文档元素"，不要和"文档"搞混了)的最高 元素， 那么不得不编写 `someNode?root.foo`。如果仅仅写了 `someNode?root`，那么得到的是文档本身，而不是文档元素。

#### 循环变量内建函数

循环变量内建函数从 FreeMarker 2.3.23 版本开始存在。

这些内建函数只能用于`list` 和 `items` 指令 的循环变量 (也可以用于已经废弃的 `foreach` 指令)。 下面是一些说明(``loopVar`?index` 在可以列表的值中进行迭代，返回从0开始的索引)：

    <#-- Note: x is a loop variable -->
    <#list ['a', 'b', 'c'] as x>
      ${x?index}
    </#list>

    0
    1
    2

当 `list` 指令不指定循环变量时， 这些内建函数就作用于 `items` 指令的循环变量：

    <#list ['a', 'b', 'c']>
      <ul>
       <#items as x>
         <li>${x?index}</li>
       </#items>
      </ul>
    </#list>

循环变量内建函数仅仅用于循环变量的 名字， 所以它们可以识别相关进行的迭代。它们不读取循环变量的 值。因此，这就会有解析错误：

    <#list ['a', 'b', 'c'] as x>
      <#assign y = x>
      ${y?index} <#-- ERROR: y isn't a loop variable -->
    </#list>

##### counter

该内建函数从 FreeMarker 2.3.23 版本开始可用。

返回当前迭代(由循环变量名称识别)从1开始的索引。

    <#list ['a', 'b', 'c'] as i>
      ${i?counter}: ${i}
    </#list>

      1: a
      2: b
      3: c

要从0开始的索引，请使用 `index` 内建函数。

##### has_next

该内建函数从 FreeMarker 2.3.23 版本开始可用。

辨别循环项是否是当前迭代(由循环变量名称识别)的最后一项。

    <#list ['a', 'b', 'c'] as i>${i?has_next?c} </#list>

    true true false

使用逗号等隔开循环项，请使用 `<#sep>`separator`</#sep>` 来代替 `<#if `var`?has_next>`separator`</#if>`，这样可读性更强。(此外 `</#sep>` 经常被忽略，比如在 `<#list `...` as `var`>`...`${`var`}`...`<#sep>`separator`</#list>` 中)

如果需要对该内建函数取反，请使用 ``var`?is_last` 来代替 `!`var`?has_next`， 因为它的可读性更强。

##### index

该内建函数从 FreeMarker 2.3.23 版本开始可用。

返回当前迭代(由循环变量名称识别)从0开始的索引。

    <#list ['a', 'b', 'c'] as i>
      ${i?index}: ${i}
    </#list>

      0: a
      1: b
      2: c

要从1开始的索引，请使用 `counter` 内建函数。

##### is_even_item

该内建函数从 FreeMarker 2.3.23 版本开始可用。

辨别循环项是否是当前迭代(由循环变量名称识别)间隔1的奇数项。

    <#list ['a', 'b', 'c', 'd'] as i>${i?is_even_item?c} </#list>

    false true false true

要将表格进行行间变色等操作，请使用 ``var`?item_parity` 或 ``var`?item_cycle(...)` 来代替。

##### is_first

该内建函数从 FreeMarker 2.3.23 版本开始可用。

辨别循环项是否是当前迭代(由循环变量名称识别)的第一项。

    <#list ['a', 'b', 'c'] as i>${i?is_first?c} </#list>

    true false false

##### is_last

该内建函数从 FreeMarker 2.3.23 版本开始可用。

辨别循环项是否是当前迭代(由循环变量名称识别)的最后一项。

    <#list ['a', 'b', 'c'] as i>${i?is_last?c} </#list>

    false false true

如果需要对该内建函数取反，请使用 ``var`?has_next` 来代替 `!`var`?is_last`， 因为它的可读性更强。

使用逗号等隔开循环项，请使用 `<#sep>`separator`</#sep>` 来代替 `<#if `var`?has_next>`separator`</#if>`，因为它的可读性更强。(此外 `</#sep>` 经常被忽略，比如在 `<#list `...` as `var`>`...`${`var`}`...`<#sep>`separator`</#list>` 中)

##### is_odd_item

该内建函数从 FreeMarker 2.3.23 版本开始可用。

辨别循环项是否是当前迭代(由循环变量名称识别)间隔1的偶数项。

    <#list ['a', 'b', 'c', 'd'] as i>${i?is_odd_item?c} </#list>

    true false true false

要将表格进行行间变色等操作，请使用 ``var`?item_parity` 或 ``var`?item_cycle(...)` 来代替。

##### item_cycle

该内建函数从 FreeMarker 2.3.23 版本开始可用。

这是 `item_parity` 内建函数 更为通用的版本，这里可以指定何值来代替 `"odd"` 和 `"even"`。 它也允许多余两个值来循环。

    <#list ['a', 'b', 'c', 'd', 'e', 'f', 'g'] as i>
      <tr class="${i?item_cycle('row1', 'row2', 'row3')}">${i}</tr>
    </#list>

      <tr class="row1">a</tr>
      <tr class="row2">b</tr>
      <tr class="row3">c</tr>
      <tr class="row1">d</tr>
      <tr class="row2">e</tr>
      <tr class="row3">f</tr>
      <tr class="row1">g</tr>

一些细节：

- 参数的个数至少是1个，没有上限。

- 参数的类型是任意的，无需只是字符串。

如果需要`"odd"` 和 `"even"`，请使用 `item_parity` 内建函数 来代替。

##### item_parity

该内建函数从 FreeMarker 2.3.23 版本开始可用。

基于当前迭代(由循环变量名称识别)间隔为1的索引的奇偶性， 返回字符串值 `"odd"` 或 `"even"`。 这通常用于表格中行间的颜色变换：

    <#list ['a', 'b', 'c', 'd'] as i>
      <tr class="${i?item_parity}Row">${i}</tr>
    </#list>

      <tr class="oddRow">a</tr>
      <tr class="evenRow">b</tr>
      <tr class="oddRow">c</tr>
      <tr class="evenRow">d</tr>

请使用 `item_parity_cap` 内建函数 来大写 `"Odd"` 和 `"Even"`。请使用 `item_cycle` 内建函数 来指定自定义值，或多于两个值。

##### item_parity_cap

该内建函数从 FreeMarker 2.3.23 版本开始可用。

基于当前迭代(由循环变量名称识别)间隔为1的索引的奇偶性， 返回字符串值 `"Odd"` 或 `"Even"` (请注意大写)。

    <#list ['a', 'b', 'c', 'd'] as i>
      <tr class="row${i?item_parity_cap}">${i}</tr>
    </#list>

      <tr class="rowOdd">a</tr>
      <tr class="rowEven">b</tr>
      <tr class="rowOdd">c</tr>
      <tr class="rowEven">d</tr>

请使用 `item_parity` 内建函数 来小写 `"odd"` 和 `"even"`。

#### 独立类型内建函数

这些内建函数不(更多)关心它们左侧参数的类型。

##### switch

该内建函数从 FreeMarker 2.3.23 版本开始可用。

这是 `switch`-`case`-`default` 指令 的基本内联(表达式)版本。它的通用版本就像 ``matchedValue`?switch(`case1`, `result1`, `case2`, `result2`, ... `caseN`, `resultN`, `defaultResult`)`，这里的 ``defaultResult`` 可以被忽略。比如：

    <#list ['r', 'w', 'x', 's'] as flag>
      ${flag?switch('r', 'readable', 'w' 'writable', 'x', 'executable', 'unknown flag: ' + flag)}
    </#list>

      readable
      writable
      executable
      unknown flag: s

也就是说， `switch` 会找到第一个 ``case`` 和参数 (从左到右)值 ``matchedValue`` 相等， 之后返回直接在 ``case`` 参数后的 ``result`` 参数的值， 如果它没有找到一个相等的 ``case``，那么就返回 ``defaultResult`` 的值，如果没有 ``defaultResult`` 参数 (换言之，参数的个数是基数)，那么就发生错误中止模板处理。

更多细节：

- The comparison of ``matchedValue`` 和 ``case`` 参数值的比较， 就像 `==` 操作符。那就只比较标量并且是相同类型的值。因此，诸如 `x?switch(1, "r1", "c2", "r2")` 就没有意思。就像 `x` 是非数字值，那么第一个case就会引发错误， 若 `x` 是数字值，那么第二个case就会引发错误 (除非 `x` 是 `1`， 那么就不会在第一个参数之后做更多的比较)。

- 不像普通的方法调用， `switch(`...`)` 的那些参数被评估为确实需要的。比如，在 `two()?switch(c1(), r1(), c2(), r2(), c3(), r3())` 中，如果 `two()` 返回 `2`， `c1()` 返回 `1`， 且 `c2()` 返回 `2`，那么只有下面的函数会被调用，而且顺序是这样： `m()`， `c1()`，`c2()`， `r2()`。(很自然地， 参数不被评估可以指向不存在的变量而不会引发错误。) 它保证了 ``case`` 参数表达式被从左到右进行评估，直到第一个匹配项被找到。 它也保证了只有属于第一个匹配 ``case`` 的 ``result`` 表达式会被评估。它还保证了如果没有匹配的 ``case`` 参数，那么 ``defaultResult`` 表达式会被评估。

- ``case`` 参数表达式不需要是常量值，它们可以是任意复杂的表达式。 当然，逻辑在 ``result``， ``defaultResult`` 和 ``matchedValue`` 中也是相同的。

- 对 ``case`` 参数值的类型没有任何限制，比如它们可以是字符串，或数字，或日期等... 但因为 `==` 操作符的特性，那么在 `相同的` `switch` 中使用不同类型的 ``case`` 参数是没有意义的 (请参考之前的解释)。

- 不像使用 `case` 指令，那里没有向下通过的行为，也就是说，不需要相等的 `break` 指令。

如果需要对布尔值进行switch操作，那么应该使用 `then` 内建函数 来代替，比如 ``matchedBoolean`?then(`whenTrue`, `whenFalse`)`。

如果需要在 ``case`` 参数中进行任意的逻辑测试来代替简单的相等比较，那么可以这么来做 (这里我们测试范围)： `true?switch(priority <= 1, "low", priority == 2, "medium", priority >= 3, "high")`

#### 很少使用的和专家级的内建函数

这些是你通常情况下不应该使用的内建函数， 但是在特殊情况下(调试，高级宏)它们会有用。 如果你需要在普通页面模板中使用这些函数， 你可能会重新访问数据模型，所以你不要使用它们。

##### api, has_api

这些内建函数从 FreeMarker 2.3.22 版本开始存在。

如果value本身支持这个额外的特性， ``value`?api` 提供访问 ``value`` 的API (通常是 Java API)，比如 ``value`?api.`someJavaMethod()``， 当需要调用对象的Java方法时，这种方式很少使用， 但是 FreeMarker 揭示的value的简化视图的模板隐藏了它，也没有相等的内建函数。 例如，当有一个 `Map`，并放入数据模型 (使用默认的对象包装器)，模板中的 `myMap.myMethod()` 基本上翻译成Java的 `((Method) myMap.get("myMethod")).invoke(...)`，因此不能调用 `myMethod`。如果编写了 `myMap?api.myMethod()` 来代替，那么就是Java中的 `myMap.myMethod()`。

尽可能地应避免使用 `api`， 基于FTL类型和相关内建函数的功能。 例如，不要使用 `users?api.size()`，但可以使用 `users?size`。使用 `?api` 的变化是很累赘的，更慢， 当 FreeMarker 配置设置修改时容易失败，最重要的是， 当数据模型的技术细节改变时更容易失败。例如，如果 `users` 由 `List` 变为数组，那么 `users?size` 继续有效，而 `users?api.size()` 就会失败。

由于一些原因，避免调用 修改 对象 (特别是 `Map` 和 `Collection`) 或非线程安全的方法。 模板通常也不希望去修改暴露于它们的对象，只是展示它们。 因此应用程序可能会传递一些对象到多个(可能是并发的)模板处理中。

`api` 内建函数不是到处都可用的， 有一些需求会遇到：

- `api_builtin_enabled` 配置设置项必须设置为 `true`。为了不降低已有应用程序的安全性，它的默认值是 `false` (至少在 2.3.22 版本中)。

- 值本身要支持它。我们在讨论当模板看到的值，它是通过 对象包装 从原始对象值(来自于数据模型或者Java方法的返回值)中创建的。 因此，这就依赖 FreeMarker 的配置设置项 `object_wrapper`， 还有被包装的(原始)对象：

  - 当对象包装器是 `DefaultObjectWrapper` ，并且它的 `incompatibleImprovements` 设置为 2.3.22 或更高 (在这里看如何设置它) (事实上，要做的是将它的 `useAdaptersForContainer` 属性设置为 `true`，但那是提到的 `incompatibleImprovements` 的默认值)时，从 `Map` 和 `List` 中得到FTL值支持 `?api`。其它的 `java.util.Collections` 也是这样，如果 `DefaultObjectWrapper` 的 `forceLegacyNonListCollections` 属性设置为 `false` (默认是 `true`， 这是为了更好的向后兼容拆包)。

  - 当被纯 `BeansWrapper` 包装时，所有值都支持 `?api`。但是再次重申，如果有其它方法，就避免使用它。

  - 实现了 `freemarker.template.TemplateModelWithAPISupport` 接口， 自定义的 `TemplateModel` 可以支持 `?api`。

当在配置中不允许或值本身不支持 `?api` 时使用了它， 就会中止模板处理并发生错误。

一个值是否支持 `?api` 可以通过 ``value`?has_api` 来检测， 返回一个布尔值。请注意，`?has_api` 的结果不受 `api_builtin_enabled` 设置的影响。

##### byte, double, float, int, long, short

返回一个包含原变量中相同值的 `SimpleNumber`， 但是在内部表示值中使用了 `java.lang.`Type``。 如果方法被重载了，这是有用的，或者一个 `TemplateModel` 解包器在自动选择适合的 `java.lang.*` 类型有问题时。 请注意，从2.3.9版本开始，解包器有本质上改进， 所以将基本不会使用到这些内建函数来转换数字类型了， 除非在重载方法调用中来解决一些含糊的东西。

内建函数 `long` 也可以用于日期， 时间和时间日期类型的值来获取返回为 `java.util.Date.getTime()` 的值。如果你不得不调用使用 `long` 类型时间戳的Java方法时， 这是非常有用的。这个转换不是自动进行的。

##### eval

这个函数求一个作为FTL表达式的字符串的值。比如 `"1+2"?eval`返回数字3。

在调用 `eval` 的地方， 已被求值的表达式看到相同的变量(比如本地变量)是可见的。 也就是说，它的行为就像在 ``s`?eval` 处， 你有 ``s`` 的 值。除了，指向在 ``s`` 之外创建的循环变量，它不能使用 循环变量内建函数。

配置设置项影响来自 `Configuration` 对象表达式解析(比如语法)，而不是来自调用 `eval` 的的模板。

##### has_content

如果变量(不是Java的 `null`) 存在而且不是"空"就返回 `true`，否则返回 `false`。"空”"含义靠具体的情形来决定。 它是直观的常识性概念。下面这些都是空：长度为0的字符串， 没有子变量的序列或哈希表，一个已经超过最后一项元素的集合。 如果值不是字符串，序列，哈希表或集合，如果它是数字，日期或布尔值 (比如 `0` 和 `false` 是非空的)， 那么它被认为是非空的，否则就是空的。注意当你的数据模型实现了多个模板模型接口， 你可能会得到不是预期的结果。然而，当你有疑问时你通常可以使用 `expr!?size > 0` 或 `expr!?length > 0` 来代替 `expr?has_content`。

这个函数是个特殊的函数，你可以使用像 默认值操作符 那样的圆括号手法。也就是说，你可以编写 `product.color?has_content` 和 `(product.color)?has_content` 这样的代码。 第一个没有控制当 `product` 为空的情形，而第二个控制了。

##### interpret

该内建函数解析字符串作为FTL模板，而且返回一个用户自定义指令， 也就是当应用于任意代码块中时，执行模板就像它当时 `被包含` 一样。例如：

    <#assign x=["a", "b", "c"]>
    <#assign templateSource = r"<#list x as y>${y}</#list>">
    <#-- Note: That r was needed so that the ${y} is not interpreted above -->
    <#assign inlineTemplate = templateSource?interpret>
    <@inlineTemplate />

将会输出：

    abc

正如你看到的，`inlineTemplate` 是用户自定义指令， 也就是当被执行时，运行当时内容是是 `templateSource` 值的模板。

配置设置项影响来自 `Configuration` 对象的解析(比如标签语法和命名转换)，而不是来自调用 `interpret` 的模板。 这也就以为着之前的自动探测标签语法或命名转换不会影响已解释模板的解析。 这也和 `include` 指令 的工作方式一致。

通过 `interpret` 创建的模板名称就是模板调用 `interpret` 的名称，并加上 `"->anonymous_interpreted"`。例如， 如果模板调用的内建函数是 `"foo/bar.ftl"`， 那么结果模板的名称就是 `"foo/bar.ftl->anonymous_interpreted"`。 因此，在已解释模板中的相对路径也就相对于该路径 (也就是说，根路径就是 `"foo"`)， 而且在已解释模板内部的错误将会指向这个生成的模板名称。

要得到更多有用的错误消息，可以在 `"->"` 之后覆盖模板名称部分。例如，我们说 `mailTemplateSource` 来自于数据库表 `mail_template`，那么在错误时， 想得到包含数据库ID的失败模板的错误日志：

    <#assign inlineTemplate = [mailTemplateSource, "mail_templates id=${mailTemplateId}"]?interpret>

正如你看到的，`interpret` 可以应用于有两项的序列， 这里的第一项是要解释的FTL字符串，第二项是在 `"->"` 之后使用的模板名称。

##### is_...

这些内建函数用来检查变量的类型，然后根据类型返回 `true` 或 `false`。 下面是 `is_`...`` 内建函数列表：

内建函数 | 如果值是 … 时返回 `true`
--- | ---
`is_string` | 字符串
`is_number` | 数字
`is_boolean` | 布尔值
`is_date` | 不要使用它！使用 `is_date_like` 来代替， 它们是相同的。往后也许会修改它的含义为 `date_only`。
`is_date_like` | 日期，也就似乎日期，时间或者日期-时间， 亦或者是未知精确类型的日期(从 FreeMarker 2.3.21 版本开始)
`is_date_only` | 日期 (没有时间部分) (从 FreeMarker 2.3.21 版本开始)
`is_time` | 时间 (没有年-月-日部分) (从 FreeMarker 2.3.21 版本开始)
`is_datetime` | 日期-时间 (包含年-月-日和时间两者)
`is_unknown_date_like` | 不清楚是日期或时间或日期-时间的日期
`is_method` | 方法
`is_transform` | 变换
`is_macro` | 宏或函数(当然，由于历史问题，也对函数有效)
`is_hash` | 哈希表 (包含扩展的哈希表)
`is_hash_ex` | 扩展的哈希表 (支持 `?keys` 和 `?values`)
`is_sequence` | 序列
`is_collection` | 集合 (包含扩展的集合)
`is_collection_ex` | 扩展的集合 (支持 `?size`)
`is_enumerable` | 序列或集合
`is_indexable` | 序列
`is_directive` | 指令类型 (例如宏 或 `TemplateDirectiveModel`， `TemplateTransformModel`, 等...)， 或者函数 (由于历史问题)
`is_node` | 结点

##### namespace

该内建函数返回和宏变量或函数变量关联的命名空间 (也就是命名空间的"入口"哈希表)。你只能和宏和函数一起来用它。

##### new

这是用来创建一个确定的 `TemplateModel` 实现变量的内建函数。

在 `?` 的左边你可以指定一个字符串， 是 `TemplateModel` 实现类的完全限定名。 结果是调用构造方法生成一个方法变量，然后将新变量返回。

比如：

    <#-- Creates an user-defined directive be calling the parameterless constructor of the class -->
    <#assign word_wrapp = "com.acmee.freemarker.WordWrapperDirective"?new()>
    <#-- Creates an user-defined directive be calling the constructor with one numerical argument -->
    <#assign word_wrapp_narrow = "com.acmee.freemarker.WordWrapperDirective"?new(40)>

更多关于构造方法参数被包装和如何选择重载的构造方法信息， 请阅读： pgui_misc_beanwrapper

该内建函数可以是出于安全考虑的， 因为模板作者可以创建任意的Java对象，只要它们实现了 `TemplateModel` 接口，然后来使用这些对象。 而且模板作者可以触发没有实现 `TemplateModel` 接口的类的静态初始化块。你可以(从 2.3.17版开始)使用 `Configuration.setNewBuiltinClassResolver(TemplateClassResolver)` 或设置 `new_builtin_class_resolver` 来限制这个内建函数对类的访问。 参考Java API文档来获取详细信息。如果允许并不是很可靠的用户上传模板， 那么你一定要关注这个问题。

##### number_to_date, number_to_time, number_to_datetime

它们被用来转换数字(通常是Java的 `long`类型)到日期， 时间或时间日期类型。这就使得它们和Java中的 `new java.util.Date(long)` 是一致的。那也就是说， 现在数字可以被解释成毫秒数进行参数传递。数字可以是任意内容和任意类型， 只要它的值可以认为是 `long` 就行。如果数字不是完整的， 那么它就会根据"五入"原则进行进位。这个转换不是自动进行的。

比如：

    ${1305575275540?number_to_datetime}
    ${1305575275540?number_to_date}
    ${1305575275540?number_to_time}

将会输出这样的内容(基于当前的本地化设置和时区)：

    May 16, 2011 3:47:55 PM
    May 16, 2011
    3:47:55 PM

### 指令参考

#### Alphabetical index

基于 FreeMarker 2.3.23，对指令名可以使用驼峰形式来代替全小写形式， 比如 `noParse` 来代替 `noparse`。 但是要知道在相同的模板中，FreeMarker 对所有标识符会强制使用驼峰形式， 这是模板语言的一部分(用户自定义名称不受影响)。

- assign

- attempt

- break: in switch, in list

- case

- compress

- default

- else: in if, in list

- elseif

- escape

- fallback

- function

- flush

- ftl

- global

- if

- import

- include

- items

- list

- local

- lt

- macro

- nested

- noescape

- noparse

- nt

- recover

- recurse

- return: in macro, in function

- rt

- sep

- setting

- stop

- switch

- t

- User-defined directive (<@...>)

- visit

如果在这里没有发现模板中使用的指令，那么可能会在 ref_deprecated 中找到。

#### assign

##### 概要

    <#assign name1=value1 name2=value2 ... nameN=valueN>
    或
    <#assign same as above... in namespacehash>
    或
    <#assign name>
      capture this
    </#assign>
    或
    <#assign name in namespacehash>
      capture this
    </#assign>

这里：

- ``name``：变量的名字。 它不是表达式。而它可以写作是字符串，如果变量名包含保留字符这是很有用的， 比如 `<#assign "foo-bar" = 1>`。 请注意这个字符串没有展开插值(如`"${foo}"`)； 如果需要赋值一个动态创建的名字，那么不得不使用 这个技巧。

- `=`：赋值操作符。 它也可以是一个简写的赋值操作符(从 FreeMarker 2.3.23 版本开始)： `++`，`--`， `+=`，`-=`， `*=`，`/=` 或 `%=`。比如 `<#assign x++>` 和 `<#assign x = x + 1>` 是一样的，并且 `<#assign x += 2>` 和 `<#assign x = x + 2>` 是相同的。 请注意， `++` 通常意味着算术加法 (对于非数字将会失败)，不像 `+` 或 `+=` 可以进行字符连接等重载操作。

- ``value``： 存储的值。是表达式。

- ``namespacehash``：(通过 `import`) 为命名空间创建的哈希表。是表达式。

##### 描述

使用该指令你可以创建一个新的变量， 或者替换一个已经存在的变量。注意仅仅顶级变量可以被创建/替换 (也就是说你不能创建/替换 `some_hash.subvar`， 除了 `some_hash`)。

关于变量的更多内容，请阅读：dgui_misc_var

比如：变量 `seq` 存储一个序列：

    <#assign seq = ["foo", "bar", "baz"]>

比如：变量 `x` 中存储增长的数字：

    <#assign x++>

作为一个方便的特性，你可以使用一个 `assign` 标记来进行多次定义。比如这个会做上面两个例子中相同的事情：

    <#assign
      seq = ["foo", "bar", "baz"]
      x++
    >

如果你知道什么是命名空间：`assign` 指令在命名空间中创建变量。通常它在当前的命名空间 (也就是和标签所在模板关联的命名空间)中创建变量。但如果你是用了 `in `namespacehash``， 那么你可以用另外一个 命名空间 来创建/替换变量。 比如，这里你在命名空间中 `/mylib.ftl` 创建/替换了变量 `bgColor`：

    <#import "/mylib.ftl" as my>
    <#assign bgColor="red" in my>

`assign` 的极端使用是当它捕捉它的开始标记和结束标记中间生成的输出时。 也就是说，在标记之间打印的东西将不会在页面上显示， 但是会存储在变量中。比如：

    <#macro myMacro>foo</#macro>
    <#assign x>
      <#list 1..3 as n>
        ${n} <@myMacro />
      </#list>
    </#assign>
    Number of words: ${x?word_list?size}
    ${x}

将会输出：

    Number of words: 6
        1 foo
        2 foo
        3 foo

请注意，你不应该使用它来往字符串中插入变量：

    <#assign x>Hello ${user}!</#assign> <#-- BAD PRACTICE! -->

你可以这么来写：

    <#assign x="Hello ${user}!">

#### attempt, recover

##### 概要

    <#attempt>
      attempt block
    <#recover>
      recover block
    </#attempt>

这里：

- ``attempt block``：任意内容的模板块。这是会被执行的， 但是如果期间发生了错误，那么这块内容的输出将会回滚， 之后 ``recover block`` 就会被执行。

- ``recover block``: 任意内容的模板块。 这个仅在 ``attempt block`` 执行期间发生错误时被执行。你可以在这里打印错误信息或其他操作。

``recover`` 是强制的。 `attempt`/`recover` 可以嵌套在其他 ``attempt block`` 或 ``recover block``中。

上面的格式是从 2.3.3 版本开始支持的，之前它是 `<#attempt>`...`<#recover>`...`</#recover>`，也支持向下兼容。此外， 这些指令是在 FreeMarker 2.3.1 版本时引入的，在 2.3 版本中是不存在的。

##### 描述

如果你想让页面成功输出内容，尽管它在页面特定位置发生错误也这样， 那么这些指令就是有用的。如果一个错误在 ``attempt block`` 执行期间发生， 那么模板执行就会中止，但是 ``recover block`` 会代替 ``attempt block`` 执行。 如果在 ``attempt block`` 执行期间没有发生错误， 那么 ``recover block`` 就会忽略。 一个简单的示例如下：

    Primary content
    <#attempt>
      Optional content: ${thisMayFails}
    <#recover>
      Ops! The optional content is not available.
    </#attempt>
    Primary content continued

如果 `thisMayFails` 变量不存在，将会输出：

    Primary content
      Ops! The optional content is not available.
    Primary content continued

如果 `thisMayFails` 变量存在而且值为 `123`，将会输出：

    Primary content
      Optional content: 123
    Primary content continued

``attempt block`` 块有多或没有的语义：不管 ``attempt block``块的完整内容是否输出(没有发生错误)， 或者在 ``attempt block`` (没有发生错误)块执行时没有输出结果。比如，上面的示例， 发生在"Optional content"之后的失败被打印出来了，而没有在"Ops！"之前输出。 (这是在 ``attempt block`` 块内，侵入的输出缓冲的实现，甚至连 `flush` 指令也会送输出到客户端。)

为了阻止来自上面示例的误解： `attempt`/`recover` 不(仅仅)是处理未定义变量(可以使用 不存在变量控制符)。 它可以处理发生在块执行期间的各种类型的错误 (而不是语法错误，这会在执行之前被检测到)。它的目的是包围更大的模板段， 错误可能发生在很多地方。比如，你在模板中有一个部分，来处理打印广告， 但是它不是页面的主要内容，所以你不想你的页面因为一些打印广告 (也可能是短暂的数据库服务器故障)的错误而挂掉。 所以你将整个广告区域放在 ``attempt block`` 块中。

在一些环境下，程序员配置 FreeMarker，所以对于特定的错误， 它不会中止模板的执行，在打印一些错误提示信息到输出 (更多内容，请参考 这里...)中之后， 而是继续执行。`attempt` 指令不会将这些抑制的错误视为错误。

在 ``recover block`` 块中，错误的信息存在 特殊变量 `error` 中。 不要忘了以点开始引用特殊变量(比如：`${.error}`)。

在模板执行期间发生的错误通常被 日志记录，不管是否发生在 ``attempt block``块中。

#### compress

##### 概要

    <#compress>
      ...
    </#compress>

##### 描述

当你使用了对空白不敏感的格式(比如HTML或XML) 时压缩指令对于移除多余的 空白 是很有用的。它捕捉在指令体(也就是在开始标签和结束标签中)中生成的内容， 然后缩小所有不间断的空白序列到一个单独的空白字符。 如果被替代的序列包含换行符或是一段空间，那么被插入的字符也会是一个 换行符。 开头和结尾的不间断的空白序列将会完全被移除。

    <#assign x = "    moo  \n\n   ">
    (<#compress>
      1 2  3   4    5
      ${moo}
      test only

      I said, test only

    </#compress>)

将会输出：

    (1 2 3 4 5
    moo
    test only
    I said, test only)

#### escape, noescape

##### 概要

    <#escape identifier as expression>
      ...
      <#noescape>...</#noescape>
      ...
    </#escape>

##### 描述

当你使用escape指令包围模板中的一部分时，在块中出现的插值 (`${`...`}`) 会和转义表达式自动结合。这是一个避免编写相似表达式的很方便的方法。 它不会影响在字符串形式的插值(比如在 `<#assign x = "Hello ${user}!">`)。而且，它也不会影响数值插值 (`#{`...`}`)。

例如：

    <#escape x as x?html>
      First name: ${firstName}
      Last name: ${lastName}
      Maiden name: ${maidenName}
    </#escape>

事实上它等同于：

      First name: ${firstName?html}
      Last name: ${lastName?html}
      Maiden name: ${maidenName?html}

请注意，它和你在指令中用什么样的标识符无关 - 它仅仅是作为一个转义表达式的正式参数。

当在调用宏或者 `include` 指令时， 理解 在模板文本 中转义仅仅对出现在 `<#escape `...`>` 和 `</#escape>` 中的插值起作用是很重要的。 也就是说，它不会转义文本中 `<#escape `...`>` 之前的东西或 `</#escape>` 之后的东西， 也不会从 `escape` 的部分中来调用。

    <#assign x = "<test>">
    <#macro m1>
      m1: ${x}
    </#macro>
    <#escape x as x?html>
      <#macro m2>m2: ${x}</#macro>
      ${x}
      <@m1/>
    </#escape>
    ${x}
    <@m2/>

将会输出：

      &lt;test&gt;
      m1: <test>
    <test>
    m2: &lt;test&gt;

从更深的技术上说， `escape` 指令的作用是用在模板解析的时间而不是模板处理的时间。 这就表示如果你调用一个宏或从一个转义块中包含另外一个模板， 它不会影响在宏/被包含模板中的插值，因为宏调用和模板包含被算在模板处理时间。 另外一方面，如果你用一个转义区块包围一个或多个宏声明(算在模板解析时间，和宏调用想法)， 那么那些宏中的插值将会和转义表达式合并。

有时需要暂时为一个或两个在转义区块中的插值关闭转义。你可以通过关闭， 过后再重新开启转义区块来达到这个功能，但是那么你不得不编写两遍转义表达式。 你可以使用非转义指令来替代：

    <#escape x as x?html>
      From: ${mailMessage.From}
      Subject: ${mailMessage.Subject}
      <#noescape>Message: ${mailMessage.htmlFormattedBody}</#noescape>
      ...
    </#escape>

和这个是等同的：

      From: ${mailMessage.From?html}
      Subject: ${mailMessage.Subject?html}
      Message: ${mailMessage.htmlFormattedBody}
      ...

转义可以被嵌套(尽管你不会在罕见的情况下来做)。 因此，你可以编写如下面代码(这个例子固然是有点伸展的， 正如你可能会使用 `list` 来迭代序列中的每一项， 但是我们现在所做的是阐述这个观点)的东西：

    <#escape x as x?html>
      Customer Name: ${customerName}
      Items to ship:
      <#escape x as itemCodeToNameMap[x]>
        ${itemCode1}
        ${itemCode2}
        ${itemCode3}
        ${itemCode4}
      </#escape>
    </#escape>

实际上和下面是等同的：

      Customer Name: ${customerName?html}
      Items to ship:
        ${itemCodeToNameMap[itemCode1]?html}
        ${itemCodeToNameMap[itemCode2]?html}
        ${itemCodeToNameMap[itemCode3]?html}
        ${itemCodeToNameMap[itemCode4]?html}

当你在嵌入的转义区块内使用非转义指令时，它仅仅不处理一个单独层级的转义。 因此，为了在两级深的转义区块内完全关闭转义，你需要使用两个嵌套的非转义指令。

#### flush

##### 概要

    <#flush>

##### 描述

当 FreeMarker 生成输出时，它通常不会立即发送到最终接收端 (比如web浏览器或最终的文件)，而是会将内容累积在缓冲区，发送一个大块的内容。 缓冲区的精确规则不是由 FreeMarker 决定的，而是由嵌入的软件决定的。 将缓冲区中累积的内容发送出去称为冲洗。尽管冲洗是自动发生的， 有时你想在模板处理时的一点强制执行，这就是 `flush` 指令要做的。如果需要在确定之处用到它，这是由程序员决定的，而不是设计师。

请注意， `flush` 告诉嵌入的软件我们想要冲洗， 那么也许就会决定忽略该请求。这不由 FreeMarker 之手控制。

冲洗简单调用当前使用 `java.io.Writer` 实例的 `flush()` 方法。 整个缓冲区和冲洗机制由 `Writer`(就是传递给 `Template.process` 方法的参数)实现； FreeMarker不用来处理它。

#### ftl

##### 概要

    <#ftl param1=value1 param2=value2 ... paramN=valueN>

这里：

- ``param1``, ``param2`` 等： 参数的名字，不是表达式。允许的参数有： `encoding`， `strip_whitespace`， `strip_text` 等。参见下面。

- ``value1``, ``value2`` 等： 参数的值。必须是一个常量表达式(如 `true`， 或 `"ISO-8859-5"`，或 `{x:1, y:2}`)。它不能用变量。

##### 描述

告诉 FreeMarker 和其他工具关于模板的信息， 而且帮助程序员来自动检测一个文本文件是否是 FTL 文件。该指令， 如果存在，必须是模板的第一句代码。该指令前的任何 空白 将被忽略。 该指令的老式语法(`#`-less)格式是不支持的。

一些设置(编码方式，空白剥离等)在这里给定的话就有最高的优先级， 也就是说，它们直接作用于模板而不管其他任何 FreeMarker 的配置设置。

参数：

- `encoding`： 使用它，你可以在模板文件本身中为模板指定编码方式(字符集) (也就是说，这是新创建 `Template` 的 `encoding` 设置， 而且 `Configuration.getTemplate` 中的 `encoding` 参数不能覆盖它)。要注意， FreeMarker 会尝试会和自动猜测的编码方式 (这依赖于程序员对 FreeMarker 的配置)找到 `ftl` 指令并解释它，然后就会发现 `ftl` 指令会让一些东西有所不同，之后以新的编码方式来重新读取模板。 因此，直到 `ftl` 标记使用第一个编码方式读取到结尾， 模板必须是合法的FTL。 这个参数的合法值是从IANA字符集注册表中参考MIME中的字符集名称。 比如 ISO-8859-5，UTF-8 或 Shift_JIS。

- `strip_whitespace`： 这将开启/关闭 空白剥离。 合法的值是布尔值常量 `true` 和 `false` (为了向下兼容，字符串 `"yes"`，`"no"`， `"true"`，`"false"` 也是可以的)。 默认值(也就是当你不使用这个参数时)是依赖于程序员对 FreeMarker 的配置， 但是对新的项目还应该是 `true`。

- `strip_text`：当开启它时， 当模板被解析时模板中所有顶级文本被移除。这个不会影响宏，指令，或插值中的文本。 合法值是布尔值常量 `true` 和 `false` (为了向下兼容，字符串 `"yes"`，`"no"`， `"true"`，`"false"` 也是可以的)。 默认值(也就是当你不使用这个参数时)是 `false`。

- `strict_syntax`：这会开启/关闭"严格的语法"。 合法值是布尔值常量 `true` 和 `false` (为了向下兼容，字符串 `"yes"`，`"no"`， `"true"`，`"false"` 也是可以的)。 默认值(也就是当你不使用这个参数时)是依赖于程序员对 FreeMarker 的配置， 但是对新的项目还应该是 `true`。(程序员：对于 `config.setStrictSyntaxMode(true);` 你必须明确设置它为 `true`) 要获取更多信息，可以参考：ref_depr_oldsyntax

- `ns_prefixes`：这是关联结点命名空间前缀的哈希表。 比如：`{"e":"http://example.com/ebook", "vg":"http://example.com/vektorGraphics"}`。这通常是用于XML处理的， 前缀可以用于XML查询，但是它也影响 指令 `visit` 和 `recurse`的工作。 相同结点的命名空间只能注册一个前缀(否则会发生错误)， 所以在前缀和结点命名空间中是一对一的关系。前缀 `D` 和 `N` 是保留的。如果你注册前缀 `D`， 那么除了你可以使用前缀 `D` 来关联结点命名空间， 你也可以设置默认的结点命名空间。前缀 `N` 不能被注册； 当且仅当前缀 `D` 被注册时， 它被用来表示在特定位置没有结点命名空间的结点。 (要参考默认结点命名空间的用法，`N`，一般的前缀， 可以参考 XML 处理 和 `visit` 和 `recurse`)。`ns_prefixes` 的作用限制在单独的 FTL 命名空间内， 换句话说，就是为模板创建的FTL命名空间内。这也意味着 `ns_prefixes` 当一个FTL命名空间为包含它的模板所创建时才有作用， 否则 `ns_prefixes` 参数没有效果。FTL命名空间当下列情况下为模板创建： (a)模板是"主"模板，也就是说它不是被 `<#include ...>` 来调用的模板，但是直接被调用的(和类 `Template` 或 `Environment` 中的Java方法 `process`)； (b)模板直接被 `<#import ...>` 调用。

- `attributes`：这是关联模板任意属性(名-值对)的哈希表。 属性的值可以是任意类型(字符串，数字，序列等)。FreeMarker 不会尝试去理解属性的含义。 它是由封装 FreeMarker(比如Web应用框架)的应用程序决定的。 因此，允许的属性的设置是它们依赖的应用(Web应用框架)的语义。 程序员：你可以通过关联 `Template` 对象的 `getCustomAttributeNames` 和 `getCustomAttribute` 方法 (从 `freemarker.core.Configurable` 继承而来)获得属性。 如当模板被解析时，关联 `Template` 对象的模板属性， 属性可以在任意时间被读取，而模板不需要被执行。 上面提到的方法返回未包装的属性值，也就是说， 使用 FreeMarker 独立的类型，如 `java.util.List`。

该指令也决定模板是否使用尖括号语法(比如 `<#include 'foo.ftl'>`)或 方括号语法 (如 `[#include 'foo.ftl']`)。简单而言， 该指令使用的语法将会是整个模板使用的语法， 而不管 FreeMarker 是如何配置的。

#### function, return

##### 概要

    <#function name param1 param2 ... paramN>
      ...
      <#return returnValue>
      ...
    </#function>

这里：

- ``name``：方法变量的名称(不是表达式)

- ``param1``, ``param2`` 等： 局部变量的名称， 存储参数的值(不是表达式)，在 `=` 号后面和默认值 (是表达式)是可选的。

- ``paramN``，最后一个参数， 可以可选的包含一个尾部省略(`...`)， 这就意味着宏接受可变的参数数量。局部变量 ``paramN`` 将是额外参数的序列。

- ``returnValue``： 计算方法调用值的表达式。

`return` 指令可以在 `<#function `...`>` 和 `</#function>` 之间被用在任意位置和任意次数。

没有默认值的参数必须在有默认值参数 (``paramName`=`defaultValue``) 之前

##### 描述

创建一个方法变量(在当前命名空间中，如果你知道命名空间的特性)。 这个指令和 `macro` 指令 的工作方式一样，除了 `return` 指令必须有一个参数来指定方法的返回值，而且视图写入输出的将会被忽略。 如果到达 `</#function>` (也就是说没有 `return `returnValue``)， 那么方法的返回值就是未定义变量。

示例1：创建一个方法来计算两个数的平均值：

    <#function avg x y>
      <#return (x + y) / 2>
    </#function>
    ${avg(10, 20)}

将会输出：

    15

示例2：创建一个方法来计算多个数的平均值：

    <#function avg nums...>
      <#local sum = 0>
      <#list nums as num>
        <#local sum = sum + num>
      </#list>
      <#if nums?size != 0>
        <#return sum / nums?size>
      </#if>
    </#function>
    ${avg(10, 20)}
    ${avg(10, 20, 30, 40)}
    ${avg()!"N/A"}

将会输出：

    15
    25
    N/A

#### global

##### 概要

    <#global name=value>
    或
    <#global name1=value1 name2=value2 ... nameN=valueN>
    或
    <#global name>
      capture this
    </#global>

这里：

- ``name``：变量的名称。 它不是表达式。但它可以被写作是字符串形式，如果变量名包含保留字符这是很有用的， 比如 `<#global "foo-bar" = 1>`。 注意这个字符串没有扩展插值(如 `"${foo}"`)。

- `=`：赋值操作符，也可以简写的赋值操作符之一 (`++`， `+=`，等...)，和 `assign` 指令 相似

- ``value``：存储的值，是表达式。

##### 描述

该指令和 `assign` 相似， 但是被创建的变量在所有的 命名空间 中都可见， 但又不会存在于任何一个命名空间之中。精确地说，正如你会创建 (或替换)一个数据模型变量。因此，这个变量是全局的。如果在数据模型中， 一个相同名称的变量存在的话，它会被使用该指令创建的变量隐藏。 如果在当前的命名空间中，一个相同名称的变量存在的话， 那么会隐藏由 `global` 指令创建的变量。

例如，用 `<#global x = 1>` 创建一个变量， 那么在所有命名空间中 `x` 都可见， 除非另外一个称为 `x` 的变量隐藏了它 (比如你已经用 `<#assign x = 2>` 创建了一个变量)。 这种情形下，你可以使用 特殊变量 `globals`，比如 `${.globals.x}`。请注意， 使用 `globals` 你看到所有全局可访问的变量； 不但由 `global` 指令创建的变量，而且是数据模型中的变量。

自定义JSP标记的用户请注意：用这个指令创建的变量集合和JSP页面范围对应。 这就意味着，如果自定义JSP标记想获得一个页面范围的属性(page-scope bean)， 在当前命名空间中一个相同名称的变量，从JSP标记的观点出发，将不会隐藏。

#### if, else, elseif

##### 概要

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

这里：

- ``condition``, ``condition2``， 等：将被计算成布尔值的表达式。

`elseif` 和 `else` 是可选的。

##### 描述

你可以使用 `if`， `elseif` 和 `else` 指令来条件判断是否越过模板的一个部分。 ``condition`` 必须计算成布尔值， 否则错误将会中止模板处理。`elseif` 和 `else` 必须出现在 `if` 内部 (也就是，在 `if` 的开始标签和结束标签之间)。 `if` 中可以包含任意数量的 `elseif`(包括0个) 而且结束时 `else` 是可选的。比如：

只有 `if` 没有 `elseif` 和 `else`：

    <#if x == 1>
      x is 1
    </#if>

只有 `if` 没有 `elseif` 但是有 `else`：

    <#if x == 1>
      x is 1
    <#else>
      x is not 1
    </#if>

有 `if` 和两个 `elseif` 但是没有 `else`：

    <#if x == 1>
      x is 1
    <#elseif x == 2>
      x is 2
    <#elseif x == 3>
      x is 3
    </#if>

有 `if` 和三个 `elseif` 还有 `else`:

    <#if x == 1>
      x is 1
    <#elseif x == 2>
      x is 2
    <#elseif x == 3>
      x is 3
    <#elseif x == 4>
      x is 4
    <#else>
      x is not 1 nor 2 nor 3 nor 4
    </#if>

要了解更多布尔表达式，可以参考：dgui_template_exp.

你(当然)也可以嵌套 `if` 指令：

    <#if x == 1>
      x is 1
      <#if y == 1>
        and y is 1 too
      <#else>
        but y is not
      </#if>
    <#else>
      x is not 1
      <#if y < 0>
        and y is less than 0
      </#if>
    </#if>

当你想测试是否 `x > 0` 或 `x >= 0`，编写 `<#if x > 0>` 和 `<#if x >= 0>` 是错误的， 因为第一个 `>` 会结束 `#if` 标签。要这么来做，可以编写 `<#if x gt 0>` 或 `<#if gte 0>`。也请注意，如果比较发生在括号内部，那么就没有这样的问题， 比如 `<#if foo.bar(x > 0)>` 就会得到想要的结果。

#### import

##### 概要

    <#import path as hash>

这里：

- ``path``：模板的路径。 这是一个算作是字符串的表达式。(换句话说，它不是一个固定的字符串， 它可以是这样的一些东西，比如，`profile.baseDir + "/menu.ftl"`。)

- ``hash``: 访问命名空间的哈希表变量不带引号的名字。不是表达式。 (如果要引入动态创建的名字，那么就不得不使用 这个技巧。)

##### 描述

引入一个库。也就是说，它创建一个新的空命名空间， 然后在那个命名空间中执行给定 ``path`` 参数中的模板， 所以模板用变量(宏，函数等)填充命名空间。 然后使得新创建的命名空间对哈希表的调用者可用。 这个哈希表变量将会在命名空间中，由 `import` (就像你可以用 `assign` 指令来创建一样。) 的调用者被创建成一个普通变量，名字就是 ``hash`` 参数给定的。

如果你用同一个 ``path`` 多次调用 `import`，它会创建命名空间， 但是只运行第一次 `import` 的调用。 后面的调用仅仅创建一个哈希表变量，你只是通过它来访问 同一个 命名空间。

由引入的模板打印的输出内容将会被忽略 (不会在包含它的地方被插入)。模板的执行是来用变量填充命名空间， 而不是写到输出中。

比如：

    <#import "/libs/mylib.ftl" as my>

    <@my.copyright date="1999-2002"/>

``path`` 参数可以是一个相对路径，比如 `"foo.ftl"` 和 `"../foo.ftl"`，或者是像 `"/foo.ftl"` 一样的绝对路径。 相对路径是相对于使用 `import` 指令模板的目录。 绝对路径是程序员配置 FreeMarker 时定义的相对于根路径 (通常指代"模板的根目录")的路径。

通常使用`/`(斜杠)来分隔路径组成， 而不是`\`(反斜杠)。如果你从你本地的文件系统中加载模板， 那么它使用反斜杠(比如在Windows环境下)，FreeMarker 将会自动转换它们。

像 `include` 指令一样，获得机制 和 本地化查找 也可以用来解决路径问题。

请注意，对于所有模板来说， 它可以自动做通用的引入操作，使用 `Configuration` 的"自动引入"设置就行了。

如果你命名空间不是很了解，应该阅读： dgui_misc_namespace

#### include

##### 概要

    <#include path>
    或
    <#include path options>

这里：

- ``path``： 要包含文件的路径；一个算作是字符串的表达式。(用其他话说， 它不用是一个固定的字符串，它也可以是像 `profile.baseDir + "/menu.ftl"`这样的东西。)

- ``options``： 一个或多个这样的选项： `encoding=`encoding``, `parse=`parse``

  - ``encoding``： 算作是字符串的表达式

  - ``parse``： 算作是布尔值的表达式(为了向下兼容，也接受一部分字符串值)

  - ``ignore_missing``: 算作是布尔值的表达式

##### 描述

你可以使用它在你的模板中插入另外一个 FreeMarker 模板文件 (由 ``path`` 参数指定)。 被包含模板的输出格式是在 `include` 标签出现的位置插入的。 被包含的文件和包含它的模板共享变量，就像是被复制粘贴进去的一样。 `include` 指令不能由被包含文件的内容所替代， 它只是当 FreeMarker 每次在模板处理期间到达 `include` 指令时处理被包含的文件。所以对于如果 `include` 在 `list` 循环之中的例子， 你可以为每个循环周期内指定不同的文件名。

这个指令不能和JSP(Servlet)的include搞混， 因为它不涉及到Servlet容器中，只是处理应外一个FreeMarker模板， 不能"离开"FreeMarker。关于如何处理"JSP include"，请阅读...。

``path`` 参数可以是如 `"foo.ftl"` 和 `"../foo.ftl"` 一样的相对路径，或者是如 `"/foo.ftl"` 这样的绝对路径。 相对路径是相对于使用 `import` 指令的模板文件夹。 绝对路径是相对于程序员在配置 FreeMarker 时定义的基路径 (通常指代"模板的根路径")。

这和 FreeMarker 2.1 版本之前的处理方式不同， 之前的路径通常是绝对路径。为了保留原来的行为， 要在 `Configuration` 对象中开启经典的兼容模式。

通常使用 `/`(斜杠)来分隔路径成分， 而不是 `\`(反斜杠)。如果你从你本地的文件系统加载模板， 而它使用反斜杠(像Windows操作系统)，也要使用 `/`。

比如：

假设 /common/copyright.ftl 包含：

    Copyright 2001-2002 ${me}<br>
    All rights reserved.

那么：

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

将会输出：

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

支持的 ``options`` 选项有：

- `parse`：如果它为 `true`， 那么被包含的文件将会当作FTL来解析，否则整个文件将被视为简单文本 (也就是说不会在其中查找 FreeMarker 的结构)。如果你忽略了这个选项， 那么它默认是 `true`。

- `encoding`：被包含文件从包含它的文件继承的编码方式 (实际就是字符集)，除非你用这个选项来指定编码方式。 合法的名字有：ISO-8859-2，UTF-8，Shift_JIS，Big5，EUC-KR，GB2312。 编码名称要和java.io.InputStreamReader 中支持的那些一致(对于Java API 1.3版本：MIME 希望的字符集是从IANA字符集注册处得到的)

- `ignore_missing`：当为 `true`，模板引用为空时压制错误，而 `<#include ...>` 不会输出任何东西。当为 `false` 时，如果模板不存在， 那么模板处理就会发生错误并停止。如果忽略这个选项，那么它的默认值是 `false`。

比如：

    <#include "/common/navbar.html" parse=false encoding="Shift_JIS">

请注意， 对于所有模板可能会用 `Configuration` 的"自动包含"设置自动处理通用的包含物。

###### 使用获得机制

有一个特殊的路径组成，是用一个星号(`*`)来代表的。 它被解释为"当前目录或其他任意它的父目录"。因此， 如果模板在 `/foo/bar/template.ftl` 位置上，有下面这行：

    <#include "*/footer.ftl">

那么引擎就会在下面的位置上寻找模板，并按这个顺序：

- `/foo/bar/footer.ftl`

- `/foo/footer.ftl`

- `/footer.ftl`

该机制被称为 acquisition 并允许设计者在父目录中放置通用的被包含的文件， 而且当需要时在每个子路径基础上重新定义它们。 我们说包含它们的模板获得了从包含它的第一个父目录中的模板。请注意， 你不但可以在星号的右面指定一个模板的名字，也可以指定一个子路径。 也就是说，如果前面的模板由下面这个所替代：

    <#include "*/commons/footer.ftl">

那么引擎将会从下面的路径开始寻找模板，并按这个顺序：

- `/foo/bar/commons/footer.ftl`

- `/foo/commons/footer.ftl`

- `/commons/footer.ftl`

最终，星号不再是路径的第一个元素：

    <#include "commons/*/footer.ftl">

会让引擎将会从下面的路径开始寻找模板，并按这个顺序：

- `/foo/bar/commons/footer.ftl`

- `/foo/bar/footer.ftl`

- `/foo/footer.ftl`

- `/footer.ftl`

然而，在路径中最多只能有一个星号。 指定多余一个星号会导致模板不能被发现。

###### 本地化查找

本地化是语言和可选的国家或方言标识符 (加上可能的更多变体标识符，比如 MAC)。 无论何时模板被请求，期望的本地化都会被指定(明确或含蓄)， FreeMarker 会试图找到变化的模板来匹配本地化环境。当模板包含或引入其它模板时， 在内部也会被请求一个本地化环境，也就是 `locale` 配置的本地化， 通常它是顶级模板的本地化设置。

假设模板使用本地化 `en_US` 来加载， 就是美国英语。当包含其它模板时：

    <#include "footer.ftl">

引擎实际上就会寻找一些模板，并按照这个顺序：

- `footer_en_US.ftl`,

- `footer_en.ftl`

- `footer.ftl`

它会使用第一个存在的。

请注意，如果 FreeMarker 查找的本地化变化是由程序员配置的， 那么这里我们只能描述默认的行为。 可以使用 `localized_lookup` 设置来禁用本地化查找 (`Configuration.setLocalizedLookup(boolean)`)。 而且，可以使用 `template_lookup_strategy` 设置来自行定义推导出的模板名称序列 (`Configuration.setTemplateLookupStrategy(TemplateLookupStrategy)`)。

当你同时使用获得机制(也就是路径中的 `*` 步骤) 和本地化查找时，在父目录中有指定本地化的模板优先于在子目录中有很少本地化的模板。 假设你使用下面的代码来包含 `/foo/bar/template.ftl`：

    <#include "*/footer.ftl">

引擎将会查找这些模板，并按照这个顺序：

- `/foo/bar/footer_en_US.ftl`

- `/foo/footer_en_US.ftl`

- `/footer_en_US.ftl`

- `/foo/bar/footer_en.ftl`

- `/foo/footer_en.ftl`

- `/footer_en.ftl`

- `/foo/bar/footer.ftl`

- `/foo/footer.ftl`

- `/footer.ftl`

#### list, else, items, sep, break

##### 概要

形式 1：

    <#list sequence as item>
        Part repeated for each item
    <#else>
        Part executed when there are 0 items
    </#list>

这里：

- `else` 部分是可选的， 而且仅仅从 FreeMarker 2.3.23 版本开始支持。

- ``sequence``： 将我们想要迭代的项，算作是序列或集合的表达式

- ``item``： 循环变量 的名称 (不是表达式)

- 在标签之间的多个 parts 可以是任意的FTL (包括嵌套的 `list`)

形式 2 (从 FreeMarker 2.3.23 版本开始)：

    <#list sequence>
        Part executed once if we have more than 0 items
        <#items as item>
            Part repeated for each item
        </#items>
        Part executed once if we have more than 0 items
    <#else>
        Part executed when there are 0 items
    </#list>

这里：和上面形式1的 这里 部分相同。

##### 描述

###### 最简形式

假设 `users` 包含 `['Joe', 'Kate', 'Fred']` 序列：

    <#list users as user>
      <p>${user}
    </#list>

      <p>Joe
      <p>Kate
      <p>Fred

`list` 指令执行在 `list` 开始标签和 `list` 结束标签 ( `list` 中间的部分) 之间的代码， 对于在序列(或集合)中每个值指定为它的第一个参数。 对于每次迭代，循环变量(本例中的 `user`)将会存储当前项的值。

循环变量(`user`) 仅仅存在于 `list` 标签体内。 而且从循环中调用的宏/函数不会看到它(就像它只是局部变量一样)。

###### else 指令

在 `list` 中的 `else` 仅从 FreeMarker 2.3.23 版本开始支持。

当没有迭代项时，才使用 `else` 指令， 可以输出一些特殊的内容而不只是空在那里：

    <#list users as user>
      <p>${user}
    <#else>
      <p>No users
    </#list>

该输出和之前示例是相同的，除了当 `users` 包含0项时：

      <p>No users

请注意，循环变量 (`user`) 在 `else` 标签和 `list` 结束标签中间不存在， 因为那部分不是循环中的部分。

`else` 必须是真的在 (也就是在源代码中) `list` 指令体内部。也就是说， 不能将它移出到宏或包含的模板中。

###### items 指令

`items` 从 FreeMarker 2.3.23 版本开始存在

如果不得不在第一列表项之前或在最后一个列表项之后打印一些东西， 那么就要使用 `items` 指令，但至少要有一项。典型的示例为：

    <#list users>
      <ul>
        <#items as user>
          <li>${user}</li>
        </#items>
      </ul>
    </#list>

      <ul>
          <li>Joe</li>
          <li>Kate</li>
          <li>Fred</li>
      </ul>

如果没有迭代项，那么上面的代码不会输出任何内容， 因此不用以空的 `<ul></ul>` 来结束。

也就是说，当 `list` 指令没有 `as `item`` 参数， 如果只有一个迭代项，指令体中的代码仅仅执行一次，否则就不执行。 必须内嵌的 `items` 指令体会对每个迭代项执行， 那么 `items` 指令使用 `as `item`` 定义循环变量，而不是 `list`。

有 `items` 的 `list` 指令也可以有 `else` 指令：

    <#list users>
      <ul>
        <#items as user>
          <li>${user}</li>
        </#items>
      </ul>
    <#else>
      <p>No users
    </#list>

更多细节：

- 解析器会检查没有 `as `item`` 参数的 `list` 通常会有嵌入的 `items` 指令，该 `items` 指令通常会有一个包围的 `list`，它没有 `as `item`` 参数。当模板解析时就会检查，而不是当模板执行的时候。因此，这些规则也适用于FTL源代码本身， 所以不能将 `items` 移出到宏或者被包含的模板中。

- `list` 可以有多个 `items` 指令， 但是只有一个允许执行(直到不离开或重新进入包围的 `list` 指令)； 之后试图调用 `items` 会发生错误。所以多个 `items` 可以用于不同的 `if`-`else` 分支中去，但不能迭代两次。

- `items` 指令不能有它自己的嵌入 `else` 指令，只能被包含的 `list` 可以有。

- 循环变量 (`user`) 仅仅存在于 `items` 指令体内部。

###### sep 指令

`sep` 从 FreeMarker 2.3.23 版本开始存在。

当不得不显示介于每个迭代项(但不能在第一项之前或最后一项之后) 之间的一些内容时，可以使用 `sep`。例如：

    <#list users as user>${user}<#sep>, </#list>

    Joe, Kate, Fred

上面的 `<#sep>, </#list>` 是 `<#sep>, </#sep></#list>` 的简写； 如果将它放到被包含的指令关闭的位置时，`sep` 结束标签可以忽略。下面的示例中，就不能使用该简写 (HTML标签不会结束任何代码，它们只是 FreeMarker 输出的原生文本)：

    <#list users as user>
      <div>
        ${user}<#sep>, </#sep>
      </div>
    </#list>

`sep` 是编写 `<#if `item`?has_next>...</#if>` 的方便形式，有 `list` 或 `items` 循环变量时，它就可以使用，并且不限次数。而且， 也可以有任意的 FTL 作嵌入的内容。

解析器会检查在 `list `...` as item` 内部使用的 `sep` 或者 `items` 指令，所以不能将 `sep` 从重复的部分移出到宏或被包含的模板中。

###### break 指令

可以使用 `break` 指令在迭代的任意点退出。例如：

    <#list 1..10 as x>
      ${x}
      <#if x == 3>
        <#break>
      </#if>
    </#list>

      1
      2
      3

`break` 指令可以放在 `list` 中的任意位置，直到有 `as `item`` 参数， 否则，可以放在 `items` 指令中的任意位置。 如果 `break` 在 `items` 内部， 那么就只能从 `items` 开始时存在，而不能从 `list` 开始时存在。通常来说，`break` 将仅存在于为每个迭代项调用的指令体中，而且只能存在于这样的指令中。 例如不能在 `list` 的 `else` 部分使用 `break`，除非 `list` 内嵌到了其它 可以 `break` 的指令中。

像 `else` 和 `items`， `break` 只能在指令体内部使用，而不能移出到宏或被包含的模板中。

###### 访问迭代状态

从 2.3.23 版本开始， 循环变量内建函数 就是访问当前迭代状态的最佳方式。例如，这里我们使用 `counter` 和 `item_parity` 循环变量内建函数(在 循环变量内建函数参考 中查看它们全部)：

    <#list users>
      <table>
        <#items as user>
          <tr class="${user?item_parity}Row">
            <td>${user?counter}
            <td>${user}
        </#items>
      </table>
    </#list>

      <table>
          <tr class="oddRow">
            <td>1
            <td>Joe
          <tr class="evenRow">
            <td>2
            <td>Kate
          <tr class="oddRow">
            <td>3
            <td>Fred
      </table>

在 2.3.22 和之前的版本中，有两个额外的循环变量来获得迭代状态 (出于向后兼容考虑，它们仍然存在)：

- ``item`_index` (已废弃，由 ``item`?index` 代替)： 循环中当前项的索引(从0开始的数字)。

- ``item`_has_next` (已废弃，由 ``item`?has_next` 代替)： 辨别当前项是否是序列的最后一项的布尔值。

所以在上面的示例中，可以将 `${user?counter}` 替换为 `${user_index + 1}`。

###### 相互嵌套循环

很自然地，`list` 或 `items` 可以包含更多 `list`：

    <#list 1..2 as i>
      <#list 1..3 as j>
        i = ${i}, j = ${j}
      </#list>
    </#list>

        i = 1, j = 1
        i = 1, j = 2
        i = 1, j = 3
        i = 2, j = 1
        i = 2, j = 2
        i = 2, j = 3

允许使用冲突的循环变量名称，比如：

    <#list 1..2 as i>
      Outer: ${i}
      <#list 10..12 as i>
        Inner: ${i}
      </#list>
      Outer again: ${i}
    </#list>

      Outer: 1
        Inner: 10
        Inner: 11
        Inner: 12
      Outer again: 1
      Outer: 2
        Inner: 10
        Inner: 11
        Inner: 12
      Outer again: 2

###### Java程序员请注意

如果经典兼容模式下 `list` 接受标量，并将它视为单元素序列。

如果传递包装了 `java.util.Iterator` 的集合到 `list` 中，那么只能迭代其中的元素一次，因为 `Iterator` 是它们天然的一次性对象。 当视图再次去迭代这样的集合变量时，会发生错误并中止模板处理。

#### local

##### 概要

    <#local name=value>
    或
    <#local name1=value1 name2=value2 ... nameN=valueN>
    或
    <#local name>
      capture this
    </#local>

这里：

- ``name``： 在root中局部对象的名称。它不是一个表达式。但它可以被写作是字符串形式， 如果变量名包含保留字符，这是很有用的，比如 `<#local "foo-bar" = 1>`。 请注意，这个字符串没有扩展插值(如`"${foo}"`)。

- `=`：赋值操作符，也可以简写的赋值操作符之一 (`++`，`+=` 等...)，和 the `assign` 指令 相似。

- ``value``： 存储的值，是表达式。

##### 描述

它和 assign 指令 类似，但是它创建或替换局部变量。 这仅仅在宏和方法的内部定义才会有作用。

要获得更多关于变量的信息，可以阅读：dgui_misc_var

#### macro, nested, return

##### 概要

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

这里：

- ``name``： 宏变量的名称，它不是表达式。和 顶层变量 的语法相同，比如 `myMacro` 或 `my\-macro`。 然而，它可以被写成字符串的形式，如果宏名称中包含保留字符时，这是很有用的， 比如 `<#macro "foo~bar">`...``。 注意这个字符串没有扩展插值(如 `"${foo}"`)。

- ``param1``， ``param2``，等...： 局部变量 的名称，存储参数的值 (不是表达式)，在 `=` 号后面和默认值(是表达式)是可选的。 默认值也可以是另外一个参数，比如 `<#macro section title label=title>`。参数名称和 顶层变量 的语法相同，所以有相同的特性和限制。

- ``paramN``， 最后一个参数，可能会有三个点(`...`)， 这就意味着宏接受可变数量的参数，不匹配其它参数的参数可以作为最后一个参数 (也被称作笼统参数)。当宏被命名参数调用， ``paramN`` 将会是包含宏的所有未声明的键/值对的哈希表。当宏被位置参数调用， ``paramN`` 将是额外参数的序列。 (在宏内部，要查找参数，可以使用 ``myCatchAllParam`?is_sequence`。)

- ``loopvar1``， ``loopvar2``等...： 可选的，循环变量 的值， 是 `nested` 指令想为嵌套内容创建的。这些都是表达式。

`return` 和 `nested` 指令是可选的，而且可以在 `<#macro `...`>` 和 `</#macro>` 之间被用在任意位置和任意次数。

没有默认值的参数必须在有默认值参数 (``paramName`=`defaultValue``) 之前。

##### 描述

创建一个宏变量(在当前命名空间中，如果你知道命名空间的特性)。 如果你对宏和自定义指令不了解，你应该阅读 自定义指令指南。

宏变量存储模板片段(称为宏定义体)可以被用作 自定义指令。 这个变量也存储自定义指令的被允许的参数名。当你将这个变量作为指令时， 你必须给所有参数赋值，除了有默认值的参数。 默认值当且仅当你调用宏而不给参数赋值时起作用。

变量会在模板开始时被创建；而不管 `macro` 指令放置在模板的什么位置。因此，这样也可以：

    <#-- call the macro; the macro variable is already created: -->
    <@test/>
    ...

    <#-- create the macro variable: -->
    <#macro test>
      Test text
    </#macro>

然而，如果宏定义被插在 `include` 指令中， 它们直到 FreeMarker 执行 `include` 指令时才会可用。

例如：没有参数的宏：

    <#macro test>
      Test text
    </#macro>
    <#-- call the macro: -->
    <@test/>

将会输出：

      Test text

示例：有参数的宏：

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

将会输出：

      Test text, and the params: a, b, 23

示例：有参数和默认值参数的宏：

    <#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

示例：更为复杂的宏。

    <#macro list title items>
      <p>${title?cap_first}:
      <ul>
        <#list items as x>
          <li>${x?cap_first}
        </#list>
      </ul>
    </#macro>
    <@list items=["mouse", "elephant", "python"] title="Animals"/>

将会输出：

      <p>Animals:
      <ul>
          <li>Mouse
          <li>Elephant
          <li>Python
      </ul>

示例：支持多个参数和命名参数的宏：

    <#macro img src extra...>
      <img src="/context${src?html}"
      <#list extra?keys as attr>
        ${attr}="${extra[attr]?html}"
      </#list>
      >
    </#macro>
    <@img src="/images/test.png" width=100 height=50 alt="Test"/>

将会输出：

      <img src="/context/images/test.png"
        alt="Test"
        height="50"
        width="100"
      >

示例：支持多个位置参数的宏，不管是否使用命名或位置参数传递：

    <#macro m a b ext...>
      a = ${a}
      b = ${b}
      <#if ext?is_sequence>
        <#list ext as e>
          ${e?index} = ${e}
        </#list>
      <#else>
        <#list ext?keys as k>
          ${k} = ${ext[k]}
        </#list>
      </#if>
    </#macro>

    <@m 1 2 3 4 5 />

    <@m a=1 b=2 c=3 d=4 e=5 data\-foo=6 myns\:bar=7 />

将会输出：

      a = 1
      b = 2
          0 = 3
          1 = 4
          2 = 5

      a = 1
      b = 2
          c = 3
          d = 4
          e = 5
          data-foo=6
          myns:bar=7

当前，命名的笼统参数是无序的，也就是说，不知道它们枚举时的顺序。 那么它们不会按相同传递顺序返回(上述示例输出相同的顺序只是为了理解)。

###### nested

`nested` 指令执行自定义指令开始和结束标签中间的模板片段。 嵌套的片段可以包含模板中任意合法的内容：插值，指令等...它在上下文环境中被执行， 也就是宏被调用的地方，而不是宏定义体的上下文中。因此，比如， 你不能看到嵌套部分的宏的局部变量。如果你没有调用 `nested` 指令， 自定义指令开始和结束标记中的部分将会被忽略。

比如：

    <#macro do_twice>
      1. <#nested>
      2. <#nested>
    </#macro>
    <@do_twice>something</@do_twice>

将会输出：

      1. something
      2. something

nested 指令可以对嵌套内容创建循环变量。例如：

    <#macro do_thrice>
      <#nested 1>
      <#nested 2>
      <#nested 3>
    </#macro>
    <@do_thrice ; x>
      ${x} Anything.
    </@do_thrice>

将会输出：

      1 Anything.
      2 Anything.
      3 Anything.

更为复杂的示例：

    <#macro repeat count>
      <#list 1..count as x>
        <#nested x, x/2, x==count>
      </#list>
    </#macro>
    <@repeat count=4 ; c, halfc, last>
      ${c}. ${halfc}<#if last> Last!</#if>
    </@repeat>

将会输出：

      1. 0.5
      2. 1
      3. 1.5
      4. 2 Last!

###### return

使用 `return` 指令， 你可以在任意位置留下一个宏或函数定义。比如：

    <#macro test>
      Test text
      <#return>
      Will not be printed.
    </#macro>
    <@test/>

将会输出：

      Test text

#### noparse

##### 概要

    <#noparse>
      ...
    </#noparse>

##### 描述

FreeMarker 不会在这个指令体中间寻找FTL标签， 插值和其他特殊的字符序列，除了noparse的结束标记。

比如：

    Example:
    --------

    <#noparse>
      <#list animals as animal>
      <tr><td>${animal.name}<td>${animal.price} Euros
      </#list>
    </#noparse>

将会输出：

    Example:
    --------

      <#list animals as animal>
      <tr><td>${animal.name}<td>${animal.price} Euros
      </#list>

#### nt

##### 概要

    <#nt>

##### 描述

"不要削减"。该指令禁用行中出现的 剥离空白。 它也关闭其他同一行中出现的削减指令(`t`， `rt`，`lt`的效果)。

#### setting

##### 概要

    <#setting name=value>

这里：

- ``name``： 设置的名称。不是表达式！

- ``value``： 设置的新值，是表达式。

##### 描述

为进一步的处理而设置。设置是影响 FreeMarker 行为的值。 新值仅仅在被设置的模板处理时出现，而且不触碰模板本身。 设置的初始值是由程序员设定的 (参考： pgui_config_settings)。

支持的设置有：

- `locale`：输出的本地化(语言)。 它可以影响数字，日期等显示格式。它的值是由语言编码 (小写两个字母的ISO-639编码)和可选的国家码 (大写的两个字母ISO-3166编码)组成的字符串，它们以下划线相分隔， 如果我们已经指定了国家那么一个可选的不同编码 (不是标准的)会以下划线分隔开国家。合法的值示例：`en`， `en_US`，`en_US_MAC`。 FreeMarker 会尝试使用特定可用的本地化设置，所以如果你指定了 `en_US_MAC`，但是它不被知道，那么它会尝试 `en_US`，然后尝试 `en`， 然后是计算机(可能是由程序员设置的)默认的本地化设置。

- `number_format`： 当没有指定确定的格式化形式时，用来转化数字到字符串形式的数字格式化设置。 可以是下列中的一个预定义值 `number`(默认的)， `computer`，`currency`， 或 `percent`。此外，以 Java小数数字格式化语法 书写的任意的格式化形式也可以被指定。 更多格式形式内容: `string` 内建函数。

- `boolean_format`： 以逗号分隔的一对字符串来分别展示 true 和 false 值， 当没有指定确定的格式时(比如在 `${`booleanValue`}` 中)， 将转换布尔值到字符串。请注意，当前的空格没有从该字符串中移除， 所以不要将空格放在逗号后面。默认值是 `"true,false"`。 但是 FreeMarker 会拒绝为 `${`booleanValue`}` 使用特定值，而需要使用 `${`booleanValue`?c}` 来代替(从 2.3.21 版本开始有效)。对于其它任意值，比如 `"Y,N"`， `${`booleanValue`}` 也是有效的。 请参考：`string` 内建函数。

- `date_format`, `time_format`, `datetime_format`：当没有通过 `string` 内建函数(或相反)指定确定的格式时，格式将日期/时间/日期-时间值 (Java `java.util.Date` 和它的子类)转换为字符串， 比如 `${someDate}`。`date_format` 设置仅仅格式于存储的无时间部分的值，`time_format` 仅仅格式于存储无日期部分的值，而 `datetime_format` 仅仅格式于日期-时间值。除了当它应用于字符串值时，这些设置也影响进行了 `?time`， `?date`， 和 `?datetime` 操作的格式。

  可能的设置是(引号标记不是值本身的一部分)：

  - Java 的 `SimpleDateFormat` 接受 的模式，例如 `"dd.MM.yyyy HH:mm:ss"` (这里 `"HH"` 表示 0-23 时) 或 `"MM/dd/yyyy hh:mm:ss a"` (如果当前语言是英语，这里 `"a"` 输出 AM 或 PM)。

  - `"xs"` 就是XML Schema 格式，或 `"iso"` 是 ISO 8601:2004 格式。 这些格式允许多个可选项，由空格分隔开，比如 `"iso m nz"` (或者使用 `_`，比如 `"iso_m_nz"`； 比如设置 `lastModified?string.iso_m_nz` 时就很有用)。 选项和它们的意义是：

    - 精度选择：

      - `ms`：毫秒，通常显示3位数字， 即便它们都是0。例如：`13:45:05.800`

      - `s`：秒(如果非0，小数部分就被丢弃了)， 比如 `13:45:05`

      - `m`：分，比如 `13:45`。它不允许用于 `"xs"`。

      - `h`：小时，比如 `13`。它不允许用于 `"xs"`。

      - 两者皆不：上至毫秒的精度，但是尾部的0毫秒就被移除了， 否则，如果它是0，整个毫秒部分也被移除。比如： `13:45:05.8`

    - 时区偏移可见性选项：

      - `fz`: Force Zone，通常显示时区偏移(也对 `java.sql.Date` 和 `java.sql.Time` 值)。但是， 因为 ISO 8601 不允许日期(也就是没有时间的日期)显示时区偏移， 该选项对使用 `"iso"` 的日期就没有作用。

      - `nz`: No Zone， 从不显示时区偏移

      - 两者皆不：除了 `java.sql.Date` 和 `java.sql.Time`，还有 `"iso"` 日期值，通常都显示时区偏移。

    - 时区选项：

      - `u`：使用 UTC 来代替 `time_zone` 设置建议的内容。 然而，`java.sql.Date` 和 `java.sql.Time` 不受它影响 (参考 `sql_date_and_time_time_zone` 去理解为什么)

      - `fu`: Force UTC，也就是说，使用 UTC 来代替 `time_zone` 或 `sql_date_and_time_time_zone` 设置建议的内容。这会影响 `java.sql.Date` 和 `java.sql.Time` 值。

      - 两者皆不：使用 `time_zone` 或 `sql_date_and_time_time_zone` 配置设置项建议的时区。

    来自相同分类的选项是互斥的，比如一起使用 `m` 和 `s` 就会有错误。

    选项可以指定一个任意的顺序。

    精度和时区偏移可见性选项不影响解析，只影响格式化。例如， 即使使用 `"iso m nz"`， `"2012-01-01T15:30:05.125+01"` 也会被成功解析含有毫秒精度。仅当解析不包含时区偏移的字符串时， 时区选项(比如 `"u"`) 影响选择的时区。

    使用 `"iso"` 解析会理解 extend format 和 basic format，比如 `20141225T235018`。 它不支持所有的 ISO 8601 字符串：如果有日期部分， 必须使用年，月和日值(不是年中的星期)，并且日不能被忽略。

    `"iso"` 的输出是有意的， 所以它也是有 XML Schema 格式值的很好表述，除了0和负数的年， 这里是不可能的。也请注意，时区偏移在 `"iso"` 格式中是忽略的，而在 `"xs"` 格式中是保留的。

  - `"short"`， `"medium"`， `"long"`，或 `"full"`，这些由Java平台定义，有本地依赖含义 (参考 `java.text.DateFormat` 的文档)。 对于日期-时间值，可以分别指定日期和时间部分的长度，使用 `_` 将它们分开，比如 `"short_medium"`。 (对于时间-日期值，`"medium"` 表示 `"medium_medium"`。)

- `time_zone`：时区的名称来显示并格式化时间。 默认情况下，使用JVM的时区。也可以是 Java 时区 API 接受的值，或者 `"JVM default"` (从 FreeMarker 2.3.21 版本开始) 使用JVM默认的时区。比如： `"GMT"`， `"GMT+2"`， `"GMT-1:30"`， `"CET"`， `"PST"`， `"America/Los_Angeles"`。

  如果修改了该设置的默认值，那么也应该设置 `sql_date_and_time_time_zone` 为 "JVM default"。在 `Configurable.setSQLDateAndTimeTimeZone(TimeZone)` 的Java API 文档中参考更多内容。

- `sql_date_and_time_time_zone` (从 FreeMarker 2.3.21 版本开始)：它控制高度技术性的问题， 所以它应该由程序员在Java代码中来设置。 对于程序员：如果它设置为 非 `null`，对于来自SQL数据库(更精确地，就是 `java.sql.Date` 和 `java.sql.Time` 对象)的仅日期和仅时间值来说， FreeMarker 会使用该时区来代替由 `time_zone` 设置项指定的时区。在 `Configurable.setSQLDateAndTimeTimeZone(TimeZone)` 的Java API文档中参考更多。

- `url_escaping_charset`： 用来URL转义(比如`${foo?url}`)的字符集， 来计算转义(`%`XX``)的部分。 通常包含 FreeMarker 的框架应该设置它，所以不应该在模板中来设置。(程序员可以在 这里... 阅读更多内容。)

- `output_encoding`：告诉 FreeMarker 输出的字符集是什么。因为 FreeMarker 输出 UNICODE 字符集 (写入 `java.io.Writer`)的流，它不由输出编码所影响， 但是一些宏/函数和内建函数也许想使用这些信息。

- `classic_compatible`：这是对于专家来说的。 它的值应该是布尔值。参考 `freemarker.template.Configurable` 的文档来获取更多信息。

比如：假设初始化的模板本地化是 de_DE (德国)。那么：

    ${1.2}
    <#setting locale="en_US">
    ${1.2}

将会输出：

    1,2
    1.2

因为德国人使用逗号作为小数分隔符，而美国人使用点。

#### stop

##### 概要

    <#stop>
    或
    <#stop reason>

这里：

- ``reason``： 关于终止原因的信息化消息。是表达式，被算做是字符串。

##### 描述

中止模板处理，给出(可选的)错误消息。 不要在普通情况下对结束模板处理使用！ FreeMarker 模板的调用者会将它视为失败的模板呈现， 而不是普通完成的。

该指令抛出 `StopException`，而且 `StopException` 会持有 reason 参数的值。

#### switch, case, default, break

##### 概要

    <#switch value>
      <#case refValue1>
        ...
        <#break>
      <#case refValue2>
        ...
        <#break>
      ...
      <#case refValueN>
        ...
        <#break>
      <#default>
        ...
    </#switch>

这里：

- ``value``， ``refValue1``，等： 表达式将会计算成相同类型的标量。

`break` 和 `default` 是可选的。

##### 描述

这个指令的用法是不推荐的，因为向下通过的行为容易出错。使用 `elseif`来代替， 除非你想利用向下通过这种行为。

Switch 被用来选择模板中的一个片段，如何选择依赖于表达式的值：

    <#switch animal.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>

在 `switch` 中间必须有一个或多个 `<#case `value`>`， 在所有 `case` 标签之后，有一个可选的 `<#default>`。 当FreeMarker到达 `switch` 指令时，它会选择一个 `case` 指令，这里的 ``refValue`` 等于 ``value`` 并且继续模板处理。 如果没有和合适的值匹配的 `case` 指令，那么就继续处理 `default` 指令，如果它存在，否则就继续处理 `switch` 结束标签之后的内容。现在有一个混乱的事情： 当它选择一个 `case` 指令后，它就会继续处理其中的内容， 直到遇到 `break` 指令。也就是它遇到另外一个 `case` 指令或 `<#default>` 标记时也不会自动离开 `switch` 指令。比如：

    <#switch x>
      <#case 1>
        1
      <#case 2>
        2
      <#default>
        d
    </#switch>

如果 `x` 是 1，它会打印1 2 d；如果 `x` 是 2，那么就会打印2 d；如果 `x` 是 3，那么就会打印d。这就是前面提到的向下通过行为。 `break` 标记指示 FreeMarker 直接略过剩下的 `switch` 代码段。

#### t, lt, rt

##### 概要

    <#t>

    <#lt>

    <#rt>

##### 描述

这些指令，指示FreeMarker去忽略标记中行的特定的空白：

- `t` (整体削减)：忽略本行中首和尾的所有空白。

- `lt` (左侧削减)：忽略本行中首部所有的空白。

- `rt` (右侧削减)：忽略本行中尾部所有的空白。

这里：

- "首部空白" 表示本行所有空格和制表符 (和其他根据 UNICODE 中的空白字符，除了换行符) 在第一个非空白字符之前。

- "尾部空白" 表示本行所有的空格和制表符 (和其他根据 UNICODE 中的空白字符，除了换行符) 在最后一个非空白字符之后，还有 行末尾的换行符。

理解这些检查模板本身的指令是很重要的，而 不是 当你合并数据模型时，模板生成的输出。 (也就是说，空白的移除发生在解析阶段。)

例如：

    --
      1 <#t>
      2<#t>
      3<#lt>
      4
      5<#rt>
      6
    --

将会输出：

    --
    1 23
      4
      5  6
    --

这些指令在行内的放置不重要。也就是说，不管你是将它们放在行的开头， 或是行的末尾，或是在行的中间，效果都是一样的。

#### User-defined directive (<@...>)

##### 概要

    <@user_def_dir_exp param1=val1 param2=val2 ... paramN=valN/>
    (注意 XML 风格， / 在 > 之前)
    或如果需要循环变量 (更多细节...)
    <@user_def_dir_exp param1=val1 param2=val2 ... paramN=valN ; lv1, lv2, ..., lvN/>

    或和上面两个相同但是使用结束标签 (更多细节...):

    <@user_def_dir_exp ...>
      ...
    </@user_def_dir_exp>
    或
    <@user_def_dir_exp ...>
      ...
    </@>

    或和上面的相同但是使用位置参数传递 (更多细节...):

    <@user val1, val2, ..., valN/>
    等...

这里：

- ``user_def_dir_exp``： 表达式算作是自定义指令(比如宏)，将会被调用。

- ``param1``， ``param2``等...： 参数的名称，它们 不是 表达式。

- ``val1``， ``val2``等...： 参数的值，它们 是 表达式。

- ``lv1``， ``lv2``等...： 循环变量 的名称， 它们 不是 表达式。

参数的数量可以是0(也就是没有参数)。

参数的顺序并不重要(除非你使用了位置参数传递)。 参数名称必须唯一。在参数名中小写和大写的字母被认为是不同的字母 (也就是 `Color` 和 `color` 是不同的)。

##### 描述

这将调用用户自定义指令，比如宏。参数的含义， 支持和需要的参数的设置依赖于具体的自定义指令。

你可以阅读 自定义指令。

示例1：调用存储在变量 `html_escape` 中的指令：

    <@html_escape>
      a < b
      Romeo & Juliet
    </@html_escape>

将会输出：

      a &lt; b
      Romeo &amp; Juliet

示例2：调用有参数的宏：

    <@list items=["mouse", "elephant", "python"] title="Animals"/>
    ...
    <#macro list title items>
      <p>${title?cap_first}:
      <ul>
        <#list items as x>
          <li>${x?cap_first}
        </#list>
      </ul>
    </#macro>

将会输出：

      <p>Animals:
      <ul>
          <li>Mouse
          <li>Elephant
          <li>Python
      </ul>

    ...

###### 结束标签

你可以在 结束标签 中忽略 ``user_def_dir_exp``。 也就是说，你可以写 `</@>` 来替代 `</@`anything`>`。 这个规则当表达式 ``user_def_dir_exp`` 太复杂时非常有用，因为你不需要在结束标签中重复表达式。 此外，如果表达式包含比简单变量名和点还多的表达式，你就不能再重复它们了。比如， `<@a_hash[a_method()]>`...`</@a_hash[a_method()]>` 就是错的，你必须写为 `<@a_hash[a_method()]>`...`</@>`。 但是 `<@a_hash.foo>`...`</@a_hash.foo>` 是可以的。

###### 循环变量

一些自定义指令创建循环变量(和 `list` 指令相似)。 正如预定义指令(如 `list`)一样，当你调用这个指令 (如 `<#list foos as foo>`...`</#list>`中的 `foo`)时循环变量的 名称 就给定了， 而变量的 值 是由指令本身设置的。 在自定义指令的情形下，语法是循环变量的名称在分号之后给定。比如：

    <@myRepeatMacro count=4 ; x, last>
      ${x}. Something... <#if last> This was the last!</#if>
    </@myRepeatMacro>

请注意，由自定义指令创建的循环变量数量和分号之后指定的循环变量数量需要不匹配。 也就是说，如果你对重复是否是最后一个不感兴趣，你可以简单来写：

    <@myRepeatMacro count=4 ; x>
      ${x}. Something...
    </@myRepeatMacro>

或者你可以：

    <@myRepeatMacro count=4>
      Something...
    </@myRepeatMacro>

此外，如果你在分号之后指定更多循环变量而不是自定义指令创建的， 也不会引起错误，只是最后的循环变量不能被创建 (也就是在嵌套内容中那些将是未定义的)。尝试使用未定义的循环变量， 就会引起错误(除非你使用如 `?default` 这样的内建函数)， 因为你尝试访问了一个不存在的变量。

参考 自定义指令 来获取更多内容。

###### 位置参数传递

位置参数传递(如`<@heading "Preface", 1/>`) 是正常命名参数传递(如`<@heading title="Preface" level=1/>`) 的速记形式，这里忽略了参数的名称。如果自定义指令只有一个参数， 或者对于经常使用的自定义指令它参数的顺序很好记忆，速记形式应该被应用。 为了应用这种形式，你不得不了解声明的命名参数的顺序(如果指令只有一个参数这是很琐碎的)。 也就是，如果 `heading` 被创建为 `<#macro heading title level>`...``， 那么 `<@heading "Preface", 1/>` 和 `<@heading title="Preface" level=1/>` (或 `<@heading level=1 title="Preface"/>`； 如果你使用参数名称，那顺序就不重要了)是相等的。 要注意位置参数传递现在仅仅支持宏定义。

#### visit, recurse, fallback

##### 概要

    <#visit node using namespace>
    或
    <#visit node>

    <#recurse node using namespace>
    或
    <#recurse node>
    或
    <#recurse using namespace>
    或
    <#recurse>

    <#fallback>

这里：

- ``node``： 算作 结点变量 的表达式。

- ``namespace``： 命名空间，或者是命名空间的序列。 命名空间可以以命名空间哈希表(又称为根哈希表)给定， 或者可以引入一个存储模板路径的字符串。代替命名空间哈希表， 你也可以使用普通哈希表。

##### 描述

`visit` 和 `recurse` 指令是用来递归处理树的。在实践中，这通常被用来 处理XML。

###### Visit

当你调用了 `<#visit `node`>`时， 它看上去像用户自定义指令(比如宏)来调用从结点名称 (``node`?node_name`) 和命名空间 (``node`?node_namespace`) 中有名称扣除的结点。名称扣除的规则：

- 如果结点不支持结点命名空间(如XML中的文本结点)， 那么这个指令名仅仅是结点的名称 (``node`?node_name`)。 如果 `getNodeNamespace` 方法返回 `null` 时结点就不支持结点命名空间了。

- 如果结点支持结点命名空间(如XML中的元素结点)， 那么从结点命名空间中的前缀扣除可能在结点名称前和一个做为分隔符 (比如 `e:book`)的冒号追加上去。前缀，以及是否使用前缀， 依赖于何种前缀 FTL命名空间 中用 `ftl` 指令的 `ns_prefixes` 参数注册的， 那里 `visit` 寻找控制器指令 (`visit` 调用的相同FTL命名空间不是重要的，后面你将会看到)。 具体来说，如果没有用 `ns_prefixes` 注册默认的命名空间， 那么对于不属于任何命名空间(当 `getNodeNamespace` 返回 `""`)的结点来说就不使用前缀。 如果使用 `ns_prefixes` 给不属于任意命名空间的结点注册了默认命名空间， 那么就使用前缀 `N`，而对于属于默认结点命名空间的结点就不使用前缀了。 否则，这两种情况下，用 `ns_prefixes` 关联结点命名空间的前缀已经被使用了。 如果没有关联结点命名空间的结点前缀，那么 `visit` 仅仅就好像没有以合适的名称发现指令。

自定义指令调用的结点对于特殊变量 `.node` 是可用的。比如：

    <#-- Assume that nodeWithNameX?node_name is "x" -->
    <#visit nodeWithNameX>
    Done.
    <#macro x>
       Now I'm handling a node that has the name "x".
       Just to show how to access this node: this node has ${.node?children?size} children.
    </#macro>

将会输出：

       Now I'm handling a node that has the name "x".
       Just to show how to access this node: this node has 3 children.
    Done.

如果使用可选的 `using` 从句来指定一个或多个命名空间， 那么 `visit` 就会在那么命名空间中寻找指令， 和先前列表中指定的命名空间都获得优先级。如果指定 `using` 从句， 对最后一个未完成的 `visit` 调用的用 `using` 从句指定命名空间的命名空间或序列被重用了。如果没有这样挂起的 `visit` 调用，那么当前的命名空间就被使用。 比如，如果你执行这个模板：

    <#import "n1.ftl" as n1>
    <#import "n2.ftl" as n2>

    <#-- This will call n2.x (because there is no n1.x): -->
    <#visit nodeWithNameX using [n1, n2]>

    <#-- This will call the x of the current namespace: -->
    <#visit nodeWithNameX>

    <#macro x>
      Simply x
    </#macro>

这是 `n1.ftl`：

    <#macro y>
      n1.y
    </#macro>

这是 `n2.ftl`：

    <#macro x>
      n2.x
      <#-- This callc n1.y as it inherits the "using [n1, n2]" from the pending visit call: -->
      <#visit nodeWithNameY>
      <#-- This will call n2.y: -->
      <#visit nodeWithNameY using .namespace>
    </#macro>

    <#macro y>
      n2.y
    </#macro>

将会输出：

      n2.x
      n1.y
      n2.y

      Simply x

如果 `visit` 既没有在和之前描述规则的名称扣除相同名字的FTL命名空间发现自定义指令， 那么它会尝试用名称 `@`node_type`` 查找， 又如果结点不支持结点类型属性 (也就是 ``node`?node_type` 返回未定义变量)， 那么使用名称 `@default`。对于查找来说，它使用和之前描述相同的机制。 如果仍然没有找到处理结点的自定义指令，那么 `visit` 停止模板执行， 并抛出错误。一些XML特定的结点类型在这方面有特殊的处理； 参考：xgui_declarative_details。比如：

    <#-- Assume that nodeWithNameX?node_name is "x" -->
    <#visit nodeWithNameX>

    <#-- Assume that nodeWithNameY?node_type is "foo" -->
    <#visit nodeWithNameY>

    <#macro x>
    Handling node x
    </#macro>

    <#macro @foo>
    There was no specific handler for node ${node?node_name}
    </#macro>

将会输出：

    Handling node x

    There was no specific handler for node y

###### Recurse

`<#recurse>` 指令是真正纯语义上的指令。 它访问结点的所有子结点(而没有结点本身)。所以来写：

    <#recurse someNode using someLib>

和这个是相等的：

    <#list someNode?children as child><#visit child using someLib></#list>

而目标结点在 `recurse` 指令中是可选的。 如果目标结点没有指定，那就仅仅使用 `.node`。 因此，`<#recurse>` 这个精炼的指令和下面这个是相同的：

    <#list .node?children as child><#visit child></#list>

对于熟悉XSLT的用户的评论，`<#recurse>` 是和XSLT中 `<xsl:apply-templates/>` 指令相当类似的。

###### Fallback

正如前面所学的，在 `visit` 指令的文档中， 自定义指令控制的结点也许在多个FTL命名空间中被搜索。 `fallback` 指令可以被用在自定义指令中被调用处理结点。 它指挥 FreeMarker 在更多的命名空间 (也就是，在当前调用列表中自定义指令命名空间之后的命名空间) 中来继续搜索自定义指令。如果结点处理器被发现， 那么就被调用，否则 `fallback` 不会做任何事情。

这个指令的典型用法是在处理程序库之上写定制层，有时传递控制到定制的库中：

    <#import "/lib/docbook.ftl" as docbook>

    <#--
      We use the docbook library, but we override some handlers
      in this namespace.
    -->
    <#visit document using [.namespace, docbook]>

    <#--
      Override the "programlisting" handler, but only in the case if
      its "role" attribute is "java"
    -->
    <#macro programlisting>
      <#if .node.@role[0]!"" == "java">
        <#-- Do something special here... -->
        ...
      <#else>
        <#-- Just use the original (overidden) handler -->
        <#fallback>
      </#if>
    </#macro>

### 特殊变量参考

特殊变量是由FreeMarker引擎自己定义的变量。要访问它们， 你可以使用 `.`variable_name`` 语法。 比如，你不能仅仅写 `version`，而必须写`.version`。

在 FreeMarker 2.3.23 版本中，可以使用驼峰格式的特殊变量名来代替蛇形格式， 比如 `dataModel` 代替 `data_model`。 但是需要知道在相同的模板中，FreeMarker 会对模板语言部分的标识符强制使用驼峰格式 (用户自定义名称是无效的)。

支持的特殊变量有：

- `current_template_name```： 当前所在的模板名称(从 FreeMarker 2.3.23 版本开始可用)。 如果模板是在Java中 (通过 `new Template(null, `...`)`) 动态创建的， 而不是从后台通过名称 (通过 ``cfg`.getTemplate(name, `...`)`)加载的。 那么它可以为空(`null`)。 迁移说明：如果使用它来替换废弃的 `template_name`， 请注意，如果模板没有名字，那么它是一个长度为0的字符串，而不是空 (`null`)，所以可以在遗留的模板中编写 `current_template_name!''`。

- `data_model`：可以用来直接访问数据模型的哈希表。 也就是，使用 `global` 指令定义在这里不可见的的变量。

- `error` (从 FreeMarker 2.3.1 版本开始可用)： 该变量在 `recover` 指令 体中可以访问，它存储了我们要恢复错误的信息。

- `globals`：可以用来访问全局可访问的变量的哈希表： 数据模型和由 `global` 指令创建的变量。请注意，用 `assign` 或 `macro` 创建的变量不是全局的。 因此当你使用 `globals` 时你不能隐藏变量。

- `lang`：返回当前本地化设置的语言部分的值。 比如 `.locale` 是 `en_US`， 那么 `.lang` 是 `en`。

- `locale`：返回当前本地化设置的值。 这是一个字符串，比如 `en_US`。 要获取关于本地化字符串值的更多内容，请参考 `setting` 指令。

- `locale_object` (从 FreeMarker 2.3.21 版本开始可用)： 以 `java.util.Locale` 对象返回本地化设置的当前值，而不是字符串。 也就是说，当你想要传递一个 `java.util.Locale` 对象给Java方法时， 它可以用于代替 `.locale`。(`Locale` 对象会根据 `object_wrapper` 设置项的值来被包装。是否真的可以以 `Locale` 对象传递该值给Java方法依赖于对象包装器， 但是对象包装器允许你直接调用Java方法不太可能不支持它。)

- `locals`：你可以访问局部变量的哈希表 (由 `local` 指令创建的变量，还有宏的参数)。

- `main`：可以用来访问主命名空间的哈希表。 请注意，像数据模型中的全局变量通过这个哈希表是 不 可见的。

- `main_template_name`：顶级模板的名称 (从 FreeMarker 2.3.23 版本开始可用)。(在Java中，这就是 `Template.process` 调用的模板) 如果模板是在Java中 (通过 `new Template(null, `...`)`) 动态创建出来的，而不是从存储器中以名称加载(通过 ``cfg`.getTemplate(name, `...`)`)的， 那么它可以不存在(`null`)。迁移说明： 如果使用它来替换废弃的 `template_name`， 请注意，如果模板没有名字，那么它是一个长度为0的字符串，而不是空 (`null`)，所以可以在遗留的模板中编写 `current_template_name!''`。

- `namespace`：可以用来访问当前 命名空间 的哈希表。 请注意，像数据模型中的全局变量通过这个哈希表是 不 可见的。

- `node` (由于历史原因重命名为 `current_node`)：可以用访问者模式(也就是用 `visit`， `recurse` 等指令)处理的当前结点。 而且，当使用 FreeMarker XML Ant 任务 时， 它初始存储根结点。

- `now`：返回当前的日期-时间。使用示例： "`Page generated: ${.now}`"， "`Today is ${.now?date}`"， "`The current time is ${.now?time}`"。

- `output_encoding` (从 FreeMarker 2.3.1 版本开始可用)：返回当前输出字符集的名称。 如果框架封装 FreeMarker 却没有为 FreeMarker 指定输出字符集时这个特殊变量是不存在的。 (程序员可以在 这里... 阅读关于字符集问题的更多内容。)

- `template_name`：不要使用它， 因为当使用宏时，它的行为是很奇怪的；使用 `current_template_name` 或 `main_template_name` 来代替(参考那里的迁移说明)。 给出主模板的名字，如果我们运行包含或导入的模板，那么就是它们的名字。 当调用宏时，那就有些困惑了：宏调用不改变该特殊变量的值，但是当 `nested` 被调用时，它会变成模板所属当前命名空间的名字。 (从FreeMarker 2.3.14 版本开始可用)

- `url_escaping_charset` (从 FreeMarker 2.3.1 版本开始可用)：如果存在， 它存储了应该用于URL转义的字符集的名称。 如果这个变量不存在就意味着没有人指定URL编码应该使用什么样的字符集。 这种情况下，`url` 内建函数 使用特殊变量 `output_encoding` 指定的字符集来进行URL编码。 处理机制和它是相同的。(程序员可以在 这里... 阅读关于字符集问题的更多内容。)

- `vars`：表达式 `.vars.foo` 返回和表达式 `foo` 相同的变量。 出于某些原因你不得不使用方括号语法时这是有用的，因为它只对哈希表子变量有用， 所以你需要一个人工创建的父哈希表。比如，要读取有特殊名称的顶层变量可能会把 FreeMarker 弄糊涂，你可以写 `.vars["A strange name!"]`。 或者，使用和变量 `varName` 给定的动态名称访问顶层变量你可以写 `.vars[varName]`。请注意，这个哈希表由 `.vars` 返回，并不支持 `?keys` 和 `?values`。

- `version`：返回 FreeMarker 版本号的字符串形式， 比如 `2.2.8`。这可以用来检查你的应用程序使用的是哪个版本的 FreeMarker，但是要注意这个特殊变量在 2.3.0 或 2.2.8 版本之前不存在。 非最终发行版本号在数字包含破折号和进一步信息，比如 2.3.21-nightly_20140726T151800Z.

### FTL 中的保留名称

下面的这些名称不能在非方括号语法中被用作顶层变量 (比如 `.vars["in"]`)，因为这是FTL中的关键字：

- `true`：布尔值"true"

- `false`：布尔值"false"

- `gt`：比较运算符"大于"

- `gte`：比较运算符"大于或等于"

- `lt`：比较运算符"小于"

- `lte`：比较运算符"小于或等于"

- `as`：由少数指令使用

- `in`：由少数指令使用

- `using`：由少数指令使用

### 废弃的 FTL 结构

#### 废弃的指令列表

下面这些指令是废弃的，但是仍然可以运行：

- `call`：使用 自定义指令调用 来代替。

- `comment`：这是 `<#--`...`-->` 的老格式。 在 `<#comment>` 和 `</#comment>` 之间的任何东西都会被忽略。

- `foreach`: 它是 `list` 指令的代名词，有着略微不同的参数语法。它的语法结构是 `<#foreach `item` in `sequence`>`，和 `<#list `sequence` as `item`>`是相同的。

- `transform`： 使用 自定义指令调用 来代替

下面这些指令不再可以运行：

- 遗留的 `function`：起初 `function` 是被用作定义宏，现在由 `macro` 指令完成，它就被废弃了。 对于 FreeMarker 2.3 版本来说，这个指令由于不同的意义而再次引入： 它被用来定义方法。

#### 废弃的内建函数列表

下面这些内建函数是被废弃的，但是仍可以运行：

- `default`：由于 默认值操作符 的引入，它被废弃了。``exp1`?default(`exp2`)` 和 ``exp1`!`exp2`` 是相同的， `(`exp1`)?default(`exp2`)` 和 `(`exp1`)!`exp2`` 是相同的。 唯一的不同是在 FreeMarker 2.4 版本之前，内建函数 `default` 通常算作是 ``exp2``，而默认值操作符仅仅当默认值真的需要时才算。 从 FreeMarker 2.4 版本之后，内建函数 `default` 被改进了， 和默认值运算符的行为非常像了。

- `exists`：由于 空值测试操作符 的引入，它被废弃了。 ``exp1`?exists` 和 ``exp1`??` 是一样的， `(`exp1`)?exists` 和 `(`exp1`)??` 也是一样的。

- `if_exists`：由于 默认值操作符 的引入，它被废弃了。 ``exp1`?if_exists` 和 ``exp1`!` 相似， `(`exp1`)?if_exists` 和 `(`exp1`)!` 相似。不同之处在于， 用 `if_exists` 的默认值不仅仅同时是空字符串，空序列和空哈希表， 而且布尔值 `false` 和不做任何事情的变换，还有忽略所有参数。

- `web_safe`：和 `html` 相同。

#### 老式的 macro 和 call 指令

##### 概要

    <#macro name(argName1, argName2, ... argNameN)>
      ...
    </#macro>

    <#call name(argValue1, argValue2, ... argValueN)>

这里：

- ``name``：宏的名称(不是表达式)

- ``argName1``， ``argName2``等： 存储参数值的 局部变量 的名称(不是表达式)

- ``argValue1``， ``argValue2``， 等：表达式，参数的值

##### 描述

这是 FreeMarker 2.1 版本的文档中宏还有宏它相关的指令。 这仍然可以用，但是已经被废弃了。你也许想阅读 FreeMarker2.2+ 版本的参考： macro, return，自定义指令调用

宏是关联名称的模板段。你可以在你的模板中的很多位置使用命名的代码段， 所以它可以在重复的任务中帮助你。宏可以有参数，这会在你调用它的时候影响生成的输出。

你可以使用 `macro` 指令来定义宏，之后你可以在整个模板中定义宏。 `macro` 指令本身不往输出中写任何东西，它只是用来定义宏。 例如这会定义一个名为 `warning` 的宏：

    <#macro warning(message)>
      <div align=center>
      <table border=1 bgcolor=yellow width="80%"><tr><td align=center>
        <b>Warning!</b>
        <p>${message}
      </td></tr></table>
      </div>
    </#macro>

当你使用 `call` 指令和宏名称时， 宏定义体(在宏开始标签和结束标签之间)会被处理。例如， 这会调用名为 `warning` 的宏：

    <#call warning("Unplug the machine before opening the cover!")>

将会输出：

      <div align=center>
      <table border=1 bgcolor=yellow width="80%"><tr><td align=center>
        <b>Warning!</b>
        <p>Unplug the machine before opening the cover!
      </td></tr></table>
      </div>

给 `call` 指令传递的参数可以在宏定义体中作为 局部变量访问。

当调用宏时，必须指定和宏定义时指定的个数相同的参数。 例如，如果这是宏的定义：

    <#macro test(a, b, c)>Nothing...</#macro>

那么这些是合法的宏调用：

    <#call test(1, 2, 3)>
    <#call test("one", 2 + x, [1234, 2341, 3412, 4123])>

如果宏没有参数，那么可以忽略圆括号：

    <#macro test>mooo</#macro>
    <#call test>

当你定义宏时，那么它在模板中就是可用的，你也只能在模板中来定义宏。 但是你可能想在更多模板中使用相同的宏。这种情况下你可以在公共文件中存储你定义的宏， 之后在所有你需要这些宏的模板中包含那个文件。

调用定义在模板下部的宏是不错的 (因为宏在解析时间定义，而不是执行时间)。然而， 如果宏定义被插入到 `include` 指令中， 它们知道 FreeMarker 执行 `include` 指令时才会可用。

你可以用 `return` 指令在 `</#macro>` 标签之前留下宏定义体。

#### 转换指令

##### 概要

    <transform transVar>
      ...
    </transform>
    or
    <transform transVar name1=value1 name2=value2 ... nameN=valueN>
      ...
    </transform>

这里：

- ``transVar``： 要来转换的表达式

- ``name1``， ``name2``，... ``nameN``： 参数的名称。文字值，不是表达式

- ``value1``， ``value2``， ... ``valueN``： 算作参数值的表达式

##### 描述

这个指令仍然可用，但是已经被废弃了。你也许想阅读 自定义指令调用 来查看它的替代物。

捕捉生成在它体内(也就是开始标签和结束标签之间)的输出， 之后让给定的转换物在写入最终的输出之前改变。

比如：

    <p>A very simple HTML file:
    <pre>
    <transform html_escape>
    <html>
      <body>
        <p>Hello word!
      </body>
    </html>
    </transform>
    </pre>

将会输出：

    <p>A very simple HTML file:
    <pre>
    &lt;html&gt;
      &lt;body&gt;
        &lt;p&gt;Hello word!
      &lt;/body&gt;
    &lt;/html&gt;
    </pre>

一些转换可能需要参数。参数的名称和意义依赖于转换的问题。 比如这里我们给出一个名为"var"的参数：

    <#-- This transform stores the output in the variable x,
         rather than sending it to the output -->
    <transform capture_output var="x">
    some test
    </transform>

这是程序员在数据模型中放置必要转换的任务。 对于可访问转换的名称和用法请问程序员。最初对在 `freemarker.template.utility` 包中的大多数转换来说有 共享变量。要获取更多信息，请参考：pgui_config_sharedvariables

#### 老式 FTL 语法

在FTL标签中使用 `#` 形式的FTL语法已经是不要求 (在 2.1 版本之前是不允许的)的了。比如，你可以这样写代码：

    <html>
    <head>
      <title>Welcome!</title>
    </head>
    <body>
      <h1>Welcome ${user}!</h1>
      <p>We have there animals:
      <ul>
      <list animals as animal>
        <li>${animal.name} for ${animal.price} Euros
      </list>
      </ul>
      <include "common_footer.html">
    </body>
    </html>

而没有 `#` 样式语法的代码对于HTML作者来说更加自然， 它有很多的缺点，所以最终我们决定废弃它。使用新式语法(又称为"严格的语法")， `#` 是严格要求的。也就是说，像 `<include "common_footer.html">` 这样的东西将会原样出现在输出中，因为它们不被认为是FTL标签。 注意用户自定义指令使用 `@` 代替 `#`。

然而，为了给用户时间来准备这种改变，在 FreeMarker 2.1 和 2.2 版本中， `#` 的用法是可选的，除非程序员调用 `Configuration` 的 `setStrictSyntaxMode(true)` 在 FreeMarker 配置中开启严格语法模式。 事实上，我们把这个强烈建议给程序员。从后续释出版本开始，这个设置将会初始设置为 `true`。而且，如果你在模板文件中想使用严格语法或老式语法，你可以用 `ftl` 指令来指定。

"严格语法"比遗留的FTL语法的好处是：

- 对于FTL来说，所有 `<#`...`>` 和 `</#`...`>` 都是保留的：

  - 我们可以引入新的指令而不破坏向后兼容。

  - 我们可以检测你是否创留了一个打字错误，也就是 `<#inculde `...`>` 被视为解析时的错误， 而不是被静默地视为简单文本。

  - 对于第三方工具来处理模板(比如高亮语法显示)来说是简单的， 特别是因为它们不需要知道新释出版本中被引入的新指令。

  - 模板更易于阅读，因为很容易辨认嵌入在HTML或其他标记中的 `<#...>` 标签。

- `<#` 和 `</#` 是合法的XML (除了在CDATA段中)，而且其他大多数SGML应用中也是合法的， 所以它们不能妨碍用在静态文本部分(比如你在生成的XML中有 `include` 元素)的标签。

#### #{...}: 数字插值

已经被废弃了：使用 `number_format` 设置项 和 the `string` 内建函数 来代替。对于计算机使用 (也就非本地的格式化)的格式化，使用 `c` 内建函数 (比如 ``number`?c`)。

##### 概要

    #{expression}
    或
    #{expression; format}

这里：

- ``expression``： 可以算作是数字的表达式

- ``format``： 可选的格式说明符

##### 描述

数字插值被用来输出数值。如果表达式不能算成数字， 那么计算过程就会以抛出错误而终止。

可选的格式说明符指定了使用 `m`min`M`max`` 语法显示的小数位数的最小和最大值。比如，`m2M5` 表示"最少两位，最多5位小数位"。最小值和最大值说明符部分可以被忽略。 如果仅指定最小值，那么最大值和最小值相等。如果仅指定最大值，那么最小值是0。

输出的小数点字符是国际化的(根据当前本地设置)，这表示它可能不是一个点。

不像 `${...}`, `#{...}` 忽略 `number_format` 设置项。实际上这是向后兼容的一个怪点，但是当你在如 `<a href="quertyDatabase?id=#{id}">` 这些情况打印数字时它可能是有用的，这里你肯定不想分组分隔符或像那些幻想的东西。 然而，从 FreeMarker 2.3.3 版本开始，而使用 `?c` 内建函数 来达到这个目的， 比如 `<a href="quertyDatabase?id=${id?c}">`。

比如。假设 `x` 是 `2.582` 而 `y` 是 `4`：

               <#-- If the language is US English the output is: -->
    #{x}       <#-- 2.582 -->
    #{y}       <#-- 4 -->
    #{x; M2}   <#-- 2.58 -->
    #{y; M2}   <#-- 4    -->
    #{x; m1}   <#-- 2.6 -->
    #{y; m1}   <#-- 4.0 -->
    #{x; m1M2} <#-- 2.58 -->
    #{y; m1M2} <#-- 4.0  -->

## XML处理指南

### 前言

尽管 FreeMarker 最初被设计用作Web页面的模板引擎， 对于2.3版本来说，它的另外一个应用领域目标是： 转换XML到任意的文本输出（比如HTML）。 因此，在很多情况下，FreeMarker 也是一个可选的XSLT。

从技术上来说，在转换XML文档上没有什么特别之处。 它和你使用 FreeMarker 做其他事情都是一样的： 你将XML文档丢到数据模型中(和其他可能的变量)， 然后你将FTL模板和数据模型合并来生成输出文本。 对于更好的XML处理的额外特性是结点FTL变量类型 (在通用的树形结构中象征一个结点，不仅仅是对XML有用)和用内建函数， 指令处理它们，你使用的XML包装器会暴露XML文档，并将作为模板的FTL变量。

使用 FreeMarker 和XSLT有什么不同？FTL语言有常规的命令式/过程式的逻辑。 另一方面，XSLT是声明式的语言，由"很聪明"的人设计出来， 所以它并不能轻易吸收它的逻辑，也不会在很多情况下使用。而且它的语法也非常繁琐。 然而，当你处理XML文档时，XSLT的"应用模板"方法可以非常方便， 因此 FreeMarker 支持称作"访问者模式"的相似事情。 所以在很多应用程序中，写FTL的样式表要比写XSLT的样式表容易很多。 另外一个根本的不同是FTL转换结点树到文本，而XSLT转换一课树到另一棵树。 所以你不能经常在使用XSLT的地方使用 FreeMarker。

### 揭示XML文档

#### 结点树

我们使用如下示例的XML文档：

    <book>
      <title>Test Book</title>
      <chapter>
        <title>Ch1</title>
        <para>p1.1</para>
        <para>p1.2</para>
        <para>p1.3</para>
      </chapter>
      <chapter>
        <title>Ch2</title>
        <para>p2.1</para>
        <para>p2.2</para>
      </chapter>
    </book>

W3C 的 DOM 定义XML文档模型为结点树。上面XML的结点树可以被视为：

    document
     |
     +- element book
         |
         +- text "\n  "
         |
         +- element title
         |   |
         |   +- text "Test Book"
         |
         +- text "\n  "
         |
         +- element chapter
         |   |
         |   +- text "\n    "
         |   |
         |   +- element title
         |   |   |
         |   |   +- text "Ch1"
         |   |
         |   +- text "\n    "
         |   |
         |   +- element para
         |   |   |
         |   |   +- text "p1.1"
         |   |
         |   +- text "\n    "
         |   |
         |   +- element para
         |   |   |
         |   |   +- text "p1.2"
         |   |
         |   +- text "\n    "
         |   |
         |   +- element para
         |      |
         |      +- text "p1.3"
         |
         +- element
             |
             +- text "\n    "
             |
             +- element title
             |   |
             |   +- text "Ch2"
             |
             +- text "\n    "
             |
             +- element para
             |   |
             |   +- text "p2.1"
             |
             +- text "\n    "
             |
             +- element para
                 |
                 +- text "p2.2"

请注意，烦扰的 `"\n "` 是行的中断 (这里用 `\n` 指示，在FTL字符串中使用转义序列) 和标记直接的缩进空格。

请注意和DOM相关的术语：

- 一棵树最上面的结点称为根 root，在XML文档中，它通常是"文档"结点， 而不是最顶层元素(本例中的 `book`)。

- 如果B是A的 直接 后继， 我们说B结点是A结点的子结点 child。比如， 两个 `chapter` 元素是 `book` 元素的子结点， 但是 `para` 元素就不是。

- 如果A是B的 直接 前驱，也就是说， 如果B是A的子结点，我们说结点A是结点B的父结点 parent。比如，`book` 元素是两个 `chapter` 元素的父结点， 但是它不是 `para` 元素的父结点。

- XML文档中可以出现几种成分，比如元素，文本，注释，处理指令等。 所有这些成分都是DOM树的结点，所以就有元素结点，文本结点，注释结点等。 原则上，元素的属性也是树的结点--它们是元素的子结点--， 但是，通常我们(还有其他XML相关的技术)不包含元素的子结点。 所以基本上它们不被记为子结点。

程序员将DOM树的文档结点放到 FreeMarker 的数据模型中， 那么模板开发人员可以以变量为出发点来使用DOM树。

FTL中的DOM结点和 node variables 结点变量对应。这是变量类型，和字符串，数字，哈希表等类型相似。 结点变量类型使得 FreeMarker 来获取一个结点的父结点和子结点成为可能。 这是技术上需要允许模板开发人员在结点间操作，也就是，使用node 内建函数 或者 `visit` 和 `recurse` 指令;我们会在后续章节中展示它们的使用。

#### 将XML放到数据模型中

本部分是对程序员来说的。

创建一个简单的程序来运行下面的示例是非常容易的。 仅仅用下面这个例子来替换程序开发指南中快速入门示例 中的"Create a data-model"部分：

    /* Create a data-model */
    Map root = new HashMap();
    root.put(
            "doc",
            freemarker.ext.dom.NodeModel.parse(new File("the/path/of/the.xml")));

然后你可以在基本的输出(通常是终端屏幕) 中得到一个程序可以输出XML转换的结果。

注意：

- `parse` 方法默认移除注释和处理指令结点。 参见API文档获取详细信息。

- `NodeModel` 也允许你直接包装 `org.w3c.dom.Node`。 首先你也许想用静态的实用方法清空DOM树，比如 `NodeModel.simplify` 或你自定义的清空规则。

请注意，有可用的工具，你可以使用它们从XML文档中来生成文件， 所以你不需对通用任务来写自己的代码。请参考这里...

### 必要的XML处理

#### 基本内容

这部分我们使用的DOM树和变量都是前一章做的那个。

假设程序员在数据模型中放置了一个XML文档，就是名为 `doc` 的变量。这个变量和DOM 树的根结点"document"对应。 真实的变量 `doc` 之后结构是非常复杂的， 大约类似DOM树。所以为了避免钻牛角尖，我们通过例子来看看如何使用。

##### 通过名称来访问元素

这个FTL打印book的title：

    <h1>${doc.book.title}</h1>

将会输出：

    <h1>Test Book</h1>

正如你所看到的，`doc` 和 `book` 都可以当作哈希表来使用。你可以按照子变量的形式来获得它们的子结点。 基本上，你用描述路径的方法来访问在DOM树中的目标(元素`title`)。 你也许注意到了上面有一些是假象:使用 `${doc.book.title}`， 就好像我们指示 FreeMarker 打印 `title` 元素本身， 但是我们应该打印它的子元素文本(看看 DOM 树)。 那也可以办到，因为元素不仅仅是哈希表变量，也是字符串变量。 元素结点的标量是从它的文本子结点级联中获取的字符串结果。然而，如果元素有子元素， 尝试使用一个元素作为标量会引起错误。比如`${doc.book}`将会以错误而终止。

该FTL打印2个chapter的title：

    <h2>${doc.book.chapter[0].title}</h2>
    <h2>${doc.book.chapter[1].title}</h2>

这里，`book` 有两个 `chapter` 子元素， `doc.book.chapter` 是存储两个元素结点的序列。 因此，我们可以概括上面的FTL，所以它以任意chapter的数量起作用：

    <#list doc.book.chapter as ch>
      <h2>${ch.title}</h2>
    </#list>

但是如果只有一个chapter会怎么样呢？实际上， 当你访问一个作为哈希表子变量的元素时，通常 也可以是序列(不仅仅是哈希表和字符串)，但如果序列只包含一个项， 那么变量也作为项目自身。所以，回到第一个示例中，它也会打印book的title：

    <h1>${doc.book[0].title[0]}</h1>

但是你知道那里就只有一个 `book` 元素， 而且book也就只有一个title，所以你可以忽略那些 `[0]`。 如果book恰好有一个 `chapter`(否则它就是模糊的： 它怎么知道你想要的是哪个 `chapter` 的 `title`？ 所以它就会以错误而停止)，`${doc.book.chapter.title}` 也可以正常进行。 但是因为一个book可以有很多chapter，你不能使用这种形式。如果元素 `book` 没有子元素 `chapter`， 那么 `doc.book.chapter` 将是一个长度为零的序列， 所以用FTL `<#list ...>` 也可以进行。

知道这样一个结果是很重要的，比如，如果 `book` 没有 `chapter`，那么 `book.chapter` 就是一个空序列，所以 `doc.book.chapter??` 就 不会 是 `false`，它就一直是 `true`！类似地，`doc.book.somethingTotallyNonsense??` 也不会是 `false`。来检查是否有子结点，可以使用 `doc.book.chapter[0]??`(或`doc.book.chapter?size == 0`)。 当然你可以使用类似所有的空值处理操作符 (比如 `doc.book.author[0]!"Anonymous"` )，只是不要忘了那个 `[0]`。

序列的大小是1的规则是方便XML包装的方便特性(通过多类型的FTL变量来实现)。 通常其他序列将不会起作用。

现在我们完成了打印每个chapter所有的 `para` 示例：

    <h1>${doc.book.title}</h1>
    <#list doc.book.chapter as ch>
      <h2>${ch.title}</h2>
      <#list ch.para as p>
        <p>${p}
      </#list>
    </#list>

将会输出：

    <h1>Test</h1>
      <h2>Ch1</h2>
        <p>p1.1
        <p>p1.2
        <p>p1.3
      <h2>Ch2</h2>
        <p>p2.1
        <p>p2.2

上面的FTL可以书写的更加漂亮：

    <#assign book = doc.book>
    <h1>${book.title}</h1>
    <#list book.chapter as ch>
      <h2>${ch.title}</h2>
      <#list ch.para as p>
        <p>${p}
      </#list>
    </#list>

最终，一个"广义的"子结点选择机制是： 模板列出所有示例XML文档的`para`：

    <#list doc.book.chapter.para as p>
      <p>${p}
    </#list>

将会输出：

      <p>p1.1
      <p>p1.2
      <p>p1.3
      <p>p2.1
      <p>p2.2

这个示例说明了哈希表变量选择序列子结点的做法 (在前面示例中的序列大小为1)。在这个具体的例子中，子变量 `chapter` 返回一个大小为2的序列 (因为有两个 `chapter`)，之后子变量 `para` 在那个序列中选择 `para` 所有结点的子结点。

这种机制的一个负面结果是类似于 `doc.somethingNonsense.otherNonsesne.totalNonsense` 这样的东西会被算作是空序列，而且你也不会得到任何错误信息。

##### 访问属性

这个XML和原来的那个是相同的，除了它使用title属性，而不是元素：

    <!-- THIS XML IS USED FOR THE "Accessing attributes" CHAPTER ONLY! -->
    <!-- Outside this chapter examples use the XML from earlier.       -->

    <book title="Test">
      <chapter title="Ch1">
        <para>p1.1</para>
        <para>p1.2</para>
        <para>p1.3</para>
      </chapter>
      <chapter title="Ch2">
        <para>p2.1</para>
        <para>p2.2</para>
      </chapter>
    </book>

一个元素的属性可以通过和元素的子元素一样的方式来访问， 除了你在属性名的前面放置一个@符号：

    <#assign book = doc.book>
    <h1>${book.@title}</h1>
    <#list book.chapter as ch>
      <h2>${ch.@title}</h2>
      <#list ch.para as p>
        <p>${p}
      </#list>
    </#list>

这会打印出和前面示例相同的结果。

按照和获取子结点一样的逻辑来获得属性，所以上面的 `ch.@title` 结果就是大小为1的序列。如果没有 `title` 属性，那么结果就是一个大小为0的序列。 所以要注意，这里使用内建函数也是有问题的：如果你很好奇 `foo` 是否含有属性 `bar`， 那么你不得不写 `foo.@bar[0]??`。 (`foo.@bar??` 是不对的，因为它总是返回 `true`)。类似地，如果你想要一个 `bar` 属性的默认值，那么你就不得不写 `foo.@bar[0]!"theDefaultValue"`。

正如子元素那样，你可以选择多结点的属性。 例如，这个模板将打印所有chapter的title属性：

    <#list doc.book.chapter.@title as t>
      ${t}
    </#list>

##### 探索DOM树

这个FTL将会枚举所有book元素的子结点：

    <#list doc.book?children as c>
    - ${c?node_type} <#if c?node_type == 'element'>${c?node_name}</#if>
    </#list>

将会输出：

    - text
    - element title
    - text
    - element chapter
    - text
    - element chapter
    - text

`?node_type` 的意思可能没有解释清楚。 有一些在DOM树中存在的结点类型，比如 `"element"`， `"text"`，`"comment"`， `"pi"`等。

`?node_name` 返回结点的结点名称。 对于其他的结点类型，也会返回一些东西，但是它对声明的XML处理更有用，这会在后面章节中讨论。

如果book元素有属性，由于实际的原因它可能 不会 在上面的列表中出现。 但是你可以获得包含元素所有属性的列表，使用变量元素的子变量 `@@`。如果你将XML的第一行修改为这样：

    <book foo="Foo" bar="Bar" baaz="Baaz">

然后运行这个FTL：

    <#list doc.book.@@ as attr>
    - ${attr?node_name} = ${attr}
    </#list>

然后得到这个输出(或者其他相似的结果)：

    - baaz = Baaz
    - bar = Bar
    - foo = Foo

要返回子结点的列表，有一个方便的子变量来仅仅列出元素的子元素：

    <#list doc.book.* as c>
    - ${c?node_name}
    </#list>

将会输出：

    - title
    - chapter
    - chapter

你可以使用内建函数 `parent` 来获得元素的父结点：

    <#assign e = doc.book.chapter[0].para[0]>
    <#-- Now e is the first para of the first chapter -->
    ${e?node_name}
    ${e?parent?node_name}
    ${e?parent?parent?node_name}
    ${e?parent?parent?parent?node_name}

将会输出：

    para
    chapter
    book
    @document

在最后一行你访问到了DOM树的根结点，文档结点。 它不是一个元素，这就是为什么得到了一个奇怪的名字； 现在我们不来处理它。很明显，文档结点没有父结点。

你可以使用内建函数 `root` 来快速返回到文档结点：

    <#assign e = doc.book.chapter[0].para[0]>
    ${e?root?node_name}
    ${e?root.book.title}

将会输出：

    @document
    Test Book

在内建函数完整的列表中你可以用来在DOM树中导航， 可以阅读结点内建函数参考。

##### 使用XPath表达式

XPath表达式仅在Jaxen(推荐使用， 但是使用至少Jaxen 1.1-beta-8版本，不能再老了)或Apache Xalan库可用时有效。 (Apache Xalan库在Sun J2SE 1.4，1.5和1.6(也许在后续版本)中已经包含了； 不需要独立的Xalan的jar包。)

不要使用前一部分的示例XML，那里的`title` 是一个属性；仅对那部分使用。

如果哈希表的键使用了结点变量而不能被解释(下一部分对此精确定义)， 那么它就会被当作Xpath表达式被解释。要获得XPath的更多信息， 可以访问http://www.w3.org/TR/xpath。

例如，这里我们列出 `title` 元素(不是属性！)内容为"Ch1"的chapter的 `para` 元素：

    <#list doc["book/chapter[title='Ch1']/para"] as p>
      <p>${p}
    </#list>

将会输出：

      <p>p1.1
      <p>p1.2
      <p>p1.3

长度为1(在前面部分解释过了)的序列的规则也代表XPath的结果。 也就是说，如果结果序列仅仅包含1个结点，它也会当作结点自身。 例如，打印chapter元素"Ch1"第一段：

    ${doc["book/chapter[title='Ch1']/para[1]"]}

这也会输出相同内容：

    ${doc["book/chapter[title='Ch1']/para[1]"][0]}

XPath表达式的内容结点(或者是结点序列) 是哈希表子变量被用作发布XPath表达式的结点。 因此，这将打印和上面例子相同的内容：

    ${doc.book["chapter[title='Ch1']/para[1]"]}

请注意，现在你可以使用0序列或多(比1多)结点作为内容， 这只在程序员已经建立 FreeMarker 使用Jaxen而不是Xalan时才可以。

也要注意XPath序列的项索引从1开始，而FTL的序列项索引是用0开始的。 因此，要选择第一个chapter，XPath表达式是 `"/book/chapter[1]"`， 而FTL表达式是 `book.chapter[0]`。

如果程序员设置 FreeMarker 使用Jaxen而不是Xalan， 那么 FreeMarker 的变量在使用XPath变量引用时是可见的：

    <#assign currentTitle = "Ch1">
    <#list doc["book/chapter[title=$currentTitle]/para"] as p>
    ...

请注意，`$currentTitle` 不是 FreeMarker 的插值， 因为那里没有 `{` 和 `}`。 那是XPath表达式。

一些XPath表达式的结果不是结点集，而是字符串，数字或者布尔值。 对于那些XPath表达式，结果分别是FTL字符串，数字或布尔值变量。 例如，下面的例子将会计算XML文档中 `para` 元素的总数， 所以结果是一个数字：

    ${x["count(//para)"]}

将会输出：

    5

##### XML命名空间

默认来说，当你编写如 `doc.book` 这样的东西时， 那么它会选择属于任何XML命名空间(和XPath相似)名字为 `book` 的元素。如果你想在XML命名空间中选择一个元素， 你必须注册一个前缀，然后使用它。比如，如果元素 `book` 是命名空间 `http://example.com/ebook`， 那么你不得不关联一个前缀，要在模板的顶部使用 `ftl` 指令 的 `ns_prefixes` 参数：

    <#ftl ns_prefixes={"e":"http://example.com/ebook"}>

现在你可以编写如 `doc["e:book"]` 的表达式。 (因为冒号会混淆 FreeMarker，方括号语法的使用是需要的。)

`ns_prefixes` 的值作为哈希表， 你可以注册多个前缀：

    <#ftl ns_prefixes={
        "e":"http://example.com/ebook",
        "f":"http://example.com/form",
        "vg":"http://example.com/vectorGraphics"}
    >

`ns_prefixes` 参数影响整个 FTL 命名空间。 这就意味着实际中，你在主页面模板中注册的前缀必须在所有的 `<#include ...>` 的模板中可见，而不是 `<#imported ...>` 的模板(经常用来引用FTL库)。从另外一种观点来说， 一个FTL库可以注册XML命名空间前缀来为自己使用，而前缀注册不会干扰主模板和其他库。

要注意，如果一个输入模板是给定XML命名空间域中的， 为了方便你可以设置它为默认命名空间。这就意味着如果你不使用前缀， 如在 `doc.book` 中，那么它会选择属于默认命名空间的元素。 这个默认命名空间的设置使用保留前缀 `D`，例如：

    <#ftl ns_prefixes={"D":"http://example.com/ebook"}>

现在表达式 `doc.book` 选择属于XML命名空间 `http://example.com/ebook` 的 `book` 元素。 不幸的是，XPath不支持默认命名空间。因此，在XPath表达式中， 没有前缀的元素名称通常选择不输入任何XML命名空间的元素。然而， 在默认命名空间中访问元素你可以直接使用前缀`D`，比如： `doc["D:book/D:chapter[title='Ch1']"]`。

请注意，当你使用默认命名空间时，那么你可以使用保留前缀 `N` 来选择不属于任意结点空间的元素。比如 `doc.book["N:foo"]`。这对XPath表达式不起作用， 上述的都可以写作 `doc["D:book/foo"]`。

##### 不要忘了转义！

我们在所有的示例中都犯了大错。我们生成HTML格式的输出， HTML格式保留如 `<`，`&` 等的字符。所以当我们打印普通文本(比如标题和段落)时， 我们不得不转义它，因此，示例的正确版本是：

    <#escape x as x?html>
    <#assign book = doc.book>
    <h1>${book.title}</h1>
    <#list book.chapter as ch>
      <h2>${ch.title}</h2>
      <#list ch.para as p>
        <p>${p}
      </#list>
    </#list>
    </#escape>

所以如果book的标题是"Romeo & Julia"， 那么HTML输出的结果就是正确的：

    ...
    <h1>Romeo &amp; Julia</h1>
    ...

#### 具体细节

每一个和DOM树中单独结点对应的变量都是结点和哈希表类型的多类型的变量 (对于程序员：实现`TemplateNodeModel` 和 `TemplateHashModel` 两个接口)。因此，你可以使用结点内建函数来处理它们。 哈希表的键被解释为XPath表达式，除了在下面表格中显示的特殊键。 一些结点变量也有字符串类型，所以你可以使用它们作为字符串变量 (对于程序员：他们需要实现 `TemplateScalarModel` 接口)。

结点类型 (`?node_type`) | 结点名称 (`?node_name`) | 字符串值 (比如 `<p>${node}`) | 特殊哈希表键
--- | --- | --- | ---
`"document"` | `"@document"` | 没有字符串值。(当你尝试用字符串来使用时发生错误。) | `"`elementName`"`, `"`prefix`:`elementName`"`, `"*"`, `"**"`, `"@@markup"`, `"@@nested_markup"`, `"@@text"`
`"element"` | `"`name`"`： 元素的名称。这是本地命名(也就是没有命名空间前缀的名字)。 | 如果它没有子元素，所有子结点的文本串联起来。 当你尝试用它当字符串时会发生错误。 | `"`elementName`"`, `"`prefix`:`elementName`"`, `"*"`, `"**"`, `"@`attrName`"`, `"@`prefix`:`attrName`"`, `"@@"`, `"@*"`, `"@@start_tag"`, `"@@end_tag"`, `"@@attributes_markup"`, `"@@markup"`, `"@@nested_markup"`, `"@@text"`, `"@@qname"`
`"text"` | `"@text"` | 文本本身。 | `"@@markup"`, `"@@nested_markup"`, `"@@text"`
`"pi"` | `"@pi$`target`"` | 在目标名称和 `?>` 之间的部分。 | `"@@markup"`, `"@@nested_markup"`, `"@@text"`
`"comment"` | `"@comment"` | 注释的文本，不包括分隔符 `<!--` 和 `-->`。 | `"@@markup"`, `"@@nested_markup"`, `"@@text"`
`"attribute"` | `"`name`"`： 属性的名字。这是本地命名(也就是没有命名空间前缀的名字)。 | 属性的值。 | `"@@markup"`, `"@@nested_markup"`, `"@@text"`, `"@@qname"`
`"document_type"` | `"@document_type$`name`"`: ``name`` 是文档元素的名字。 | 没有字符串值。(当你尝试用字符串来使用时发生错误。) | `"@@markup"`, `"@@nested_markup"`, `"@@text"`

注意：

- 没有CDATA类型，CDATA结点被透明地认为是文本结点。

- 变量 不 支持 `?keys` 和 `?values`。

- 元素和属性结点的名字是本地命名，也就是，它们不包含命名空间前缀。 结点所属的命名空间的URI可以使用内建函数 `?node_namespace` 来获得。

- XPath表达式需要Jaxen(推荐使用，但是请使用1.1-beta-8之后的版本； 可以从此处下载) 或者Apache的Xalan库，否则会有错误并且终止模板的执行。要注意， 隐藏在XPath表达式中一些特殊哈希表键有相同的意思， 尽管没有XPath可用的实现，但那些XPath表达式仍然会起作用。 如果Xalan和Jaxen两者都可用， FreeMarker 将会使用Xalen，除非你在Java代码中通过调用 `freemarker.ext.dom.NodeModel.useJaxenXPathSupport()` 方法，才会使用Jaxen。

- 如果Jaxen被用来支持XPath(而不是Xalan)， 那么 FreeMarker 变量通过XPath变量的引用是可见的 (比如`doc["book/chapter[title=$currentTitle]"]`)。

特殊哈希表键的含义：

- `"`elementName`"`， `"`prefix`:`elementName`"`： 返回元素名为 ``elementName`` 的子结点的序列。(注意这里的"子"结点就是 直接 后继) 选择是XML命名空间的标识，除非XML文档用不再命名空间标识结点中的XML解析器解析。 在XML命名空间标识结点中，不含前缀的名字(`elementName`) 仅仅选择不属于任何XML命名空间的元素(除非你已经注册了默认的XML命名空间)， 有前缀的名字(`prefix`:`elementName`) 选择属于前缀代表命名空间的元素。前缀的注册和默认XML命名空间的设置是由`ftl` 指令 的 `ns_prefixes` 参数完成的。

- `"*"`：返回所有子(直接后继) 元素 结点的序列。这个序列会按"文档顺序"包含元素， 也就是说，按照每个XML结点的表现形式的第一个字符的顺序出现 (在一般实体的扩展之后)。

- `"**"`：返回所有后继 元素 结点的序列。这个序列按文档顺序包含元素。

- `"@`attName`"`， `"@`prefix`:`attrName`"`： 作为一个大小为1，包含属性结点的序列的形式，返回元素的属性名 ``attName``，如果属性不存在时， 作为一个空序列返回(所以来检查属性是否存在，可以使用 `foo.@`attName`[0]??`， 而不是 `foo.@`attName`??`)。 正如 `"`elementName`"` 这个特殊的键， 如果序列的长度为1，那么它也当作是第一个子变量。如果没有使用 ``prefix``，那么它只返回属性， 而不使用XML命名空间(尽管你已经设置了默认的XML命名空间)。 如果使用了 ``prefix``， 它返回仅仅属于关联的 ``prefix`` 的XML命名空间的属性。前缀的注册是由 `ftl` 指令 的 `ns_prefixes` 参数完成的。

- `"@@"` 或 `"@*"` ：返回属于父结点的结点的属性序列，这和XPath中的 `@*` 是相同。

- `"@@qname"`：返回元素的完全限定名 (比如 `e:book`，和由 `?node_name` 返回的本地名 `book` 形成对比)。使用的前缀 (如 `e`)是基于在当前命名空间用 `ftl` 指令的 `ns_prefixes` 参数注册的前缀而选择的， 而不受源XML文档中使用的前缀影响。如果你已经设置了一个默认的XML命名空间， 那么结点会使用默认的，前缀 `D` 就会被使用了。 不属于任何XML命名空间的结点，不使用前缀(尽管你设置过默认的命名空间)。 如果结点没有为命名空间注册的前缀，那结果是不存在的变量 (`node.@@qname??` 是 `false`)。

- `"@@markup"`：这会以字符串形式返回一个结点的完整XML标记。 (完整的XML标记表示它也包含子结点的标记，而且包含子结点的子结点的标记，以此类推) 你得到的标记和在源XML文档中的标记相比不是必须的，它只是语义上的相同。特别地， 注意CDATA段将会解释成普通文本。也要注意基于你是怎么用包装原生的XML文档的， 注释或处理指令结点可能被移除，而且它们将会从源文件的输出中消失。 对于在输出XML段的每个XML命名空间，第一个被输出的开始标记将会包含 `xmlns:`prefix`` 属性， 而且那些前缀将会在输出的元素和属性名中使用。这些前缀和使用 `ftl` 指令的 `ns_prefixes` 参数注册的前缀相同 (没有前缀使用 `D`，因为它会和 `xmlns` 属性被用来注册默认的命名空间)，如果XML命名空间没有定义前缀， 那么会使用一个任意未被选择使用的前缀。

- `"@@nested_markup"`：这个和 `"@@markup"` 相似，但是它返回不包括开放和封闭标记元素的XML标记。对于文档结点，它返回和 `"@@markup"` 相同的内容。对于其他类型结点(文本，处理指令等)， 它返回一个空字符串。不像 `"@@markup"`，在输出中没有 `xmlns:`prefix`` 属性， 但是关于在元素和属性名中使用前缀规则是相同的。

- `"@@text"`：它返回文本结点(所有后继文本结点， 而不是直接子结点)点的值，连接成一个单独的字符串。 如果结点没有子文本结点，那么返回的是空字符串。

- `"@@start_tag"`：返回元素结点 开始标签 的标记。 正如 `@@markup`，输出和源XML文档相比不是必须的， 但是在语义上是相同的。关于XML命名空间 (输出中的`xmlns:`prefix``属性等)， 规则和 `"@@markup"` 是相同的。

- `"@@end_tag"`：返回元素结点 结束标签 的标记，正如 `@@markup`，输出和源XML文档相比不是必须的， 但是在语义上是相同的。

- `@@attributes_markup`：返回元素结点 属性 的标记，正如 `@@markup`，输出和源XML文档相比不是必须的， 但是在语义上是相同的。

##### 结点序列

许多特殊哈希表的键(指的是上面所有的列表)， 和XPath表达式的结果是结点集(参考XPath 推荐)， 返回结点的序列。

这些结点序列，如果它们只存储一个子变量，也会当作子变量本身。 例如，如果 `book` 元素只有一个 `title` 子结点，`${book.title[0]}` 和 `${book.title}` 是相同的。

返回一个空结点序列是普通的情形。例如，如果一个确定的XML文档， `book` 元素没有子元素 `chapter`， 那么 `book.chapter` 的结果就是一个空的结点序列。 要小心！这也意味着 `book.chaptre`(注意打字错误) 也会返回空的结点序列，而且会抛出错误而停止执行。同时， `book.chaptre??`(注意打字错误)将会返回 `true`，因为空的序列存在，所以你不得不使用 `book.chaptre[0]??` 来检查。

结点序列存储的不是1个结点(但是0或者比1多的结点) 也会支持上面所描述的哈希表的键。那就是，下面这些特殊的键都是支持的：

- `"`elementName`"`, `"`prefix`:`elementName`"`

- `"@`attrName`"`, `"@`prefix`:`attrName`"`

- `"@@markup"`, `"@@nested_markup"`

- `"@@text"`

- `"*"`, `"**"`

- `"@@"`, `"@*"`

当在一个包含多于1个结点或0个结点序列里应用上面这些特殊的键中之一的时候， 那么对于序列(就是特殊的键可以起作用，比如文本结点对于键 `*` 或 `@foo` 将会被略过)中的每个结点， 这些特殊的键将会被应用于单独的结点，结果将会从最终的结果中被连接。 结果会被以和结点在序列中出现的对应顺序来连接。 连接就意味着字符串或序列的连接是基于结果类型之上的。 如果特殊的键会得到单独结点的字符串结果，那么对于多个结点的结果就是一个单独的字符串 (对单独结点的结果进行连接)，而如果特殊的键返回单独结点的序列，那么对于多个结点， 结果就是一个单独的序列。如果在你应用特殊键的序列中没有结点，那么字符串结果就是空串， 而序列结果就是空序列。

XPath表达式可以和结点序列一同使用。然而，对于0或者大于1的结点， 因为Xalan对XPath实现的限制，仅仅你使用Jaxen代替Xalan时它才会起作用。

### 声明的XML处理

#### 基本内容

这部分使用的DOM树和变量是 前一章节 中做好的。

因为XML处理的方法非常必要--这在前面章节中已经展示-- 编写一个FTL程序来遍历树，为了找到不同种类的结点。而使用声明的方法， 宁愿定义如何控制不同种类的结点，之后让 FreeMarker 遍历那棵树， 调用你定义的处理器。这个方法对于复杂的XML模式非常有用， 相同元素可以作为其他元素的子元素出现。 这样的模式的示例就是XHTML和XDocBook。

最经常使用来处理声明方式的指令就是 `recurse` 指令， 这个指令获取结点变量，并把它作为是参数，从第一个子元素开始， 一个接一个地"访问"所有它的子元素。"访问"一个结点意味着它调用了用户自定义的指令 (比如宏)，它的名字和子结点(`?node_name`)的名字相同。 我们这么说，用户自定义指令操作结点。使用用户自定义指令 处理 的结点作为特殊变量 `.node` 是可用的。例如，这个FTL：

    <#recurse doc>

    <#macro book>
      I'm the book element handler, and the title is: ${.node.title}
    </#macro>

将会输出(这里已经移除了输出内容中一些烦扰的空白)：

    I'm the book element handler, and the title is: Test Book

如果调用 `recurse` 而不用参数，那么它使用 `.node`，也就是说，它访问现在处理这个结点的所有子结点。 所以这个FTL：

    <#recurse doc>

    <#macro book>
      Book element with title ${.node.title}
        <#recurse>
      End book
    </#macro>

    <#macro title>
      Title element
    </#macro>

    <#macro chapter>
      Chapter element with title: ${.node.title}
    </#macro>

将会输出(这里已经移除了输出内容中一些烦扰的空白)：

    Book element with title Test Book
    Title element
    Chapter element with title: Ch1
    Chapter element with title: Ch2
    End book

已经看到了如何来为元素结点定义处理器，但不是为文本结点定义处理器。 因为处理器的名字是和它处理的结点名字相同的，作为所有文本结点的结点名字是 `@text`(参考该表)， 为文本结点定义处理器，可以是这样的：

    <#macro @text>${.node?html}</#macro>

请注意 `?html`。不得不转义HTML文本， 因为生成的是HTML格式的输出。

这个模板就是转换XML到完整的HTML：

    <#recurse doc>

    <#macro book>
      <html>
        <head>
          <title><#recurse .node.title></title>
        </head>
        <body>
          <h1><#recurse .node.title></h1>
          <#recurse>
        </body>
      </html>
    </#macro>

    <#macro chapter>
      <h2><#recurse .node.title></h2>
      <#recurse>
    </#macro>

    <#macro para>
      <p><#recurse>
    </#macro>

    <#macro title>
      <#--
        We have handled this element imperatively,
        so we do nothing here.
      -->
    </#macro>

    <#macro @text>${.node?html}</#macro>

将会输出(这里包含了那些烦扰的空白)：

      <html>
        <head>
          <title>Test Book</title>
        </head>
        <body>
          <h1>Test Book</h1>

        <h2>Ch1</h2>

          <p>p1.1

          <p>p1.2

          <p>p1.3

        <h2>Ch2</h2>

          <p>p2.1

          <p>p2.2

        </body>
      </html>

请注意，可以在输出中使用trim 指令，如 `<#t>` 来大幅减少多余的空白。参考：dgui_misc_whitespace

你也许会说FTL处理它的这些必要方法可以更短些。那是对的， 但是示例XML使用了非常简单的模式，正如之前说过的， 声明方法带和XML模式一同来了它的格式， 而这个模式关于这里可以出现什么元素是不固定的。所以， 介绍元素 `mark`， 应该把文本标记为红色， 而和你在哪儿使用它无关；在 `title` 或在 `para` 中。对于这点，使用声明的方法，你可以增加一个宏：

    <#macro mark><font color=red><#recurse></font></#macro>

那么 `<mark>...</mark>` 将会自动起作用。 所以对于命令式的XML模式，声明的XML处理确实将会很短，而且更重要的是， 对于必要的XML处理，FTL-s会更清晰。但这都依赖于你的决定，什么时候使用哪种方法； 不要忘记你可以自由混合两种方法。也就是说，在一个元素处理器中， 你可以使用命令式的方法来处理元素的内容。

#### 具体细节

##### 默认处理器

对于一些XML结点类型，有默认的处理器， 这会处理你不给这些结点定义处理器的结点 (也就是说，如果没有可用的，和结点名称相同的用户自定义指令)。 这里的结点类型，默认的处理器会做：

- 文本结点：打印其中的文本。要注意，在很多应用程序中， 这对你来说并不好，因为你应该在你发送它们到输出 (使用 `?html` 或 `?xml` 或 `?rtf` 等，这基于输出的格式)前转义这些文本。

- 处理指令结点：如果你定义了自定义指令，可以通过调用处理器调用 `@pi`，否则将什么都不做(忽略这些结点)。

-  注释结点，文档类型结点：什么都不做(忽略这些结点)。

- 文档结点：调用 `recurse`，也就是说， 访问文档结点的所有子结点。

元素和属性结点通常将会被XML独立机制处理。也就是， `@`node_type`` 将会被调用作为处理器， 如果它没有被定义，那么错误会阻止模板的处理。

元素结点的情形，这意味着如果你定义了一个称为 `@element` 的宏(或其他种类的用户自定义指令)，没有其他特定的处理器时， 那么它会捕捉所有元素结点。如果你没有 `@element` 处理器， 那么 必须 为所有可能的元素定义处理器。

属性结点在 `recurse` 指令中不可见， 所以不需要为它们编写处理器。

##### 访问单独结点

使用`visit` 指令 可以访问单独的结点，而不是结点的子结点： `<#visit `nodeToVisist`>`。 有时这会很有用。

##### XML命名空间

我们说过对于一个元素的处理器，用户自定义指令(比如宏)的名字就是元素的名字。 事实上，它是元素的完全限定名： ``prefix`:`elementName``。 这个关于 ``prefix`` 的使用规则和命令式处理是相同的。 因此，用户自定义指令 `book` 仅仅处理不属于任何XML命名空间 (除非你已经定义了默认的XML命名空间)的 `book` 元素。 所以示例XML将会使用XML命名空间 `http://example.com/ebook`：

    <book xmlns="http://example.com/ebook">
    ...

那么FTL就会像这样：

    <#ftl ns_prefixes={"e":"http://example.com/ebook"}>

    <#recurse doc>

    <#macro "e:book">
      <html>
        <head>
          <title><#recurse .node["e:title"]></title>
        </head>
        <body>
          <h1><#recurse .node["e:title"]></h1>
          <#recurse>
        </body>
      </html>
    </#macro>

    <#macro "e:chapter">
      <h2><#recurse .node["e:title"]></h2>
      <#recurse>
    </#macro>

    <#macro "e:para">
      <p><#recurse>
    </#macro>

    <#macro "e:title">
      <#--
        We have handled this element imperatively,
        so we do nothing here.
      -->
    </#macro>

    <#macro @text>${.node?html}</#macro>

或者你可以定义一个默认的XML命名空间， 那后面部分的模板保持和源XML命名空间相同，比如：

    <#ftl ns_prefixes={"D":"http://example.com/ebook"}>

    <#recurse doc>

    <#macro book>
    ...

但是这种情形下不要忘了在XPath表达式(我们在默认中没有使用)中， 默认的XML命名空间必须通过明确的 `D:` 来访问， 因为在XPath中没有前缀的名称通常指代没有XML命名空间的结点。 而且注意到命令式的XML处理也是相同的逻辑，如果(当且仅当)没有默认XML命名空间时， 元素处理器的名字没有XML命名空间是 `N:`elementName``。 然而，对于不是元素类型的结点(比如文本结点)，你不能在处理器名称中使用前缀 `N`，因为这些结点在XML命名空间中是没有这些概念的。 所以对于示例，文本结点的处理器通常就是 `@text`。

对于更详细的内容，请阅读 `recurse` 和 `visit` 指令的参考文档。

## 附录

### FAQ

JSP 和 FreeMarker ?

我们比较 FreeMarker 和 JSP 2.0 + JSTL 的组合。

FreeMarker 的优点：

- FreeMarker 不绑定Servlet，网络/Web环境；它仅仅是通过合并模板和Java对象 (数据模型)来生成文本输出的类库。你可以在任意地方任意时间来执行模板； 不需要HTTP的请求转发或类似的手段，也不需要Servlet环境。 出于这些特点你可以轻松的将它整合到任何系统中去。

- 更简洁的语法。看下这个JSP(假设 `<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>`)：

      <c:if test="${t}">
        True
      </c:if>

      <c:choose>
        <c:when test="${n == 123}">
            Do this
        </c:when>
        <c:otherwise>
            Do that
        </c:otherwise>
      </c:choose>

      <c:forEach var="i" items="${ls}">
      - ${i}
      </c:forEach>

  相等的 FTL：

      <#if t>
        True
      </#if>

      <#if n == 123>
        Do this
      <#else>
        Do that
      </#if>

      <#list ls as i>
      - ${i}
      </#list>

- 在模板中没有servlet特定的范围和其它高级技术 (除非，当然，你可以故意地将它们放入数据模型中)。 一开始就是为MVC设计的，它仅仅专注于展示。

- 可以从任意位置加载模板；从类路径下，从数据库中等。

- 默认情况下，数字和日期格式是本地化敏感的。 因为我们对用户输出，你所做的仅仅是书写 `${x}`， 而不是 `<fmt:formatNumber value="${x}" />`。

- 易于定义特设的宏和函数。

- 隐藏错误并假装它不存在。丢失的变量和 `null` 也不会默认视为 `0`/`false`/空字符串， 但会引发错误。在这里参考更多内容...

- "对象包装"。允许你在模板中以自定义，面向表现的方式来展示对象。 (比如：参看这里， 来看看使用这种技术时W3C的DOM结点是如何通过模板展现出来的。)

- 宏和函数仅仅是变量，所以它们可以很容易的作为参数值来传递， 放置到数据模型中等，就像其它任意值。

- 第一次访问一个页面时几乎察觉不到的延迟 (或在它改变之后)，因为没有更高级的编译发生。

FreeMarker 的缺点：

- 不是一种标准。很少的工具和IDE来集成它，少数的开发者知道它， 很少的工业化的支持。(然而，使用合适的设置， 大部分JSP标签库可以在 FreeMarker 模板中运行，除非它们基于 `.tag` 文件。)

- 除了一些视觉上的相似性，它的语法不同于HTML/XML语法规则， 这会使得新用户感到混乱(这就是简洁的价值所在)。JSP也不遵循它， 只是接近。

- 因为宏和函数仅仅是变量，不正确的指令， 参数名和丢失的必须变量仅仅在运行时会被检测到。

- 不能和JSF一起使用。(这在技术上可行，但是没有人来实现它)

如果你认为可以用 FreeMarker 在应用程序或遗留的仅支持JSP的框架中来代替JSP， 你可以阅读这部分内容：pgui_misc_servlet_model2

为什么 FreeMarker 对 `null` 和不存在的变量很敏感，如何来处理它？

概括一下这点是关于什么的：默认情况下，FreeMarker 将试图访问一个不存在的变量或 `null` 值 (这两点是一样的)视为一个错误， 这会中断模板的执行。

首先，你应该理解敏感的原因。很多脚本语言和模板语言都能容忍不存在的变量 (还有 `null`)，通常它们将这些变量视为空字符串和/或0， 还有逻辑false。这些行为主要有以下几点问题：

- 它潜在隐藏了一些可能偶然发生的错误，就像变量名中的一个错字， 或者当模板编写者引用程序员没有放到数据模型中的变量时， 或程序员使用了一个不同的名字。人们是容易犯下这种偶然的错误的， 而计算机则不会，所以失去这些机会，模板引擎可以显示这些错误则是一个很糟糕的运行方式。 尽管你很小心地检查了开发期间模板输出的内容，那也很容易就忽略了如 `<#if hasWarnigs>`print warnings here...`</#if>` 这样的错误，可能永远不会打印警告信息， 因为你已经搞乱了变量名(注意到了吗？)。也考虑一下后期的维护，当你以后修改你的应用时， 你可能不会每次都重新来仔细检查模板(很多应用程序都有数以百计的模板)。 单元测试也不会很好的覆盖到web页面内容(如果设置了它们...)； 它们最多只会检查web页面中的某些手动设置模式，所以它们通常会光滑地通过， 但那些修改实际是有bug的。如果页面执行失败，那么测试人员将会注意， 单元测试也会注意(比如整个页面失败)，在生产环境中，维护人员会注意 (假设一些人员检查错误日志)。

- 做了危险的假设。脚本语言或模板引擎对应用程序领域是一无所知的， 所以当它决定一些它不知道是 0/false 值时，这是一个相当不负责而且很武断的事情。 仅仅因为它不知道你当前银行账户的余额，我们能说是0么？ 仅仅因为不知道一个病人是否对青霉素过敏，我们就能说他/她不对青霉素过敏？ 想一想这样错误的暗示信息。展示一个错误提示页面通常要比直接显示错误信息好很多， 导致用户端的错误决定。

这种情况下(不面对这种问题)，不对其敏感那就是隐藏错误假装它不存在了， 这样很多用户会觉得方便，但是我们仍然相信在大多数情况下严格对待这个问题， 从长远考虑会节省你更多时间并提高软件的质量。

另外一方面，我们意识到你有更好的原因在有些地方不想 FreeMarker 对错误敏感， 那么对于这种情况的解决方案如下：

- 通常数据模型中含有 `null` 或可选变量。 这种情况下使用 这些操作符。 如果你使用它们很频繁的话，那么就要重新考虑一下你的数据模型了， 因为过分依赖它们并不是那些难以使用的详细模板的结果， 但是会增加隐藏错误和打印任意不正确输出(原因前面已经说过了)的可能性。

- 在一些应用程序中，你也许想显示不完整/损坏的页面，而不是错误页面。 这种情况下，你可以 使用另一种错误控制器 而不是默认的。自定义的错误控制器可以略过有问题的部分，或者在那儿显示错误指示， 而不会中止整个页面的呈现。请注意，尽管错误控制器没有给出变量任意的默认值， 显示危急信息的页面也可能会好过显示错误页面。

- 如果页面包含的信息不是至关重要的(比如一些侧栏)， 另外一个你可能感兴趣的特性是 `attempt`/`recover` 指令。

为什么 FreeMarker 打印奇怪的数字格式 (比如 1,000,000 或 1 000 000 而不是 1000000)？

FreeMarker 使用Java平台的本地化敏感的数字格式信息。 默认的本地化数字格式可能是分组或其他不想要的格式。 为了避免这种情况，你不得不使用 FreeMarker 设置 中的 `number_format` 来重写Java平台建议的数字格式，比如：

    cfg.setNumberFormat("0.######");  // now it will print 1000000
    // where cfg is a freemarker.template.Configuration object

请注意，人们通常在没有分组分隔符时阅读大数是有些困难的。 所以通常建议保留分隔符，而在对"计算机"处理时的情况(分组分隔符会使其混乱)， 就要使用 `c` 内建函数 了。比如：

    <a href="/shop/productdetails?id=${product.id?c}">Details...</a>

对于计算机，你需要 `?c`，而根据本地化设置， 小数分隔符还是要担心。

为什么 FreeMarker 会不好打印的小数/分组分隔符号 (比如3.14而不是3,14) ?

不同的国家使用不同的小数/分组分隔符号。 如果你看到不正确的符号，那么可能你的本地化设置不太合适。 设置Java虚拟机的默认本地化或使用 FreeMarker 设置 中的 `locale` 来重写默认本地化。比如：

    cfg.setLocale(java.util.Locale.ITALY);
    // where cfg is a freemarker.template.Configuration object

然而有时你想输出一个数字，这个数字不是对用户的， 而是对"计算机"的(比如你想在CSS中打印大小)， 不管页面的本地化(语言)是怎么样的，这种情况你必须使用点来作为小数分隔符。 这样就可以使用 `c` 内建函数，比如：

    font-size: ${fontSize?c}pt;

为什么当我想用如 `${aBoolean}` 格式打印布尔值时， FreeMarker 会抛出错误，又如何来修正呢 ？

不像是数字，布尔值没有通用的可接受的格式， 在相同页面中也没有一个通用的格式。就像当你在HTML页面中展示一件产品是可洗的， 你可能不会想给访问者看"Washable：true"，而是"Washable:yes"。 所以我们强制模板作者(由 `${washable}` 引起错误)去探索用户的感知， 在确定的地方布尔值应该来显示成什么。通常我们格式化布尔值的做法是： `${washable?string("yes", "no")}`， `${caching?string("Enabled", "Disabled")}`， `${heating?string("on", "off")}`等。

但有两种情形这里是无用的：

- 当打印布尔值来生成计算机语言输出，那么就想要 `true`/`false`，使用 `${`someBoolean`?c}`。 (这至少需要 FreeMarker 2.3.20 版本。在那之前，通用的做法是编写 `${`someBoolean`?string}`， 但这是很危险的，因为它的输出基于当前的布尔值格式设置，默认的是 `"true"`/`"false"`。)

- 当对很多布尔值进行同一方式的格式化时。这种情形可以设置 `boolean_format` 设置项 (`Configuration.setBooleanFormat`) 来影响， 从 FreeMarker 2.3.20 版本开始，你可以仅仅编写 `${`someBoolean`}`。 (请注意，这对 `true`/`false` 无效 - 你还必须在那儿使用 `?c`。)

FreeMarker 没有找到我的模板 (`TemplateNotFoundException` 或 `FileNotFoundException`， Template not found 错误消息)

首先，你应该知道 FreeMarker 是不从文件系统路径直接加载模板的。 它使用一个简单虚拟的文件系统可以读取非文件系统资源 (在jar内部的模板，从数据库表中读取模板等...)。虚拟文件由配置设置项来决定， `Configuration.setTemplateLoader(TemplateLoader)`。 即便你使用的 `TemplateLoader` 映射到了文件系统， 它会有一个包含所有模板的基路径，那就是你不能伸到的虚拟文件系统的根 (也就是说，绝对路径仍然是相对于虚拟文件系统的)。

解决问题的小窍门：

- 如果你是配置 FreeMarker 的人，请确认你设置了合适的 `TemplateLoader`。

- 否则，请看未找到模板的错误消息是否包含所使用的 `TemplateLoader` 的描述。如果没有， 那么你使用的是老版本的 FreeMarker，那么请更新版本。得到 `FileNotFoundException` 而不是 `TemplateNotFoundException` 也是版本太老， 所以你不会得到更多的错误消息。(如果 `TemplateLoader` 在错误消息中是形如 `foo.SomeTemplateLoader@64f6106c` 这样的内容， 而没有显示相关的参数，你可以请作者定义一个更好的 `toString()`。)

- 常犯的错误是对基于Servlet的web应用程序使用了 `FileTemplateLoader` 而不是 `WebappTemplateLoader`。 它会在一种环境中可用， 但是不会作用于在另一种，因为Servlet规范没有承诺资源可以作为普通文本来访问， 甚至当 `war` 文件被提取时。

- 要知道当你从其它模板中包含/引入模板时，如果没有以 `/` 来开始模板名称，那么它就会被解释为相对于包含模板的路径。 错误消息会包含全(分解后的)名，所以应该注意这里。

- 检查你是否正在使用 `\` (反斜杠) 来代替 `/` (斜杠)。 (FreeMarker 2.3.22 和之后的版本会在错误消息中警告这点。)

- 作为最后的补救办法，对 `freemarker.cache` 类别开启debug级别的日志(在你使用的日志框架中)，然后来看还会有什么。

文档中编写了关于特性 `X`， 但是好像 FreeMarker 并不知道它，或者行为和文档中的不同， 或者据称已经修复的bug仍然存在。

你确定你正在使用的文档和正在使用的 FreeMarker 版本号相同？ 特别要注意，在线文档是对最新稳定的FreeMarker发布版。你可能使用的是老版本； 请更新它。

你确定Java类加载器发现了你期望使用的相同版本的 `freemarker.jar`？也许 `freemarker.jar` 是老版本的。要检查这点，尝试使用 `${.version}` 在模板中打印版本号。(如果以"Unknown built-in variable: version" 错误消息结束， 那么你使用的是相当相当老的版本。)

如果你怀疑该问题是有多个 `freemarker.jar`， 典型的罪魁祸首就是某些模块有Maven或Ivy依赖使用了老的 `freemarker` group ID， 而不是更为现代的 `org.freemarker` group ID。因为不同的group ID， 不会被Maven或Ivy视为构件冲突，而是把两个版本都引入。这种情况下， 不得不去掉 `freemarker` 依赖。

如果你认为文档或 FreeMarker 有错误，请在bug跟踪器或邮件列表中中报告。 谢谢你！

FreeMarker标签中的 `<` 和 `>` 混淆了编辑器或XML处理器，应该怎么做 ？

从 FreeMarker 2.3.4 版本开始，你可以使用 `[` 和 `]` 来代替 `<` 和 `>`。要获取更多细节， 阅读这里...

什么是合法的变量名 ？

关于在变量名中使用的字符和变量名的长度，FreeMarker 没有限制， 但是为了你的方便，在选择变量名时最好是简单变量引用表达式(参见 这里）。 如果你不得不选择一个非常极端的变量名，那也不是一个问题：参加这里。

如何使用包含负号(`-`)，冒号 (`:`)，点(`.`)，或其它特殊字符的 变量名(宏名，参数名) ？

如果你的变量名很奇怪，比如 foo-bar， 当你编写如 `${foo-bar}` 的形式时， FreeMarker 会曲解你想要的东西。在这种确定的情况下， 它会相信你想从 `foo` 中减去 `bar` 的值， 这个FAQ例子解释了如何控制这样的情况。

首先，应该清理这些句法问题。关于变量名中使用的字符和变量名的长度， FreeMarker没有限制。

如果特殊字符是负号 (`-`, UCS 0x2D) 或点 (`.`, UCS 0x2E) 或冒号 (`:`, UCS 0x3A)中的一种， 那么你所要做的就是在这些字符前面放置反斜杠(`\`)， 比如在 `foo\-bar` (从 FreeMarker 2.3.22 版本开始)。 之后 FreeMarker 就会知道你不是想要相同符号的操作符。 在你指定未被引号表示的标识符时，这都起作用，比如对宏和函数名称， 参数名称，所有种类的变量引用。(请注意，这些转义仅在标识符中起作用， 而不是在字符串中。)

当特殊字符不是负号，点，或冒号中的一种时，那就很微妙了。 我们来看看有问题的变量，名称为 a+b。那么：

- 如果你像读取变量：如果它是子变量或其它，可以编写 `something["a+b"]` (请记住， `something.x` 和 `something["x"])` 是相等的。如果它是顶级变量， 它们可以通过特殊哈希变量来访问，`.vars`， 所以你可以编写 `.vars["a+b"]`。很自然地， 这个技巧对宏和函数调用有有效： `<@.vars["a+b"]/>`， `.vars["a+b"](1, 2)`。

- 如果你想创建或修改变量：所有允许你来创建或修改变量的指令 (比如 `assign`， `local`， `global`， `macro`， `function`，等等)允许对目的变量名的引用。 比如， `<#assign foo = 1>` 和 `<#assign "foo" = 1>` 是相同的。所以你可以编写如 `<#assign "a+b" = 1>` 和 `<#macro "a+b">`。

- 不幸的是，你不能使用这样的变量名(包含不是 `-`，`.` 和 `:` 的特殊字符)来作为宏参数名。

为什么当我尝试使用 `X` JSP 自定义标签时， 得到了 "java.lang.IllegalArgumentException: argument type mismatch" ?

首先，请更新 FreeMarker，因为 2.3.22 和之后的版本给出了更多有用的错误消息， 会给出该问题更好的答案。不管怎样，原因如下。在JSP页面，你对所有参数(属性)值使用引号， 如果参数的类型是字符串或布尔值或数字，它不会起作用。 但是因为自定义标签在FTL模板中是作为普通用户自定义FTL指令来访问的， 你不得不在自定义标签内使用FTL语法规则，而不是JSP规则。因此，根据FTL规则， 必须不能对布尔值和数字参数值使用引号，否则它们会被解释成字符串值， 当 FreeMarker 尝试传递这些值给自定义标签，而它们需要非字符串值时， 这会引起类型不匹配错误。

比如，Struts Tiles的 `insert` 标签参数 `flush` 是布尔值。在JSP中，正确的语法是：

    <tiles:insert page="/layout.jsp" flush="true"/>
    ...

但是在FTL中，你应该编写：

    <@tiles.insert page="/layout.ftl" flush=true/>
    ...

而且，出于相似的原因，这是错误的：

    <tiles:insert page="/layout.jsp" flush="${needFlushing}"/>
    ...

你应该编写：

    <tiles:insert page="/layout.jsp" flush=needFlushing/>
    ...

(不是 `flush=${needFlushing}`！)

如何像 `jsp:include` 一样的方式引入其它的资源 ？

不是使用 `<#include ...>`， 那仅仅是包含另外一个 FreeMarker 模板而不涉及Servlet容器。

因为你要的包含方法是和Servlet相关的， 而纯 FreeMarker 是不知道Servlet和HTTP的存在， 那是Web应用框架来决定你是否可以这样做和如何来做。 比如，在Struts2中，你可以这么来做：

    <@s.include value="/WEB-INF/just-an-example.jspf" />

如果Web应用框架对 FreeMarker 的支持是基于 `freemarker.ext.servlet.FreemarkerServlet` 的， 那么你可以这样来做(从 FreeMarker 2.3.15 版本之后)：

    <@include_page path="/WEB-INF/just-an-example.jspf" />

但是如果Web应用框架提供它自己的解决方案， 那么你就可以参考，毕竟它可能会做一些特殊的处理。

更多关于 `include_page` 的信息，可以 阅读这里...

如何给普通Java-method/`TemplateMethodModelEx`/`TemplateTransformModel`/`TemplateDirectiveModel` 的实现传递普通 `java.lang.*`/`java.util.*` 对象 ？

不幸的是，对于这个问题没有简单的通用解决方案。 问题在于 FreeMarker 的对象包装是很灵活的，当从模板中访问变量时是很棒的， 但是会使得在Java端解包时变成一个棘手的问题。比如， 很可能将一个非 `java.util.Map` 对象包装称为 `TemplateHashModel`(FTL哈希表变量)。 但是它就不能被解包成 `java.util.Map`， 因为没有包装过的 `java.util.Map`。

所以该怎么做呢？基本上有下面两种情况：

- 对于展示目的(比如一种"工具"用来帮助 FreeMarker 模板) 指令和方法应该声明它们的形式参数为 `TemplateModel` 类型和它的更确切的子接口类型。毕竟，对象包装是对于表面转换数据模型， 并服务于展示层的，而这些方法是展示层的一部分。如果你仍然需要普通Java类型， 那么可以你可以转向当前 `ObjectWrapper` 的 `ObjectWrapperAndUnwrapper` 接口 (可以使用 `Environment.getObjectWrapper()`)。

- 和展示任务(比如，对于业务逻辑层)不相关的方法应该被实现成普通的Java方法， 而且不能使用任何 FreeMarker 特定的类，因为根据MVC范例， 它们必须独立于展示技术(FreeMarker)。如果这样的方法是从模板中调用的，那么 对象包装 的责任就是要保证参数转换到合适的类型。如果你使用了 `DefaultObjectWrapper` 或 `BeansWrapper`， 那么这就会自动发生。对于 `DefaultObjectWrapper`，如果你 设置它的 `incompatibleImprovements` 为 2.3.22， 该机制运行得更好。

为什么在 `myMap[myKey]` 表达式中不能使用非字符串的键？那现在应该怎么做 ？

FreeMarker模板语言(FTL)的 哈希表 类型和Java的 `Map` 是不同的。FTL的哈希表也是一个关联数组， 但是它仅仅使用字符串的键。这是因为它是为子变量而引入的 (比如 `user.password` 中的 `password`， 它和 `user["password"]` 是相同的)，而变量名是字符串。

所以，在FTL有支持非字符串键的类型之前，你还是不得不转向Java的 `Map` API。你可以这么来做： `myMap?api.get(nonStringKey)`。然而，对于运行 `?api`，你可能需要配置一下 FreeMarker； 在这里参考更多...

请注意，Java的 `Map`对键的确切类非常专注， 所以对于在模板中计算的数字类型的键，你不得不将它们转换成合适的Java类型， 否则其中的项就不能被发现。比如，如果你在Map中使用 `Integer` 类型的键，那么你应该编写 `${myMap.get(numKey?int)}`。 这是由FTL的有意简化的仅有单独数字类型的类型系统导致的非常丑陋的写法， 而Java区分很多数字类型。请注意，当键值直接从数据模型 (也就是说，你不用在模板中使用算数运算来改变它的值)中获取时是不需要转换的， 包含当它是方法返回值的情况，而且在包装之前要是合适的类， 因为这样解包的结果将会是原始的类型。

当使用 `?keys`/`?values` 遍历Map(哈希表)的内容时，得到了混合真正map条目的 `java.util.Map` 的方法。当然，只是想获取map的条目。

当然是使用了 `BeansWrapper` 或者你自己的对象包装器， 或者是它的自定义子类，而它的 `simpleMapWrapper` 属性将会置成 `false`。不幸的是，这是默认(出于向下兼容的考虑)的情况， 所以在你创建对象包装器的地方，你不得不明确地设置它为 `true`。 而且，至少从 2.3.22 版本开始，应用程序应该使用 `DefaultObjectWrapper` (将 它的 `incompatibleImprovements` 设置为 2.3.22 - 这很重要)， 那就不会有这个问题。

在 FreeMarker 模板中如何修改序列(list)和哈希表(maps) ？

首先，你也许不想修改序列/哈希表，仅仅是连接(增加)它们中的两个或多个， 这就会生成一个新的序列/哈希表，而不是修改已经存在的那个。这种情况下使用 序列连接 和 哈希表连接符。而且，你也可以使用 子序列操作符 来代替移除序列项。 然而，要注意性能的影响：这些操作很快，但是这些哈希表/序列都是后续操作的结果 (也就是说，当你使用操作的结果作为另外一个操作的输入等情况时)， 而这些结果的读取是比较慢的。

现在，如果你仍然想修改序列/哈希表，那么继续阅读...

FreeMarker 模板语言并不支持序列/哈希表的修改。它是用来展示已经计算好的东西的， 而不是用来计算数据的。要保持模板简洁。但是不要放弃，下面你会看到一些建议和技巧。

如果你能在数据模型构建器的程序和模板之间分离这些工作是最好的， 那么模板就不需要来改变序列/哈希表。也许你想重新构思一下你的数据模型了，你会明白这是可能的。 但是，很少有对一些复杂但都是和纯展示相关的算法进行需要修改序列/哈希表的这种情况。 它很少发生，所以要三思那些计算(或它们其中的部分)是属于数据模型领域的而不是展示领域的。 我们假设它们确实是输入展示领域的。比如，你想以一些非常精妙的方式展示一个关键词的索引， 这些算法需要你来创建，还有编写一些序列变量。那么你应该做这样的一些事情 (糟糕的情况包含糟糕的方案)：

    <#assign caculatedResults =
        'com.example.foo.SmartKeywordIndexHelper'?new().calculate(keywords)>
    <#-- some simple algorithms comes here, like: -->
    <ul>
      <#list caculatedResults as kw>
        <li><a href="${kw.link}">${kw.word}</a>
      </#list>
    </ul>

也就是说，你从模板中去除了展示任务中的复杂部分， 而把它们放到了Java代码中。请注意，它不会影响数据模型， 所以展示层仍然会和其它的应用逻辑相分离。 当然这种处理问题的缺陷就是模板设计者会需要Java程序员的帮助， 但是对于复杂的算法这可能也是需要的。

现在，如果你仍然坚持说你需要直接使用 FreeMarker 模板来改变序列/哈希表， 这里有两种解决方案，但是请阅读它们之后的警告：

- 你可以通过编写 `TemplateMethodModelEx` 和 `TemplateDirectiveModel` 的实现类来修改特定类型的序列/哈希表。 仅仅只是特定的类型，因为 `TemplateSequenceModel` 和 `TemplateHashModel` 没有用来修改的方法， 所以你需要序列或哈希表来实现一些额外的方法。这个解决方案的一个示例可以在FMPP (FMPP 是 FreeMarker-based text file PreProcessor，即基于FreeMarker的文本文件与处理器， 用于生成文本文件。可以参考FMPP项目的主页获取更多信息http://fmpp.sourceforge.net ，译者注) 中看到。它允许你这样来进行操作(`pp` 存储由FMPP为模板提供的服务)：

      <#assign a = pp.newWritableSequence()>
      <@pp.add seq=a value="red" />

  `pp.add` 指令仅仅作用于由 `pp.newWritableSequence()` 方法创建的序列。 因此，模板设计者不能修改一个来自于数据模型的序列。

- 如果你使用了定制的包装器(你可以使用 `<@myList.append foo />`)，那么序列可以有一些方法/指令。 (而且，如果你使用来配置它，那么它就会暴露出公有的方法， 你可以对变量来使用作用于 `java.util.Map` 和 `java.util.List` 对象的Java API。就像Apache的Velocity一样。)

但是要小心，这些解决方案有一个问题：序列连接， 序列切分 操作符 (比如 `seq[5..10]`) 和 `?reverse` 不会复制原来的序列，仅仅只是包装了一下(为了效率)，所以， 如果源序列后期(一种不正常的混叠效应)改变了，那么结果序列将也会改变。 相同的问题也存在于 哈希表连接 的结果；它只是包装了两个哈希表，所以，如果你之前修改了要添加的哈希表， 那么结果哈希表将会神奇地改变。作为一种变通方式，在你执行了上述有问题的操作之后， 要保证你没有修改作为输入的对象，或者没有使用由上述两点 (比如，在FMPP中，你可以这样来做：`<#assign b = pp.newWritableSequence(a[5..10])>` 和 `<#assign c = pp.newWritableHash(hashA + hashB)>`)描述的解决方案提供的方法创建结果的拷贝。 当然这很容易丢失，所以再次重申，宁可创建数据模型而不用去修改集合， 也不要使用上面展示的显示层的任务助手类。

关于 null 在 FreeMarker 模板语言是什么样的？

FreeMarker 模板语言并不知道Java语言中的 `null`。 它也没有关键字 `null`，而且它也不能测试变量是否是 `null`。当在技术上面对 `null` 时， 那么它会将其视作是不存在的变量。比如，如果 `x` 在数据模型中是 `null`，而且不会被呈现出来，那么 `${x!'missing'}` 将会打印出 "missing"，你无法辨别其中的不同。 而且，比如你想测试是否Java代码中的一个方法返回了 `null`， 仅仅像 `<#if foo.bar()??>` 这样来写即可。

你也许对这后面实现的理由感兴趣，出于展示层的观点，`null` 和不存在的东西通常是一样的。这二者之间的不同仅仅是技术上的细节， 是实现细节的结果而不是应用逻辑。你也不能将 `null` 和其它东西来比较(不像Java语言)；在模板中，`null` 和其它东西来比较是没有意义的，因为模板语言不进行标识比较 (当你想比较两个对象时，像Java中的 `==` 操作符)， 但更常见的是内容的比较(像Java语言中的 `Object.equals(Object)`； 它也不会对 `null` 起作用)。 而 FreeMarker 如何来别变一些具体的东西和不存在的或未知的东西来比较？ 或两个不存在(未知的)东西是相等的？当然这些问题无法来回答。

这个不了解 `null` 的方法至少有一个问题。 当你从模板中调用Java代码的方法时，你也许想传递 `null` 值作为参数(因为方法是设计用于Java语言的，那里是有 `null` 这个概念的)。 这种情况下你可以利用 FreeMarker 的一个bug(在我们提供一个传递 `null` 值给方法正确的方案前，这个bug我们是不会修复的)：如果你指定一个不存在的值作为参数， 那么它不会引发错误，但是 `null` 就会被传递给这个方法。就像 `foo.bar(nullArg)` 将会使用 `null` 作为参数调用 `bar` 方法，假设没有名为"nullArg"的参数存在。

我该怎么在表达式(作为另外一个指令参数)中使用指令(宏)的输出 ？

使用 `assign` 或 `local` 指令捕捉输出到变量中。比如：

    <#assign capturedOutput><@outputSomething /></#assign>
    <@otherDirective someParam=capturedOutput />

在输出中为什么用"?"来代替字符 `X` ？

这是因为你想打印的字符不能用输出流的 字符集 (编码) 来表现，所以Java平台 (而不是FreeMarker)用问号来代替了会有问题的字符。通常情况，对于输出和模板 (使用模板对象的 `getEncoding()` 方法)应该使用相同的字符集， 或者是更安全的，你通常对输出应该使用UTF-8字符集。 对输出流使用的字符集不是由FreeMarker决定的，而是你决定的，当你创建 `Writer` 对象时，传递了模板的 `process` 方法。

示例：这里在Servlet中使用了UTF-8字符集：

    ...
    resp.setContentType("text/html; charset=utf-8");
    Writer out = resp.getWriter();
    ...
    t.process(root, out);
    ...

请注意，问号(或其他替代符号)可能在 FreeMarker 环境之外产生， 这种情况上面的做法都没有用了。 比如一种糟糕的/错误配置的数据库连接或者JDBC驱动可能带来已经替代过的字符文本。 HTML形式是另外一种编码问题的潜在来源。 在很多地方打印字符串中字符的数字编码是个很好的想法， 首先来看看问题是在哪里发生的。

你可以阅读有关字符集和 FreeMarker 的更多信息：在这里...

在模板执行完成后，怎么在模板中获取计算过的值 ？

首先，要确定你的应用程序设计得很好：模板应该展示数据， 而不是来计算数据。如果你仍确定你想这么做，请继续阅读...

当你使用 `<#assign x = "foo">`时， 那么你不会真正修改数据模型(因为它是只读的，参考： pgui_misc_multithreading)，但是在处理 (参考 pgui_misc_var)运行时环境 (参考environment)创建 `x` 变量。这个问题就是当 `Template.process` 返回时，运行时环境将会被丢弃，因为它是为单独 `Template.process` 调用创建的：

    // internally an Environment will be created, and then discarded
    myTemplate.process(root, out);

要阻止这个，你可以做下面的事情，是和上面相同的， 除了你有机会返回在模板中创建的变量：

    Environment env = myTemplate.createProcessingEnvironment(root, out);
    env.process();  // process the template
    TemplateModel x = env.getVariable("x");  // get variable x

如何分派到(或 `#import` 到) 动态构建的变量名(比如存储在其它变量的名称) ?

如果你真的不能避免这么做(因为它有些混乱，应该不这么做)， 你可以动态地以字符串形式构建合适的FTL源代码来解决该问题， 然后使用 `interpret` 内建函数。比如，如果你想分派名字存储在 `varName` 变量中的变量：

    <@"<#assign ${varName}='example'>"?interpret />

我能允许用户上传模板吗？安全问题又是什么？

通常来说，你不能允许用户上传模板，除非它们是系统管理员或其他受信任的人。 因为模板是源代码的一部分，就像 `*.java` 文件一样。 如果你仍然想让用户上传模板，这里有些问题你是需要考虑的：

- Denial-of-Service(DoS，拒绝服务，译者注)攻击： 这是轻而易举地就可以创建模板，几乎要永远运行下去(使用循环)， 或者耗尽内存(通过在循环中来连接字符串)。FreeMarker 不能强制CPU或内存的使用限制， 所以这并不是在 FreeMarker 级别中可以解决的问题。

- 数据模型和包装(`Configuration.setObjectWrapper`)： 数据模型给予访问放置其中的一些对象公共Java API的能力。默认情况下， 对象若不是特殊处理类型(`String`， `Number`， `Boolean`， `Date`， `Map`， `List`，数组和其它少数类型)的实例，它们的公共Java API就会暴露。 要避免这样的情况，你不得不构建只对模板来说是必须使用的API的数据模型。 出于这样的考虑，可以使用 `SimpleObjectWrapper` (通过 `Configuration.setObjectWrapper` 或者 `object_wrapper` 设置) 来纯粹从 `Map`， `List`，`Array`，`String`， `Number`，`Boolean` 和 `Date` 来创建数据模型。或者，你可以实现你自己的非常限制的 `ObjectWrapper`， 这样就可以安全访问你的POJO了。

- 模板加载器(`Configuration.setTemplateLoader`)： 模板可以使用名称(或路径)来加载其它模板，比如 `<#include "../secret.txt">`。为了避免加载敏感的数据， 你不得不使用 `TemplateLoader` 来二次检查要加载的文件是可以访问的。 FreeMarker 会来阻止从模板根路径之外来加载文件的，不管模板加载器， 但是根据底层的存储机制，可能存在 FreeMarker 考虑不到的漏洞 (比如，仅仅作为一个例子，`~` 会跳到用户目录)。要注意 `freemarker.cache.FileTemplateLoader` 检查符合规范的路径， 所以，这也许是这个目的的不错选择，但增加文件扩展名的检查 (文件必须是 `*.ftl` )也是一个不错的想法。

- 内建函数 `new` (`Configuration.setNewBuiltinClassResolver`， `Environment.setNewBuiltinClassResolver`)： 在模板中如 `"com.example.SomeClass"?new()` 样来使用， 这对于部分在Java中实现的FTL类库来说很重要，但是在普通模板中是不需要的。 而 `new` 并不会实例化不是 `TemplateModel` 类型的类， FreeMarker中包含的 `TemplateModel` 类，就是用来创建任意的Java对象。 其它"危险的" `TemplateModel` 可以存在于你的类路径中。 即便它们没有实现 `TemplateModel` 接口，它的静态初始化块也会执行。 为了避免这些问题，你应该使用 `TemplateClassResolver` 来限制可以访问的类(可能是基于它们要求的模板)，比如 `TemplateClassResolver.ALLOWS_NOTHING_RESOLVER`。

如何在Java语言中实现方法或宏而不是在模板语言中？

这是不可能的，如果你想编写一个类分别实现 `freemarker.template.TemplateMethodModelEx` 或 `freemarker.template.TemplateDirectiveModel`， 但还是有相似的东西可以使用，那么在你编写 `<#function my `...`>`...`</#function>` 或 `<#macro my `...`>`...`</#macro>` 的地方， 可以使用 `<#assign my = "your.package.YourClass "?``new``()>` 来代替。 请注意，对这种方法使用 `assign` 指令， 因为在FreeMarker中函数(和方法)和宏仅仅是普通变量。 (出于相同的原因，你可以在调用模板之前，在数据模型中放置 `TemplateMethodModelEx` 或 `TemplateDirectiveModel` 实例， 或者当你实例化应用程序时，将它们放置到共享变量的map中去。(参考： `freemarker.template.Configuration.setSharedVariable(String, TemplateModel)`))

在基于Servlet的应用程序中， 如何在模板执行期间发生错误时，展示一个友好的错误提示页面，而不是堆栈轨迹？

首先，使用 `RETHROW_HANDLER` 来代替默认的 `DEBUG_HANDLER` (要获取更多关于模板异常处理的信息，请阅读这里...)。 现在，当错误发生时，FreeMarker 也不会打印任何东西到输出中了， 所以控制权是在你手中的。在你捕捉到 `Template.process(`...`)` 抛出的异常之后，基本上你可以执行下面两种策略：

- 调用 `httpResp.isCommitted()`，如果它返回了 `false`，那么你可以调用 `httpResp.reset()`， 之后给访问者打印一个"友好的错误提示页面"。如果返回值是 `true`， 那么尝试去完成页面，打印一些清晰的东西给访问者，因为Web服务器的错误， 页面的生成被突然中断。那么你不得不打印很多冗余的HTML结束标签， 设置颜色和字体大小来保证错误信息在客户端浏览器中是可读的 (检查在 `src\freemarker\template\TemplateException.java` 中的 `HTML_DEBUG_HANDLER` 源代码，去看一个示例)。

- 使用全页面的缓冲。这就意味着 `Writer` 对象不会逐步将输出送到客户端，而是在内存中缓冲整个页面。 因为你给 `Template.process(`...`)` 方法提供了 `Writer` 实例，这是你的责任， FreeMarker 不会做什么事情的。比如，你想使用 `StringWriter`， 如果 `Template.process(`...`)` 方法以抛出异常而返回，那么就忽略由 `StringWriter` 积累的内容， 之后发送一个替代的错误页面，否则你就要在输出中打印 `StringWriter` 对象中的内容。使用这种方法你就可以确定不用去处理部分发送的页面， 但是由于页面(比如，在生成很长的页面时会很慢，用户会感到很大的响应延迟， 而且服务器也会占用大量的内存)的特征，它也会有负面的性能影响。 要注意，使用 `StringWriter` 对象并不是最有效的解决方案， 在积累的内容增长时，它通常也会重新分配自己的缓冲。

我正使用一个可视化的HTML割裂模板标记的编辑器。 你们可以改变模板语言的语法来兼容我的编辑器么？

我们不会修改标准的版本，因为有很多模板都依赖于它。

我们的观点是这个打断模板代码的编辑器是它自己打断的。 一个优秀的编辑器应该可以忽略，而不是割裂它不能理解的东西。

从FreeMarker 2.3.4版本开始，你应该感兴趣你可以使用 `[` 和 `]` 来代替 `<` 和 `>` 了。 要获取更多信息，请阅读这里...

### 版本历史

#### 2.3.24

发布日期： FIXME

##### FTL 部分的修改

- TODO

##### Java 部分的修改

- 注意！ 提升需要的最低Java版本从1.4到1.5(也就是Java 5)

- 升级 JavaCC (使用构建过程来生成 FTL 解析器) 从 3.2 到 6.1.2。

- 添加 `Configurable.getSettingNames(camelCase)`， 将返回合法的设置项名称。这对于自动完成等很有用。

#### 2.3.23

发布日期： 2015-07-05

##### FTL 部分的修改

- 列表显示 (`#list`) 已经得到了一些专业的方便特性， 目标是人们在模板中一遍又一遍做的经典任务。

  - 新的 `list` 指令的子指令。 它们是 `else` 和 `items`，来处理0长度列表的特殊情况， `sep` 来在迭代项之前插入分隔符。 更多细节，请参考 `list` 指令。

  - 作用于循环变量的新内建函数： ``var`?index` (废弃 ``var`_index`)， ``var`?counter` (基于1的索引), ``var`?has_next` (废弃 ``var`_has_next`)， ``var`?is_first`， ``var`?is_last`， ``var`?item_parity` (返回 `"odd"` 或 `"even"`)， ``var`?item_parity_cap`， ``var`?item_cycle``(`...`)`，等等。

- 添加方便的赋值操作符，仅可以用于赋值指令 which can be used (当前是 `#assign`， `#global` 和 `#local`)：

  - `++` 和 `--`: `<#assign counter++>` 和 `<#assign counter = counter + 1>` 是相等的。

  - `+=`， `-=`, `*=`， `/=` 和 `%=`： `<#assign counter += 2>` 和 `<#assign counter = counter + 2>` 是相等的。

- 添加 `then` 内建函数，可以像三元操作符来使用： ``someBoolean`?then(`whenTrue`, `whenFalse`)`。 和很多其它语言的三元操作符相似，只有一个参数表达式会被评估。更多细节...

- 添加 `switch` 内建函数， 可以像内联(表达式) switch-case-default 语句来使用： ``someValue`?switch(`case1`, `result1`, `case2`, `result2`, ... `caseN`, `resultN`, `defaultResult`)`，这里 ``defaultResult`` 可以被忽略 (如果没有任何一个情形匹配上，那么就会有错误)。 更多细节...

- 对模板语言部分标识符添加驼峰格式个支持(自定义名称不受影响)。 例如，现在 `<#noEscape>${x?upperCase}</#noEscape>` 或 `<#setting numberFormat="0.0">` 或 `<#ftl stripText=true>` 都是合法的。 但在同一个模板中，FreeMarker 会需要你对所有模板语言部分的标识符一直使用相同的命名约定。 也可以对所有模板强制使用相同的命名约定，在Java中通过 `Configuration.setNamingConvention(int)` 来实现。 从后期的一些版本中，驼峰格式是推荐的约定，因为Java API用户从模板中调用也会用到它。

- 添加新的 特殊变量， `.current_template_name` 和 `.main_template_name`。它们废弃了 `.template_name`，因为当在宏调用时，经常会崩溃。 新的 `.current_template_name` 通常返回包含引用特殊变量的模板名称，而 `.main_template_name` 通常返回最高模板的名称。

- 很小的错误信息改进。比如，当 ``someMap`[`someNumber`]` 抱怨 ``someMap`` 不是序列或强迫为字符串时， 在常见问题的错误消息中添加提示。

- Bug 修复，激活设置 `incompatible_improvements` 为 2.3.23： 有一个长期存在的解析时间规则称为 `#break`，在FTL源代码中， 必须在嵌套的可以打断的指令中出现，比如 `#list` 或 `#switch`。 该检查可以绕过 `#macro` 或 `#function`，比如： `<#list 1..1 as x><#macro callMeLater><#break></#macro></#list><@callMeLater />`。激活这个修改之后，它会作为解析时间错误被捕获。

##### Java 部分的修改

- 添加 `Configuration.setNamingConvention(int)`。 默认情况下，FreeMarker 会自动检测用于模板语言部分的标识符的命名规则 (遗留的 和 驼峰格式)，每个模板都是独立地进行。 该设置允许你强制使用一个命名规则。

- `Configuration` (事实上，任意的 `Configurable`) 设置名称现在可以写作驼峰格式了。 例如，如果你从属性文件中配置 FreeMarker，你可以使用 `defaultEncoding=utf-8` 来代替 `default_encoding=utf-8`。你也可以混合使用两种命名规则 (驼峰格式，和传统的蛇形格式)，而且 `Configuration.setNamingConvention(int)` 不影响这个行为。

- 添加 `Configuration.setTemplateUpdateDelayMilliseconds(long)` 和 `Configuration.getTemplateUpdateDelayMilliseconds()`。 它们废弃了 `setTemplateUpdateDelay(int)`，使用第二种方案， 会基于Java习惯会导致误解。(而且那也没有成对的 getter 方法)

- 当指定字符串时(在 `java.util.Properties`)， `template_update_delay` 设置支持时间单元，比如 `template_update_delay=500 ms`。

- 添加 `Environment.getCurrentTemplate()` 方法，它会返回当前执行的模板(相对于主模板)。

- 添加 `WebappTemplateLoader.setAttemptFileAccess(boolean)`， 可以用于禁用遗留的尝试通过直接文件访问加载模板的技巧，那么模板更新就无需重启。 禁用URL连接缓存 (`someURLBasedTemplateLoader.setURLConnectionUsesCaches(false)`， 从 `incompatible_improvements` 2.3.21 开始，这是默认的) 可能会在现代的Servlet容器中解决这个问题。

- 在 `FreemarkerServlet` `TemplatePath` 初始化参数中，路径 (比如 `/templates`) 可以有 `?settings(`...`)` 前缀，使用它你可以设置 `TemplateLoader` 结果的JavaBean属性。例如： `<param-value>/templates?settings(attemptFileAccess=false, URLConnectionUsesCaches=false)</param-value>`

- 添加 `FileTemplateLoader.setEmulateCaseSensitiveFileSystem(boolean)`。 当你使用Windows系统开发而需要部署在其它大小写敏感的文件系统平台上时，这是很方便的。 默认值是 `false`，而 `true` 只是意味着开发， 而不是生产环境安装。默认值可以通过设置 `org.freemarker.emulateCaseSensitiveFileSystem` 系统属性为 `true` 来覆盖。

- Bug 修复 [424]： `WebappTemplateLoader` 无法找到存储在 `WEB-INF/lib/*.jar/META-INF/resources` 下的模板。 在这个目录下的文件从 Servlet 3.0 版本开始，可以视为 `ServletContext` 资源， 但是 `WebappTemplateLoader` 由于一些内部的把戏而通常不能找到它们。

- Bug 修复：如果模板 文件 成功读取，但是有 `IOException` 在读取它的内容中发生， 解析器(JavaCC)就当作模板 文件 在异常那儿结束， 异常被压制。这确实是JavaCC的手段，它会影响很多其它基于JavaCC的语言， 但是现在 FreeMarker 在 `Template` 构造方法中添加了变通方法， 现在异常会被期望的方式抛出了。

- Bug 修复： `InvalidReferenceException.FAST_INSTANCE` 可能会偶尔存储 `Environment` 实例的引用，因此导致无法垃圾回收。

- Bug 修复 [426]： 当设置 `incompatible_improvements` 为 2.3.22 时，在模板中的特殊变量引用 `.template_name` 通常返回主(最高)模板的名称， 这是因为在 2.3.22 版本中的疏忽。设置 `incompatible_improvements` 为 2.3.23，恢复老的，向后兼容行为。 (请注意，我们模仿的老行为是它自己破碎，因为它不能在宏调用时好用； 你应该使用 `.current_template_name` 或 `.main_template_name` 来代替。)

- Bug 修复 [53]： 对于在相同继承级别有着很多AST(abstract syntax tree，抽象语法树) 结点的模板，模板解析会不正常地慢。

- Bug 修复：当模板在后台首次加载进行的同时被替换，老版本的模板会进入缓存， 并使用新版本的时间戳来标记，因此在更新延迟配置之后就不能被重新加载了。

- Bug 修复：`log_template_exceptions` 设置项(在 2.3.22 版本中添加) 可以通过 `Configurable.setSetting(String, String)` API 来设置。

- Bug 修复： `StringUtil.FTLStringLiteralEnc` 转义了 `$` (因此生成了一个非法转义) 而没有转义 `$` 和 `#` 之后的 `{`。 而该方法只是 FreeMarker 用于生成错误消息的，它是公有的方法，所以任何人都可以使用。

- Bugs 修复：各种形式的规范问题(它们仅仅影响 FreeMarker 关心的错误消息)。

##### 其它修改

- 改进功能(可视化的导航树，使用手册内部的搜索等等...) 的现代的使用手册和网站设计，感谢 Evangelia Dendramis。 (同时现在网站使用和手册一致的相同格式和HTML生成器。)

- 很多细微的使用手册和网站内容更新/改进。

##### 注意

和 2.3.23 RC1 版本的修改比较：

- 如果模板没有名称，`.current_name_name` 和 `.main_template_name` 就不存在 (`null`) 而不在是 `""`。

- 一些很小的错误消息改进

- 文档改良

#### 2.3.22

发布日期： 2015-03-01

请注意，因为 2.3.22 版本已经设计为完全向后兼容之前的 2.3.x 发布版本， 下面描述的一些改进和修复仅仅当你特殊使用 2.3.22 版本时才有效 不兼容的改进 (它总是清楚地表示)，因为它们可以， 有很小的机会，可以破坏已有的应用程序。对于在积极维护中的应用程序，那么允许它们 是更佳的选择。请参考 如何设置 不兼容的改进。

##### FTL 部分的修改

- 新的内建函数：`api` 和 `has_api`。如果值本身支持该额外的特性， ``value`?api` 提供对 ``value`` 的API(通常是Java API)的访问，比如 ``value`?api.`someJavaMethod()``。这意味着很少使用，当你需要调用对象的Java方法时， FreeMarker 暴露于模板的值的设计好的简单视图会隐藏它，并且没有相等的内建函数。 比如，当你在数据模型(使用默认的对象包装器)中放置 `Map`， `myMap.myMethod()` 在模板中只是翻译成Java中的 `((Method) myMap.get("myMethod")).invoke(...)`，因此你不能调用 `myMethod`。如果你编写了 `myMap?api.myMethod()` 来代替，这就表示Java中的 `myMap.myMethod()`。

  如果可以，依靠FTL类型和相关内建函数的尽可能的能力。使用 `?api` 也仅仅是最后的手段。

  使用 `?api` 也要对FTL的 `[]` 操作符(比如 `myMap[key]`)非 `String` `Map` 键值支持提供一种变通的方式，因为现在你可以编写 `myMap?api.get(nonStringKey)`。

  `?api` 不是默认启用的，也不是对所有值都可用。请参考更多内容...

- 标识符(比如 `someVariable`)现在在任意位置可以包含负号 (`-`)，点(`.`)，还有冒号(`:`)， 但是那些字符必须使用前置的反斜杠来转义(`\`)， 否则它们将被解释成操作符。比如，要读取名为 data-id 的变量， 正确的表达式是 `data\-id`，因为 `data-id` 将会解释成 data 减去 id。这对命名的宏参数也起作用， 当你想在捕捉所有参数中接受任意HTML属性时，这是很有用的，比如 `<@box class="someCssClass" data\-id=product.id />`。 (当你在宏内枚举捕捉所有参数的名称，当然获取到的键值字符串是 `"data-id"`，而没有 `\`)

- 添加 `?lower_abc` 和 `?upper_abc`。这会转换 `1`，`2`， `3`，等等...为字符串 `"a"`，`"b"`， `"c"`，等(或者是 `"A"`， `"B"`，`"C"`，等)。当到达 `"z"` 时，就会继续以 `"aa"`， `"ab"`，等进行。 这和在电子表格应用程序(比如Excel或Calc)中看到的列标签有着相同的逻辑。更多内容...

- 添加 `?keep_before_last` 和 `?keep_after_last`。比如： `"foo.bar.txt"?keep_before_last(".")` 返回 `"foo.bar"`， `"foo.bar.txt"?keep_after_last(".")` 返回 `"txt"`。 (这和 `?keep_before` 和 `?keep_after` 作用很相似， 但是那些只寻找分隔符第一次出现的地方)

- 在合法的标识符字符集中添加很多丢失的UNICODE字母和数字，比如韩语字母 (bug 修复： [129])

- 错误消息质量改进：

  - 当调用自定义JSP标签时的一些改进； 请在后续介绍它们的章节中查看。

  - Bug 修复：当本地查询或模板获取出现问题， 错误消息仍然在用于请求模板的名字上加引号，而不是真实的模板源文件名称 (比如 当获取的模板是 `foo.ftl` 时，用 `foo.ftl` 代替 `foo_en.ftl`， 但在后台，是从 `foo_en.ftl` 加载的)。

  - 模板未找到 错误现在更加详细， 给出了意外使用 `\` 而不是 `/` 的示意， 或者退出 `TemplateLoader` 的根目录。

  - 当设置的名称没有被识别时，`#setting` 指令给出更多有用的错误消息，并且列出允许的设置名称或者改正的建议。

  - 当遇到错误的特殊变量名称 (`.`name``)， 可用的名称列表会显示在错误消息中。

  - 当 `Map.get` 或包装的 `Map` 的 `Map.containsKey` 抛出 `ClassCastException` 或 `NullPointerException`， 错误会指向引发问题的FTL表达式(还有一些解释)， 而不是冒出低级别的运行时错误。

##### Java 部分的修改

- 对象包装改进：

  - `DefaultObjectWrapper`，仅仅当它的 `incompatible_improvements` 设置成 2.3.22 时有效 (如何做的请参考这里...)， 或者更精确来说，将它的 `useAdaptersForContainers` 设置成 `true` (当 `incompatible_improvements` 设置成 2.3.22 时， 它默认就是 `true`)：当包装成 `TemplateModel` (它是模板可以访问所有值的接口)时，它不再复制 `Map`， `List` 和数组，仅仅将它们包装成小的 `TemplateModel` 适配器，那会达到所有操作的原始对象。 包装后的值都是新的 `DefaultMapAdapter`， `DefaultListAdapter` 和 `DefaultArrayAdapter` 类的实例， 而不是遗留的(复制) `SimpleHash` 和 `SimpleSequence` 类。(请注意，很多项目使用单纯的 `BeansWrapper` 来代替 `DefaultObjectWrapper`，也通常使用适配器方式， 虽然只是它的不同的实现罢了。`DefaultObjectWrapper` 的缺点现在已经修复了，它总是推荐 `BeansWrapper`， 而 `BeansWrapper` 却有相当迷惑的多类型值，也相当慢。)

    在这个修改中，保证尽可能多的向后兼容是很重要的因素， 这是一个相当深的修改，也许你想 回顾一下 后果和原因，请参考这里... (但重申一下，该修改默认 不会 激活， 所以仅仅更新 FreeMarker 不会对已有应用程序的稳定性构成威胁)

  - 对包装方法而不包装它们的父对象，也不在调用时期检查重载方法选择 添加了 `TemplateMethodModelEx BeansWrapper.wrap(Object object, Method method)`。

  - Bug 修复 [372]： 当一个 `SortedMap` (典型的情况是 `TreeMap`) 被 `DefaultObjectWrapper` 包装时， 之后从它获取并不存在的字符长度为一的字符串，会有 `ClassCastException`。要修复这个问题， 如果被包装的 `Map` 是 `SortedMap`，并且被 `DefaultObjectWrapper` 包装， 那么它不会在 `String` 键变成 `null` 后尝试回退到一个 `Character` 键。(该修改应该是向后兼容的， 因为当 `SortedMap` 有 `Character` 键时，使用 `String` 键的初步尝试引发 `ClassCastException`， 那么，这样的 `SortedMap` 就不能再作为 FTL 哈希变量被使用了。)

  - Bug 修复 [368]： 仅当 `incompatible_improvements` 设置成 2.3.22 或者是将它新的 `useAdaptersForContainers` 设置成 `true`时：键的排序和其它 自定义 `Map` 类型的古怪行为不会再丢失了。相同的标准对 `List` 来说也是一样的。

  - 添加了新的设置， `forceLegacyNonListCollections`。当且仅当 `useAdaptersForContainers` 是 `true` 时有效。那么，除非设置成 `true`， `java.util.Collection` 不是 `List` (比如 `Set`) 会继续使用 `SimpleSequence` (也就是复制方式) 来代替适配器方式。默认值是 `false`，至少到 `incompatible_improvements` 2.4.0，因为 `SimpleSequence` 给出了非 `List` 的索引访问，比如 `mySet[2]`，看起来很奇怪， 但是一些已有的模板会使用这种形式，即便仅仅是个意外。将 `forceLegacyNonListCollections` 设置为 `false`，那么对 `Set` 等类型 的索引访问就不可能了(`?first` 和 `?last` 都没用了，但是 `?size` 仍然有效)，所以你可能会想去重新测试老的模板。 换句话说，你得到了适配器方式的优点。因此，在新的项目中，强烈建议将 `forceLegacyNonListCollections` 设置为 `false`。(适配器方式是由 `DefaultNonListCollectionAdapter` 来实现的。)

  - 添加了新的 试验类型的 FTL 类型接口， `freemarker.template.TemplateCollectionModelEx`， 为 `TemplateCollectionModel` 接口添加了 `size()`， `isEmpty()`，和 `boolean contains(TemplateModel)` 方法。当包装 `java.util.Collections` 时，这些额外的功能区是可用的， 但是 FTL 直到现在也不能使用它们，所以就添加了。 精确的接口细节标记成试验类型，当设置 `DefaultObjectWrapper` 的 `forceLegacyNonListCollections` 属性为 `false` (参考之前内容)时， 它本身的特性已经被 `?size` 所使用。

  - 添加了新的 试验类型的 接口， `freemarker.template.ObjectWrapperAndUnwrapper`。 它扩展了 `ObjectWrapper`，带有解包功能。 这些功能在 `BeansWrapper` 和它的子类中已经存在很长时间了， 比如在 `DefaultObjectWrapper` 中，但是它不能 分解出 到它们的公有接口中，而其它的 `ObjectWrapper` 可以来实现。这对于 `TemplateModel` 实现来说是很有用的，它不需要 `BeansWrapper` (或它的子类)，仅仅是解包功能可用。

  - 添加了新的 试验类型的 接口来实现 `?api` (请在FTL部门参考相关内容)： `TemplateModelWithAPISupport`， `ObjectAPIWrapper`， `RichObjectWrapper`。请注意，该接口是试验类型的， `?api` 本身则不是。

- `FreemarkerServlet` 改进：

  - `FreemarkerServlet` 现在支持自定义 JSP EL函数(使用 `function` XML 元素在TLD中定义)。 早先则会忽略它们。自定义EL函数可以当作Java方法来调用，比如： `<#assign u=JspTaglibs["/WEB-INF/utils.tld"]> ... ${u.truncate(title, 25)}`.

  - Bug 修复：当在自定义标签参数中发生实际和期望的参数类型不匹配时， 错误信息没有帮助。在用户从FTL调用JSP标签库时，这是一个频繁发生的问题 (典型的是 "java.lang.IllegalArgumentException: argument type mismatch"，没有任何FTL上下文)。现在，错误有了适当的解释，解决方案和 FTL错误位置/引用。

  - 解决了 RFE [113] [114]： `FreemarkerServlet` 现在可以发现对类加载器可见但是不在 `WEB-INF/lib/*.jar` 中的 `META-INF/**/*.tld` 了。要激活这个特性，必须设置额外的TLD查找， 在 `FreemarkerServlet` 初始化参数中使用 `MetaInfTldSources` 和/或 `ClasspathTlds` (参考该内容描述的 `FreemarkerServlet` Java API 文档 )。 比如，如果从 Eclipse 中使用内嵌的 Servlet 容器来运行应用程序， 那么标签库的jar文件不在标准的路径下，但是在和其它依赖一样的类路径下， 那么现在可以这么来写：

        <init-param>
          <param-name>MetaInfTldSources</param-name>
          <param-value>classpath</param-value>
        </init-param>

    之后所有的 `META-INF` 目录就对类加载器可见，可以用来搜索TLD文件了。

  - `MetaInfTldSources` 和 `ClasspathTlds` 各自也可以被附加到 Java 系统属性 `org.freemarker.jsp.metaInfTldSources` 和 `org.freemarker.jsp.classpathTlds` 上， 或者被它们的值所替换。因此可以在 Eclipse 运行配置中来调整它们而不需要修改 `web.xml`。(参考 `FreemarkerServlet` 的 Java API 文档 来获得更多内容)

  - `FreemarkerServlet` 现在可以识别 `org.eclipse.jetty.server.webapp.ContainerIncludeJarPattern` servlet 上下文属性，并且从它里面添加项目到 `MetaInfTldSources` (上面已有介绍)。

  - 添加了 `protected FreemarkerServlet.createTaglibFactory()` 方法， 允许 `TaglibFactory` 配置的微调。现在它有了一些setter方法， 比如 `setObjectWrapper`， `setMetaInfTldSource`，等等。

  - 添加了新的 servlet 初始化参数， `BufferSize`。如果响应状态仍然允许，这是通过 `HTTPServletResponse.setBufferSize()` 来设置缓冲区的大小，否则就忽略它。

  - 现在 `TemplatePath` servlet 初始化参数 支持新的路径类型，就像下面这样， `classpath:com/example/myapp/templates`。 这和老式的路径 `class://com/example/myapp/templates` 很相似， 但是它使用了线程的上下文类加载器(Thread Context Class Loader) 来初始化 `FreemarkerSerlvet`，因此即便 `freemarker.jar` 不在web应用程序的本地，它也能工作。 `class://` 也有问题，它使用了 `FreemarkerSerlvet` 本身(或者它的子类)定义的类加载器。

  - 如果 `incompatible_improvements` 设置成 2.3.22 (或更高)，那么 servlet 初始化参数 `TemplatePath` 支持在 `[`...`]` 中间指定的多个逗号分隔的路径，比如 `<param-value>[ WEB-INF/templates, classpath:com/example/myapp/templates ]</param-value>`。这会在内部创建一个 `freemarker.cache.MultiTemplateLoader`。

  - 添加了新的 servlet `init-param`， `ExceptionOnMissingTemplate`。将它设置成 `true`，就会改变模板没找到错误的行为， 和其它模板异常类型相似(比如 HTTP 500 的 Internal Server error，在很多安装时的响应)。 当它是 `false` 时(就是遗留的行为)， 仅仅得到 HTTP 404 Not found。 而这也是JSP视图如何工作的方式，这就是一个问题，因为如果MVC视图返回 404， 一些框架也把 404 给访问者看。但是转发MVC视图的关键点是访问者要访问一个合法的 URL 地址，只有这个页面没有视图时，那么就是在服务器端损坏了，此时应该是 500。

  - 添加了新的可以覆盖的方法： `FreemarkerServlet.createDefaultObjectWrapper()`。 这可以用于 `createObjectWrapper()` 通常被覆盖之处， 但是没有不情愿关闭相关初始化参数的处理(比如 `object_wrapper`)。

  - 提升的(或修复的)错误日志：现在，日志会写入 FreeMarker 自己的日志，而不只是 servlet 容器日志。而且，根据 servlet 容器的不同，之前的模板未找到和模板解析错误细节日志有时会丢失。

  - Bug 修复，仅仅当 `incompatible_improvements` 设置成 2.3.22 (或更高)：一些类型的值，放置到 JSP page 范围 (通过 `#global` 或者通过 JSP `PageContext` API) 之后可以使用 JSP `PageContext` API (典型的情况是在自定义 JSP 标签内)读取回来，也可能作为 FreeMarker `TemplateModel` 对象返回，代替有标准 Java 类型的对象。 其它 Servlet 范围不受影响。不大可能有些东西期望这个bug出现。 FTL 类型受影响的值都列在下面了，要触发这个bug，它们不用在模板中直接被创建 (比如只是FTL原文或使用 `?date`/`time`/`datetime`)， 也不用使用 `DefaultObjectWrapper` 或 `SimpleObjectWrapper` (或者是它们的子类)：

    - FTL 日期/时间/日期时间(date/time/date-time) 值可能作为 `freemarker.template.SimpleDate` 返回，现在 它们作为 `java.util.Date` 返回。

    - FTL 序列值可能作为 `SimpleSequence` 返回，现在它们则作为期望的 `java.util.List` 返回。这就代表假设 `object_wrapper` 配置设置是 `BeansWrapper` (比如 `DefaultObjectWrapper`) 的子类，但是实际上， 应用程序中的通常情况是使用 FreeMarker 的 JSP 扩展 (反之它也能工作， 只是依赖于 `ObjectWrapper` 实现的质量和能力)。

    - FTL 哈希值可能作为 `SimpleHash` 返回，现在它们则作为期望的 `java.util.Map` 返回 (再次重申，假设对象包装器是 `BeansWrapper` 的子类)。

    - FTL 集合值可能作为 `SimpleCollection` 返回，现在它们则作为期望的 `java.util.Collection` 返回 (再次重申，假设对象包装器是 `BeansWrapper` 的子类)。

  - Bug 修复：现在 `*.tld` 文件会在 `WEB-INF/` 下去搜索，并且对所有的子目录进行递归。 之前只是直接在 `WEB-INF/` 和 `WEB-INF/lib/` 目录下搜索。

  - Bug 修复：在 TLD 的 `name` 和 `tag-class` 元素中的开头和结尾空白现在被移除了。

  - 不必要的行为修复：以防多个TLD映射到相同的标签库URI，现在 `WEB-INF/**/*.tld` 有着比来自 jar 包或者类路径目录下的 `META-INF/**/*.tld` 更高优先级。之前是相反的，除了 `META-INF/lib/*.tld` 可以获得随机优先。JSP 规范 (2.2) 明确地指出顺序没有定义，也不应有依赖，如果某些人将 TLD 直接放置到 `WEB-INF` 下，也是符合逻辑的，那就意味着是在特定的 web 应用程序中使用，而不是通常来自依赖的 jar 包的 TLD 被多个 web 应用程序所共享。

  - Bug 修复：在覆盖的 `FreemarkerServlet.createConfiguration` 中的默认设置不会偶然地被 `FreemarkerServlet` 重写回默认值了。这个问题只是对以下这些配置： `template_exception_handler`， `log_template_exceptions`， `object_wrapper`， `template_loader`。

  - Bug 修复：如果有多个 If you had multiple `FreemarkerServlet`，在相同的 servlet 上下文中，每个都有不同的配置设置，那么会导致失灵。 (通常来说，只能有一个， 就像只有一个 servlet 来处理 `*.jsp`。)

  - 从 FreeMarker 构件和 XML 实体解析器中移除了所有的 `xsd` 文件 (`web-app` 和 `taglib` 概要)，因为它们在 XML 解析中没有用。

  - 普遍改进了实现质量 (可维护性，错误消息，性能 bug 修复，测试覆盖) 和更好的 API 文档。

- Logging 功能改进：

  - 就像之前的，当自动选择日志库(默认行为)，如果Log4j可用， 那么 FreeMarker 选择 Log4j。但是现在，变成了 `log4j-over-slf4j`， FreeMarker 会直接使用 SLF4J 来替代。(这个修复了日志位置指向 FreeMarker 日志适配器类而不是真实调用地方的问题。)

  - FreeMarker 现在可以识别 `org.freemarker.loggerLibrary` 系统属性， 它指定了使用那个日志工具，比如 `java `...` -Dorg.freemarker.loggerLibrary=SLF4J`。该选项废弃了 `Logger.selectLoggerLibrary(int)`，因为它天生不可靠 (因为不能很好地控制类初始化顺序)。该系统属性有比 `Logger.selectLoggerLibrary` 更高的优先级。

  - 普遍改进了实现质量 (当某些东西执行失败时更多的打印信息，等等...)。

  - 新的配置设置： `log_template_exceptions` (`Configuration.setLogTemplateExceptions(boolean)`)。 它指定了如果 `TemplateException` 被模板执行抛出， 是否该被 FreeMarker 记下日志。为了向后兼容，默认值是 `true`，但是却导致了在正确编写的程序中，将异常记录两遍， 因为 `TemplateException` 被公共的 FreeMarker API 抛出时， 也被调用者记下日志(即便仅仅引发的异常是更高级别的异常)。因此， 在现代的应用程序中，应该将它设置为 `false`。(请注意，该设置对 `#attempt`/`#recover` 捕捉到的异常日志记录没有影响;它们通常都是被记录的。)

- `Environment` 和自定义指令相关的改进：

  - 添加了 `Environment.getCurrentDirectiveCallPlace()`， 当从自定义指令(比如从 `TemplateDirectiveModel.execute()`) 中调用时它会返回 `DirectiveCallPlace` 对象。 `DirectiveCallPlace` 对象可以关联任意对象到模板中的指令调用， 这可以用于调用绑定的缓存(比如非动态缩小嵌套内容)。可以参考 Java API 文档获取关于 `DirectiveCallPlace` 的更多内容。

  - 添加了 `Environment.getMainTemplate()`。废弃了含糊的 (而且经常损坏的： [145]) `Environment.getTemplate()`。

- 模板加载：

  - 添加了新的 `Configuration` 设置项， `template_lookup_strategy` (`Configuration.setTemplateLookupStrategy(TemplateLookupStrategy)`)。 当模板被请求时，这允许尝试自定义 `TemplateLoader` 级别的名称。比如，使用它可以定义自定义本地化序列查找，来代替默认的 (比如查找： `foo_de_LU_MAC.ftl, foo_de_LU.ftl, foo_de.ftl,``foo.ftl`)。

  - 添加了新的 `Configuration.getTemplate(`...`)` 参数， `Object customLookupCondition`。 该参数可以用于自定义的 `TemplateLookupStrategy` 从请求的名称中 (和基于位置的默认查找策略相似)去推断真实的模板名称。例如， 在一个多域的Web站点中，可能会想要为一个域定义一些专用的模板， 那么使用这个域名作为自定义查询的条件。之后，当 `foo.ftl` 被请求时，自定以的 `TemplateLookupStrategy` 可以首先查找 `@somedomain.com/foo.ftl`，之后再查找 `@default/foo.ftl`。参考相关的 `Configuration.getTemplate(`...`)` 重载的 JavaDoc 来获取更多细节；请注意，那里有关于 `customLookupCondition` 的 `hashCode` 和 `equals` 的需求。

  - 添加了新的 `Configuration` 设置， `template_name_format` (`Configuration.setTemplateNameFormat(TemplateNameFormat)`)。 它允许指定 FreeMarker 使用的命名规则。现在，不再允许自定义实现了， 仅可以选择在 `TemplateNameFormat.DEFAULT_2_3_0` (默认的) 和 `DEFAULT_2_4_0` (推荐的，至少对新项目选择)之中选择。 `DEFAULT_2_4_0` 有一些优点，但是不能完全向后兼容 (可是很多应用程序不会被影响)。 典型的错误是使用反斜杠来代替斜杠， 或者从根路径开始，它给出 `MalformedTemplateNameFormatException` 来代替 `TempalteNotFoundException`。 它允许概要名称以单独的 `:` 来结束，代替了 `://` (这也是支持的)，比如在 `classpath:foo/bar.ftl` 中。它修复了很多遗留问题 (bugs)，大多数都是和翻译特殊步骤之后的 `..` 相关， 比如 `.` 或 `*`。请在 `TemplateNameFormat.DEFAULT_2_4_0`的 Java API 文档 中参考各种相异之处。

  - `ClassTemplateLoader` 现在可以由指定的 `ClassLoader` 来直接创建了，而不再是指定一个基本的 `Class`。也就是说，现在有 `ClassTemplateLoader(ClassLoader, String)` 构造方法，也有 `Configuration.setClassLoaderForTemplateLoading(ClassLoader, String)` 方法。

  - 添加了新的异常，当获取模板时， `TemplateNotFoundException`，现在使用它代替了 `TemplateNotFoundException`。因为它继承自 `TemplateNotFoundException`，那么这个修改是向后兼容的。 主要目标是回答常见误解，模板路径就是真实的文件路径。 而这个新的异常，也有好处，它可以给出额外的 FreeMarker 特定的关于错误的信息， 比如现在它有 `getTemplateName()` 和 `getCustomLookupCondition()` 方法。

  - `Template` 现在有 `getSourceName()` 方法，作为 `getName()` 的补充。它们两个返回相同的没有本地化的查询或获取 (在名称中的 `*`)或者其它激活参与的查询策略。 但当 `getSourceName()` 给出的名称是模板从 `TemplateLoader` 真正加载的时候，而 `getName()` 返回 (也通常是这么返回的) 的名称是模板被请求的(规范化的形式)。`getName()` 被用于所有地方(比如相对包含的解决)，除了错误消息中的位置信息，现在使用 `getSourceName()`。而且 `TemplateException` 现在也有 `getSourceName()` 方法。

  - `Configuration.getTemplate(`...`)` 重载现在对 `locale` 和 `encoding` 参数接受 `null`，此种情况下，在参数被忽略时， 它们使用相同的默认值作为重载。

  - SPI 调试实现，请注意： `DebugBreak` 指令现在会发送模板的 `sourceName` 给 `suspendEnvironmentSpi` 回调，而不再是它的 `name`。也应该在 `registerTemplateSpi` 等中使用 `sourceName`，而不再是 `name`。

- 配置：

  - 对于一些设置项，添加了 `Configuration.unset`Xxx`` 和 `is`Xxx`ExplicitlySet` 方法。 去除一些设置，使它就像 `set`Xxx`` 从未被调用过一样， 那么设置项将会使用默认值来适合当前的 `incompatible_improvements` 值，将来也会当 `incompatible_improvements` 改变时， 它也做出调整。

  - 当从 `java.util.Properties` (或者通常是使用 `String`-`String` 名值对)中来配置FreeMarker时：

    - `default` 设置的值现在通过 `template_exception_handler`， `template_storage`， `template_loader` (还有新的 `template_lookup_strategy` 和 `template_name_format`) 配置项被识别， 它会引发 `Configuration.unset`Xxx`()` 方法的调用。

    - Bug 修复：当设置 `object_wrapper` 为 `default` (也就是不指定它)，它会忽略 `incompatible_improvements` 并通常会使用 `ObjectWrapper.DEFAULT_WRAPPER`。该修复仅仅当 `incompatible_improvements` 必须是 2.3.21时有效， 因为当默认的对象包装器从 `ObjectWrapper.DEFAULT_WRAPPER` 改变成 `new DefaultObjectWrapperBuilder(Configuration.VERSION_2_3_21).build()` 的结果，这是有点不同的单例，因为它有只读的配置设置项和bug修复的重载方法选择规则。 要使用 `ObjectWrapper.DEFAULT_WRAPPER` 而不管 `incompatible_improvements` 配置项的值，使用新的 `default_2_3_0` 值。

  - Bug 修复：更改了 `localized_lookup` 配置项的值，现在情况模板缓存， 所以老的查询结果不会被重用了。 (当然，这仅仅在已有的运行服务中修改该配置才会有效，这基本是不可能的。)

- 其它内容：

  - Bug 修复 [145]， 仅仅当 `incompatible_improvements` 设置为 2.3.22 (或更高)时有效： `#include` 和 `#nested` 不会再更改 `Environment` 的父级 `Template` (请参考 `Configurable.getParent()`) 为被包含的 `Template` 或者是 `#nested` 返回 的。因此， `Environment` 的父级现在就是主 `Template`。(主 `Template` 就是有 `process` 或者 `createProcessingEnvironment` 方法被调用来初始化生成输出的 `Template`。) 请注意，这仅仅在 `Template` 对象 (不要和在模板中通过 `#setting` 设置配置项所混淆， 那样只是修改`Environment`，而不会被此修复所影响) 上直接设置配置项时有效，而且几乎没有人会这么做。也请注意， 宏调用不会更改 `Environment` 的父级包含宏定义的 `Template`，现在那里就没有更改了。

  - Bug 修复 [419]： 当没有权限读取 Java 系统属性时，FreeMarker 不会在发生失败了， 比如在未签名的 applet 程序中使用时。它就是记录一些警告日志。

  - `HTML_DEBUG` 和 `DEBUG` `TemplateExceptionHandler` 输出现在包含了比如 HTML_DEBUG mode; use RETHROW in production! 这样的警告，这是由于频繁误用引起的。

  - 在输出中的模板规范化的一些修改和提升， 结果是 FTL 堆栈跟踪指令显示出来了。

  - 标记了一些历史上公开过但又是内部的 API 为废弃， 所以废弃标志在 IDE 中更可见。

##### 注意

对于在 `DefaultObjectWrapper` 的容器类型，当它的 不兼容改进设置为 2.3.22 时，引入适配器方式的结果和原因：

- 使用新方式 (适配器方式)，`Map` 的键的顺序不会丢失。复制方式仅仅对 `HashMap` 的子类 (比如 `LinkedHashMap`) 和 `SortedMap` (比如 `TreeMap`) 保留，但对外来的 `Map` 就不是这样，比如 Guava 的 `ImmutableMap`。而且，其它任何原生 `Map` 的古怪行为(例如，大小写敏感的键值查找) 也保留下来了。

- 当包装的值从模板回传给 Java 方法时，精确的类型和 `Map`/`List` 的识别符被保留下来。 使用遗留的方式，Java 方法得到了特殊的 FreeMarker 特定类型的 `Map` 或 `List` (作为 `TemplateModel` 的适配器)。

- 性能特点改变，大多为更好，但也基于应用程序而定。 如果模板 从数据模型中 读取 same(!) 记录大约一次或两次(或者根本不)， 这是很典型的情况，那么适配器方式就有更好的结果， 否则遗留的复制方式会更快些(因为它可以从之前的读取中重用包装后的记录)， 尽管这个减缓当然不是大多数应用程序的关注点。 新的适配器方式的性能更加可以预测，因为它没有初始化的 spike 来创建容器复制(对于大集合来说这是相当痛苦的)， 作为替代，对于数据模型读取数量来说(而不是对集合记录数量)， 性能是线性比例。

- 如果 `Map`/`List`/数组在它被包装后更改， 那么更改现在就在数据模型中可见了。使用复制的方式， 包装的值是原始 `Map`/`List`/数组 的浅快照。而有些人故意使用它是不可能的，当切换到适配器时它是一个风险因素。

- 从理论上来说，一些代码(更多是 `TemplateDirectiveModel` 实现)误以为包装的 `Map` 是 `SimpleHash`，而包装的 `List` 是 `SimpleSequence` 等等，而它们只是 `TemplateHashModel` 和 `TemplateSequenceModel`。这样的代码通常是错误的， 但是现在确实中断了，所以它也是一个风险因素。

- 现在包装后的原始对象的精确类型是用于重载方法的选择， 那么选择可以是不同的(和使用纯 `BeansWrapper` 是相似的)。 找出这些情况的例子是很难的。更改最有可能的是数组，因为使用复制方式，它们 被解包成 `List`，而不是原来的数组。由于重载方法机制可以 在数组和列表(双向的)之间进行转化，那通常不是一个问题。但是， 当重载方法在数组参数位置有可变参数类型，它就不能在不同的数组类型直接做转化， 所以这也是一个风险因素。

- `SimpleHash` 和 `SimpleSequence` 没有废弃。 它们仍然用于 FTL 中哈希表和序列的创建，特别是从模板中使用的值被创建， 这是推荐的做法，而不是包装已经存在的 `Map` 或 `List` 或数组。

- `List` 和 `Map` 在多线程环境下暴露于模板中现在在多线程，只读访问中关于它们正确的操作， 有更大的压力。这是因为适配器没有在从多线程访问它们之前， 复制它们的内容到已知的 `List` 和 `Map` 实现 (`HashMap`， `ArrayList`，等等)。所以使用自定义的 So this is mostly a concern with custom `List` 和 `Map` 实现时，这就是一个主要考虑点，它不像标准的 Java 类那样成熟。 请注意，使用纯 `BeansWrapper` 时总是这样， 这被很多项目/框架(比如 Struts)所使用，也有很长时间了， 所以它不是一个未知领域。

- 当包装的 `List` 是 `AbstractSequentialList` (比如 `LinkedList`)时，产生的适配器会为更多的高效枚举 (进行 `#list`)实现 `TemplateCollectionModel`，另外，当然是 `TemplateSequenceModel`。 `TemplateCollectionModel` 允许 FTL 横向访问列表而不需使用 索引来访问元素。使用遗留的复制方式 `TemplateCollectionModel` 没有被实现， 因为它不需要高效枚举。

- 迭代器(当直接放置它们到数据模型时)被包装成 `DefaultIteratorAdapter` 而不是 `SimpleCollection`。这会有两个结果：

  - 包装的 `Iterator` 当从模板中被传给 Java 方法时， 现在被适当解包成原来的 Java 对象。

  - 包装的 `Iterator` (不要和 `Iterable` 搞混) 不再是线程安全的了，节约一些同步， 毕竟暴露相同的 `Iterator` 到多个并行模板执行中也没有什么意义。这不是迁移所要关注的，而之前， 仅仅只有一个模板执行可以成功(`Iterator` 的 内容 没有被复制，那么第一个访问它的单独拥有者)。 该更改只是之前它被保证其它线程会失败(是关于线程安全的)， 而现在没有这些保证了。

#### 2.3.21

发布日期: 2014-10-12

请注意，从 2.3.21 版本开始，设计上是完全向后兼容之前的 2.3.x 发布版， 下面描述的一些改进和修复仅仅当要求 2.3.21 版本的 不兼容改进 时可用， 因为它们可以有很小的机会去弄坏已有的应用程序。如果相关项目仍然在进行开发， 极度推荐允许 2.3.21 "不兼容改进"。参考 如何设置 不兼容改进。

请注意，我们已经更改了所有权，BSD式许可证改为Apache许可证，2.0版。 参考 新的许可证。

请注意，Java 版本的最低需求已经从 1.2 升级到 1.4。

##### FTL 部分的修改

- 改进值域：

  - 添加了不包含结尾的值域： ``start`..<`end`` (也可以写为 ``start`..!`end``)。 更多内容...

  - 添加了限定长度的值域： ``start`..*`length``： 例如， `10..*4` 是 `[10, 11, 12, 13]`， `10..*-4` 是 `[10, 9, 8, 7]`，而 `10..*0` 则是 `[]`。当这些值域用于切分时， 如果被切分的序列或字符串结尾在指定值域长度之前，切分结束不会有错误。 比如，从字符串 `s` 中获取前10个字符，如果 `s` 不到10个字符，则获取更少，可以使用 `s[0..*10]`。 更多内容...

  - Square bracket now accepts range values from any source, like `<#assign r = 1..3> ${'foobar'[r]}` will print `"oob"`. Earlier it has only supported ranges that were specified directly inside the square brackets, like `'foobar'[1..3]`.

  - When slicing a sequence with a right-unbounded range, it's now allowed to have a range start index that's one higher than the last index of the sliced sequence. For example, `['x', 'y'][2..]` is not an error anymore, but an empty sequence. (Of course, `['x', 'y'][3..]` is still an error.)

  - ``someString`?substring(`from`, `toExclusive`)` and ``someString`?substring(`from`)` are now deprecated; use this slicing expression instead: ``someString`[`from`..<`toExclusive`]` and ``someString`[`from`..]`. A warning if you are processing XML: Since slicing expressions work both for sequences and strings, and XML nodes in FTL are typically both sequences and strings at the same time, there the equivalent expression is ``someXmlNode`?string[`from`..<`toExclusive`]` and ``exp`?string[`from`..]`, because without the `?string` it would slice the node sequence instead of the text value of the node.

  - If the `incompatible_improvements` in the FreeMarker configuration is set to at least 2.3.21, right-unbounded ranges become readable (like `#list`-able). Earlier they could only be used for slicing, and behaved like empty sequences otherwise.

- New built-in, `?url_path`: This is the same as the `url` built-in, except that it doesn't escape slash (`/`) characters. This meant to be used for converting paths (like paths coming from the OS or some content repository) that use slash (not backslash!) to a path the can be inserted into the path part of an URL.

- New built-ins for string manipulation:

  - ``someString`?keep_before(`substring`[, `flags`])`: More...

  - ``someString`?keep_after(`substring`[, `flags`])`: More...

  - ``someString`?remove_beginning(`substring`)`: More...

  - ``someString`?remove_ending(`substring`)`: More...

  - ``someString`?ensure_starts_with(`substring`[, `substitution`[, `flags`]])`: More...

  - ``someString`?ensure_ends_with(`substring`)`: More...

- ``someString`?number` now recognizes all XML Schema number formats, like `NaN`, `INF`, `-INF`, plus the Java-native formats `Infinity` and `-Infinity`.

- If `incompatible_improvements` in the FreeMarker configuration is set to at least 2.3.21, ``someNumber`?c` will return `"INF"`, `"-INF"` and `"NaN"` for positive/negative infinity and IEEE floating point Not-a-Number, respectively. These are the XML Schema compatible representations of these special values. Earlier it has returned what `java.text.DecimalFormat` did with US locale, none of which was understood by any (common) computer language.

- New built-in: ``someString`?boolean`. This is for example useful for converting "true" and "false" strings coming from XML to real boolean values. More...

- Date/time/date-time related changes:

  - Added new kind of `date_format`/`datetime_format`/`time_format` setting values: XML Schema formats, starting with `"xs"` and ISO 8601:2004 formats, starting with `"iso"`. The format string can be continued with various space (or `_`) separated options, like `h` or `m` or `s` or `ms` for setting shown accuracy, `nz` or `fz` for setting time zone offset visibility, and `u` or, `fu` for using UTC time zone . For example, to use ISO 8601 with minute precision and without the zone offset being shown, set the `datetime_format` setting to `"iso m nz"`, so then the output will be like `2014-09-03T20:56`. More...

  - Because anything that's accepted as `date_format`/`datetime_format`/`time_format` setting value can also be used with the `?string` and `?date`/`?time`/`?datetime` build-ins, you can use the new formats like `someDate?string.xs` and `someString?date.xs`. (For the `"xs"` and `"iso"` formats, `_` can be used instead of space, which means that, for example, you can write `lastModified?string.iso_m_u` instead of the more verbose `lastModified?string["iso m u"]`.)

  - That `"iso"` and `"xs"` are now possible `date_format`/`datetime_format`/`time_format` setting values also means that such values can now be parsed too via `?date`/`?time`/`?datetime`. The main application is with processing XML DOM-s, as there values are coming in as strings, and now you can do something like `order.confirmDate?date.xs` to convert them to real dates.

  - The `?iso_...` built-ins are now deprecated in favor of the new setting values described above. They can be set as the default date/time/date-time format, seamlessly fit into the formatting architecture (and thus can parse strings too), and has more/better options (`ms` always shows 3 millisecond digits, `fz` for forcing showing time zone offset).

  - If the incompatible improvements configuration setting is at least 2.3.21, the `?iso_...` built-ins won't show time zone offset for `java.sql.Time` values anymore. Most databases store time values that aren't in any time zone, but just store hour, minute, second, and decimal second field values, so showing the time zone doesn't make sense. (Notable exceptions are PostgreSQL "time with time zone" columns, where ``mzTime`?string.iso_fz` could be used.)

  - Added `?is_time`, `?is_datetime`, `?is_date_only` (should be called `?is_date`, but that was already taken) and `?is_unknown_date_like` to check the exact type of a date-like value.

  - `?is_date` is now a deprecated name, use `?is_date_like` instead. This is because `?is_date` sounds like it checks if the value is a date without time part, but actually it also returns `true` for time, date-time, and unknown date-like values.

  - Added `?date_if_unknown`, `?time_if_unknown` and `?datetime_if_unknown` built-ins, which mark a date-like value with some of the sub-types: date without time, time, or date-time, respectively. However, if the value already holds this information, the built-in has no effect. That is, it will never convert the sub-type of a value, it only adds the sub-type if it was unknown.

  - Bug fixed: ISO 8601 dates (via `?iso_...` and `"iso"` format settings) now use proleptic Gregorian calendar for the years before 1582, rather than Julian calendar. This is (indirectly) required by the standard, and it's also how the default Sun/Oracle Java XML Schema date/time/dateTime parser works.

- Error message quality improvements (targeting frequent support requests and some error message bugs):

  - Fixed glitch where if an `#if` had and `#else` or `#elseif`, the `#if`/`#else`/`#elseif` wasn't hidden in the FTL stack trace when the error was inside its nested block.

  - Some new context sensitive hints in undefined variable exception error messages.

  - Fixed unclosed directive error messages at end of file where the wrong unclosed directive name was reported

  - Better type error messages when accessing XML data (applies when wrapped with `freemarker.ext.dom`):

    - Trying to use `node.`noSuchChildNodes`` on a place where scalar value is expected will explain that the problem is that you had no matches in the constructing XML query.

    - Trying to use `node.`multipleSuchChildNodes`` on a place where scalar value is expected will explain that the problem is that you had multiple matches in the constructing XML query.

    - Trying to use `node.`exactlyOneChildNode`` as number, date/time/date-time or boolean will explain that values coming from XML are always strings (text), and must be converted explicitly via `?number`, `?boolean`, `?date.xs`, etc.

  - Trying to use `obj.someMethod` without `()` on a place where method value is not expected will recommend calling the method.

  - Trying to use methods like `obj.getFoo` or `obj.isFoo` without `()`on a place where method value is not expected will recommend using the `obj.foo` form.

  - Messages are now much more readable when rendered in environments that don't obey to line-breaks. (This often happens in improperly implemented HTML error pages and logs viewers.)

  - Better FTL instruction stack traces:

    - Error messages now contain up to 10 lines of FTL stack trace (unless it's on the top of a full FTL stack trace), because the FTL stack trace wasn't printed at all when the exception was a cause exception in a Java stack trace, or when only the value of `getMessage()` was printed instead of a stack trace.

    - The FTL stack trace is now more self explanatory as it contains more text labels.

    - Stack frames that belong to nestings are now marked differently, and are filtered out when the stack trace wouldn't fit into the error message otherwise.

  - Bug fixed: `?substring` has thrown low level `java.lang.IndexOutOfBoundsException`-s instead of more descriptive `TemplateModelException`-s with FTL stack trace.

  - Bug fixed: Slicing with ranges sometimes thrown low level `java.lang.IndexOutOfBoundsException`-s instead of more descriptive `TemplateModelException`-s with FTL stack trace.

  - Bug fixed [402]: Fixed misleading parser error message when a directive called without its required parameters (like `<#list>`) was reported as unknown directive.

  - Bug fixed [222]: Poor quality error message when ``someString`[`someIndex`]` fails with string index out of bounds.

  - Bug fixed [27]: Not very good quality error messages when `#import`-ing a template whose parsing fails.

- New `include` directive option, `ignore_missing=`boolean``. When this is set to `true`, and the template to include is missing, the error will be silently ignored, and nothing will be included.

- The `setting` directive can now set the `output_encoding` setting.

- New special variable: `.locale_object`. This is like `.locale`, except that it's a `java.util.Locale` object, not a string. This is handy if you want to pass the current locale to Java methods.

- If `incompatible_improvements` in the FreeMarker configuration is set to at least 2.3.21, hash literals that repeat keys now only have the key once with `?keys`, and only has the last value associated to that key with `?values`. This is consistent with the behavior of ``hash`[`key`]` and how maps work in Java.

- Bug fixed: `?is_enumerable` has returned `true` for Java methods get from Java objects, despite that those values aren't `<#list ...>`-able. (This is actually a historical quirk of `BeansWrapper`, not a bug in `?is_enumerable`, but now `?is_enumerable` is aware of this exceptional case.)

- Bug fixed [257]: The result value of `?matches` wasn't reentrant. For example, you couldn't list the matches inside another listing where you are also listing exactly the same result value (stored in a common variable), as they would consume from the same iterator. Most importantly, even accessing the `?size` of the same result value has terminated the outer listing of the same value.

- Bug fixed [229]: If you set `incompatible_improvements` to 2.3.21 (or higher), unclosed comments (`<#-- `...``) and `#noparse`-s won't be silently closed at the end of template anymore, but cause a parsing error instead.

##### Changes on the Java side

- Added new `Configuration` constructor, `Configuration(Version incompatibleImprovements)`. This deprecates the vague `Configuration()` constructor, and makes using `setIncompatibleImprovements(Version)` needless in most cases. See an example here...

- When setting the `incompatible_improvements` setting (like with the constructor above) to 2.3.21, two setting defaults change:

  - The default of the `object_wrapper` setting (`Configuration.getObjectWrapper()`) changes from `ObjectWrapper.DEFAULT_WRAPPER` to another almost identical `DefaultObjectWrapper` singleton, returned by `new DefaultObjectWrapperBuilder(Version).build()`. The new default object wrapper's incompatible improvements version is set to the same as of the `Configuration`. (See later regarding the 2.3.21 incompatible improvements of `BeansWrapper` and `DefaultObjectWrapper`). Furthermore, the new default object wrapper doesn't allow changing its settings; setter methods will throw `IllegalStateException`. (If anything tries to call setters on the old default in your application, that's a dangerous bug that won't remain hidden now. As the old default is a singleton too, potentially shared by independently developed components, most of them expects the out-of-the-box behavior from it (and the others are necessarily buggy). Also, then concurrency glitches can occur (and even pollute the class introspection cache) because the singleton is modified after publishing.)

  - The default of the `template_loader` setting (`Configuration.getTemplateLoader()`}) changes to `null`, which means that FreeMarker will not find any templates. Earlier the default was a `FileTemplateLoader` that used the current directory as the root. This was dangerous and fragile as you usually don't have good control over what the current directory will be. Luckily, the old default almost never looked for the templates at the right place anyway, so pretty much all applications had to set `template_loader`, so it's unlikely that changing the default breaks your application.

- New `BeansWrapper`, `DefaultObjectWrapper` and `SimpleObjectWrapper` constructor that takes a `Version` `incompatibleImprovements` argument. This has the same role as the `incompatible_improvements` setting of the `Configuration`, but it applies to the `ObjectWrapper` instead. (As `ObjectWrapper`-s are often shared among multiple `Configuration`-s, so they can't use that setting of the `Configuration`.) In new or actively developed projects it's recommended to use `Configuration.VERSION_2_3_21` now. The constructor without the `Version` parameter is now deprecated.

- Safer and more memory-efficient way of managing singletons of `DefaultObjectWrapper`-s and `BeansWrapper`-s that are possibly shared by independently developed subsystems:

  - Instead of `new DefaultObjectWrapper(`...`)` and `new BeansWrapper(`...`)`, from now on you should use `new DefaultObjectWrapperBuilder(version).build()` and `new BeansWrapperBuilder(version).build()`. (The builder objects have properties (configuration settings) like `BeansWrapper` has, which specify the properties of the objects created.) The created objects are singletons (VM-wide, or at least Web-Application-wide) and read-only (means, non-configurable, hence safe to share). The main benefit of using these factories instead of creating new instances is that it allows FreeMarker to share the class introspection caches (an internal part of `BeansWrapper`-s/`DefaultObjectWrapper`-s that is expensive to populate) among the returned instances. This allow sharing the caches (and the object wrappers) between components that aren't aware of each other and use FreeMarker internally.

  - Deprecated the static fields `ObjectWrapper.DEFAULT_WRAPPER`, `BEANS_WRAPPER` and `SIMPLE_WRAPPER`, because these `ObjectWrapper`-s are configurable (not read-only), and thus dangerous to use as singletons (a badly behaving 3rd party component can mess them up). Use the factories described above instead. They are also more flexible, as you can specify the desired incompatible-improvements version for them and various other `BeansWrapper` settings.

  - Deprecated all `SimpleHash`, `SimpleCollection` and `SimpleSequence` constructors that didn't take an `ObjectWrapper` argument, as they have usually used `ObjectWrapper.DEFAULT_WRAPPER` as the default, which itself is deprecated.

  - `BeansWrapper`, `DefaultObjectWrapper` and `SimpleObjectWrapper` now implements the `freemarker.template.utility.WriteProtectable` interface with which the configuration properties of the object wrapper can be set permanently to read-only by calling `writeProtect()`. An attempt to call a setter on a such `ObjectWrapper` will immediately cause `IllegalStateException`. (This is what's used for the singletons returned by the `getInstance` methods too; see earlier).

- The value of the `time_zone` setting, when you specify it with a `String` (in a `java.util.Properties` object, or via `<#setting `...`>`) can now be `"JVM default"` to use the JVM default time zone. The JVM default is the default value of that setting anyway, but now you can state this explicitly, or restore this value if it was overridden earlier.

- Added new configuration setting, `sql_date_and_time_time_zone` (`Configurable.setSQLDateAndTimeTimeZone(TimeZone)`). When this is set to non-`null`, the time zone used when dealing with `java.sql.Date` and `java.sql.Time` values will be this time zone instead of the value of the `time_zone` FreeMarker configuration setting. This is useful because JDBC will, usually, construct the Java `Date` objects so that they will show the year-month-day and hour-minute-seconds values from the database as is if you render them using the JVM default time zone. As time zone conversions for SQL date-only and SQL time-only values doesn't make much sense (unlike for SQL timestamps), you should certainly set this setting to the JVM default time zone (`TimeZone.getDefault()`, or if you configure FreeMarker via `java.util.Properties`, as property value "JVM default"). The default value is `null` for backward compatibility. For more details see the JavaDoc of `Configurable.setSQLDateAndTimeTimeZone(TimeZone)`.

- When configuring FreeMarker with `java.util.Properties` (typically, when the configuration is stored in a `.properties` file), for the settings where you could specify a fully qualified class name (most notably for the `object_wrapper` setting) now you can also specify constructor arguments and JavaBean property assignments. For example, now you can write `object_wrapper=com.example.MyObjectWrapper(1, 2, exposeFields=true, cacheSize=5000)`that's nearly equivalent with this Java code: `obj = new com.example.MyObjectWrapper(1, 2); obj.setExposeFields(true); obj.setCacheSize(5000); object_wrapper = obj;`. If you are using this new syntax (i.e., if you have parentheses after the class name, even if they are empty), and there's a builder class for the requested class, that will be automatically used. For example, `object_wrapper=DefaultObjectWrapper(2.3.21)` will create a `DefaultObjectWrapperBuilder` to build the final instance, thus the object wrapper will be a singleton instead of a new instance. The new syntax will also look for a public static `INSTANCE` field if there are 0 arguments and property assignments. For more details see the Java API documentation of `Configuration.setSetting`.

- Template not found exceptions now explain that the template path is interpreted by a template loader, and show the `toString` of the `TemplateLoader`. The out-of-the-box `TemplateLoader` implementations now have an overridden `toString` to show the actual base directory and such details. Custom `TemplateLoader` implementations are encouraged to override `toString`.

- Added `Configuration.setSharedVariables(Map/*<String, Object>*/)` for setting the shared variables from Spring IoC and other IoC solutions. The already existing `Configuration.setSharedVariable(String, Object)` isn't a JavaBean property so it was hard to use for that. Furthermore, the order in which `Configuration.setObjectWrapper` and `Configuration.setSharedVariables` are called doesn't mater (unlike in the case of `Configuration.setSharedVariable`), which is essential in most IoC solutions.

- Mostly concerning tool (like IDE plugin) authors:

  - `ParseException`-s now also store the end-location of the error, not just its start-location. This is useful if you want to underline the error in the source code, not just point at it.

  - `Configuration.getSupportedBuiltInDirectiveNames()` can be used to return the names of directives supported by FreeMarker.

  - `TemplateExceptions` now expose the position of the error (template name, line, column, end line, end column) similarly to `ParseException`-s. Where applicable, they also expose the blamed expression in its canonical FTL source form; this is mostly useful for `InvalidReferenceException`-s.

- The concurrent performance of overloaded method lookups (from the cache) was improved under Java 5 and later.

- The `Version` instances that are incompatible improvements break points are now available via constants like: `Configuration.VERSION_2_3_21`.

- From now on, if you try to set the incompatible improvements to greater than the current FreeMarker version, or less than 2.3.0, an `IllegalArgumentException` will be thrown. Thus, `new Configuration(`someVersion`)` not only activates the fixes up to that version, but ensures that the application will not run in an environment with an older FreeMarker version. (On an older FreeMarker version the improvements that you have requested aren't implemented yet, so you should get an exception.)

- Added new configuration setting, `show_error_tips`, defaults to `true`. Sets if tips should be shown in error messages of errors arising during template processing.

- Instead of overriding `BeansWrapper.finetuneMethodAppearance` (now deprecated), now you can use `BeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner)`, so you don't need to extend the object wrapper class to customize this aspect.

- Added `Configuration.getCoreDirecticeNames()` which returns the names of all directives that are provided by FreeMarker. This can useful for IDE-s.

- `template_loader` was added as possible configuration setting `Properties` key.

- The standard `CacheStorage` implementations now have a `getSize()` method for monitoring the cache size. `MruCacheStorage` also has `getSoftSize()` and `getStrongSize()`.

- Various smaller improvements in configuration setting errors messages.

- With incompatible improvements 2.3.21 only: Empty ranges return `Constants.EMPTY_SEQUENCE` instead of an empty `SimpleSequence`. This is in theory backward compatible, as the API only promises to give something that implements `TemplateSequenceModel`.

- FreeMarker now requires Java version has changed from 1.2 to 1.4.

- Bugs fixed and improvements in overloaded method selection/invocation, but only if you create the `BeansWrapper`/`DefaultObjectWrapper` with constructor parameter `Configuration.VERSION_2_3_21` (or if you are using `Properties` to configure FreeMarker, you can do that like `object_wrapper=BeansWrapper(2.3.21)`), or if you have a `Configuration` with similar `incompatible_improvements` 2.3.21 and you leave the `object_wrapper` setting on its default value. There's a little chance that because of these changes, a different overloaded method will be chosen than before, or even that ambiguity errors will arise where earlier they didn't (although the opposite is far more frequent), hence the fixes aren't automatically activated. But the fix mostly only effect calls that were failing or have chosen then wrong method earlier, so it's recommended to activate it for projects that are still actively developed. This fix includes numerous changes:

  - Earlier, `null` argument values has only matched overloaded methods where the corresponding parameter had `Object` type, not a subclass of it. That's clearly a bug. Now it considers all overloads where the parameter type is non-primitive, and just like the Java language, it choses the one with the most specific type among them. This is the most important fix, and also the most risky one regarding backward-compatibility. Like if you have `m(Object o)` and `m(String s)` in a Java class, earlier for a `m(null)` call in the template it has chosen `m(Object o)`, but now it will choose `m(String s)` instead (because `String` is also `null`-able and is more specific than `Object`). Furthermore, if you also had `m(File f)` in the same class, now it will cause an ambiguity exception, since the specificity of `File` and `String` can't be compared (same rule as under Java language), while earlier that wasn't a problem as only `m(Object o)` was seen as applicable.

  - The behavior of numbers with overloaded method selection was heavily reworked:

    - If possible, it now always choses the overload where overflow and truncation to integer (like 1.5 to 1) is avoided. Among the methods where no such critical loss occurs, it choses the overload with the least risk of precision loss (unless other conditions with higher priority suggest otherwise). Earlier, the method selection was prone to do choices that led to overflow or precision loss, especially when the parameter was a literal with decimals.

    - Overloaded method call can now convert to non-primitive numerical types, like a `Byte` or `byte` value is automatically converted to `Integer` if the parameter type is `Integer`. (This has always worked for non-overloaded methods.) Earlier where such conversion was needed, the method wasn't seen seen applicable.

    - Method selection is now not only based on the type of the wrapped number, but also on its value. For example, a `Long` with value `1` is now seen as compatible with a method with parameter type `int` or `short` or `byte`, as `1` can be stored in those without loss. This is important as unlike in Java language, in FTL you doesn't have strict control over the numerical types (the type of the wrapped number, actually), as FTL has no type declarations. (If multiple compatible methods are available, it will still try to chose the one with the same or bigger numerical type.)

    - Conversion from/to `BigInteger` is now supported.

  - Method choice ambiguity errors now occur much less often. Ambiguities was and are resolved by selecting the compatible methods then choosing the one with the most specific parameter types among them. The changes are:

    - When comparing the overall specificity of two parameter lists: Earlier the parameter list seen as more specific was the one that had some parameters that won in specificity, and if both had such parameters then it was an ambiguity. Now it's enough if a method has more such parameters where it's a better match than the other has, or if the two methods are still equal, if it has the first better matching parameter. This can lead to choices that seem arbitrary (but are still deterministic), but as there's no automated way of discovering method selection ambiguities in templates (unlike in Java source code, where they will be detected during compilation), especially as overloaded selection has to rely on the runtime type of the values which even make proper testing hard, this was considered to be a better compromise than throwing an exception whenever the choice of the method is not obvious. Also note that in fact this mechanism is more complicated than just counting the winner parameter positions for each methods, as certain kind of wins are stronger than any number of the others: wins where the other possibility is risking of substantial mantissa precision loss are the strongest (like dropping decimals versus not to), wins where the primitive type wins over the boxed class is the weakest (like `int` versus `Integer`), subclassing wins (like `String` versus `Object`) are between these two.

    - When comparing the specificity of two parameters types at the same parameter position: The algorithm now considers a primitive type as more specific that its corresponding boxing class (like `int` is considered to be more specific than `Integer`).

    - There was a bug with overloaded varargs methods of different parameter counts, where sometimes the last parameters of the compared methods was ignored, which is taking away a potential deciding factor and thus can lead to ambiguity error. Whether this happened depends on the order in which the Java reflection API has returned the methods, which is undocumented and known to change at least after some Java updates, breaking the application.

    - When comparing the specificity of two array types, until now they were seen as equal. Now the component types are compared, and then that with the less specific component type is preferred. For example, among `f(String[])` and `f(Object[])`, the last will always win. This might sounds controversial, but as we can't efficiently tell the common type of all the items in a sequence or `List`, an so we don't know if both arrays are indeed valid targets, we go for the safest choice.

  - FTL sequence values (like Java `List`-s or FTL `[`x`, `y`, `...`]` constants) were not seen as applicable to a parameter with array type if there were multiple overloaded methods with the same number of parameters but with different types on the position of the array parameter. That is, if you had `f(String[])` and `f(String)` in Java, then `f(['foo', 'bar'])` in the template reported no compatible overloads. Now it will choose `f(String[])`. Note that if there's also an `f(List)` or even an `f(Collection)`, it will prefer those over arrays. (For consistency, this conversion will work even if the argument is a `List` that come directly from Java (as opposed to be created inside FTL), i.e., when it was wrapped then unwrapped to the original `List` object.) For a multidimensional array parameter type, this conversion works recursively, so you can pass in a sequence-of-sequences as the argument.

  - FTL sequence values that wrapped a Java array (when FreeMarker was also aware of that via `AdapterTemplateModel` or `WrapperTemplateModel`) were not seen as applicable to a parameter with `List` type if there were multiple overloaded methods with the same number of parameters but with different types on the position of the array parameter. So this is pretty much like the issue described in the previous point, but for array to `List` conversion. The array to `List` conversion will be avoided if possible, but it will be attempted if there's no other alternative. Note that unlike with `List` to array conversions, here FreeMarker can't cope with multi-dimensional lists, that is, an array-of-arrays won't be converted to a `List`-of-`List`-s.

  - FTL string to Java `char`/`Character` conversion now works for overloaded method parameters; earlier it has worked for non-overloaded methods only. If the string length is 1, it will be seen as compatible with parameters with `char` or `Character` type.

  - Decreased the chance of choosing the wrong target Java type when unwrapping multi-typed FTL values: When unwrapping a parameter value that implements multiple FTL types (e.g. string and hash) but doesn't implement `AdapterTemplateModel` or `WrapperTemplateModel`, a decision has to be made if to what Java type the value should be unwrapped to (e.g. to `String` or to `Map`). In earlier versions that decision was made based on the most specific common super type of the parameters types of the given parameter position. However, it's quite common that the common super type is too generic, usually `Object`. Now `BeansWrapper` stores type flags for each parameter position of overloaded methods, from which it can tell whether a potential target Java type occurs in any of the overloads on the given parameter position.

  - In many cases, less specific hint class was used for unwrapping than that was possible within the limitations of the applied hint generation algorithm. (The unwrapping hint has influence when there's an ambiguity regarding how to create a Java object form an FTL value. In the vast majority of the cases, a too generic hint has no effect.) (This is a highly technical topic. The way it works is that a single common unwrapping hint class is chosen for a given argument position shared by the overloads that has the same number of parameters, and that hint class has to be as specific as possible while it must fit all those parameter types. The issue with the too generic hints had several instances: (a) When the most specific common class/interface of two same-position parameter types was searched, if there was multiple common classes/interfaces that had no relationship (this is always at most one class and one or more unrelated interfaces), due to the ambiguity it has felt back to using `Object` as the unwrapping hint. Now if there's a non-`Object` class among them in such case, it will be chosen as the hint (i.e., we ignore the common interfaces). Otherwise if only a single interface remains by removing `Cloneable`, `Serializable`, and `Comparable` (in that order), that will be chosen. Only then it falls back to `Object`. (b) The common most specific class of a primitive type and the corresponding boxing class was sometimes `Object` instead of the boxing class. This has depended on Java's internal ordering of the methods, and so were quite unpredictable, like the result could change after upgrading Java under the application. (c) The common superclass of a numerical primitive value and a numerical non-primitive value was always `Object`, now if they are a primitive-boxing class pair, then it's the boxing class, otherwise it's `Number`. (d) If the varags parameter position was not the same in all the overloaded varargs methods, sometimes some varargs arguments where unwrapped with too generic hints. When this happened was unpredictable as it depended on Java's internal method ordering again.)

  - When unwrapping method call arguments before calling a Java method, if the argument was an `AdapterTemplateModel` and the target parameter type was primitive, `AdapterTemplateModel.getAdaptedObject(Class hint)` has received the primitive type of the target parameter (like `int` instead of `Integer`) as the hint. This did not make sense since `getAdaptedObject` can only return `Object`-s, not primitive values. Yet, `BeansWrapper` has expected the returned value to be of the primitive type, otherwise it has discarded it. Exactly the same problem occurs with `WrapperTemplateModel`. Thus, ultimately, if the target parameter type was primitive and some of these interfaces were implemented, their return value was always discarded and FreeMarker has felt back to other means of unwrapping. Now `BeansWrapper` always passes in and expects the boxing type (like `Integer`) instead of the primitive type.

- Bug fixed [373]: These are three bugs actually, which can cause problems when FreeMarker re-loads a template because of a charset override with `<#ftl encoding="...">`: First, if the template loader was a `URLTemplateLoader`, when `TemplateLoader.getReader()` was called for the second time, and the `Reader` returned for the first time was already used, it might returned an empty or corrupted template, depending on the backing URL implementation. Secondly, when FreeMarer has decided if a template file has to be re-loaded because its encoding specified with `<#ftl encoding="...">` differs from the encoding used for loading the template first, it has used case-sensitive comparison, thus often re-loaded needlessly (like "UTF-8" and "utf-8" mean the same). Now this comparison is case-insensitive. Last not least, when retrying with the second charset, the `TemplateCache` has forgotten to close the first `Reader`, which can be a handle leak.

- Bug fixed [411]: Invalid and redundant execution environment names from the OSGi bundle manifest were removed. It looks like this now: `Bundle-RequiredExecutionEnvironment: J2SE-1.5, J2SE-1.4`. That is, we prefer (and compile against) 1.5, but only require 1.4.

- Bug fixed [409]: `SimpleHash`'s internal `Map` is concurrently modified on a non-safe way when getting length-1 `String` key that exists but maps to `null`. This operation will accidentally add a `Character` key to the internal map, which is not a thread-safe operation.

- Bug fixed [273]: `TemplateLoader`-s that use `java.net.URLConnection`-s should set `URLConnection.useCaches` to `false`, or else it won't detect template caches on certain configurations.

  - `URLTemplateLoader` and its subclasses and `WebApplicationTemplateLoader` now has a `setURLConnectionUsesCaches(Boolean)` method. It's recommended to set this property to `false` from its default backward compatible value, `null`. As FreeMarker has its own template cache with its own update delay setting (`template_update_delay`, `Configuration.setTemplateUpdateDelay(int)`), it shouldn't cause performance problems. The `null` value will leave the caching of the `java.net.URLConnection` on its default, which is usually `true`.

  - If `incompatible_improvements` is set to 2.3.21 (or higher) and templates are loaded through `Configuration.getTemplate`, and the `TemplateLoader` in use has `URLConnectionUsesCaches` left on `null`, it will behave as if it was set to `false`. Note that this `incompatible_improvements` trick only works if the template is loaded through `Configuration.getTemplate` (or `TemplateCache`).

- Bug fixed: When changing the properties of `DefaultObjectWrapper` or `BeansWrapper` that influenced class introspection results (like `exposureLevel` or `exposeFields`), the introspection cache wasn't cleared, and thus returned stale information for the classes that were introspected before those properties were changed. Now changing such properties always clears the introspection caches.

- Bug fixed: Constants used for empty sequence, empty hash, empty collection and empty iterator weren't `Serializable`.

- Bug fixed [300]: Logger class availability check was incorrect in that it has checked the availability of logger libraries with the thread context class loader, then later it tried to link to them with the defining class loader of the FreeMarker classes. With some class loader setups (notably under Netbeans sometimes) this led to `ClassDefNotFoundError`-s that made FreeMarker unusable. (The check itself was also not very durable, as it didn't expected `LinakeError`-s, only `ClassNotFoundException`.)

- Bug fixed: `ClassUtil.forName`, used inside FreeMarker everywhere to resolve class names to classes, if the thread context class loader is `null`, no longer tries to load with the bootstrap class loader before loading with the defining class loader of FreeMarker.

- Bug fixed [311]: `TemplateBooleanModel.TRUE` and `FALSE` are now serializable

- Bug fixed: Various issues in `Version` class, such as wrong `hashCode`, possible concurrency glitches, and acceptance of some malformed version strings.

- Bug fixed [414]: Eclipse debug mode running was suspended during FreeMarker static initialization on the JRebel availability checked if JRebel wasn't available.

##### Other changes

- The license has changed from our proprietary BSD-Style license to the well know "Apache License, Version 2.0". Furthermore, the copyright owner has changed from "Visigoth Software Society" (which was founded by Jonathan Revusky) to the three main FreeMarker 2 developers/contributors, "Attila Szegedi, Daniel Dekany, and Jonathan Revusky". See the new license here.

- The required minimum Java version was raised from 1.2 to 1.4. FreeMarker will not work on Java 1.2 or 1.3.

- Many smaller improvements and fixes in the Manual and API JavaDocs.

#### 2.3.20

Date of release: 2013-06-27

If you are IDE/tools author, note these changes.

##### Changes on the FTL side

- Error message quality improvements:

  - Many error messages are now more helpful, especially for users who are not experienced with FreeMarker. For example, some of the most common user mistakes are recognized and tips are shown to fix them, reducing support costs or the time employees spend to figure them out.

  - It's now ensured that the error location in the template is included in the message returned by `TemplateException.getMessage()`. The stack trace always showed this information anyway, but some users only see the message, not the stack trace, and that often didn't contained the location.

  - The template language part of the stack trace is now more detailed, and easier to understand. This is especially helpful in applications that use a complex library of macros and functions.

  - Several smaller bugs were fixed that made the error information wrong or lacking.

  - The layout of the error messages is now more consistent, and generally easier to read.

- Changes regarding boolean to string conversions and formatting:

  - `?c` (computer-language formatting) now works with booleans too, always giving `"true"` or `"false"` regardless of the `boolean_format`. This way it's safe for generating JavaScript in a context where human-readable text is also rendered.

  - If the `boolean_format` setting is set to anything but the default `"true,false"` value, boolean values will be automatically converted to string where a string value is expected by the template language, instead of giving an error. This helps you spare those`?string`-s after boolean values. This is the same logic as with numbers and dates, which were always automatically converted to string, according the corresponding format setting. Except, the provided default boolean format is useless for automatic conversion (but it's still there for `?string`, for backward compatibility), hence it must be set manually. (We certainly couldn't come up with a sensible default anyway, as for booleans it depends too much on the application, not to mention the localisation issues.)

    Exactly like with numbers and dates, automatic conversion doesn't happen in these cases:

    - Comparisons, i.e., `someBoolean == 'true'` is still an error

    - Method calls where the declared type of the parameter is `String` but the actual value is a boolean; still an error

    - When the boolean value is used as key in ``expr`[`key`]`, it's still an error (there was no automatic conversion there for other types either, as numerical and string keys have different meaning)

    - The opposite direction, i.e., string to boolean conversion; won't happen

- New built-ins for numbers: `abs`, `is_nan`, `is_infinite`. Like `n?abs` will give the absolute value of `n`.

- New built-in for sequences: `join`. Like `[1, 2, 3]?join(", ")` will give the string `"1, 2, 3"`.

- If you set the `incompatible_improvements` setting (see here) to `2.3.20` or higher, `?html` will escape apostrophe-quotes just like `?xhtml` does. Utilizing this is highly recommended, because otherwise if interpolations are used inside attribute values that use apostrophe-quotation (`<foo bar='${val}'>`) instead of plain quotation mark (`<foo bar="${val}">`), they might produce HTML/XML that's not well-formed. Note that `?html` didn't do this because long ago there was no cross-browser way of doing this, but it's not a real concern anymore. Also note that this will be the default behavior starting from 2.4.

- Bug fix [390] (and other improvements): `?js_string` and `?json_string` didn't escape the `u2028`-`u2029` line terminators (problem for JavaScript) and the `u007F`-`u009F` control characters (maybe a problem in JSON, depending on implementation). Furthermore, the escaping of `\`, `<`, and `>` become safer in that now they are escaped whenever it can't be guaranteed that they won't be part of `<!`, `]]>` or `</`. Earlier they were only escaped when it was known that they are part of these patterns, thus it was possible to assemble these patterns from two adjacent interpolations. Additionally, from now on `<?` and `-->` also count as dangerous patterns, and will trigger `<` and `>` escaping.

- Bug fixed: The following string built-ins didn't coerce the numerical, date (and now the boolean) left-values to string, instead they threw a type error: contains, `index_of`, `last_index_of`, `left_pad`, `right_pad`, `matches`, `replace`, `split`, `new`. The other string built-ins already did this conversion for a long time; this was an accidental inconsistency.

- Bug fixed: With the default arithmetic engine, it's now supported to compare infinite (positive or negative) with 0, to decide its sign.

##### Changes on the Java side

- `BeansWrapper` introspection cache improvements:

  - Added public API to `BeansWrapper` for clearing the class cache: `clearClassIntrospecitonCache()`, `removeFromClassIntrospectionCache(Class)`

  - Significantly improved multi-core performance:

    - Uses `ConcurrentHashMap` when running on Java 5 or later.

    - The cache won't block readers while introspecting a class after a cache miss

    - If multiple threads need to introspect the same class that's not in the cache yet, only one of them will do it, the others will wait for its results.

  - Bug fix [361]: There was a small chance of deadlock when class-reloading was detected. Locking was redesigned to prevent such oversights in the future.

  - The internal package-visible `freemarker.ext.beans` API was slightly changed as the result of internal cleanup. Nobody but the FreeMarker developers should define classes in that package, so it shouldn't break anything. But if somebody did some in-house hacks there, re-compile to see if it still works.

- Nameless templates (those directly created with `new Template(null, `...`)` instead of loaded through `Configuration`) couldn't include or import other templates, and thrown a `NullPointerException` when they tried to. Now they resolve relative paths as if they were in the template root directory.

- Bug fix: Regular expression built-ins and some logger libraries (most importantly Log4J) were unavailable on the Google App Engine platform. This fix is only present in the GAE-compatible build, 2.3.20-gae.

- Added new method to `Configuration`: `CacheStorage getCacheStorage()`

- Added new methods to `Environment` to make comparisons among `TemplateModel`-s according the rules of the template language operators: `applyEqualsOperator`, `applyEqualsOperatorLenient`, `applyLessThanOperator`, `applyLessThanOrEqualsOperator`, `applyGreaterThanOperator`, `applyWithGreaterThanOrEqualsOperator`

- Added new method, `Environment.isInAttemptBlock()` to check if we are within an `#attempt` block. This can be useful for `TemplateExceptionHandler`-s, as then they don't need to print the error to the output since `#attempt` will roll it back anyway. This is already utilized by the built-in `TemplateExceptionHandler`-s (`DEBUG_HANDLER` and `HTML_DEBUG_HANDLER`).

- Added convenience constructor `Template(String name, String sourceCode, Configuration cfg)`.

- `TemplateException`-s and `TemplateModelExcepton`-s now can have `Throwable` cause, not just `Exception` (it was an old oversight that somehow wasn't fixed so far).

- Parsing error messages under the JBoss Tools FreeMarker IDE now doesn't contain the usual location line, so that the actual error description is immediately visible in the Eclipse Problems view. (It's a hack in FreeMarler itself; it tries to detect if it runs under the plugin and then changes its behavior.)

- Mostly concerning tool (like IDE plugin) authors:

  - The error message formats (what `Throwable.getMessage()` returns) were heavily changed for `TemplateException`-s, and somewhat for `ParseException`-s. It's unlikely that anybody depends on these, but if you tried to parse these messages, be aware of this.

  - Fixed bug where `ParseException` has contained 0 as line and column number for lexical errors. Now it contains the correct information.

  - Added `ParseException.getEditorMessage()`: As in IDE-s the error markers show the error location to the user already, the location should not be repeated in the error message. So in IDE-s you should use this method instead of `getMessage()`. (Under JBoss Tools: FreeMarker now tries to detect that it runs under the plugin, and then it already does this, except that it still shows the column number as that's missing from the error marker location.)

  - Added `ParseException.getTemplateName()`

  - Added `Configuration.getSupportedBuiltInNames()`. As new built-ins (``expr`?`builtin_name``) are very often added to new FreeMarker versions, auto-completion or syntax highlighting should use this set instead of a fixed set of a names.

  - The format returned by `TemplateElement.getDescription()` was heavily changed. It's what FTL stack traces and maybe some outline views (tree-views) show. It was always for human reading (and till now was too inconsistent for anything else), so it's unlikely that this breaks anything.

  - There were some smaller changes in `freemarker.debug`, and it's expected that there will be more, so it was marked as experimental. As far as we know, nobody used it, so it shouldn't break anything.

- In experimental status only, but `freemarker.jar` is now an OSGi bundle (see `freemarker.jar/META-INF/MANIFEST.MF`). Depending on user feedback, the bundle description may change in the future. So please give feedback, especially if you are an OSGi expert!

- Improved the HTML generated by `HTML_DEBUG_HANDLER` (the red-on-yellow-background error message). Most importantly, now it will word-wrap. Other changes are minor, like now it can break out of CDATA sections, or now it has less intense colors.

- New `Template` method, `getActualTagSyntax()`: Tells if the template is using traditional or square-bracket syntax. As the syntax can be overridden in the template, also it's possibly decided by auto-detection, it wasn't trivial to it tell till now.

- Added some utility methods that are useful for generating error messages in custom directives: `ClassUtil.getFTLTypeDescription(TemplateModel)`, `getShortClassName`, `getShortClassNameOfObject`

- Bug fix [364]: `freemarker.template.EmptyMap` (which is passed to `TemplateDirectiveModel`-s if there are no parameters) now allows `remove(key)`, `clear()` and `putAll(anyEmptyMap)` as these do nothing anyway.

- Bug fix [375]: `NullPointerException` on IBM J9 VM (not on the Sun/Oracle implementation) in `BeansWrapper` when the Java implementation legally returns `null` for some `BeanInfo` getters.

- Bug fix: Cloning a `Configuration` didn't deep-clone the data structures storing the `auto_imports` and `auto_includes` settings, hence possibly leading to aliasing problems.

- Bug fix [377]: After a failed method call the exception handler could fail in the rare occasion when `targetObject.toString()` fails, raising a runtime exception that not even the `attempt` directive will catch.

- Bug fix [391]: If a template name has contained `*` that was not the only character in the path step, it threw `NegativeArraySizeException` instead of `FileNotFoundException`.

- With the default arithmetic engine, performance optimizations of comparison operations when some of the numbers is 0, and when the sign of the numbers differ.

- Some smaller fixes in `TemplateElement.getCanonicalForm()`, also some quality improvements there.

- Bug fixes in `classic_compatible` mode (this mode is to help migrating from FreeMarker 1), thanks to Information Mosaic:

  - When a macro was called with a `null`/missing parameter value, it has caused error like in FreeMarker 2.3

  - When a hash literal contained reference to a `null`/missing variable, like in `{ 'a': missingVar }`, it has caused an error like in 2.3

  - When a sequence literal contained reference to a `null`/missing variable, like in `[1, missingVar]`, it has caused an error like in 2.3

  - When a the left-side of the `.` (dot) or `[`key`]` operator was `null` or missing variable, like in `missingVar.subVar`, it has caused an error like in 2.3

  - When `BeanModel`-s are tried to be treated as strings, for most subclasses it has failed with type error, like in 2.3. In FreeMarker 1 all `BeanModel`-s were `TemplateScalarModel`-s, so it should succeed. The fix for this only works where FreeMarker coerces to string (string built-ins on the left-side and concatenation (`+`) and interpolation (`${`...`}`) do that), otherwise unfortunately it will still fail.

  - The `classic_compatible` setting now accepts value `2` along `true` (alias `1`) and `false` (alias `0`). `2` means `true` but with emulating bugs in early 2.x classic-compatibility mode. Currently this only affects how booleans are converted to string; with `1` it's always `"true"`/`""`, but with `2` it's `"true"/"false"` for values wrapped by `BeansWrapper` as then `Boolean.toString()` prevails. Note that ``someBoolean`?string` will always consistently format the boolean according the `boolean_format` setting, just like in FreeMarker 2.3.

- Bug fix [394]: When trying to access the optional Jython (or W3C DOM) classes has failed in `DefaultObjectWrapper` with an `Error`, rather than with an `Exception`, loading the `DefaultObjectWrapper` class itself has failed, instead of the Jython (or W3C DOM) support being disabled. From now in, it will survive any kind of `Throwable` there, and if the `Throwable` is not an `ClassNotFoundException`, it will also log the `Throwable`.

- Improved the performance of `(thisVarIsMissing.foo)!default` and similar parenthetical existence operators and existence built-ins in the case when the `null`/missing variable is not the last step inside the parenthesis. In that case it's about 30 times faster now, measured on Java 6. In other cases (when all variables exists, or the the last step is missing) the performance is about the same (relatively fast) as before.

- Added interface `freemarker.cache.CacheStorageWithGetSize` which allows querying the current number of cache entries in a `CacheStorage` that implements it. It's implemented by all out-of-the-box `CacheStorage` implementations. Also added `getStrongSize()` and `getSoftSize()` to `MRUCacheStorage`.

- Version and build information changes:

  - The form of the nightly build version numbers has changed to be Maven/JSR 277 compliant. What earlier was `2.3.19mod` is now something like `2.3.20-nightly_20130605T130506Z` (note how the last points to the target release version instead of the last release version).

  - The form of the Release Candidate and Preview version numbers where changed to be Maven/JSP 277 compliant: `2.4pre2` is now `2.4.0-pre02`, `2.4rc1` is now `2.4.0-rc01`.

  - Added new static method to `Configuration` to query build date: `getBuildDate()`. This is also printed by the main command line class.

- Various internal code cleanups.

##### Other changes

- Many JavaDoc improvements, mostly in the documentation of the basic (most frequently used) classes.

- FreeMarker source code has moved to GitHub (https://github.com/freemarker/freemarker), other project resources has remained on sourceforge.net.

- Project structure cleanup, Ivy-based build script.

#### 2.3.19

发布日期：2012-02-29

不要忘了 安全相关的修复， 它可能会影响到你的应用程序！

##### FTL部分的修改

- 注意：在 2.3.17 版引入的 ISO 8601 日期/时间格式内建函数 的输出，有轻微的调整。从现在开始，时区偏移，用于显示而且不是 `Z` 时，通常包含了分钟。比如在模板输出中， `15:30:15+02` 现在就变成 `15:30:15+02:00` 了。根据ISO 8601(那么ISO 8601 日期/时间格式的内容应该不会有问题)两种格式都是合法的， 但是最后的格式使用了 XML Schema 日期/时间格式来编译，因此做了这个修改。

- 新的内建函数，用来转义JSON字符串：`json_string`。

- Bug修复：如果在同一个模板之前没有正确的 `#` 标记， 错误的 `#` 标记被打印成静态的文本，而不会引发解析错误。 因为这个修复并不会100%的向后兼容，老版本中的行为会被保留下来， 除非你将 `incompatible_enhancements` (也就是`Configuration.setIncompatibleEnhancements(String)`) 设置成 `"2.3.19"` 或更高版本。

##### Java部分的修改

- 注意： 本次发布包含两个重要的安全修复，很明显， 这些安全问题会导致一些应用程序被利用。 FreeMarker不能在所有的配置中解决这个问题， 所以请阅读下面的细节而不仅仅是升级FreeMarker！ 理论上，这些修改并不是100%向后兼容的， 但是破坏任何东西也是不可能的。这两个修改是：

  - The character with character code 0 (`\u0000`) is not allowed in template paths anymore. When a path contains it, FreeMarker behaves as if the template was not found.

    This is to fix the security problem where a template path like `"secret.txt\u0000.ftl"` is used to bypass extension filtering in an application. FreeMarker itself doesn't care about the extension, but some applications decide based on the extension if they will delegate a path to FreeMarker. When they do with such a path, the C/C++ implementation behind the storage mechanism may sees the path as `"secret.txt"` as the 0 terminates the string in C/C++, and thus load a non-FTL file as a template, returning the file contents to the attacker.

    Note that some HTTP servers, notably Tomcat and the Apache HTTP Server blocks URL-s where the URL contains 0 (`%00`) outside the query string, thus this wasn't exploitable there through such Web URL-s. Some other HTTP servers however, like Jetty, doesn't block such URL-s.

  - `ClassTemplateLoader`, when it's created with base path `"/"` (like with `new ClassTemplateLoader(someClass, "/")`), will not allow template paths that contain colon earlier than any `/`, and will act like if the template was not found in such case.

    This is to fix the security problem where a template path like `"file:/etc/secret"` or `"http://example.com/malware.ftl"` is interpreted as a full URL by a `java.net.URLClassLoader` in the class-loader hierarchy, and thus allow loading files from these URL-s as templates. This is a quirk (or bug) of `java.net.URLClassLoader`, thus this problem only exists on systems that use such class-loaders.

    Beware, some frameworks use their own `TemplateLoader` implementations, and if those are vulnerable, they will remain so after updating FreeMarker too! Note that this exploit only works if the class-loader hierarchy contains an `URLClassLoader` and the class-loader is used to load templates without adding any prefix before the template path (other than `"/"`).

  These security issues mostly only affect applications where the user (the visitor) can supply arbitrary template paths to the application. This is not the case with properly built MVC applications, as there only the MVC Controller can be addressed directly, and it's the Controller that specifies the template paths. But legacy MVC applications based on JSP Model-2 often expose the MVC Views as public URL-s ending with `.ftl`, thus allowing the user to give arbitrary paths to FreeMarker. Such applications should be secured with a `security-constratint` in `web.xml` as shown in the related Manual section. This should be done regardless of the current security fixes.

  In general, you should not allow users to specify arbitrary template paths, or if you do allow that, you should be extra careful with the `TemplateLoader` used.

- `Configuration` has new methods: `removeTemplateFromCache(...)`. This will remove the given template for the given locale from the cache, so it will be re-loaded regardless of the template update delay when it's next time requested.

- `BeansWrapper` ignores setter methods from now when introspecting classes. They weren't used anyway, so they unnecessarily caused "`java.beans.IntrospectionException`: type mismatch between read and write methods" errors.

- `TemplateClassResolver.SAFER_RESOLVER` now disallows creating `freemarker.template.utility.JythonRuntime` and `freemarker.template.utility.Execute`. This change affects the behavior of the `new` built-in if FreeMarker was configured to use `SAFER_RESOLVER`, which is not the default until 2.4 and is hence improbable.

- Bug fixed: Calling varargs methods now indeed works. (Earlier it only worked for overloaded methods.)

- Bug fixed [1837697] [2831150] [3039096] [3165425]: Jython support now works with Jython 2.2 and 2.5.

- Bug fixed [3325103]: `TemplateException`-s and `ParseException`-s are now serializable.

#### 2.3.18

Date of release: 2011-05-21

##### Changes on the Java side

- Bugfix [3304568]: 2.3.17 didn't find TLD-s in `WEB-INF\lib\*.jar` unless they were explicitly pointed in the `web.xml` with a `taglib` element. This bug was introduced in 2.3.17.

##### Other changes

- Added `LICENSE.txt` and `NOTICE.txt` to `freemarker.jar` under `META-INF`.

#### 2.3.17

Date of release: 2011-05-17

It's possibly urgent to update to this version because of a security fix!

##### Changes on the FTL side

- `?seq_index_of` and `?seq_last_index_of` now works on collections (`freemarker.template.TemplateCollectionModel`-s) too, not only on sequences (`freemarker.template.TemplateSequenceModel`-s).

- `?long` now works for date, date-time or time values, and returns the milliseconds since the epoch (as `java.util.Date.getTime()`).

- To convert numbers (usually Java `long`-s) to date or date-time and time values, `?number_to_date`, `?number_to_time`, `?number_to_datetime` was added. See more here... (Unfortunately, `?date` and like can't be extended to support this due to backward compatibility issues.)

- New built-ins to format numbers with ISO 8601 "extended" format regardless of the current date/time formatting settings, and even regardless of the current time zone setting. For example `${myTimeStamp?iso_utc}` will print something like `2010-05-16T23:05:45Z`. See more here...

- New special variable, `now`. This returns the current date-time. Usage examples: "`Page generated: ${.now}`", "`Today is ${.now?date}`", "`The current time is ${.now?time}`".

- `?sort` and `?sort_by` now supports sorting boolean values.

- When using unsupported or unknown string built-in flags, FreeMarker will now log warnings (maximum 25 times per class-loader, to prevent flooding the log). It's certain that starting from FreeMarker 2.4 these will count as errors.

- Bug fixed [3047201]: Using regular expressions (like with `?match`) could cause lockup in multi-threaded environment, also memory leakage when using dynamically generated regular expressions.

- Bug fixed: `?seq_contains`, `?seq_index_of` and `?seq_last_index_of` has failed with non-`java.util.List` `java.util.Collection`-s that are wrapped with pure `BeansWrapper` (not the `DefaultObjectWrapper`) as `TemplateSequenceModel`. (See also: `getSupportsIndexedAccess()` below)

##### Changes on the Java side

- Security fix: Using carefully crafted template names (template paths) that contain code point 0 (`'\u0000'`), it was possible to load files from outside the template root directory like if they were FreeMarker templates. The root of the problem is that the underlying native C/C++ part (which belongs to the Java platform or to the OS) interprets the 0 as the end of the string, while Java (and hence FreeMarker and the Servlet container) doesn't. Thus a path that looked safe for FreeMarker become unsafe on the lower level. The problem is present with all ways of loading templates by name (`Configuration.getTemplate(`...`)`, `<#include `...`>`, `<#import `...`>`).

  You are not affected if you don't allow users to upload templates and also at least one of these stands:

  - In your system users can't provide arbitrary strings as template names (template paths). For example, if users are only allowed to visit the URL-s that belong to the MVC Controller (like they can't visit `*.ftl`) then they can't suggest arbitrary template names.

  - The template names are part of the path in the Web page URL, and your webserver or Servlet container disallows URL-s that contain `%00`, or terminate the URL at it before passing it to the servlets.

  - You are using `FileTemplateLoader` and linking is not allowed in it (by default it isn't allowed).

- FreeMarker now can log its messages directly using SLF4J or Apache Commons Logging. However, it will not use these logger libraries automatically, until 2.4; see more here... But it's recommended to switch to SLF4J now.

- New setting: `"auto_flush"`, `Configurable.setAutoFlush(boolean)`. Sets whether the output `Writer` is automatically flushed at the end of `Template.process(Object, Writer)` (and its overloads). The default is `true`, which corresponds to the earlier behavior. Using `false` is needed for example when a Web page is composed from several boxes (like portlets, GUI panels, etc.) that aren't inserted with `#include` (or with similar directives) into a master FreeMarker template, rather they are all processed with a separate `Template.process(`...`)` call. In a such scenario the automatic flushes would commit the HTTP response after each box, hence interfering with full-page buffering, and also possibly decreasing performance with too frequent and too early response buffer flushes.

- Added new setting: `Configuration.setNewBuiltinClassResolver(TemplateClassResolver)`, or `new_builtin_class_resolver` property. This allows you to specify how the `new` built-in (like in `"com.example.SomeClass"?new()`) resolves classes and which classes are accessible at all. If you are allowing not-so-much-trusted users to upload templates, you should be definitely interested; see the Java API docs of `freemarker.core.Configurable.setSetting` and `freemareker.template.Configuration.setNewBuiltinClassResolver`. Otherwise it's still recommended to set this to `TemplateClassResolver.SAFER_RESOLVER` (or `safer` if you are using properties), although that's not 100% backward compatible (see Java API docs) .

- Added `freemarker.cache.NullCacheStorage`: Setting this as the cache storage in `Configuration` disables caching.

- Added `getSupportsIndexedAccess()` to `freemarker.ext.beans.CollectionModel`, so one can check if `TemplateSequenceModel.get(int)` will work with a particular `CollectionModel` instance or not.

- Bug fixed [2992265]: JSP `FreeMarkerPageContext.include` behaved incorrectly.

- Bug fixed: When using FreeMarker's JSP support with JSP tags that use `javax.servlet.jsp.PageContext.pushBody` (like some Stripes tags), `"ArrayIndexOutOfBoundsException: -1"` occurred inside `freemarker.ext.jsp.FreeMarkerPageContext.popWriter`.

- Bug fixed [3033015]: `AllHttpScopesHashModel` used `WrappingTemplateModel.getDefaultObjectWrapper()` for wrapping variables in the page scope, while used the user-specified `ObjectWrapper` for all other scopes (request, session, etc.). Now it uses the user-specified wrapper in the page scope as well.

- Bug fixed [3128073]: `HashAdapther.containsKey(...)` returned `true` for a key that doesn't exist when unwrapping the key has failed. As a side effect of the fix, `BeansWrapper.CAN_NOT_UNWRAP` is now private; earlier it was public by mistake.

- Big fixed [3151085]: `freemarker.jsp.TaglibFactory` didn't locate tld files properly. This fix gives better compliance with JSP specification for resolving and loading tld files.

- Bug fixed: Unwrapping `null` with a `BeansWrapper` that had a custom null-model didn't result in `null`. Now both unwrapping `null` and the custom null-model gives `null`.

- Log messages doesn't contain line-breaks (CR or LF) anymore and quote paths and other arbitrary text with Java string literal syntax that also escapes `<` characters as `\u003C`. These address security concerns related to poor quality log appenders and buggy log readers. This change is mostly noticeable on template processing error entries, which will now quote the exception message. Note that how stack traces (the `Throwable` objects) are logged is still up to the logging framework you are using.

##### Other changes

- The DTD-s and XSD-s that are included in `freemarker.jar` under `freemarker/ext/jsp` are now under Apache Software License, Version 2. This is also clarified in the `LICENSE.txt`. Earlier these files had no clear license terms.

#### 2.3.16

Date of release: 2009-12-07

##### Changes on the Java side

- Fixed a bug that caused incorrect unwrapping of sequences to Java arrays (See bug report)

- Fixed a bug that caused rounding of float and double values (See bug report)

- Created a new `freemarker.runtime.attempt` category and exceptions caught in `<#attempt>` blocks are logged into it at a DEBUG severity.

- Fixing the (ages old) problem of `RhinoWrapper` not working with all versions of Rhino because of binary incompatible change of Rhino's `Undefined.instance`.

- Fixed bug where `TextUtil.XMLEncNQG` didn't escape `]]>` as `]]&gt;`.

- Fixed bug where the root directory couldn't be used as the template base directory, as `FileTemplateLoader` believed that the template is outside the base directory.

- Macro names can no longer be changed through the API.

- FreemarkerServlet now cooperates with Session Fixation Attack Protection in Spring Security, see forum discussion for details.

- Substantially improved performance of the `<#return>` directive.

##### Changes on the FTL side

- Fixed bug where ``anXMLNode`.@@markup` and `@@nested_markup` didn't escape `]]>` as `]]&gt;`.

#### 2.3.15

Date of release: 2008-12-16

##### Changes on the FTL side

- Bug fixed: Hash concatenation (like `hash1 + hash2`) shuffled the order of keys/values even if both hashes were ordered.

- In web pages that are based on the `FreemarkerServlet`, you can now use `<@include_page path="..."/>` to use servlet includes. See more here...

##### Changes on the Java side

- The `BeansWrapper` can automatically detect that classes were reloaded by JavaRebel.

- Fixed a bug that caused `null` to be returned from `Environment.getCurrentEnvironment()` while processing autoincludes and autoimports. (See bug report)

- Fixed a bug that caused `getObject(Object)` method on POJOs to not be recognized as a general get method.

- Substantially improved performance of the `<#break>` directive.

- `DeepUnwrap` now unwraps custom null model of the current object wrapper into a Java `null`.

#### 2.3.14

Date of release: 2008-09-01

##### Changes on the FTL side

- New built-in: `xhtml`. See more here...

- New special variable: `template_name`. See more here...

- Now you can use the values of parameters as the defaults of other parameters, for example `<#macro section title label=title>`. In earlier versions it worked unreliably. There are no restriction regarding the order of parameters, like `<#macro section label=title title>` works too.

- Added a new number format specifier, `computer`. This uses the same formatting as ``exp`?c`.

##### Changes on the Java side

- The constructor to `freemarker.ext.servlet.AllHttpScopesHashModel` is now public, allowing it to be reused in 3rd party web frameworks.

- Bugfix: `freemarker.ext.beans.SimpleMapModel` (unlike either `freemarker.ext.beans.MapModel` or `freemarker.template.SimpleHash`) didn't allow lookup by `java.lang.Character` key when passed a single-character string as a key.

- Bugfix: permissive unwrapping in `freemarker.template.utility.DeepUnwrap` class was not recursively permissive with elements of sequences and hashes.

- Bugfix: `freemarker.ext.beans.MapModel` returns `BeansWrapper.wrap(null)` instead of `null` for `null` values explicitly bound into the map.

- Bugfix: Fixed a subtle bug with property getters of classes implementing a type-parametrized interface.

- Bug fixed: A further corner case of [1939742].

#### 2.3.13

Date of release: 2008-05-05

##### Changes on the FTL side

- New built-ins for rounding numbers: `round`, `floor`, `ceiling`. See more here...

##### Changes on the Java side

- [1898300], [1818742], [1780882]: Reworked template caching mechanism for radically improved concurrent performance, with help from Azul Systems engineers. (Achieved 20x speedup with Struts2 webapps on a 128-CPU Azul device compared to 2.3.12.) Also, template loading (including parsing) errors are now cached, improving performance in applications that often try to get missing templates.

- [1892546] Allow for custom `TemplateLoader` in `FreemarkerServlet`.

- Bug fixed: [1725107] Using the FreeMarker JSP taglib support with Servlet 2.4 may generates XML validation warnings.

- Bug fixed: [1939742] `ConcurrentModificationException` on accessing nonexistent `SimpleHash` entries in a loop

- Bug fixed: [1902012] `IteratorModel` eats exception causes

- Bug fixed: `<#assign x></#assign>` (empty nested content) has caused `NullPointerException`

- Bug fixed: [1926150] `CachedTemplate` should be serializable

#### 2.3.12

Date of release: 2008-02-03

##### Changes on the Java side

- Bug fixed: [1857161] JSP `SimpleTag` support was broken in 2.3.11.

- In the templates, now you can conveniently call Java methods that use the Java 5 varargs feature (variable-length argument lists). Also the overloaded-method chooser logic now considers vararg methods more intelligently.

- Enum constants are now identified by their `name()` instead of by their `toString()` (because the latter can be overridden in subclasses). This doesn't affect the way enum constants are printed; of course that still uses `toString()`.

- Messages in parser exceptions now display the name of the template.

#### 2.3.11

Date of release: 2007-12-04

This release contains several performance and usability improvements.

##### Changes on the FTL side

- Bug fixed: [1687248] Warning! This bugfix may breaks some templates! Fixed the bugs of the `c` built-in (`?c`) that sometimes caused whole numbers to be formatted with ``.0'' at the end (like: 1.0), and caused numbers sometimes formatted to exponential form (like 4E-20). From now whole numbers will never use decimal dot (not even if the wrapped number is a `double`; remember, the template language knows only a single numerical type), and exponential form will never be used either. Also, the maximum number of digits after the decimal dot was limited to 16, so numbers smaller than 1E-16 will be shown as 0.

##### Changes on the Java side

- FreeMarker now has much better JSP 2.0 and JSP 2.1 compliance. Most notably, the JSP 2.0 `SimpleTag` interface is now supported. Additionally, even when run in an environment that doesn't have its own JSP implementation, the FreeMarker JSP runtime will make available its own implementation of `JspFactory` and `JspEngineInfo` to tags when JSP 2.0 API JAR is available in classpath, as well as an implementation of `JspApplicationContext` when JSP 2.1 API JAR is available in classpath.

- A new model interface, `TemplateDirectiveModel` provides an easier paradigm for implementing user-defined directives than `TemplateTransformModel` did previously. `TemplateTransformModel` will be deprecated.

- FreeMarker now finds the Xalan-based XPath support included in Sun JRE/JDK 5 and 6, so no separate Xalan jar is required for the XPath support to work. (However, we recommend Jaxen over Xalan, as the FreeMarker XPath support is more complete with that. Of course for that the Jaxen jar is still needed.)

- Wrapping performance of `BeansWrapper` has been significantly improved by eliminating repetitive execution of various class tests.

  Note for `BeansWrapper` customizers: subclasses of `BeansWrapper` that previously overrode `getInstance(Object, ModelFactory)` method should now instead override `getModelFactory(Class)` to take advantage of this improvement. Overriding the old method still works, but it will not take advantage of the performance improvement.

- Memory footprint of a wrapper created by `BeansWrapper` has been reduced (by a size of one default-sized `HashMap`) until methods or indexed properties are accessed on it (simple properties can be accessed without increasing memory footprint).

- Rhino objects can be used in templates as scalars, numbers, and booleans, following the JavaScript conversion semantics for these types.

- `.data_model` is now a `TemplatHashModelEx` when possible. This means that the list of the data-model variable names usually can be get with `.data_model?keys`.

- `FileTemplateLoader` can now optionally allow following symlinks that point out of the base directory. It is disabled by default for backward compatibility.

- Bug fixed: [1670887] `TaglibFactory` taglib matching did not follow JSP 1.2 FCS.

- Bug fixed: [1754320] Bug in `setXPathSupportClass` prevented plugging in a user-supplied `XPathSupport` implementation.

- Bug fixed: [1803298] Parser error while parsing macro with loop variables

- Bug fixed: [1824122] Loading templates from JAR files could lead to leaking of file handles (due to a bug in the Java API implementation of Sun).

- Bug fixed: Cached template is now removed from the cache if the re-loading of the modified template file fails, so no staled template is served.

##### Documentation changes

- Substantial reworkings in the Template Authors's Guide (which was previously called Designer's Guide), especially in the Getting Started section.

- `#{...}` is documented as deprected construct from now.

- The "transform" term is now removed from the documentation. Instead the more general "user-defined directive" term is used, which encompasses macros, `TemplateTransformModel`-s and the new `TemplateDirectiveModel`-s, which are just different ways of implementing user-defined directives.

- Some more minor improvements in the Manual.

#### 2.3.10

Date of release: 2007-04-20

This release contains several important bugfixes.

##### Changes on the Java side

- [1589245] `MultiTemplateLoader` clears its internal cached data (used for optimizing subsequent lookups of the same template) when `Configuration.clearTemplateCache()` is invoked.

- [1619257] A bug that caused an exception when `strict_bean_model` was used in a FreeMarker configuration `Properties` object or in the `<#setting .../>` directive has been fixed.

- [1685176] A bug that caused `StackOverflowError` in certain interactions of garbage collector with MRU cache under Sun's Java 6 JVM has been fixed.

- [1686955] When `ResourceBundleModel` constructs `MessageFormat` objects, it passes them its own locale. More info...

- [1691432] A bug that caused `BeansWrapper.EXPOSE_SAFE` to be no safer than `BeansWrapper.EXPOSE_ALL` has been fixed.

##### Changes on the FTL side

- [1628550] You can now use `dateExp?string.full` for formatting dates using Java built-in format `java.util.Date.FULL` More info...

#### 2.3.9

Date of release: 2007-01-23

This release contains support for accessing JDK 1.5 enums and public fields of classes from the templates through the BeansWrapper.

##### Changes on the Java side

- `BeansWrapper` can now expose public fields of objects to the template if you call the `setExposeFields(true)` on it. More info...

- `BeansWrapper` can now pass any sequence model to Java methods expecting a `java.util.Collection` or a native Java array (including primitive arrays). More info...

- `BeansWrapper` can now pass any sequence and collection model to Java methods expecting a `java.lang.Iterable`. More info...

- `BeansWrapper` can now unwrap numeric models into correct target types when passing to Java methods expecting a primitive or boxed number. Use of various expert built-ins to manually coerce the types becomes mostly unnecessary.

- Fixed a bug where `BeansWrapper` would pass a `java.util.Collection` to a method expecting a `java.util.Set` in certain rare cases. More info...

- Support for JDK 1.5 enums in `BeansWrapper` and `DefaultObjectWrapper`. By calling the `getEnumModels()` method, you can retrieve a hash model that is keyed by class names and allows access to enumerated values. I.e. if you bind this hash model under name `enums` in the data-model, you can write expressions like `enums["java.math.RoundingMode"].UP` in the template. The enum values can be used as scalars and support equality and inequality comparisons. More info...

- `freemarker.ext.rhino.RhinoWrapper` now correctly translates Rhino `Undefined` instance, `UniqueTag.NOT_FOUND`, and `UniqueTag.NULL` to FreeMarker undefined value.

#### 2.3.8

Date of release: 2006-07-09

This release substantially improves the JSP 2.0 compatibility. (For those who have seen the same points in 2.3.7: Sorry, the version history was incorrect... those JSP 2.0 related changes were not in the release yet.)

##### Changes on the Java side

- JSP support improvement: [1326058] Added support for `DynamicAttributes` (new in JSP 2.0)

- JSP support improvement: Added support for `pushBody()`/`popBody()` in `FreemarkerPageContext`

- JSP support improvement: Added support for `getVariableResolver()` (new in JSP 2.0).

- JSP support improvement: Added support for `include(String, boolean)` (new in JSP 2.0).

- JSP support improvement: Added support for `getExpressionEvaluator()` (new in JSP 2.0). However, it will need Apache commons-el in the class path, or else this method will not work (it's optional). Note that EL support is not needed in principle, since FreeMarker has it's own expression language. But some custom JSP 2 tags may still want to use this method, after all it's in the JSP 2 API.

#### 2.3.7

Date of release: 2006-06-23

This release, compared to 2.3.7 RC1, contains new operators for handling null/missing variables, , the `substring` built-in, and some more bugfixes. Note that 2.3.7 RC1 has a long change log, so you may want to read that too.

##### Changes on the Java side

- The `seq_contains` built-in now handles `TemplateCollectionModel`-s as well.

- Bug fixed: In 2.3.7 RC1 `FreemarkerServlet` has always died with `NullPointerException` during initialization.

##### Changes on the FTL side

- 3 new operators were added for terser missing variable handling. These operators make the `default`, `exists` and `if_exists` built-ins deprecated. (The parser doesn't issue any warning messages when you use deprecated built-ins, and they are still working.):

  - ``exp1`!`exp2`` is near equivalent with ``exp1`?default(`exp2`)`, also `(`exp1`)!`exp2`` is near equivalent with `(`exp1`)?default(`exp2`)`. The only difference is that this new operator doesn't evaluate the ``exp2`` when the default value is not needed.

  - ``exp1`!` is similar to ``exp1`?if_exists`, also `(`exp1`)!` is similar to `(`exp1`)?if_exists`. The difference is that with this new operator the default value is an empty string and an empty list and empty hash at the same time (multi-type variable), while with `if_exists` the default value was an empty string and an empty list and empty hash and boolean `false` and a transform that does nothing and ignores all parameters at the same time.

  - ``exp1`??` is equivalent with ``exp1`?exists`, also `(`exp1`)??` is equivalent with with `(`exp1`)?exists`.

- New built-in: ``exp`?substring(`from`, `toExclusive`)`, also callable as ``exp`?substring(`from`)`. Getting substrings was possible for a long time like ``myString`[`from`..`toInclusive`]` and ``myString`[`from`..]`, but ``myString`?substring(`from`, `toExclusive`)` and ``myString`?substring(`from`)` has the advantage that it has an exclusive end, which is more practical. (Edit: Since 2.3.21 ranges are the preferred way again, as it has ``myString`[`from`..<`toExclusive`]`.) Sequence (list) slices still has to be get with the old syntax, since `substring` only applies to strings. Please note that the ``to'' parameter is 1 greater with this new builtin, as it is an exclusive index. Further difference is that the `substring` built-in requires that the ``from'' index is less than or equal to the ``to'' index. So 0 length substrings are possible now, but not reversed substrings.

- Bug fixed: [1487694] malfunction when the `recover` directive has no nested content

#### 2.3.7 RC1

Date of release: 2006-04-27

This release contains many bugfixes and some `FreemarkerServlet` related improvements. It's a Release Candidate, which means that it shouldn't be used in production environment yet. We recommend this release for development, however. Please test it.

##### Changes on the Java side

- `FreemarkerServlet` improvement: `AllHttpScopesHashModel` is now public, so you can add unlisted variables to the data-model.

- `FreemarkerServlet` improvement: When it throws a `ServletException`, the J2SE 1.4 cause exception is now set under J2SE 1.4.

- Bug fixed: [1469275] `NullPointerException` when using `BeansWrapper` with reloaded classes

- Bug fixed: [1449467] `HttpSessionHashModel` is not `Serializable`

- Bug fixed: [1435113] Error in `BeanWrapper` with indexed properties

- Bug fixed: [1411705] Acquisition bug in `TemplateCache`

- Bug fixed: [1459699] Tag syntax can't set with `Configuration.setSetting(String, String)`

- Bug fixed: [1473403] `ReturnInstruction.Return` should be public

##### Changes on the FTL side

- Bug fixed: [1463664]kup `[/#noparse]` is printed out

#### 2.3.6

Date of release: 2006-03-15

Quick release that fixes a serious bug of 2.3.5, days after its release. So for the recently added new features please see the section of 2.3.5.

##### Changes on the Java side

- Bug fixed: In FreeMarker 2.3.5 only, when you read a bean property for the second time, FreeMarker will say that it's missing (null).

#### 2.3.5

Date of release: 2006-03-11

This release was withdrawn because of a serious bug in it. Please don't use it! Of course, all new features of it are included in FreeMarker 2.3.6.

A few new features and several bugfixes.

##### Changes on the FTL side

- Bug fixed: [1435847] Alternative syntax doesn't work for comments

- Bug fixed: With the new square bracket syntax, the tag could be closed with `>`. Now it can be closed with `]` only.

- Bug fixed: [1324020] `ParseException` with the `ftl` directive if it wasn't in its own line

- Bug fixed: [1404033] `eval` built-in fails with hash concatenation

##### Changes on the Java side

- A new `Configuration` level setting, `tagSyntax` was added. This determines the syntax of the templates (angle bracket syntax VS square bracket syntax) that has no `ftl` directive in it. So now you can choose to use the new square bracket syntax by default. However, the recommended is to use auto-detection (`yourConfig.setTagSyntax(Configuration.AUTO_DETECT_TAG_SYNTAX)`), because that will be the default starting from 2.4. Auto-detection chooses syntax based on the syntax of the first FreeMarker tag of the template (could be any FreeMarker tag, not just `ftl`). Note that as with the previous version, if a the template uses `ftl` directive, then the syntax of the `ftl` directive determines the syntax of the template, and the `tagSyntax` setting is ignored.

- Now `BeansWrapper`, `DefaultObjectWrapper` and `SimpleObjectWrapper` support lookup with 1 character long strings in `Map`-s (like `myHash["a"]`) that use `Character` keys. Simply, as a special case, when a hash lookup fails on a string that is 1 character long, it checks for the `Character` key in the underlying map. (Bug tracker entry [1299045] FreeMarker doesn't support map lookup with Character keys.)

- A new property, `strict` was added to `BeansWrapper`, `DefaultObjectWrapper` and `SimpleObjectWrapper`. If this property is `true` then an attempt to read a bean propertly in the template (like `myBean.aProperty`) that doesn't exist in the bean class (as opposed to just holding `null` value) will cause `InvalidPropertyException`, which can't be suppressed in the template (not even with `myBean.noSuchProperty?default('something')`). This way `?default('something')` and `?exists` and similar built-ins can be used to handle existing properties whose value is `null`, without the risk of hiding typos in the property names. Typos will always cause error. But mind you, it goes against the basic approach of FreeMarker, so use this feature only if you really know what are you doing.

- Bug fixed: [1426227] `NullPointerException` in `printStackTrace(...)`

- Bug fixed: [1386193] Division by zero in `ArithmeticEngine`

#### 2.3.4

Date of release: 2005-10-10

Some new features and bugfixes.

##### Changes on the FTL side

- Now you can use `[` and `]` instead of `<` and `>` for the FreeMarker tags. For example you can write `[#if loggedIn]`...`[/#if]` and `[@myMacro /]`. More info...

- Bugfix: the `has_content` built-in returned `false` for number, date and boolean values (if the value was not a multi-type value that is also a sequence or collection or hash or string). Now it always returns `true` for a number, date or boolean values (except if the value is also a sequence or collection or hash or string, because then it will be examined only like that).

##### Changes on the Java side

- Bugfix: the parameterless constructor of the `ClassTemplateLoader` didn't worked.

- Bugfix: The Jython wrapper didn't wrapped `java.util.Date` objects well. Now it wraps them with `BeanWrapper` to `TemplateDateModel`.

- Bugfix: the `include` directive was blamed when the included file had syntax error.

##### Other changes

- Minor Manual fixes.

#### 2.3.3

Date of release: 2005-06-23

Some new features and lot of bugfixes.

Attention:

- If you are using the Log4J logging, from now at least Log4J 1.2 is required. This is because of incompatible changes in the Log4J API.

- If you build FreeMarker yourself: from now at least JavaCC 3.2 (instead of JavaCC 2.1) and at least Ant 1.6.1 (instead of Ant 1.5.x) is required. This doesn't affect users who use the `freemarker.jar` comes with the distribution.

##### Changes on the FTL side

- New built-in for formatting numbers for ``computer audience'' as opposed to human audience: `c`. It should be used for numbers that must use Java language formatting regardless of the number format and locale settings, like for a database record ID used as the part of an URL or as invisible field value in a HTML form, or for printing CSS/JavaScript numerical literals.

- New built-in for the columnar/tabular displaying of sequences: `chunk`.

- The sequence slice and substring operators now allow the omitting of the last index, in which case it defaults to the index of the last sequence item or character. Example: `products[2..]`. (Also, numerical range literals now allow the omitting of the final number, in which case it defaults to infinity. Example: `5..`.)

- Bugfix: `?replace` has worked forever if the string to replace was `""`.

##### Changes on the Java side

- New template loader: `freemarker.cache.StringTemplateLoader`. It uses a `Map` with `Strings` as its source of templates. See more in the JavaDoc.

- Experimental Rhino support: FreeMarker now comes with an experimental object wrapper for Rhino (Java ECMAScript implementation): `freemarker.ext.rhino.RhinoWrapper`

- Some new utility methods for `Simple`Xxx`` classes: `SimpleHash.toMap()`, `SimpleSequence.toList()`.

- Bugfix: FTL literals and any other `SimpleSequnce`-s, and `SimpleHash`-es now can be used as parameters to the FreeMarker-unaware Java methods that are exposed by `DefaultWrapper` or `BeansWrapper`. That is, the method parameters are automatically converted from `Template`Type`Model`-s to `java.util.Map` and `java.util.List` respectively.

- Bugfix: The JSP support now works in JSP 2 compliant containers as well. No, it doesn't support the new features of JSP 2 yet, it's just that the JSP 1.2 taglib support has not worked in JSP 2 containers.

- Bugfix: The `Configuration.setOutputEncoding` and `setURLEscapingCharset` methods died with `NullPointerException` when you tried to set the setting value to `null`, which is legal for these settings.

- Bugfix: `freemarker.template.utility.StringUtil.replace(...)` has worked forever if the string to replace was `""`.

- Bugfix: The Log4J logging was updated to be compatible with the upcoming Log4J 1.3. Note that now FreeMarker will need at least Log4J 1.2.

- Bugfix: FreeMarker didn't built from the source code on J2SE 1.5, because of the introduction of the `enum` keyword.

- Bugfix: The return value of `SimpleSequence.synchronizedWrapper()` was not properly synchronized. Same with `SimpleHash.synchronizedWrapper()`.

- Bugfix: Problem with `BeansWrapper` and overridden bean methods/properties. (Details: bug-tracker entry #1217661 and #1166533)

- Bugfix: Can't access JSP taglibs if `Request` attribute is defined in the data-model (Details: bug-tracker entry #1202918).

- Bugfix: Various minor parser glitches were fixed.

##### Other changes

- Manual improvements, especially in the FAQ.

#### 2.3.2

Date of release: 2005-01-22

Bugfix release.

##### Changes on the Java side

- Bugfix: If you use JSP taglibs in FreeMarker templates, FreeMarker possibly tried to get DTD-s from the Sun Web site because of a bug introduced with FreeMarker 2.3.1. This was a serious problem since if your server is offline or the Sun Web site becomes temporarily inaccessible the templates that are using JSP taglibs will possibly die with error.

- Bugfix: The `DefaultObjectWrapper` has ignored the value of the `nullModel` property. (Note that it's discouraged to use a ``null model''.)

#### 2.3.1

Date of release: 2005-01-04

Maintenance (with some important new features) and bugfix release.

##### Possible backward compatibility issue

There is a bugfix that may affect the behavior of you Web application if you use JSP tags in FreeMarker templates: FreeMarker's implementation of `javax.servlet.jsp.PageContext.getSession()` was incorrect. The `getSession()` method is a convenience method by which the custom tag can get the current `HttpSession` object (possibly `null` if there is no session). Till now, if the session didn't existed then it has created it automatically, so it never returned `null`. This was a bug, so starting from 2.3.1 it never creates the session, just returns `null` if it doesn't exist. The old incorrect behavior could cause page rendering to fail if the method is called after the page is partially flushed. But beware, the old behavior has possibly hidden some bugs of the Web application, where it forgot to create the session, so with the new correct behavior you may face malfunction caused by previously cloaked bugs of the Web application. (It's the task of the MVC Controller to create the session, except if the JSP tag that needs a session is written so it creates it automatically, but then it doesn't expects that `getSession()` will do it.)

##### Changes on the FTL side

- New built-in: `url`. This built-in can be used for URL escaping. Note, however, that to use this built-in conveniently, the software that encapsulates FreeMarker has to be 2.3.1 aware (programmers will find more info bellow...).

- New special variables: `output_encoding` and `url_escaping_charset`. Note, however, that to use these, the software that encapsulates FreeMarker has to be 2.3.1 aware (programmers will find more info bellow...).

- New built-ins for sequences: `seq_contains`, `seq_index_of`, `seq_last_index_of`.

- New built-ins for strings: `left_pad`, `right_pad` and `contains`.

- New directive: `attempt`/`recover`

- The `js_string` built-in now escapes `>` as `\>` (to avoid `</script>`).

- The `sort` and `sort_by` built-ins now can sort by date values. Also, `sort_by` built-in now can sort by the subvarible of a subvariable of a subvariable... etc. for any level depth. (Details...)

- `freemarker.template.TemplateExceptionHandler.HTML_DEBUG_HANDLER` now prints more HTML-context-proof messages.

##### Changes on the Java side

- New setting: `output_encoding`. This setting is used for informing FreeMarker about the charset that the enclosing software (as a Web application framework) uses for the output of FreeMarker. It's undefined by default, and although it is not strictly required to set it, the enclosing software should do so. This setting must be set if templates want to use the new `output_encoding` special variable, and possibly if they want to use the new `url` built-in. Note that the FreeMarker API allows you to set settings for each template execution individually (look at `Template.createProcessingEnvironment(...)`).

- New setting: `url_escaping_charset`. This is the charset used for calculating the escaped parts (`%`XX``) when you do URL escaping with the new `url` built-in. If it is not set, then the `url` built-in uses the value of the `output_encoding` setting, and if that's not set either, then the parameterless version of `url` built-in (`${foo?url}`) can't be used.

- Using the singleton (static) `Configuration` instance is clearly a bad practice, so related methods are now deprecated, and the Manual was adjusted, and the `FreemarkerXmlTask` was updated as well.

- The `freemarker.template.utility.Constants` class was added that contains various static final fields that store frequently used constant `TemplateModel` values, as `EMPTY_SEQUENCE`, `ZERO`, ...etc.

- When using `SecurityManager` with FreeMarker, accessing system properties may caused AccessControlException. Now such exceptions are catched and logged with warning level, and the default value of the property is returned.

- The needles `InvocationTargetException` is now removed from the exception cause trace in certain cases.

- Added a dirty hack that prints `ServletException` root cause in `TemplateException`'s stack trace if that's the direct cause exception of the `TemplateException`, despite the poorly written `ServletException` class.

- Bugfix: FreeMarker's implementation of `javax.servlet.jsp.PageContext.getSession()` was incorrect. The `getSession()` method is a convenience method by which the custom tag can get the current `HttpSession` object (possibly `null` if there is no session). Till now, if the session didn't existed then it has created it automatically, so it never returned `null`. This was a bug, so starting from 2.3.1 it never creates the session, just returns `null` if it doesn't exist. The old incorrect behavior could cause page rendering to fail if the method is called after the page is partially flushed. But beware, the old behavior has possibly hidden some bugs of the Web application, where it forgot to create the session, so with the new correct behavior you may face malfunction caused by previously cloaked bugs of the Web application. (It's the task of the MVC Controller to create the session, except if the JSP tag that needs a session is written so it creates it automatically, but then it doesn't expects that `getSession()` will do it.)

- Bugfix: The `BeansWrapper` didn't always handled properly the case of a Java class having both a public static field and a public static method with the same name.

- Bugfix: `SimpleMethodModel` had incorrectly propagate exceptions sometimes, causing null pointer exception.

- Bugfix: The template execution may used outdated cached values when you have processed the same `Environment` for multiple times, and changed settings between the two processings. Note that this could happen only in single-thread environment, where such setting modifications are allowed.

- Bugfix: Some of the string built-ins has died with `IndexOutOfBounds` exception if the template author has forgotten to specify required parameters. Now they die with more helpful error messages.

- Bugfix: `freemarker.ext.dom.NodeModel.equals(...)` has died with null pointer exception if its argument was `null`.

- Bugfix: The cause exception of `TemplateException`-s was sometimes printed twice in stack traces with J2SE 1.4 or later.

- Bugfix: The `StringUtil.FTLStringLiteralEnc(String)` method was finished.

##### Other changes

- Fixes and improvements in the Manual and in the API JavaDoc.

##### The history of the releases before the final version

###### Differences between the preview release and final release

- Added a dirty hack that prints `ServletException` root cause in `TemplateException`'s stack trace if that's the direct cause exception of the `TemplateException`, despite the poorly written `ServletException` class.

- Bugfix: `freemarker.ext.dom.NodeModel.equals(...)` has died with null pointer exception if its argument was `null`.

- Bugfix: The cause exception of `TemplateException`-s was sometimes printed twice in stack traces with J2SE 1.4 or later.

- More minor improvements in the Manual.

#### 2.3

Date of release: 2004-June-15

FreeMarker 2.3 introduces numerous little new features and quality improvements compared to the 2.2.x series. The most notable improvements are the ability to define functions (methods) in templates, the ability to interpolate variables in string literals, the support for a variable number of macro parameters, and the more intelligent default object wrapper. Although none of the improvements is a drastic change, the 2.3.x series is not backward compatible with the 2.2.x series (see the list below), so you may choose to use it for new projects only.

Probably the most ``loudly promoted'' new feature is the totally redesigned XML wrapper. With the new XML wrapper FreeMarker targets a new application domain, which is similar to the application domain of XSLT: transforming complex XML to whatever textual output. Although this subproject is young, it is definitely usable in practice. See the XML Processing Guide for more details.

##### Non backward-compatible changes!

- Since interpolations (`${...}` and `#{...}`) now work inside string literals, the character sequence `${` and `#{` in string literals are reserved for that. So if you have something like `<#set x = "${foo}">`, then you have to replace it with `<#set x = r"${foo}">` -- beware, escapes such as `\n` will not work in raw (`r`) strings.

- The default (initial) value of the `strict_syntax` setting has been changed from `false` to `true`. When `strict_syntax` is `true`, tags with old syntax as `<include "foo.ftl">` will be considered as static text (so they go to the output as-is, like HTML tags do), and not as FTL tags. Such tags have to be rewritten to `<#include "foo.ftl">`, since only parts that starts with `<#`, `</#`, `<@`, or `</@` count as FTL tags. Or, to recover the old transitional behavior, where both legacy and new tag syntax was recognized, you have to explicitly set `strict_syntax` to `false`: `cfg.setStrictSyntaxMode(false)`. Also, for individual templates you can force the old behavior by starting the template with `<#ftl strict_syntax=false>`. (For more information about why strict syntax is better than old syntax read this...)

- Several classes were moved from the `freemarker.template` package, to the new `freemarker.core` package:

  - "Normal" classes: `ArithmeticEngine`, `Configurable`, `Environment`

  - Exceptions: `InvalidReferenceException`, `NonBooleanException`, `NonNumericalException`, `NonStringException`, `ParseException`, `StopException`

  - Errors: `TokenMgrError`

  The main reason of the splitting of `freemarker.template` package was that the amount of "expert" public classes and interfaces grows too much, as we introduce API-s for third-party tools, such as debugging API.

- `freemarker.template.TemplateMethodModel.exec` now returns `Object` instead of `TemplateModel`.

- White-space stripping is now more aggressive as before: it always removes leading and trailing white-space if the line only contains FTL tags. (Earlier the white-space was not removed if the tag was `<#include `...`>` or user-defined directive tag with empty directive syntax as `<@myMacro/>` (or its equivalents: `<@myMacro></@myMacro>` and `<@myMacro></@>`). Now white-space is removed in these cases as well.) Also, white-space sandwiched between two non-outputting elements, such as macro definitions, assignments, imports, or property settings, is now ignored. More information: dgui_misc_whitespace_stripping

- The `function` directive is now used for defining methods. You should replace `function` with `macro` in your old templates. Note, however, that old `function`-s will still work if you don't use the `return` directive in them, and you invoke them with the deprecated the `call` directive.

- The expressions `as`, `in`, and `using` are now keywords in the template language and cannot be used as top-level variable names without square-bracket syntax. If, by some chance, you have top-level variables that use one of these names, you will have to rename them, or use the square-bracket syntax with the `.vars` special variable: `.vars["in"]`.

- The `?new` built-in, as it was implemented, was a security hole. Now, it only allows you to instantiate a java object that implements the `freemarker.template.TemplateModel` interface. If you want the functionality of the `?new` built-in as it existed in prior versions, make available an instance of the `freemarker.template.utility.ObjectConstructor` class to your template. (For example: `myDataModel.put("objConstructor", new ObjectConstructor());`, and then in the template you can do this: `<#assign aList = objConstructor("java.util.ArrayList", 100)>`)

- Changes to the `FreemarkerServlet`:

  - The `FreemarkerServlet` uses `ObjectWrapper.DEFAULT_WRAPPER` by default instead of `ObjectWrapper.BEANS_WRAPPER`. What this means is that, by default, objects of type `java.lang.String`, `java.lang.Number`, `java.util.List`, and `java.util.Map` will be wrapped as `TemplateModels` via the classes `SimpleScalar`, `SimpleNumber`, `SimpleSequence`, and `SimpleHash` respectively. Thus, the java methods on those objects will not be available. The default wrapper implementation in FreeMarker 2.3 automatically knows how to wrap Jython objects, and also wraps `org.w3c.dom.Node` objects into instances of `freemarker.ext.dom.NodeModel`.

  - The `FreemarkerServlet` base implementation no longer deduces the locale used for templates with `HttpRequest.getLocale()`. Rather, it simply delegates to the new protected method, `deduceLocale`. The default implementation of this method simply returns the value of configuration the `locale` setting.

##### Changes on the FTL side

- Interpolation in string literals. For convenience, interpolations are now supported in string literals. For example: `<@message "Hello ${user}!" />` is the same as `<@message "Hello " + user + "!" />`

- Raw string literals: In string literals prefixed with `r`, interpolations and escape sequences will not be interpreted as special tokens. For example: `r"\n${x}"` will be simply interpreted as the character sequence `'\'`, `'n'`, `'$'`, `'{'`, `'x'`, `'}'`, and not as line-feed and the value of the `x` variable.

- Method variables can be defined in FTL, with the `function` directive.

- Support for a variable number of macro parameters. If the last parameter in a macro declaration ends with `...`, all extra parameters passed to the macro will be available via that parameter. For macros called with positional parameters, the parameter will be a sequence. For named parameters, the parameter will be a hash. Note that it all works with the new `function` directive as well.

- A new header parameter, `strip_text`, that removes all top-level text from a template. This is useful for ``include files'' to suppress newlines that separate the macro definitions. See `ftl` directive

- New special variable: `.vars`. This is useful to read top-level variables with square bracket syntax, for example `.vars["name-with-hyphens"]` and `.vars[dynamicName]`.

- `macro` and assignment directives now accept arbitrary destination variable name with quoted syntax. For example: `<#macro "name-with-hyphens">`...`` or `<#assign "foo bar" = 123>`.

- The `?keys` and `?values` hash built-ins now return sequences. In practical terms this means you can access their sizes or retrieve their sub variables by index, and use all of the sequence built-ins. (Note for the programmers: The `TemplateHashModelEx` interface has not been changed. Your old code will work. See the API documentation to see why.)

- Existence built-ins (`?default`, `?exists`, etc.) are now working with sequence sub variables as well. Read the documentation of the `default` built-in for more information.

- White-space stripping is now more aggressive as before: it always removes leading and trailing white-space if the line only contains FTL tags. (Earlier the white-space was not removed if the tag was `<#include `...`>` or user-defined directive tag with empty directive syntax as `<@myMacro/>` (or its equivalents: `<@myMacro></@myMacro>` and `<@myMacro></@>`). Now white-space is removed in these cases as well.) Also, top-level white-space that separates macro definitions and/or assignments is now ignored. More information: dgui_misc_whitespace_stripping

- White-space stripping can be disabled for a single line with the `nt` directive (for No Trim).

- Hashes can be concatenated using the `+` operator. The keys in the hash on the right-hand side take precedence.

- New built-ins for Java and JavaScript string escaping: j_string and js_string

- The `replace` and `split` built-ins now support case-insensitive comparsion and regular expressions (J2SE 1.4+ only), and some other new options. More information can be found here.

- New built-in for regular expression matching (J2SE 1.4+ only): `matches`

- New built-in, `eval`, to evaluate a string as FTL expression. For example `"1+2"?eval` returns the number 3.

- New built-ins for Java and JavaScript string escaping: j_string and js_string

- New special variables to read the value of the locale setting: `locale`, `lang`. See more in the reference...

- New special variable to read the FreeMarker version number: `version`. See more in the reference...

- Tree new directives, `recurse`, `visit` and `fallback`, were introduced to support declarative node-tree processing. These are meant to be used typically (though not exclusively) for processing XML input. Together with this, a new variable type has been introduced, the node type. See the chapter on declarative XML processing for more details.

- The `?new` built-in, as it was implemented, was a security hole. Now, it only allows you to instantiate a java object that implements the `freemarker.template.TemplateModel` interface. If you want the functionality of the `?new` built-in as it existed in prior versions, make available an instance of the `freemarker.template.utility.ObjectConstructor` class to your template. (For example: `myDataModel.put("objConstructor", new ObjectConstructor());`, and then in the template you can do this: `<#assign aList = objConstructor("java.util.ArrayList", 100)>`)

- Variable names can contain `@` anywhere (without using quote-bracket syntax). For example: `<#assign x@@@ = 123>` is valid.

- The expressions `as`, `in`, and `using` are now keywords in the template language and cannot be used as top-level variable names without square-bracket syntax (as `.vars["in"]`).

- New parameter to the `ftl` directive: `attributes`. The value of this attribute is a hash that associates arbitrary attributes (name-value pairs) to the template. The values of the attributes can be of any type (string, number, sequence... etc.). FreeMarker doesn't try to understand the meaning of the attributes. It's up to the application that encapsulates FreeMarker (as a Web application framework). Thus, the set of allowed attributes and their semantic is application (Web application framework) dependent.

- Other minor quality improvements...

##### Changes on the Java side

- Smarter default object wrapping: The default object wrapper is now `freemarker.template.DefaultObjectWrapper`, which falls back on wrapping arbitrary objects as beans using the `freemarker.ext.beans.BeansWrapper`. Also, it will wrap `org.w3c.dom.Node` objects with the new DOM wrapper. Also, it is aware of Jython objects, and will use `freemarker.ext.jython.JythonWrapper` if the object passed in is a Jython object. (We count it as a backward compatible change, since this new object wrapper wraps differently only those objects that the old wrapper was not able to wrap, so it has thrown exception.)

- `freemarker.template.TemplateMethodModel.exec` now returns `Object` instead of `TemplateModel`.

- The default (initial) value of the `strict_syntax` setting has been changed from `false` to `true`. When `strict_syntax` is `true`, tags with old syntax as `<include "foo.ftl">` will be considered as static text (so they go to the output as-is, like HTML tags do), and not as FTL tags. Such tags have to be rewritten to `<#include "foo.ftl">`, since only parts that starts with `<#`, `</#`, `<@`, or `</@` count as FTL tags. Or, to recover the old transitional behavior, where both legacy and new tag syntax was recognized, you have to explicitly set `strict_syntax` to `false`: `cfg.setStrictSyntaxMode(false)`. Also, for individual templates you can force the old behavior by starting the template with `<#ftl strict_syntax=false>`. (For more information about why strict syntax is better than old syntax read this...)

- New `CacheStorage` implementation: `freemarker.cache.MruCacheStorage`. This cache storage implements a two-level Most Recently Used cache. In the first level, items are strongly referenced up to the specified maximum. When the maximum is exceeded, the least recently used item is moved into the second level cache, where they are softly referenced, up to another specified maximum. `freemarker.cache.SoftCachseStorage` and `StrongCachseStorage` are deprected, `MruCachseStorage` is used everywhere instead. The default cache storage is now an `MruCachseStorage` object with 0 strong size, and infinite soft size. `Configuration.setSetting` for `cache_storage` now understands string values as `"strong:200, soft:2000"`.

- For `BeansWrapper` generated models, you can now use the `${obj.method(args)}` syntax to invoke methods whose return type is `void`. `void` methods now return `TemplateModel.NOTHING` as their return value.

- `freemarker.template.SimpleHash` now can wrap read-only `Map`-s, such as the map of HTTP request parameters in Servlet API.

- The `TemplateNodeModel` interface was introduced to support recursive processing of trees of nodes. Typically, this will be used in relation to XML.

- New package: `freemarker.ext.dom`. This contains the new XML wrapper, that supports the processing of XML documents using the visitor pattern (i.e. with `<#visit `...`>` and similar directives), and to provide more convenient XML traversing as the legacy wrapper. See the XML processing guide for more details.

- New package: `freemarker.core`. Classes used by mostly power-users was moved here from the `freemarker.template` package. The main reason of the splitting of `freemarker.template` package was that the amount of "expert" public classes and interfaces grows too much, as we introduce API-s for third-party tools, such as debugging API.

- New package: `freemarker.debug`. This provides a debugging API, by which you can debug executing templates through network (RMI). You have to write the front-end (client), as the API is just the server side. For more information please read the JavaDoc of the `freemarker.debug` package.

- You can query the FreeMarker version number with static method `Configuration.getVersionNumber()`. Also, the `Manifest.mf` included in `freemarker.jar` now contains the FreeMarker version number, furthermore, executing it with `java -jar freemarker.jar` will print the version number to the stdout.

- Added a new protected `FreemarkerServlet` method: `Configuration getConfiguration()`.

- Date support is now labeled as final. (It was experimental earlier.)

- The `BeansWrapper` has been improved to prevent some security exceptions when introspecting.

- Other minor quality improvements and extensions...

##### Other changes

- Fixes and improvements in the Manual and in the API JavaDoc.

##### The history of the releases before the final version

###### Differences between the final release and Release Candidate 4

- Added a new special variable to print the FreeMarker version number: `version`. See more in the reference...

- Minor documentation fixes and improvements.

###### Differences between the Release Candidate 4 and Release Candidate 3

- The `BeansWrapper` has been improved to prevent some security exceptions when introspecting.

- The `FreemarkerXmlTask` has two new sub-tasks that can be used to prepare template execution with Jython scripts: `prepareModel` and `prepareEnvironment`. The `jython` sub-task is now deprecated, and does the same as `prepareEnvironment`. See the Java API documentation for more details.

- New special variable to read the FreeMarker version number: `version`. See more in the reference...

- Bugfix: Greater-than sign doesn't confuse the `eval` built-in anymore.

- Bugfix: The `BeansWrapper` now wrapps the `null` return values of methods appropriately.

- Bugfix: The `FreemarkerXmlTask` doesn't need Jython classes anymore, unless you really use Jython scripts. Several other bugfixes in the Jython related features.

- Bugfix: If the template exception handler has ignored the exception, errors occurring in interpolations inside FTL tags (e.g. `<#if "foo${badVar}" != "foobar">`) were handled in the same way as errors occuring in interpolations outside FTL tags. Thus, the directive call was not skipped, and the problematic interpolation was replaced with an empty string. (This was inconsistent with the behavior of `<#if "foo"+badVar != "foobar">`, which should be 100% equivalent with the previous example.)

- Bugfix: The `FileTemplateLoader` is now more robust when it receives paths that are malformed according the native file system. In the earlier version such paths sometimes caused unexpected `IOException` that aborted the searching for the template in further `FileTemplateLoader`-s when you use the `MultiTemplateLoader`.

###### Differences between the Release Candidate 3 and Release Candidate 2

- Bugfix: Fixing a fatal bug in the template cache that was introduced with the latest cache ``bugfix''. The template cache has always reloaded the unchanged template when the update delay has been elapsed, until the template has been actually changed, in which case it has never reloaded the template anymore.

###### Differences between the Release Candidate 2 and Release Candidate 1

- Bugfix: The template cache didn't reload the template when it was replaced with an older version.

- API JavaDoc fix: date/time related classes/interfaces were marked as experimental. They are not experimental.

- Minor site improvements.

###### Differences between the Release Candidate 1 and Preview 16 releases

- Warning! Non-backward-compatible change! The default (initial) value of the `strict_syntax` setting has been changed from `false` to `true`. When `strict_syntax` is `true`, tags with old syntax as `<include "foo.ftl">` will be considered as static text (so they go to the output as-is, like HTML tags do), and not as FTL tags. Such tags have to be rewritten to `<#include "foo.ftl">`, since only parts that starts with `<#`, `</#`, `<@`, or `</@` count as FTL tags. Or, to recover the old transitional behavior, where both legacy and new tag syntax was recognized, you have to explicitly set `strict_syntax` to `false`: `cfg.setStrictSyntaxMode(false)`. Also, for individual templates you can force the old behavior by starting the template with `<#ftl strict_syntax=false>`. (For more information about why strict syntax is better than old syntax read this...)

- New parameter to the `ftl` directive: `attributes`. The value of this attribute is a hash that associates arbitrary attributes (name-value pairs) to the template. The values of the attributes can be of any type (string, number, sequence... etc.). FreeMarker doesn't try to understand the meaning of the attributes. It's up to the application that encapsulates FreeMarker (as a Web application framework). Thus, the set of allowed attributes and their semantic is application (Web application framework) dependent.

- Bugfix: `freemarker.template.utility.DeepUnwrap` unwrapped sequences to empty `ArrayList`-s.

- Bugfix: If you included/imported a template with `*/` in path (acquisition), and that template in turn itself included/imported another template with `*/` in path, it may failed.

- New methods to the `freemarker.core.Environment`: `importLib(Template loadedTemplate, java.lang.String namespace)`, `getTemplateForImporting(...)`, `getTemplateForInclusion(...)`.

- Improvements in the `java.io.IOException` related error messages of the `include` and `import` directives.

- Minor improvements in the documentation.

###### Differences between the Preview 16 and Preview 15 releases

- New package: `freemarker.debug`. This provides a debugging API, by which you can debug executing templates through network (RMI). You have to write the front-end (client), as the API is just the server side. For more information please read the JavaDoc of the `freemarker.debug` package. (The debugging API is present for a while, just I forgot to announce it in the version history. Sorry for that.)

- Bugfix: With the new XML wrapper, `@@markup` and similar special keys:

  - have returned `<foo></foo>` for empty elements instead of `<foo />`. Other than it was needlessly verbose, it has confused browsers if you generate HTML.

  - have showed the attributes that have no explicitly given value in the original document, just a default value coming form the DTD.

  - have forgot to put space before the system identifier in the `<!DOCTYPE `...`>`.

- Bugfix: XPath with Jaxen has died with `NullPointerException` if the context was an empty node set.

- A bit more intelligent Xalan XPath error messages.

- Revoked fallback-to-classloader logic from the template cache.

- From now, if no XPath engine is available, and the hash key in an ``XML query'' can't be interpreted without XPath, an error will tell this clearly, rather than silently returning undefined variable (null).

- Bugfix: Some templates have caused the parser to die.

- Some other minor improvements here and there...

###### Differences between the Preview 15 and Preview 14 releases

- Bugfix: The new default template cache storage (`MruCacheStorage`) has started to continually fail with `NullPointerException` from a random point of time, usually when the memory usage was high in the JVM.

- Bugfix: In error messages, when the quoted FTL directive had nested content, that was quoted as well, so the quotation could be very long and expose nested lines needlessly.

###### Differences between the Preview 14 and Preview 13 releases

- `freemarker.template.TemplateMethodModel.exec` now returns `Object` instead of `TemplateModel`.

- Fixes and improvements for XPath with Jaxen (not Xalan). Non-node-set XPath expressions are now working. FreeMarker variables are accessible in XPath expressions with XPath variable references (e.g. `doc["book/chapter[title=$currentTitle]"]`).

- `freemarker.cache.SoftCachseStorage` and `StrongCachseStorage` is deprected. The more flexible `MruCachseStorage` is used instead everywhere. The default cache storage is now an `MruCachseStorage` object with 0 strong size, and infinite soft size. `Configuration.setSetting` for `cache_storage` now understands string values as `"strong:200, soft:2000"`.

- Bugfix: `freemarker.cache.MruCachseStorage` has died with `ClassCastException` sometimes.

- New built-ins for Java and JavaScript string escaping: j_string and js_string

- `freemarker.template.TemplateExceptionHandler.HTML_DEBUG_HANDLER` now prints more HTML-context-proof messages.

- You can query the FreeMarker version number with static method `Configuration.getVersionNumber()`. Also, the `Manifest.mf` included in `freemarker.jar` now contains the FreeMarker version number, furthermore, executing it with `java -jar freemarker.jar` will print the version number to the stdout.

- Added a new protected `FreemarkerServlet` method: `Configuration getConfiguration()`.

- Bugfix: FreeMarker has frozen on empty conditional blocks in certain contexts.

- Bugfix: Methods called twice on an object using the `list` directive, as `parent.getChildren()` with `<#list parent.children as child> ...</#list>`

###### Differences between the Preview 13 and Preview 12 releases

- White-space stripping is now more aggressive as before: it always removes leading and trailing white-space if the line only contains FTL tags. (Earlier the white-space was not removed if the tag was `<#include `...`>` or user-defined directive tag with empty directive syntax as `<@myMacro/>` (or its equivalents: `<@myMacro></@myMacro>` and `<@myMacro></@>`). Now white-space is removed in these cases as well.) Also, top-level white-space that separates macro definitions and/or assignments is now ignored. More information: dgui_misc_whitespace_stripping

- White-space stripping can be disabled for a single line with the `nt` directive (for No Trim).

- A new directive for the declarative XML processing: `fallback`

- `freemarker.template.SimpleHash` now can wrap read-only `Map`-s, such as the map of HTTP request parameters in Servlet API.

###### Differences between the Preview 12 and Preview 11 releases

The only change between this and the previous preview release is that Preview 11 had a bug where DOM trees would never be garbage-collected.

###### Differences between the Preview 11 and Preview 10 releases

- Many XML related changes. Some of them are incompatible with the previous preview releases! For a more detailed explanation of how XML related features now work, see: xgui

  - Attention! Attribute queries such as `foo.@bar` now return sequences (similarly to child element queries and XPath queries), not single nodes. Because of the rule with node sequences of size 1, it is still good to write `${foo.@bar}`, but built-ins such as `?exists`, `?if_exists` or `?default` don't work as before. For example, instead of `foo.@bar?default('black')`, you now have to write `foo.@bar[0]?default('black')`. So if you have used existence built-ins with attributes, you have to find those occurrences in the templates and add that `[0]`.

  - Attention! XML name-space handling has been totally reworked and is absolutely incompatible with pre 10. Don't worry about this if none of your XML input documents use you use `xmlns` attributes. Worry, though, if you have utilized the ``loose mode'', where only the local name of elements were compared, because that's now gone. Sorry...

  - Attention! Special-keys `@@` and `@*` now return a sequence of attribute nodes instead of the hash of them.

  - Several hash keys are now working for node sequences that store multiple nodes. For example, to get the list of all `para` elements of all `chapter`-s, just write `doc.book.chapter.para`. Or, to get list of title attributes of all `chapter`-s write `doc.book.chapter.@title`.

  - New special hash keys: `**`, `@@start_tag`, `@@end_tag`, `@@attribute_markup`, `@@text`, `@@qname`.

  - `?parent` for attribute nodes now returns the element node the attribute node belongs to.

  - You can use Jaxen instead of Xalan for XPath expressions, if you call the static `freemarker.ext.dom.NodeModel.useJaxenXPathSupport()` method once. We plan to use Jaxen automatically instead of Xalan if it is available, just the Jaxen support is not fully functional yet.

- New special variable: `.vars`. This is useful to read top-level variables with square bracket syntax, for example `.vars["name-with-hyphens"]` and `.vars[dynamicName]`.

- New built-in, `eval`, to evaluate a string as FTL expression. For example `"1+2"?eval` returns the number 3.

- `FreemarkerServlet` now uses the configuration's `locale` setting, rather than `Locale.getDefault()`, to set the locale of the templates. Also, the signature of the `deduceLocale` method has been changed.

- We have a new (beta status) `CacheStorage` implementation: `freemarker.cache.MruCacheStorage`. This cache storage implements a two-level Most Recently Used cache. In the first level, items are strongly referenced up to the specified maximum. When the maximum is exceeded, the least recently used item is moved into the second level cache, where they are softly referenced, up to another specified maximum. You can plug to try it with `cfg.setCacheStorage(new freemarker.cache.MruCacheStorage(maxStrongSize, maxSoftSize))`.

###### Differences between the Preview 10 and Preview 9 releases

- The special key `@@xmlns` was removed in favor of a new FTL directive for the same purpose, `<#xmlns...>`.

- By default, the system is stricter about the use of namespace prefixes. In general, you must use a prefix to qualify subelements that are associated with an XML nampespace. You can do this with the new `<#xmlns...>` directive, but prefixes declared in the input XML doc will actually work with no declaration.

- Introduced a new special key called `@@text` that returns all the text nodes contained (recursively) in an element all concatenated together.

- Either Jaxen or Xalan can be used to provide XPath functionality. Prior versions only worked with Xalan.

- The `FreemarkerServlet` uses `ObjectWrapper.DEFAULT_WRAPPER` by default instead of `ObjectWrapper.BEANS_WRAPPER`. What this means is that, by default, objects of type `java.lang.String`, `java.lang.Number`, `java.util.List`, and `java.util.Map` will be wrapped as `TemplateModels` via the classes `SimpleScalar`, `SimpleNumber`, `SimpleSequence`, and `SimpleHash` respectively. Thus, the java methods on those objects will not be available. The default wrapper implementation in FreeMarker 2.3 automatically knows how to wrap Jython objects, and also wraps `org.w3c.dom.Node` objects into instances of `freemarker.ext.dom.NodeModel`.

- The `FreemarkerServlet` base implementation no longer deduces the locale to use from the HttpRequest.getLocale() hook. Rather, it simply delegates to a `deduceLocale()` hook that is overridable in subclasses. The base implementation simply uses `Locale.getDefault()`

###### Differences between the Preview 9 and Preview 8 releases

- Fixed bugs introduced with Preview 8: XPath, `@@markup` and `@@nested_markup` now works with the document node.

###### Differences between the Preview 8 and Preview 7 releases

- `macro` and assignment directives now accept arbitrary destination variable name with quoted syntax. For example: `<#macro "foo-bar">`...`` or `<#assign "this+that" = 123>`. This is important, because XML element names can contain hyphen, and it was not possible to define a handler macro for those elements, till now.

- Special key `@@content` was renamed to `@@nested_markup`.

- Fixed outdated XML related Manual parts (that were outdated even in Preview 7).

- Better parse-error messages.

- Minor bugfixes here and there...

###### Differences between the Preview 7 and Preview 6 releases

- Caching of XPath queries should lead to significant performance improvements for XML processing, at least when XPath is heavily used.

- Refinements in handling of XML namespaces in the XML processing functionality. The new `strict_namespace_handling` setting introduced in 2.3pre6 was removed. A general-purpose solution was arrived at that should make that configuration setting unnecessary.

- Special key `@xmlns` was renamed to @@xmlns. Reserved namespace prefix `default` was renamed to `@@default`.

- The `ftl` directive now accepts non-string types.

- New special keys were introduced for XML node wrappers in the freemarker.ext.dom package. The `@@markup` key returns the literal markup that make up that element and the `@@content` key returns all the element's markup excluding the opening and closing tags.

- Minor bugfixes here and there...

###### Differences between the Preview 6 and Preview 5 releases

- Existence built-ins (`?default`, `?exists`, etc.) now work with sequence sub variables as well. Read the documentation of the `default` built-in for more information.

- The `matches` built-in now returns a sequence instead of a collection.

- Refinements in handling of XML namespaces in the XML processing functionality. A new setting, `strict_namespace_handling` was introduced. If this is set (it is off by default) any node-handling macro used in with the visit/recurse machinery must be from a macro library that declares in its ftl header that it handles the namespace in question.

- Minor bugfixes here and there...

###### Differences between the Preview 5 and Preview 4 releases

- The `replace` and `split` built-ins now support case-insensitive comparison and regular expressions (J2SE 1.4+ only), and some other new options. More information can be found here.

- New butilt-in for regular expression matching (J2SE 1.4+ only): `matches`

- Minor bugfixes here and there...

- Manual: More browser-safe HTML-s. More updated content.

###### Differences between the Preview 4 and Preview 3 releases

- Bugfix: with multi-type variables, `+` operator overload for hash type had higher precedence than the precedence of some older overloads.

- The API documentation was missing from the distribution `tar.gz`.

###### Differences between the Preview 3 and Preview 2 releases

- XML processing: Many various bugfixes, especially with the declarative processing.

- XML processing: the `namespace_uri` built-in, the `xmlnsuri` header parameter, and the `TemplateNodeModel.getNodeNamespace` method were renamed to `node_namespace` and `getNodeNamespace` respectively.

- XML processing: Better documentation. Especially, note: xgui

- A new header parameter, `strip_text`, that removes all top-level text from a template. See `ftl` directive

- Support for a variable number of macro parameters. If the last parameter in a macro declaration ends with `...`, all extra parameters passed to the macro will be available via that parameter. For macros called with positional parameters, the parameter will be a sequence. For named parameters, the parameter will be a hash.

- For `BeansWrapper` generated models, you can now use the `${obj.method(args)}` syntax to invoke methods whose return type is `void`. `void` methods now return `TemplateModel.NOTHING` as their return value.

###### Differences between the Preview 2 and Preview 1 releases

- The `freemarker.ext.dom.NodeModel` API changed slightly. The `setDocumentBuilder()` method was changed to `setDocumentBuilderFactory()` because the older scheme was not thread-safe. The `stripComments` and `stripPIs` methods are renamed to The `removeComments` and `removePIs`, and are fixed now. A new method, `simplify` has been added.

- The expressions `as`, `in`, and `using` are now keywords in the template language and cannot be used as top-level variable names without square-bracket syntax (as `.vars["in"]`). If, by some chance, you have top-level variables that use one of these names, you will have to rename them (or use the square-bracket syntax). Sorry for the inconvenience.

- The `?new` built-in, as it was implemented, was a security hole. Now, it only allows you to instantiate a java object that implements the `freemarker.template.TemplateModel` interface. If you want the functionality of the `?new` built-in as it existed in prior versions, make available an instance of the new `freemarker.template.utility.ObjectConstructor` class to your template.

- The `<#recurse>` directive was broken. It did not work with a `using` clause. This is now fixed.

#### 2.2.8

Date of release: 2004-June-15

Bugfix and maintenance release.

##### Changes on the FTL side

- Added a new special variable to print the FreeMarker version number: `version`. See more in the reference...

##### Changes on the Java side

- The `BeansWrapper` has been improved to prevent some security exceptions when introspecting.

- Bugfix: The `FileTemplateLoader` is now more robust when it receives paths that are malformed according the native file system. In the earlier version such paths sometimes caused unexpected `IOException` that aborted the searching for the template in further `FileTemplateLoader`-s when you use the `MultiTemplateLoader`.

- Some parts of the FreeMarker code has been marked as privileged code section, so you can grant extra privileges to FreeMarker when you use a security manager (this is a backporting from 2.3). See more here...

##### Other changes

- Minor documentation fixes and improvements.

#### 2.2.7

Date of release: 2004-March-17

Important bugfix release.

##### Changes on the Java side

- Bugfix: Fixing a fatal bug in the template cache that was introduced with the latest cache ``bugfix''. The template cache has always reloaded the unchanged template when the update delay has been elapsed, until the template has been actually changed, in which case it has never reloaded the template anymore.

#### 2.2.6

Date of release: 2004-March-13

Maintenance and bugfix release. Some of improvements are back-portings from FreeMarker 2.3rc1.

##### Changes on the FTL side

- New special variable: `.vars`. This is useful to read top-level variables with square bracket syntax, for example `.vars["name-with-hyphens"]` and `.vars[dynamicName]`.

- New built-ins for Java and JavaScript string escaping: j_string and js_string

##### Changes on the Java side

- Bugfix: The template cache didn't reload the template when it was replaced with an older version.

- Bugfix: `freemarker.template.utility.DeepUnwrap` unwrapped sequences to empty `ArrayList`-s.

- Bugfix: In error messages, when the quoted FTL directive had nested content, that was quoted as well, so the quotation could be very long and expose nested lines needlessly.

- `freemarker.template.TemplateExceptionHandler.HTML_DEBUG_HANDLER` now prints more HTML-context-proof messages.

- You can query the FreeMarker version number with static method `Configuration.getVersionNumber()`. Also, the `Manifest.mf` included in `freemarker.jar` now contains the FreeMarker version number, furthermore, executing it with `java -jar freemarker.jar` will print the version number to the stdout.

- Date support is now labeled as final. (It was experimental earlier.) There was no change since FreeMarker 2.2.1.

##### Other changes

- Fixes and improvements in the Manual and in the API JavaDoc. The documentation now works with the Eclipse help plugin (accessible in the ``Editor/IDE plugins'' section of the FreeMarker Web page).

- Minor site improvements.

#### 2.2.5

Date of release: 2003-09-19

Maintenance and bugfix release.

##### Changes on the Java side

- Creating a `Configuration` instance using the default constructor no longer fails if the current directory is unreadable due to I/O problems, lack of security permissions, or any other exception.

#### 2.2.4

Date of release: 2003-09-03

Maintenance and bugfix release.

##### Changes on the Java side

- Improvements to JSP taglib support. If some third party taglib didn't work for you with FreeMarker, maybe now it will.

  - The JSP `PageContext` now implements `forward` and `include` methods.

  - Accepting `EVAL_PAGE` as an alias to `SKIP_BODY` in return values from `doStartTag`. It's a common bug in some widespread tag libraries, and now FreeMarker is less strict and accepts it.

- Fixes for some rare problems regarding namespaces of macros.

##### Other changes

- Minor improvements to the documentation.

#### 2.2.3

Date of release: 2003-07-19

Bugfix release.

##### Changes on the FTL side

- Added the `is_date` built-in.

- Bugfix: Various `is_xxx` built-ins were returning `false` when applied to undefined expressions. Now they correctly fail on them.

##### Changes on the Java side

- Bugfix: The JSP taglib support can now read JSP 1.2 compliant TLD XML files.

- Bugfix: The JSP taglib support now emits more helpful exception messages when the specified TLD XML file is not found (previously it threw a `NullPointerException`).

- Bugfix: The JSP taglib support now initializes a custom tag after its parent and page context is set as some tags expect them to be set when attribute setters are called.

- Bugfix: The `BeansWrapper` could fail to analyze classes under very rare circumstances due to a premature storage optimization.

#### 2.2.2

Date of release: 2003-05-02

Bugfix release.

##### Changes on the Java side

- Bugfix: The `_text` key of the `freemarker.ext.xml.NodeListModel` was not returning the text of the element when used with W3C DOM trees.

- The classes are now built against JDK 1.2.2 classes, ensuring the binary compatibility of FreeMarker distribution with JDK 1.2.

#### 2.2.1

Date of release: 2003-04-11

This version introduces important new features, such as the native FTL date/time type, and the auto-include and auto-import settings.

The date/time support is experimental, but we hope it will not substantially change. We would like to label it as final ASAP, so we urge everybody to send feedback on this topic to the mailing lists.

##### Changes on the FTL side

- New scalar type: date. For more information read: dgui_datamodel_scalar, dgui_datamodel_scalar, interpolation, ?string built-in for dates

##### Changes on the Java side

- New `TemplateModel` subinterface: `TemplateDateModel`. For more information read pgui_datamodel_scalar

- auto-include and auto-import: With these new configuration level settings, you can include and import commonly used templates (usually collection of macro definitions) at the top of all templates, without actually typing `<#include `...`>` or `<#import `...`>` into the templates again and again. For more information please read the Java API documentation of `Configuration`

- New template method: `createProcessingEnvironment`. This method makes it possible for you to do some special initialization on the `Environment` before template processing, or to read the environment after template processing. For more information please read the Java API documentation.

- Changes to `freemarker.ext.beans` package: `BeanModel`, `MapModel`, and `ResourceModel` now implement `TemplateHashModelEx`.

- Bugfix: `Configurable.setSettings(Properties)` didn't removed redundant spaces/tabs at the end of property values.

#### 2.2

Date of release: 2003-03-27

This release introduces some really important new features. Unfortunately, evolution was painful again; we have a few non-backward compatible changes (see below). Also, for those of you awaiting desired native date/time type, sorry, it is still not here (because of some internal chaos in the team... stand by, it's coming).

##### Non backward-compatible changes!

- Macros are now plain variables. This means that if you are unlucky and you have both a macro and another variable with the same name, now the variable will overwrite the macro, so your old template will malfunction. If you have a collection of common macros, you should use the new namespace feature to prevent accidental clashes with the variables used in the templates.

- With the introduction of the new namespace support, `global` and `assign` directives are no longer synonyms. `assign` creates a variable in the current `namespace`, while `global` creates variable that is visible from all namespaces (as if the variable would be in the data-model). Thus, the variable created with `assign` is more specific, and hides the variable of the same name created with `global`. As a result, if you use both `global` and `assign` mixed for the same variable in your templates, now they will malfunction. The solution is to search-and-replace all `global`s in your old templates with `assign`.

- The reserved hash `root` no longer exists as a predefined variable (we no longer have reserved variables). Use special variable expressions to achieve similar effects. However, we have no equivalent replacement for `root` because of the changes in the variable scopes caused by the introduction of namespaces. You may should use `.globals` or `.namespace`.

- The `BeansWrapper` no longer exposes native Java arrays, booleans, numbers, enumerations, iterators, and resource bundles as `TemplateScalarModel`. This way, number objects wrapped through `BeansWrapper` are subject to FreeMarker's number formatting machinery. Also, booleans can be formatted using the `?string` built-in.

- The signature of `Configuration.setServletContextForTemplateLoading` has been changed: the first parameter is now `Object` instead of `javax.servlet.ServletContext`. Thus, you have to recompile your classes that call this method. The change was required to prevent class-loading failure when `javax.servlet` classes are not available and you would not call this method.

- This release introduces a parse-time white-space remover that strips some of the typical superfluous white-space around FreeMarker tags and comments. This feature is on by default! Most probably this will not cause problems if you generate white-space neutral output like HTML. But if it does cause undesirable reformatting in output you generate, you can disable it with `config.setWhitespaceStripping(false)`. Also, you can enable/disable it on a per-template basis with the new `ftl` directive.

- Some new directives were introduced: `nested`, `import`, `escape`, `noescape`, `t`, `rt`, `lt`. This means that if you are unlucky and the text of your template contains something like `<nested>`, then that will be misinterpreted as a directive. To prevent this kind of problem in the future, we recommend everybody to switch from the old syntax to the new syntax (``strict syntax''). The strict syntax will be the the default syntax starting from some of the later releases anyway. We plan to release a conversion tool for converting old templates. For more information please read: ref_depr_oldsyntax

- The data-model created by the `FreemarkerServlet` now uses automatic scope discovery, so writing `Application.`attrName``, `Session.`attrName``, `Request.`attrName`` is no longer mandatory; it's enough to write ``attrName`` (for more information read this). This may break an old template if that rely on the non-existence of certain top-level variables.

- `FreemarkerServlet` now uses the encoding of the template file for the output, unless you specify the encoding in the `ContentType` init-param, such as `text/html; charset=UTF-8`.

- The format of template paths is now more restricted than before. The path must not use `/`, `./` and `../` and `://` with other meaning as they have in URL paths (or in UN*X paths). The characters `*` and `?` are reserved. Also, the template loader must not want paths starting with `/`. For more information please read: pgui_config_templateloading

- Till now `TemplateTransformModel.getWriter` has received null as parameter map if the transform was called without parameters. From now, it will receive an empty Map instead. Note that the previous API documentation didn't state that it always receives null if there are no parameters, so hopelessly only very few classes exploit this design mistake.

##### Changes in FTL (FreeMarker Template Language)

- User-defined directives: Transform and macro call syntax has been unified; they can be called in the same way, as user-defined directives. This also means that macros support named parameters and nested content (like the -- now deprecated -- `transform` directive did). For example, if you have a macro called `sect`, you may call it via `<@sect title="Blah" style="modern">Blah blah...</@sect>`. For more information read: dgui_misc_userdefdir

- Macros are now plain variables. This significantly simplifies FreeMarker semantics, while providing more flexibility; for example you can pass macros as parameters to other macros and transforms. As for the problem of clashing commonly-used-macro and variable names, we provide a more powerful solution: namespaces.

- Namespaces: Names-spaces are invaluable if you want to assemble collections (``libraries'') of macros and transforms (and other variables), and then use them in any template without worrying about accidental name clashes with the application specific and temporary variables, or with the variables of other collections you want to use in the same template. This is extremely important if FreeMarker users want to share their macro/transform collections. For more information read: dgui_misc_namespace

- With the introduction of namespaces our variable related terminology changed. As a result, `assign` is no longer synonymous with `global`. The `assign` directive has been undeprecated, and should be used instead of `global` almost everywhere. In the new approach `assign` creates variables in the current namespace, while `global` creates a variable that is visible from all namespaces (as if the variable were in the root of the data-model). A variable created with `assign` in the current namespace hides the variable of the same name that was created with `global`.

- `ftl` directive: With this directive you can give information about the template for FreeMarker, like the encoding (charset) of the template, the used FTL syntax variant, etc. Also, this directive helps you to write templates that are less dependent on FreeMarker configuration settings, also it helps third-party tools to identify and correctly parse FreeMarker templates. For more information see: `ftl` directive

- White-space stripping: FreeMarker now automatically removes some of the typical superfluous white-spaces around FreeMarker tags and comments, like the indentation spaces before- and line-break after `<#if ...>` tags. For more information read: dgui_misc_whitespace_stripping

- New directive to apply a common ("escaping") expression to all interpolations in a block: `escape`. The name comes from the common usage of this directive for automatic HTML-escaping of interpolations.

- The new and preferred way of number formatting with `string` built-in is `foo?string(format)`, instead of the less natural `foo?string[format]`.

- The `string` built-in works for boolean values. For example: `${spamFilter?string("enabled", "disabled")}`. For more information read the reference.

- The default strings for outputting boolean value using the `string` built-in can be set using the `boolean_format` setting.

- Comments can be placed inside FTL tags and interpolations. For example: `<#assign <#-- a comment --> x = 3>`

- All letters and numbers are enabled in variable names, also `$` is allowed (as in Java programming language). Thus you can use accents, Arabic letters, Chinese letters, etc.

- String literals can be quoted with apostrophe-quote. `"foo"` and `'foo'` are equivalent.

- New string built-ins: `index_of`, `last_index_of`, `starts_with`, `ends_with`, `replace`, `split`, `chop_linebreak`, `uncap_first`.

- New sequence built-ins: `sort`, `sort_by`.

- New built-ins for experts to check the type of a variable. See: `is_`...`` built-ins

- New built-in for experts to create a variable of certain Java `TemplateModel` implementation. See: `new` built-in

- New built-in, `namespace`, to get the namespace of a macro.

- New expression type: special variable expression. To prevent backward compatibility problems when we introduce new predefined variables, from now special variable expressions are used to access them.

- New directives: `t`, `rt` and `lt` directives allow you to do explicit white-space removal in extreme FTL applications. For more information read the reference.

- `assign`, `local` and `global` now can capture the output generated be the nested template fragment into the variable. This deprecates `capture_output` transform. More information: assign directive reference

- Bulk assignments (as `<#assign x=1, y=2, z=3>`) no longer need colon to separate the assignments (as `<#assign x=1 y=2 z=3>`), although it is still allowed to preserve backward compatibility.

- Path that contains `//:` is considered as absolute path.

- `include` and `transform` directives no longer need a semicolon to separate the template or transform name from the parameter list, although it is still allowed to preserve backward compatibility.

- `#`-less tag syntax is deprecated (but still working). That is, you should write `<#`directive ...`>` instead of `<`directive ...`>`, and `</#`directive ...`>` instead of `</`directive ...`>`. For more info read: ref_depr_oldsyntax

- `foreach` is depreciated (but still working). Use `list` instead.

- Bugfix: Undefined variables in hash and sequence constructors (as `[a, b, c]`) didn't caused errors.

- Bugfix: String concatenation had performance problem if there was multiple concatenations chained, as: `"a"+x+"a"+x+"a"+x+"a"+x+"a"+x`.

##### Changes on the Java side

- Arbitrary JSP custom tags can be used as FreeMarker transforms in `FreemarkerServlet`-driven templates. More information: pgui_misc_servlet

- Various improvements for `BeansWrapper`:

  - The `BeansWrapper` no longer exposes arbitrary objects as `TemplateScalarModel`s, only `java.lang.String` and `Character` objects. This way, number objects wrapped through `BeansWrapper` are subject to FreeMarker's number formatting machinery. As a side effect, non-string and non-number objects that were previously accepted in equality and inequality operations (because they had a string representation) will now cause the engine to throw exception on comparison attempt.

  - `java.lang.Character` objects are exposed as scalars through `BeansWrapper`.

  - Experimental feature: With the `setSimpleMapWrapper` method of `BeansWrapper` you can configure it to wrap `java.util.Map`-s as `TemplateHashModelEx`-s, and do not expose the methods of the object.

- `TransformControl` interface (was experimental earlier): If the `Writer` returned by `TemplateTransformModel.getWriter` implements this interface, it can instruct the engine to skip or to repeat evaluation of the nested content, and gets notified about exceptions that are thrown during the nested content evaluation. Note that the `onStart` and `afterBody` methods now are allowed to throw `IOException`. For more information please read the API documentation.

- Localized lookup can be disabled with the new `Configuration` methods: `set/getLocalizedLookup`, `clearTemplateCache`

- The new interface `freemarker.cache.CacheStorage` allows users to plug custom template caching strategies with the `cache_storage` setting. The core package now ships with two implementations: `SoftCacheStorage` and `StrongCacheStorage`. For more information read: pgui_config_templateloading

- You can set settings with string name and string value with the new `setSetting(String key, String value)` method of `Configurable` super-classes (as `Configuration`). Also you can load settings from `.properties` file with the `setSettings` method.

- Other new `Configuration` methods: `clearTemplateCache`, `clearSharedVariables`, `getTemplateLoader`, and `clone`.

- Changes to `TemplateTransformModel` interface: `getWriter` can throw `IOException`, and can return `null` if the transform does not support body content.

- Till now `TemplateTransformModel.getWriter` has received null as parameter map if the transform was called without parameters. From now, it will receive an empty Map instead. Note that the previous API documentation didn't state that it always receives null if there are no parameters, so hopelessly only very few classes exploit this design mistake.

- Various improvements for `FreemarkerServlet`:

  - The data-model now uses automatic scope discovery, so writing `Application.`attrName``, `Session.`attrName``, `Request.`attrName`` is no longer mandatory; it's enough to write ``attrName``. For more information read this.

  - `FreemarkerServlet` now uses the encoding of the template file for the output, unless you specify the encoding in the `ContentType` init-param, such as `text/html; charset=UTF-8`.

  - All `Configuration` level settings can by set with Servlet init-params (`template_exception_handler`, `locale`, `number_format`, etc.).

  - The object wrapper the servlet internally uses is now set as the default object wrapper for its `Configuration` instance.

  - It no longer forces session creation for requests that don't belong to an existing session, improving scalability.

- JDOM independent XML-wrapping: `freemarker.ext.xml.NodeListModel` is a re-implementation of `freemarker.ext.jdom.NodeListModel` that does not rely on JDOM; you don't need JDOM .jar anymore. The new `NodeListModel` automatically uses W3C DOM, dom4j, or JDOM, depending on which library is available (that is, depending on what object do you pass to its constructor).

- Bugfix: `WebappTemplateLoader`: Template updating didn't worked correctly with Tomcat due the caching of resources. Now `WebappTemplateLoader` tries to access the resources directly as `File`, if it is possible, thus bypasses the caching.

- Various bug-fixes for `FreemarkerServlet`:

  - The servlet now loads the correct template if it was called through `RequestDispatcher.include`.

  - The caching of `HttpServletRequest` objects is now compliant with the servlet specification.

  - `TemplateException`s was suppressed in certain situations resulting in half-rendered pages without error message.

- Bugfix: FreeMarker didn't work if the `javax.servlet` classes was not available, because `Configuration` explicitly referred to `javax.servlet.ServletContext`.

- Bugfix: classes may were not found if they was available only in the `WEB-INF`, and FreeMarker tried to load the class dynamically.

- Bugfix: the `Template` constructor (and thus `Configuration.getTemplate`) sometimes threw `TokenMgrError` (a non-checked exception) instead of `ParseException`.

##### Other changes

- The Web application related examples has been replaced.

##### The history of the releases before the final version

###### Differences between the final and RC2 releases

- You can load settings from `.properties` file with the `setSettings` method of `Configuration` and other `Configurable` subclasses.

- New string built-in: `uncap_first`

- Bugfix: When exposing an XML document to a template and accessing it with XPath using Jaxen a `ClassCastException` has occurred.

- Bugfix: The template cache has loaded templates with bad `Configuration` instance in certain situations if you use not the static default `Configuration` instance.

###### Differences between the RC2 and RC1 releases

- Non backward compatible change!: `FreemarkerServlet` now uses the encoding of the template file for the output, unless you specify the encoding in the `ContentType` init-param, such as `text/html; charset=UTF-8`.

- Non backward compatible change compared to RC1!: The `capture_output` transform creates variable in the current namespace (as `assign` directive) with the `var` parameter, not a global variable.

- The new and preferred way of number formatting with `string` built-in is `foo?string(format)`, instead of the less natural `foo?string[format]`.

- The `string` built-in works for boolean values. For example: `${spamFilter?string("enabled", "disabled")}`. For more information read the reference.

- The default strings for outputting boolean value using the `string` built-in can be set using the `boolean_format` setting.

- String literals can be quoted with apostrophe-quote. `"foo"` and `'foo'` are equivalent.

- The new interface `freemarker.cache.CacheStorage` allows users to plug custom template caching strategies with the `cache_storage` setting. The core package now ships with two implementations: `SoftCacheStorage` and `StrongCacheStorage`. For more information read: pgui_config_templateloading

- You can set settings with string name and string value with the new `setSetting(String key, String value)` method of `Configurable` super-classes (as `Configuration`).

- Other new `Configuration` methods: `getTemplateLoader`, `clone`.

- `assign`, `local` and `global` now can capture the output generated be the nested template fragment into the variable. This deprecates `capture_output` transform. More information: assign directive reference

- Other new `Configuration` methods: `getTemplateLoader`, `clone`.

- Changes to `TemplateTransformModel` interface: `getWriter` can throw `IOException`, and can return `null` if the transform does not support body content.

- Till now `TemplateTransformModel.getWriter` has received null as parameter map if the transform was called without parameters. From now, it will receive an empty Map instead. Note that the previous API documentation didn't state that it always receives null if there are no parameters, so hopelessly only very few classes exploit this design mistake.

- Changes to `TemplateControl` interface: `onStart` and `afterBody` methods are now allowed to throw `IOException`.

- Path that contains `//:` is considered as absolute path.

- New string built-ins: `index_of`, `last_index_of`, `starts_with`, `ends_with`, `replace`, `split`, `chop_linebreak`.

- New sequence built-ins: `sort`, `sort_by`.

- All `Configuration` level settings can by set with Servlet init-params (`template_exception_handler`, `locale`, `number_format`, etc.).

- Bugfix: classes may were not found if they was available only in the `WEB-INF`, and FreeMarker tried to load the class dynamically.

- Bugfix: `setLocalizedLookup(false)` of `Configuration` was overridden when you have called `setTemplateLoader`.

- Bugfix: String concatenation had performance problem if there was multiple concatenations chained, as: `"a"+x+"a"+x+"a"+x+"a"+x+"a"+x`.

- Bugfix: white-space stripping was not worked with tags spanning over multiple lines.

- Bugfix: Removing several dependencies on JDK 1.3, so FreeMarker can be build for JDK 1.2.2.

###### Differences between the Preview 2 and RC1 releases

- `ftl` is now stricter, and does not allow custom parameters. To associate custom attributes to templates, we may add a new directive later, if there is a demand for it.

- `escape` directive does not affect numerical interpolations (`#{`...`}`) anymore, as it has caused errors with string escapes as `?html`.

- The `normalizeName` method of `freemarker.cache.TemplateLoader` has been removed, because it has caused too many complications. Instead, normalization happens on a single point in the `TempateCache`. In consequence, FreeMarker is now stricter about the format of template paths, as things like `/../` are interpreted by the core.

- Experimental feature: With the `setSimpleMapWrapper` method of `BeansWrapper` you can configure it to wrap `java.util.Map`-s as `TemplateHashModelEx`-s, and do not expose the methods of the object.

- New `Configuration` methods: `set/getLocalizedLookup`, `clearTemplateCache`, `clearSharedVariables`.

- More cleanups in the `Environment` API.

- Better JSP standard compliance: JSP page-scope variables are the global variables that were created in the template (not the variables of the data-model).

- JDOM independent XML-wrapping: `freemarker.ext.xml.NodeListModel` is a re-implementation of `freemarker.ext.jdom.NodeListModel` that does not rely on JDOM; you don't need JDOM .jar anymore. The new `NodeListModel` automatically uses W3C DOM, dom4j, or JDOM, depending on which library is available (that is, depending on what object do you pass to its constructor).

- Bugfix: `WebappTemplateLoader`: Template updating didn't worked correctly with Tomcat due the caching of resources. Now `WebappTemplateLoader` tries to access the resources directly as `File`, if it is possible, thus bypasses the caching.

- Bugfix: Templates loaded with `MultiTemplateLoader` subclasses was removed from the template cache after the template update delay has elapsed (5 seconds by default) even if the template file was unchanged. This can cause lot of extra load for a high-traffic server if you have many templates or if the template update delay was set to 0 second.

- Bugfix: Undefined variables in hash and sequence constructors (as `[a, b, c]`) didn't caused errors.

###### Differences between the Preview 1 and Preview 2 releases

- All 16-bit Unicode letters and numbers are allowed in identifiers, as well as the `$` character (as in Java programming language). Thus you can use accented letters, Arabic letters, Chinese letters, etc. as identifiers in templates

- Macros now can create loop variables for the nested content. For more information read this.

- New directives: `t`, `rt` and `lt` directives allow you to do explicit white-space removal in extreme FTL applications. For more information read the reference.

- The syntax of assignment-with-namespace has changed from `<#assign foo=123 namespace=myLib>`) to `<#assign foo=123 in myLib>`, since the previous syntax was confusing because its similarity to a bulk-assignment.

- Bulk assignments (as `<#assign x=1, y=2, z=3>`) no longer need colon to separate the assignments (as `<#assign x=1 y=2 z=3>`), although it is still allowed to preserve backward compatibility.

- Positional parameter passing is supported for macro calls as shorthand form of normal named parameter passing. For more details read read the reference.

- New built-in, `namespace`, to get the namespace of the currently executing macro.

- `TransformControl` interface (was experimental earlier): If the `Writer` returned by `TemplateTransformModel.getWriter` implements this interface, it can instruct the engine to skip or to repeat evaluation of the nested content, and gets notified about exceptions that are thrown during the nested content evaluation. For more information please read the API documentation.

- Jython wrapper can now wrap arbitrary Java objects, not only `PyObject`-s. If an object is passed to the wrapper that is neither a `TemplateModel`, nor a `PyObject`, it is first coerced into a `PyObject` using Jython's own wrapping machinery, and then wrapped into a `TemplateModel` as any other `PyObject`.

- Some cleanups in the `Environment` API.

- The Web application related examples has been replaced.

- Bugfix: Templates loaded with `URLTemplateLoader` subclasses was removed from the template cache after the template update delay has elapsed (5 seconds by default) even if the template file was unchanged. This can cause lot of extra load for a high-traffic server if you have many templates or if the template update delay was set to 0 second.

- Bugfix: `FreeMarkerServlet` has thrown `ServletException` even if a debug `TemplateException` handler was in use (so you may got Error 500 page instead of debug information).

#### 2.1.5

Date of release: 2003-02-08

##### Changes on the Java side

- Bugfix: Fixed a bug that forced the cache to frequently reload templates accessed through URL and multi template loaders: Templates loaded with `URLTemplateLoader` subclasses and `MultiTemplateLoader` was removed from the template cache after the template update delay has elapsed (5 seconds by default) even if the template file was unchanged. This can cause lot of extra load for a high-traffic server if you have many templates or if the template update delay was set to 0 second.)

- Bugfix: Many anomalies in the `JythonWrapper` were resolved, making the integration with Jython much smoother: Jython wrapper can now wrap arbitrary Java objects, not only `PyObject`-s. If an object is passed to the wrapper that is neither a `TemplateModel`, nor a `PyObject`, it is first coerced into a `PyObject` using Jython's own wrapping machinery, and then wrapped into a `TemplateModel` as any other `PyObject`.

#### 2.1.4

Date of release: 2002-12-26

##### Changes on the Java side

- Bugfix: Log4J is now found when automatically discovering the logging library to use.

- Bugfix: An exception is no longer thrown in the static initializer of the `Configuration` if the directory specified in the `"user.dir"` system property is not readable.

#### 2.1.3

Date of release: 2002-12-09

##### Changes on the FTL side

- Bugfix: `cap_first` built-in did what `double` built-in does.

##### Other changes

- The official extension of FreeMarker template files is `ftl` from now, not `fm`. (This is the name of the template language; FTL, for FreeMarker Template Language.) Of course you can use any extensions, since FreeMarker does not deal with the file extension. But we recommend `ftl` extension as default.

- Web application examples got tweaked again, as under JDK 1.4 a class in an explicit (named) package can no longer import classes from the default (unnamed) package. Our webapp example was using classes in the default package, they are now moved into named packages.

#### 2.1.2

Date of release: 2002-11-28

##### Changes in FTL (FreeMarker Template Language)

- `FreeMarkerServlet` now has a setting for the `Content-Type` header of the response, defaulting to `text/html`. Previously it set no content type, which made it not play nicely when integrated with software that expected it (i.e. OpenSymphony SiteMesh).

- `FreeMarkerServlet` now works correctly when mapped to an URL extension instead of URL path prefix.

- You can emulate `include` directive call within Java code by calling `Environment.include(`templateName`, `charset`, `parse`)`.

- Bugfix: When `Template.process()` was called from another template processing, it set `currentEnvironment` to null when it returned, thus crashed the parent template processing.

- Bugfix: the `_descendant` key in JDOM support incorrectly left the document root element out of the result when applied to a Document node.

- Bugfix: because we incorrectly assumed certain behavior of JDK 1.4 Beans introspector, calls to public interface methods on non-public classes that implement the interface were causing exceptions on JDK 1.4

##### Other changes

- Various minor supplements to the manual.

- Documentation HTML pages don't try to load the SourceForge logo from the Internet anymore.

- The default ant target is `jar`, not `dist`.

#### 2.1.1

Date of release: 2002-11-04

##### Changes in FTL (FreeMarker Template Language)

- Multi-type variables that are both string and number or string and date are now output using their number or date value instead of the string value when used in the `${...}` interpolation. This practically makes the string part of a string/number or a string/date variables useless.

- Bugfix: operator ``or'' (`||`) worked wrongly when its left operand was a composite expression (e.g. the second `||` in `false || true || false`; this was evaluated to `false`, but it should be `true`)

- Bugfix: Less-than sign inside comments confused the FTL parser (e.g. `<#-- blah < blah -->`); it commented out everything after the problematic comment.

- Bugfix: Comparing two numerical constants (e.g. `3 == 3`) caused internal error in the FTL parser, and aborted template processing with error.

- Experimental date/time type support was removed, since it seems that this initial implementation was misguided. FreeMarker 2.2 will certainly support data/time.

##### Changes on the Java side

- Bugfix: `Number`s wrapped with `BEANS_WRAPPER` was displayed with the `toString()` method of wrapped object. Now they are rendered according to the `number_format` setting, because multi-type variables that are both string and number are now output using their number value instead of the string value.

- Experimental date/time type support was removed, since it seems that this initial implementation was misguided. FreeMarker 2.2 will certainly support data/time.

#### 2.1

Date of release: 2002-10-17

Templates and the Java API are not fully compatible with 2.0 releases. You will need to revisit existing code and templates, or use 2.1 for new projects only. Sorry for this inconvenience; FreeMarker has undergone some revolutionary changes since the 1.x series. We hope things will soon be sufficiently mature for us to offer (almost) backward-compatible releases. Note that there is a backward-compatibility flag that can be set via `Configuration.setClassicCompatible(true)` that causes the new FreeMarker to emulate most of FreeMarker 1.x's quirks.

##### Changes in FTL (FreeMarker Template Language)

- More strict, reveals accidental mistakes in the templates, prevents showing incorrect information when something went wrong:

  - An attempt to access an undefined variable causes an error and aborts template processing (by default at least; see later). In earlier versions undefined variables were silently treated as empty (zero-length) strings. However, you can handle undefined variables in the template with some new built-ins. For example, `${foo?if_exists}` is equivalent with the `${foo}` of earlier versions. Another way of looking at this is that null values no longer exist from the viewpoint of a template designer. Anything referenced must be a defined variable.

    Note however that the programmer can configure FreeMarker so that it ignores certain errors (say, undefined variables), and continues template processing by skipping the problematic part. This ``loose'' policy should be used only for sites that don't show critical information.

  - New variable type: boolean. Conditions in `if`/`elseif` and operands of logical operators (`&&`, `||`, `!`) must be booleans. Empty strings are no longer treated as a logical false.

- Local and global variables. More info: dgui_misc_var

  - Local variables for macros. You can create/replace local variables in macro definition bodies with the `local` directive

  - You can create/replace global (non-local) variables with the `global` directive

- The `include` directive now by default treats the passed filename as being relative to the including template's path. To specify absolute template paths, you now have to prepend them with a slash.

- The `include` directive can now use the acquisition algorithm (familiar from the Zope system) to look up the template to include. Basically, if a template is not found where it is looked up first, it is looked up in parent directories. This is however not a default behavior, rather it is triggered by a new syntactic element.

- Strict syntax mode: Allows you to generate arbitrary SGML (XML) without worrying about clashes with FreeMarker directives. For more information read: ref_depr_oldsyntax

- Terse comments: you can use `<#-- `...` -->` instead of `<comment>`...`</comment>`

- Directive that you can use to change the locale (and other settings) inside the template: `setting`

- Directive to explicitly flush the output buffer: `flush`

- The top-level (root) hash is available via the variable `root`, which is now a reserved name.

- The misnamed `function` directive has been renamed to `macro`.

- String literals support various new escape sequences, including UNICODE escapes (`\x`CODE``)

- The `compress` directive is now more conservative in removing line breaks.

- Built-in to capitalize the first word: `cap_first`

- Built-in to generate on-the-fly templates: `interpret`

- `stop` directive has an optional parameter to describe the reason of termination

- Better error messages.

- New variable type: date. Date support is experimental. It can change substantially in the future. Keep this in mind if you use it.

##### Changes on the Java side

- `ObjectWrapper`: You can put non-`TemplateModel` objects directly into hashes, sequences and collections, and they will be automatically wrapped with the appropriate `TemplateModel` implementation. The API of objects that are exposed to templates (`Simple`XXX``) has been changed according to this, for example in `SimpleHash` the old `put(String key, TemplateModel value)` is now `put(String key, Object object)`. Also, you can pass any kind of object as data-model to `Template.process`. The alternative reflection based `ObjectWrapper` can expose the members of any Java object automatically for the designer. More information: Object wrapping, Bean wrapper, Jython wrapper.

- The `Configuration` object was introduced as a central point to hold all your FreeMarker-related global settings, as well as commonly used variables that you want to have available from any template. Also it encapsulates the template cache and can be used to load templates. For more information read pgui_config.

- `TemplateLoader`: pluggable template loader, separates caching from template loading

- `TemplateNumberModel`-s do not control their formatting anymore. They just store the data (i.e. a number). Number formatting is done by the FreeMarker core based on the `locale` and `number_format` settings. This logic applies to the new experimental date type as well.

- `TemplateBooleanModel` introduced: Only objects that implements this interface can be used as a boolean in true/false conditions. More info: pgui_datamodel_scalar

- `TemplateDateModel` introduced: objects that implements this interface are recognized as dates and can be locale-sensitively formatted. Date support is experimental in FreeMarker 2.1. It can change substantially in the future. Keep this in mind if you use it.

- The `TemplateModelRoot` interface was deprecated. As of FreeMarker 2.1, you can simply use any instance of `TemplateHashModel` instead. This actually is due to a significant architectural change. Variables set or defined in a template are stored in a separate `Environment` object that only exists while the template is being rendered. Thus, the template doesn't modify the root hash.

- Changes to transformations

  - Completely rewritten `TemplateTransformModel` interface. More flexible, and does not impose output holding. More information: pgui_datamodel_directive

  - The `transform` directive now takes an optional set of key/value pairs. `<transform myTransform; `key1`=`value1`, `key2`=`value2` `...`>`. More information: `transform` directive

  - The transforms that ship with the FreeMarker core are now available by default to all templates - i.e. `<transform html_escape>` will invoke the `freemarker.template.utility.HtmlEscape` transform. More information: pgui_config_sharedvariables

- User-defined `TemplateModel` objects now can access the runtime environment (read and set variables, get the current locale, etc.) using an `Environment` instance, which can be obtained by the static `Environment.getCurrentEnvironment()` method. As a result, `TemplateScalarModel.getAsString` has been changed: it has no locale parameter.

- `TemplateExceptionHandler`-s make it possible to define your own rules on what to do when a runtime error occurs (e.g. accessing a non existing variable) during template processing. For example, you can abort template processing (recommended for most sites), or skip the problematic statement and continue template processing (similar to old behavior). DebugMode has been removed, use `TemplateExceptionHandler.DEBUG_HANDLER` or `HTML_DEBUG_HANDLER` instead.

- Logging: FreeMarker logs certain events (runtime errors for example). For more information read pgui_misc_logging.

- `SimpleIterator` was removed, but we provide a `TemplateCollectionModel` implementation: `SimpleCollection`.

- Arithmetic engine is pluggable (`Configuration.setArithmeticEngine`). The core distribution comes with two engines: `ArithmeticEngine.BIGDECIMAL_ENGINE` (the default) that converts all numbers to `BigDecimal` and then operates on them, and `ArithmeticEngine.CONSERVATIVE_ENGINE` that uses (more-or-less) the widening conversions of Java language, instead of converting everything to `BigDecimal`.

- Changes to `freemarker.ext.beans` package: The JavaBeans adapter layer has suffered several major changes. First, `BeansWrapper` is no longer a static utility class - you can now create instances of it, and every instance can have its own instance caching policy and security settings. These security settings are also new - you can now create JavaBeans wrappers that hide methods that are considered unsafe or inappropriate in a templating environment. By default, you can no longer call methods like `System.exit()` from the template (although you can manually turn off these safeguards). The `StaticModel` and `StaticModels` classes are gone; their functionality is now replaced with the `BeansWrapper.getStaticModels()` method.

- `freemarker.ext.jython` package: FreeMarker can now directly use Jython objects as data-models using the Jython wrapper.

- Changes to `freemarker.ext.jdom` package: The package now uses the Jaxen package instead of its predecessor, the werken.xpath package to evaluate XPath expressions. Since Jaxen is a successor to werken.xpath, this can be considered to be an upgrade. As a consequence, namespace prefixes are now recognized in XPath expressions and the overall XPath conformance is better.

- Better error reporting: If the processing of a template is aborted by a `TemplateException` being thrown, or using a `<#stop>` directive, FreeMarker will now output an execution trace with line and column numbers relative to the template source.

- The output is written to a simple `Writer`; no more `PrintWriter`. This redesign causes FreeMarker to no longer swallow `IOException`s during template processing.

- Various API cleanups, primarily the removing of superfluous constructor and method overloads.

##### Other changes

- Documentation has been rewritten from scratch

##### Differences between the RC1 and final release

- Added the support for date models and locale-sensitive date formatting. Date support is experimental in FreeMarker 2.1. It can change substantially in the future. Keep this in mind if you use it.

- Added the `default` built-in which makes it possible to specify default values for undefined expressions.

- `SimpleIterator` has been removed, `SimpleCollection` has been introduced

- Arithmetic engine is pluggable. The core now contains two arithmetic engines: `ArithmeticEngine.BIGDECIMAL_ENGINE` and `ArithmeticEngine.CONSERVATIVE_ENGINE`.

- `BeansWrapper` supports a new exposure level: `EXPOSE_NOTHING`

- `Constants` interface was removed. ``...`_WRAPPER` constants have been moved from `Constants` to `ObjectWrapper`, `EMPTY_STRING` constant was moved to `TemplateScalarModel`, `NOTHING` constant was moved to `TemplateModel`, `TRUE` and `FALSE` constants were moved to `TemplateBooleanModel`.

- `JAVABEANS_WRAPPER` was renamed to `BEANS_WRAPPER`

- `Configuration.get` and `put`, `putAll` were renamed to `getSharedVariable` and `setSharedVariable`, `setAllSharedVariables`

- `Configuration.getClassicCompatibility`, `setClassicCompatibility` were renamed to `isClassicCompatible`, `setClassicCompatible`

- `Template.process` method overloads with `useReflection` parameter was removed. But now we have `setObjectWrapper` method in the `Configuration`, so you can set the preferred root-object wrapper there.

- Some superfluous method overloads were removed; these changes are backward compatible with RC1

- Various minor JavaDoc and Manual improvements

- Bugfix: `include` directive has calculated the base path of relative paths wrongly

- Bugfix: We have accidentally used a J2SE 1.3 class, but FreeMarker 2.1 must able to run on J2SE 1.2

#### 2.01

The main improvement is in error reporting. Now exceptions are much more informative since they come with complete line number and column information.

The only API change between 2.0 and 2.01 was the elimination of the CacheListener/CacheEvent API. Now, if the updating of a template file fails, the exception is thrown back to the caller to handle. If you want logging to occur when a template file is updated successfully, you can override the logFileUpdate() method in FileTemplateCache.

#### 2.0

FreeMarker 2.0 final was released on 18 April 2002. The changes with respect to the previous release, 2.0 RC3 are fairly minor.

##### Bugfixes

- There were a couple of bugs in handling null values, where Lazarus did not do the same thing as FreeMarker Classic. Traditionally, in FreeMarker, nulls were treated as being equivalent to an empty string in the appropriate context. At this point, to the best of our knowledge, there is backward compatibility with FreeMarker Classic in this respect.

- Literal strings can now include line breaks. This was a backward compatibility issue with FreeMarker Classic that has been fixed.

##### Changes to the Template language

- You can use the extra built-in of `myString?web_safe` to convert a string to its "web-safe" equivalent, where problematic characters such as '<' are converted to &lt;.

- In displaying numbers with a fractional part, the rendering apparatus now respects the decimal separator of the template's locale, so that, for example, in continental Europe, you would see 1,1 and in the U.S. locale, 1.1.

##### Changes to the API

- The `getAsString()` method in the `TemplateScalarModel` interface now takes a `java.util.Locale` as a parameter. For the most part, this is a hook for later use. In the default implementation, `SimpleScalar`, this parameter is unused. If you are implementing this interface yourself, your implementation may ignore the parameter. However, it will be appealing for certain implementations.

- The constructors of `FileTemplateCache` have changed. If you are using an absolute directory on the file system as the location of your templates, you need to pass in an instance of `java.io.File` to indicate the location. If you use the constructors that take a string, this is taken to mean relative to the classloader classpath.

##### Miscellany

The ant build script build.xml now contains a target that builds a .war file containing the Hello, World and Guestbook examples. It builds a fmexamples.war. For example, if you are using Tomcat in its out-of-the-box configuration, you would place this under <TOMCAT_HOME>/webapps and then you would use http://localhost:8080/fmexamples/servlet/hello and http://localhost:8080/fmexamples/servlet/guestbook for the Hello, World and Guestbook examples respectively.

#### 2.0 RC3

FreeMarker 2.0 RC3 was released on 11 April 2002. This release was primarily devoted to fixing bugs that were reported in RC2.

##### Bug Fixes

- Variables defined in an <include...> were not available in the enclosing page. This has been fixed.

- The JavaCC parser was not configured to handle Unicode input correctly. Now, Unicode support is working.

- There was a bug when comparing a number with null. It should have returned false, but threw an exception instead. This has been fixed.

##### Changes to the Template Language

- The syntax of the include directive has changed. To indicate an unparsed include file, you do as follows:

      <include "included.html" ; parsed="n" >

  You can also indicate the encoding of the included file this way:

       <include "included.html" ; encoding="ISO-8859-5">

- The built-in myString?trim was added for trimming the leading and trailing white-space from strings.

##### API changes

- The TemplateEventAdapter machinery was taken out. This was never set up in a very useful manner and we anticipate that version 2.1 will have more complete support for logging events.

- The template caching mechanism was streamlined and simplified.

- The FileTemplateCache can now be configured to load files relative to a class loader, using the Class.getResource() call. This allows templates to be bundled up in .jar files or in a .war file for easy deployment of web-based apps.

#### 2.0 RC2

FreeMarker 2.0 RC 2 was released on 4 April 2002. Here is a summary of changes wrt to the first release.

##### Changes to Template Language

- Certain built-in functionality is provided via a new operator, '?'. Thus, `myList?size` provides the number of elements in a list. Similarly, `myString?length` provides the length of a string, `myString?upper_case` puts the string all in capital letters, and `myHash?keys` provides a sequence containing the keys in the hash. See ref_builtins for list of all available built-ins.

- Numerical comparisons can now be made using the "natural" operators < and > but there are also "web-safe" alternatives, such as \lt and \gt, since the use of these characters may confuse HTML editors and parsers. Note that these changed between rc1 and rc2, they now start with a backslash. A little asymmetry is the fact that if you use the natural greater-than or greater-than-or-equals operators (i.e. > or >=) the expression must be in parentheses. With any other operator, the parentheses are optional.

- Within an iteration loop -- i.e. a `foreach` or a `list` block -- the current count in the loop is available as the special variable ``index`_count`. where `index` is the name of the variable in the iteration. A boolean variable called ``index`_has_next` is also defined that indicates whether there are any more items in the iteration after this one. Note that the index starts at zero, so you will often be adding one to it in practice.

- The `<#break>` directive can now be used to break out of a `<#foreach...>` or a `<list...>` loop. (Prior to this version, it only worked within a switch-case block.) There is a new directive called `<#stop>` that, when encountered, simply halts processing of the template. This can be useful for debugging purposes.

- When invoking java methods that have been exposed to the page, using the code in freemarker.ext.*, there are built-ins that allow you to indicate the numerical type that you wish to pass as the value. For instance, if you had two methods, one that takes an int and another that takes a long, and you wanted to pass in a value, you would have to specify which method. `myMethod(1?int)` or `myMethod(1?long)`. This is unnecessary if there is only one method of the given name.

- Ranges can be used to get the sublist from a list or the substring of a string. For example: `myList[0..3]` will return items 0 through 3 of the list in question. Or, for example, you could get all the elements of the list except for the first and last ones via: `myList[1..(myList?size-2)]`

- Or we could get the first 6 characters of a string via `myString[0..5]`

- Lists can be concatenated using the '+' operator. Previously, this overloading of '+' only applied to strings.

- An attempt to compare a number to a string now throws an exception, since it is indicative of a coding error. Note that there is a backward compatibility mode that can be set (see below) that loosens this up in order to be able to process legacy templates.

##### API Changes

- The `TemplateSequenceModel` interface now has a `size()` method for getting the number of elements in the sequence in question.

- The `TemplateModelIterator` interface now has a `hasNext()` method.

- The default sequence and hash implementations, `freemarker.template.SimpleSequence` and `freemarker.template.SimpleHash` are now unsynchronized. If you need the methods to be synchronized, you can get a synchronized wrapper via the `synchronizedWrapper()` in either class.

- The `freemarker.utility.ExtendedList` and `freemarker.utility.ExtendedHash` classes were removed, since all of the extra keys that it defined are now available using the appropriate '?' built-in operation, i.e. `myHash?keys` or `myList?size` or `myList?last`.

- There is a method in `java.freemarker.Configuration` named `setDebugMode()` which allows you to decide whether stack traces are simply output to the web client (the best situation in development) or thrown back to the caller to be handled more gracefully (the best situation in production).

- There is a flag that can be set to turn on a processing mode that is more backward-compatible with FreeMarker Classic. This is off by default, but you can set it via `Template.setClassicCompatibility(true)`. What this does is that it allows scalars to be treated as a single-item list in a list directive. Also, it allows somewhat more looseness about types. In FreeMarker 1.x, `<#if x=="1">` and `<#if x==1>` were in fact equivalent. This meant that legacy templates might tend to be slack about this. If classic compatibility is not set, an attempt to compare the string "1" with the number 1 will result in an exception being thrown. (Note that it is preferable to get your templates working without the backward compatibility flag, since it usually will require only minor changes. However, for people with a lot of templates and no time to check over them, this flag may be of use.)

#### 2.0 RC1

The first public release of FreeMarker 2.0 was on 18 March 2002. Here is a summary of the changes in the Lazarus release, with respect to the last stable release of FreeMarker Classic.

NOTA BENE:

Despite the changes delineated above, the Lazarus release is almost entirely backward-compatible with FreeMarker Classic. We believe that most existing code and templates that work under FreeMarker Classic will continue working under Lazarus, with at most minimal changes. In practice, the most common cases where legacy template code is broken will be where assumptions were made about numbers and strings being equivalent. Note that in FreeMarker 2, 2 + 2 does not result in "22". The String "1" and the number 1 are entirely different animals and thus, any code will be broken if it relies on the boolean expression ("1"==1) being true. There is a "classic compatibility mode" that can be set via: `Template.setClassCompatibility()` that can be set so that Lazarus emulates some of the quirky behavior of FreeMarker Classic. However, any code that relied on the above "features" of FreeMarker classic really should be reworked. You are less likely to run into the other incompatibilities that are listed above. If you come across any other anomalies, please do tell us about them.

##### Support for Numerical operations, both arithmetic and boolean, as well as numerical ranges.

- Scalars can now be either strings or numbers. (In FreeMarker Classic all scalars were strings.) The basic operations allowed are addition, subtraction, multiplication, division, and modulus using the `+`, `-`, `*`, `/`, and `%` operators respectively. Arbitrary-precision arithmetic with integers and floating point numbers are provided. Though our goal is definitely to follow the principle of least surprise, for backward compatibility, the `+` operator still is used for string concatenation. If either the left hand side or the right hand side of `lhs + rhs` is non-numerical, we revert to interpreting this as string concatenation. Thus, in FreeMarker 2, 2+2 evaluates to the number 4, while any of "2"+2 or 2+"2" or "2"+"2" evaluate to the string "22". In FreeMarker Classic, rather embarrassingly, all of the above, including 2+2, evaluated to the string "22". An attempt to use any other arithmetic operator besides the `+` with non-numerical operands will cause an exception to be thrown.

- Output of a numerical expression can be made explicit via the alternative `#{....}` syntax. If the expression within the curly parentheses does not evaluate to a numerical value, an exception is thrown. The older ${....} syntax can evaluate to either a number or a string. In general, if, for logical reasons, the output must be numerical, it is preferable to use the #{...} syntax, since it adds an extra sanity check. Note that if, by some miracle, the character sequence "#{" occurs in your template, you will have to use a workaround to prevent problems. (The <noparse> directive is one possibility.)

- In this release, there is a facility for specifying the number of digits to show after the decimal point. The following code specifies to show at least 3 digits after the decimal point but not more than 6. This is optional. This option is only available if you use the #{...} syntax.

      #{foo + bar ; m3M6}

  (Note that the above is something of a stopgap measure. Future releases will move toward supporting fully internationalization and localization of number and currency formatting.

- Numerical expressions can be used in boolean expressions via the comparison operators: `lt`, `gt`, `lte`, and `gte`. In the web space, where FreeMarker is most used in practice, using the more natural operators such as < and > would tend to confuse HTML-oriented editors. An attempt to compare non-numerical expressions using these operators leads to a `TemplateException` being thrown. If, by some coincidence, you have variables named "lt", "gt", "lte", or "gte", you will have to change their names, since they are now keywords in the language.

- Numerical ranges are supported.

      <#list 1990..2001 as year>
        blah blah in the year ${year} blah
      </#list>

  The left hand and right hand sides of the `..` operator must be numerical, or an exception is thrown. They also need not be literal numbers, but can be more complex expressions that evaluate to a numerical scalar value. Note that it is also possible to write a range that descends in value:

      <#list 2001..1990 as year>
        blah blah in the year ${year} blah blah
      </#list>

##### API Changes

- The `TemplateNumberModel` interface and the `SimpleNumber` implementation were added to support exposing numerical values.

- The `TemplateListModel` API in FreeMarker Classic had some design problems -- particularly in terms of supporting thread-safe code. It has been deprecated in favor of the following API's: `TemplateCollectionModel` and `TemplateSequenceModel`. The `SimpleList` class was refactored to implement the above interfaces (and paradoxically, does not implement the TemplateListModel interface.) Code that uses the deprecated `TemplateListModel` should be refactored.

- The Expose Package by Attila Szegedi has been made an integral part of the FreeMarker distribution and is now under the freemarker.ext.* hierarchy. This package provides advanced models for representing arbitrary Java objects as template models, for representing XML documents as template models, as well as classes to facilitate the integration of FreeMarker with servlets and Ant.

- In FreeMarker Classic, there were some utility classes such as `freemarker.template.utility.Addition` etcetera that existed as workarounds for the lack of numerical operations in FreeMarker. Those have been removed and will probably not be missed.

- In FreeMarker Classic, the `SimpleScalar` object was mutable, it had a `setValue` method. This was fairly obviously a design mistake. Any code that relied on this must be refactored. Note that in this release, both `SimpleScalar` and the newly introduced `SimpleNumber` are both immutable and final.

##### Syntactical Miscellany

- The if-elseif-else syntax was introduced. FreeMarker classic only had if-else. This construct should probably (in the opinion of the author of this document -- Revusky) be used in preference to switch-case since the switch-case with fall-through is a notoriously error-prone construct for most mortal men.

- You can now do a multiple assignment in one <assign...> directive. For example: `<assign x = 1, y = price*items, message="foo">`

- A scalar will no longer be interpreted as a one-item list in a <list...> or <#foreach...> block. If you have code that relied on this feature, there is an easy workaround, since you can simply define a list literal with exactly one item.

       <assign y=[x]>
       and then...
       <list y as item>...</list>

### Installing FreeMarker

No real installation is needed. Simply ensure that `freemarker.jar` is somewhere where your Java application's class-loader will find it. In web application this usually means putting `freemarker.jar` into the `WEB-INF/lib` directory of your web application. (If you want to use FreeMarker with JSP Model-2 style (which also means that you can use custom JSP taglibs in the templates), some extra steps needed. For more information please see the chapter about servlets.)

FreeMarker has no required dependencies. But to use certain optional FreeMarker features, the related party libraries have to be available for the class-loader:

- Jaxen (recommended, download here) or Apache Xalan is needed for XML XPath support. Please use at least Jaxen 1.1-beta-8, not older versions! Apache Xalan classes are included in a package-relocated form in Sun/Oracle J2SE 1.4-1.8 (maybe later too), and FreeMarker will use those if it doesn't find Jaxen or Xalan elsewhere. But as Oracle can change these internal packages anytime, it's still recommended to use an external Jaxen or Xalan.

- Obviously, `javax.servlet` classes are needed for `FreemarkerServlet`. Servlet version 2.2 or later is needed.

- For the custom JSP taglib support, you will need JSP 1.2 API or later avilable. No JSP implementation is needed, just the API. This is already present in pretty much every servlet container. For more information please see the chapter about servlets.

- Jython classes are needed for the Jython wrapper.

- Pre-1.0 JDOM is needed for the long deprecated `freemarker.ext.jdom` package. (When it was created, there was no JDOM 1.0 yet.)

### Legal

#### License

    Copyright 2014 Attila Szegedi, Daniel Dekany, Jonathan Revusky

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

    ==============================================================================
    END LICENSE

    FreeMarker subcomponents with different copyright owners
    --------------------------------------------------------

    FreeMarker, both in its source code and binary form (freemarker.jar)
    includes a number of files that are licensed by the Apache Software
    Foundation under the Apache License, Version 2.0. This is the same
    license as the license of FreeMaker, but the copyright owner is the
    Apache Software Foundation. These files are:

        freemarker/ext/jsp/web-app_2_2.dtd
        freemarker/ext/jsp/web-app_2_3.dtd
        freemarker/ext/jsp/web-jsptaglibrary_1_1.dtd
        freemarker/ext/jsp/web-jsptaglibrary_1_2.dtd

    Historical notes
    ----------------

    FreeMarker 1.x was released under the LGPL license. Later, by
    community consensus, we have switched over to a BSD-style license. As
    of FreeMarker 2.2pre1, the original author, Benjamin Geer, has
    relinquished the copyright in behalf of Visigoth Software Society.

    With FreeMarker 2.3.21 the license has changed to Apache License,
    Version 2.0, and the owner has changed from Visigoth Software Society
    to three of the FreeMarker 2.x developers, Attila Szegedi, Daniel
    Dekany, and Jonathan Revusky.

#### Export Control

The FreeMarker source code doesn't include cryptography. Furthermore its binary (downloadable) forms don't include any cryptography software. Hence, FreeMarker has no Export Control Classification Number (ECCN). Where an ECCN should be filled, the label "not subject to EAR" could be used.

FreeMarker itself doesn't add any exporting limitations.

Start-tag

Tag, which indicates that the following content is under the element, up to the end-tag. The start-tag may also specifies attributes for the element. An example of a start-tag: `<body bgcolor=black>`

Boolean

This is a variable type. A boolean variable represents a logical true or false (yes or no). For example, if the visitor has been logged in or not. There are only two possible boolean values: `true` and `false`. Typically, you will use booleans with an `<#if `...`>` directive when you want to display text based on some condition, say, you show a certain part of the page only for visitors who has logged in.

Character

A symbol that people use in writing. Examples of characters: Latin capital letter A (``A''), Latin small letter A (``a''), digit four (``4''), number sign (``#''), colon (``:'')

Charset

A charset is a rule (algorithm) for transforming a sequence of characters (text) to a sequence of bits (or in practice, to a sequence of bytes). Whenever a character sequence is stored on a digital media, or sent through a digital channel (network), a charset must be applied. Examples of charsets are ISO-8859-1, ISO-8859-6, Shift_JIS , UTF-8.

The capabilities of different charsers are different, that is, not all charsets can be used for all languages. For example ISO-8859-1 can't represent Arabic letters, but ISO-8859-6 can, however it can't represent the accented letters that that ISO-8859-1 can. Most charsets are highly restrictive regarding the allowed characters. UTF-8 allows virtually all possible characters, but most text editors can't handle it yet (2004).

When different software components exchange text (as the HTTP server and the browser, or the text editor you use for saving templates and FreeMarker who loads them), it's very important that they agree in the charset used for the binary encoding of the text. If they don't, then the binary data will be misinterpreted by the receiver (loader) component, which usually results in the distortion of the non-English letters.

Output encoding

Means output charset. In the Java world the term ``encoding'' is commonly (mis)used as a synonym to ``charset''.

Template encoding

Means template charset. In the Java world the term ``encoding'' is commonly (mis)used as a synonym to ``charset''.

Collection

A variable that (in conjunction with the `list` directive) can spit out a series of variables.

Data-model

Something that holds the information the template has to show (or use in some other ways) when the template processor assembles the output (e.g. a Web page). In FreeMarker this is best visualized as a tree.

Directive

Instructions to FreeMarker used in FTL templates. They are invoked by FTL tags.

Element

Elements are the most fundamental building pieces of SGML documents; an SGML document is basically a tree of elements. Example of elements used in HTML: body, head, title, p, h1, h2.

End-tag

Tag, which indicates that the following content is not under the element. Example: `</body>`.

Environment

An `Environment` object stores the runtime state of a single template template processing job. That is, for each `Template.process(`...`)` call, an `Environment` instance will be created, and then discarded when `process` returns. This object stores the set of temporary variables created by the template, the value of settings set by the template, the reference to the data-model root, etc. Everything that is needed to fulfill the template processing job.

Extensible Markup Language

A subset (restricted version) of SGML. This is less powerful than SGML, but it easier to learn and much easier to process with programs. If you are an HTML author: XML documents are similar to HTML documents, but the XML standard doesn't specify the usable elements. XML is a much more general-purpose thing than HTML. For example you can use XML to describe Web pages (like HTML) or to describe non-visual information like a phone book database.

SGML
FreeMarker Template Language

Simple programming language designed to write text file templates, especially HTML templates.

FTL
FTL tag

Tag-like text fragment used to invoke FreeMarker directives in FTL templates. These are similar to HTML or XML tags at the first glance. The most prominent difference is that the tag name is started with `#` or `@`. Another important difference is that FTL tags do not use attributes, but a substantially different syntax to specify parameters. Examples of FTL tags: `<#if newUser>`, `</#if>`, `<@menuitem title="Projects" link="projects.html"/>`

Hash

A variable that acts as a container that stores sub variables that can be retrieved via a string that is a lookup name.

Line break

Line break is a special character (or a sequence of special characters) that causes a line breaking when you see the text as plain text (say, when you read the text with Windows notepad). Typically you type this character by hitting ENTER or RETURN key. The line break is represented with different characters on different platforms (to cause incompatibility and confusion...): ``line feed'' character on UNIX-es, ``carriage return'' character on Macintosh, ``carriage return''+``line feed'' (two characters!) on Windows and DOS. Note that line breaks in HTML do not have a visual effect when viewed in a browser; you must use markup such as `<BR>` for that. This manual never means `<BR>` when it says ``line-break''.

Macro definition body

The template fragment between the `<#macro `...`>` and `</#macro>`. This template fragment will be executed when you call the macro (for example as `<@myMacro/>`).

Method

A variable that calculates something based on parameters you give, and returns the result.

MVC pattern

MVC stands for Model View Controller. It's a design pattern started his life in the 70's as a framework developer by Trygve Reenskaug for Smalltalk, and was used primary for for UI-s (user interfaces). MVC considers three roles:

- Model: Model represents application (domain) specific information in a non-visual way. For example, an array of product objects in the memory of your computer is the part of the model.

- View: View displays the model and provides UI. For example, it's the task of the view component to render the array of product objects to a HTML page.

- Controller: The controller handles user input, modifies the model, and ensures that the view is updated when needed. For example it is the task of controller to take the incoming HTTP requests, parse the received parameters (forms), dispatch the requests to the proper business logic object, and chose the right template for the HTTP response.

The most important thing for us when applying MVC for Web applications is the separation of View from the other two roles. This allows the separation of designers (HTML authors) from programmers. Designers deal with the visual aspects, programmers deal with the application logic and other technical issues; everybody works on what he is good at. Designers and programmers are less dependent on each other. Designers can change the appearance without programmers having to change or recompile the program.

For more information I recommend reading chapter 4.4 of Designing Enterprise Applications with the J2EE Platform blueprint.

Predefined directive

Directive what is defined by FreeMarker, thus always available. Example of predefined directives: `if`, `list`, `include`

Scalar

A scalar variable stores a single value. A scalar is either a string or a number or a date/time or a boolean.

Sequence

A sequence is a variable that contains a sequence of sub variables. The sequence's sub variables are accessible via numerical index, where the index of the very first object is 0, the index of the second objects is 1, the index of the third object is 2, etc.

Regular expression

A regular expression is a string that specifies a set of strings that matches it. For example, the regular expression `"fo*"` matches `"f"`, `"fo"`, `"foo"`, etc. Regular expressions are used in several languages and other tools. In FreeMarker, the usage of them is a ``power user'' option. So if you have never used them before, there is no need to worry about not being familiar with them. But if you are interested in regular expressions, you can find several Web pages and books about them. FreeMarker uses the variation of regular expressions described at: http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html

SGML
Standard Generalized Markup Language

This is an international standard (ISO 8879) that specifies the rules for the creation of platform-independent markup languages. HTML is a markup language created with SGML. XML is a subset (restricted version) of SGML.

XML
String

A sequence of characters such as ``m'', ``o'', ``u'', ``s'', ``e''.

Tag

Text fragment indicating the usage of an element in SGML. Examples of tags: `<body bgcolor=black>`, `</body>`

Template

A template is a text file with some special character sequences embedded into it. A template processor (e.g. FreeMarker) will interpret special character sequences and it outputs a more or less different text from the original text file, where the differences are often based on a data-model. Thus, the original text acts as a template of the possible outputs.

Template processing job

A template processing job is the act when FreeMarker merges a template with a data-model to produce the output for a visitor. Note that this may includes the execution of multiple template files because the template file used for the Web page may invokes other templates with `include` and `import` directives. Each template-processing job is a separated cosmos that exists only for the short period of time while the given page is being rendered for the visitor, and then it vanishes with all the variables created in the templates (for example, variables created with `assign`, `macro` or `global` directives).

Transform

This term refers to user-defined directives that are implemetned with the now obsolete `TemplateTransformModel` Java interface. The feature was originally made for implementing output filters, hence the name.

Thread-safe

An object is thread-safe if it is safe to call its methods from multiple threads, even in parallel (i.e. multiple threads execute the methods of the object at the same time). Non-thread-safe objects may behave unpredictably in this situation, and generate wrong results, corrupt internal data structures, etc. Thread-safety is typically achieved in two ways with Java: with the usage `synchronized` statement (or `synchronized` methods), and with the immutability of encapsulated data (i.e. you can't modify the field after you have created the object).

User-defined directive

Directive that is not defined by the FreeMarker core, but by the user. These are typically application domain specific directives, like pull-down menu generation directives, HTML form handling directives.

UCS

This is international standard (ISO-10646) that defines a huge set of characters and assigns a unique number for each character (``!'' is 33, ..., ``A'' is 61, ``B'' is 62, ..., Arabic letter hamza is 1569... etc.). This character set (not charset) contains almost all characters used today (Latin alphabet, Cyrillic alphabet, Chinese letters, etc.). The idea behind UCS is that we can specify any character with a unique number, not mater what the platform or the language is.

Unicode

De-facto standard developed by Unicode organization. It deals with the classification of the characters in UCS (which is letter, which is digit, which is uppercase, which is lowercase, etc.), and with other problems of processing text made from the characters of UCS (e.g. normalization).

White-space(空白)

完全透明的字符，但是对文本的视觉呈现会有作用。 空白字符的示例:空格，制表符(水平和垂直)，换行符(CR和LF)，换页。

XML
Attribute(属性)

为了连接 XML 或HTML (或通用的 SGML)，属性是关联元素的命名的值。 比如，在 `<body bgcolor=black text=green>`...`</body>`中， 属性是 `bgcolor=black` 和 `text=green`。 在符号 `=` 的左边是属性的名字，而在右边的是属性的值。 注意在XML中，值必须是被引号引起来的(比如：`<body bgcolor="black" text='green'>`)，而在HTML中它对某些值是可选的。

Full-qualified name(完全限定名)

... 对于结点来说(XML结点或其它FTL结点变量)： 结点的完全限定名不仅仅指定结点名称 (``node`?node_name`)， 而且指定结点的命名空间 (``node`?node_namespace`)， 这种方式明确地指出结点的确定类型。完全限定名的格式是 ``nodeName`` 或 ``prefix`:`nodeName``。 前缀是识别结点命名空间(结点的命名空间通常是使用很长的URI来指定的)的速记形式。 在FTL中，前缀使用`ftl` 指令 的 `ns_prefixes` 参数和结点的命名空间相关联。 在XML文件中，前缀使用 `xmlns:`prefix`` 属性和结点的命名空间相关联。如果默认的命名空间被定义了， 缺少前缀说明结点使用默认的命名空间；否则就说明结点不属于任何结点命名空间。 FTL中定义的默认结点命名空间通过使用 `ftl` 指令 的 `ns_prefixes` 参数来注册保留前缀 `D`。 在XML文件中，使用属性 `xmlns` 来定义。

... 对于Java类来说：Java类的完全限定名包含类名和所属包的名字。 这种方式明确地指出了类，而不管其内容。类的完全限定名示例： `java.util.Map` (和 `Map`相对)。

## 字母顺序索引