1、FreeMarker macro(宏)的使用.txt14 热情是一种巨大的力量，从心灵内部迸发而出，激励我们发挥出无穷的智慧和活力；热情是一根强大的支柱，无论面临怎样的困境，总能催生我们乐观的斗志和顽强的毅力没有热情，生命的天空就没的色彩。FreeMarker macro(宏)的使用 有人说用 freemarker，但没有用到它的宏（macro） ，就没有真正用过 freemarker。说的就是宏是 freemarker 的一大特色。 宏的定义可以查看相关的文档，里面介绍得很清楚，下面来看看它的一个用法（javaeye 帖子里有讨论） 。 /WEB-INF/template/common/co
2、mmon.ftl： $title 然后在 freemarker.properties 里定义： auto_import=/WEB-INF/template/common/common.ftl as c 然后其他的 ftl 文件就可以使用它了 test.ftl： 你的内容 如果不在 freemarker.properties 里定义，可以在每个文件里包含这个 ftl： 不同的场合有不同的运用。使用得好的话，将会大大节省你的开发时间。 macro, nested, return 语法 . . . 用例 Test text, and the params: $foo, $bar, $baaz 输出
3、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 定义循环输出的宏 $title?cap_first: $x?cap_first 输出结果 Animals: Mouse Elephant Python 包含 body 的宏 $c. $halfc Last! 输出 1. 0.5 2. 1 3. 1.5 4. 2 Last! - 注意在使用的时候：别忘了双
4、引号。 宏 Macro 宏是在模板中使用 macro 指令定义 l.1 基本用法 宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量，下面是一个例子： Hello Joe! 调用宏时，与使用 FreeMarker 的其他指令类似，只是使用替代 FTL 标记中的#。 在 macro 指令中可以在宏变量之后定义参数，如： Hello $person! 可以这样使用这个宏变量： 但是下面的代码具有不同的意思： 这意味着将 Fred 变量的值传给 person 参数，该值不仅是字符串，还可以是其它类型，甚至是复杂的表达式。 宏可以有多参数，下面是一个例子： Hello $person
5、! 可以这样使用该宏变量，其中参数的次序是无关的： 可以在定义参数时指定缺省值，否则，在调用宏的时候，必须对所有参数赋值： Hello $person! 注意：宏的参数是局部变量，只能在宏定义中有效。 嵌套内容 FreeMarker 的宏可以有嵌套内容，指令会执行宏调用指令开始和结束标记之间的模板片断，举一个简单的例子： 执行宏调用： The bordered text 输出结果： The bordered text 指令可以被多次调用，每次都会执行相同的内容。 Anything. FMPP 输出结果： Anything.Anything.Anything. 嵌套内容可以是有效的 FTL，下面
6、是一个有些复杂的例子，我们将上面三个宏组合起来： 输出结果： Hello Joe!Hello Joe!Hello Joe! 宏定义中的局部变量对嵌套内容是不可见的，例如： $y $count/$x: $y?default(“?“) $x?default(“?“) $count?default(“?“) 输出结果： test 3/1: ? ? ?test 3/2: ? ? ?test 3/3: ? ? ? 在宏定义中使用循环变量 nestted 指令也可以有循环变量（循环变量的含义见下节） ，调用宏的时候在宏指令的参数后面依次列出循环变量的名字，格式如下： 例如： $c. $halfc Last
7、! 这里 count 是宏的参数，c, halfc,last 则为循环变量，输出结果： 1. 0.5 2. 1 3. 1.5 4. 2 Last! 循环变量和宏标记指定的不同不会有问题，如果调用时少指定了循环变量，那么多余的值不可见。调用时多指定了循环变量，多余的循环变量不会被创建： $c. $halfc Last! $c. $halfc Just repeat it. 在模板中定义变量 在模板中定义的变量有三种类型： plain 变量：可以在模板的任何地方访问，包括使用 include 指令插入的模板，使用 assign指令创建和替换。 局部变量：在宏定义体中有效，使用 local 指令创建
8、和替换。 循环变量：只能存在于指令的嵌套内容，由指令（如 list）自动创建；宏的参数是局部变量，而不是循环变量 局部变量隐藏（而不是覆盖）同名的 plain 变量；循环变量隐藏同名的局部变量和 plain 变量，下面是一个例子： $x 6. $x 7. $x 8. $x 9. $x 2. $x 3. $x 4. $x 5. $x 输出结果： 1. plain 2. plain 3. local 4. loop 5. local 6. plain 7. loop 8. loop 9. plain2 内部循环变量隐藏同名的外部循环变量，如： $x $x $x $x $x 输出结果： loop 1
9、 loop 2 loop 3 loop 2 loop 1 模板中的变量会隐藏（而不是覆盖）数据模型中同名变量，如果需要访问数据模型中的同名变量，使用特殊变量 global，下面的例子假设数据模型中的 user 的值是 Big Joe： $user $.globals.user 名字空间 通常情况，只使用一个名字空间，称为主名字空间，但为了创建可重用的宏、变换器或其它变量的集合（通常称库） ，必须使用多名字空间，其目的是防止同名冲突 创建库 下面是一个创建库的例子（假设保存在 lib/my_test.ftl 中）： Copyright (C) $date Julia Smith. All rig
10、hts reserved. Email: $mail 使用 import 指令导入库到模板中，Freemarker 会为导入的库创建新的名字空间，并可以通过 import 指令中指定的散列变量访问库中的变量： $my.mail$mail 输出结果： Copyright (C) 1999-2002 Julia Smith. All rights reserved. Email: 可以看到例子中使用的两个同名变量并没有冲突，因为它们位于不同的名字空间。还可以使用 assign 指令在导入的名字空间中创建或替代变量，下面是一个例子： $my.mail$my.mail 输出结果： 数据模型中的变量
11、任何地方都可见，也包括不同的名字空间，下面是修改的库： Copyright (C) $date $user. All rights reserved. 假设数据模型中的 user 变量的值是 Fred，则下面的代码： $my.mail 输出结果： Copyright (C) 1999-2002 Fred. All rights reserved.F 选择 Velocity 还是 FreeMarker? Velocity 是另外一个优秀的模板引擎，它是 FreeMarker 的有力竞争者。但是它的模板语言不够强大，也不够严谨。 除开 FreeMarker 内建的 Velocity 所没有的强大函
12、数外，FreeMarker 还在以下方面更胜一筹： 与 Velocity 相比，FreeMarker 对表现逻辑和业务逻辑的划分更为严格，Freemarker 在模板中不允许对 Servlet API 进行直接操作（而 Velocity 可以） ，如 FreeMarker 中禁止对HttpServletRequest 对象直接访问（但可以访问 HttpServletRequest 对象中的Attribute） 。通过更加严格的隔离机制，牵涉逻辑处理的操作被强制转移到逻辑层。从而完全保证了层次之间的清晰性。 另外一个 Velocity 无法实现的特性，也是最具备实际意义的特性：FreeMarker 提供了强大的宏。 此 外，FreeMarker 对 JSP Tag 提供了良好支持。我们可以将 FreeMarker 看作是仅允许使用 TAG 的 JSP 页面（实际上，FreeMarker 的表达式语法与 EL 语法也非常类似） 。从开发角度而言，只允许使用 TAG 的 JSP 页面，已经在很大程度上保证了页面表现逻辑与业务逻辑的分离。程序员在 JSP Script 中混杂逻辑代码的原因，大部分是出于慵懒，只要无法在页面模板中直接编写 Java 代码，相信程序员也不会去专门编写一个 JSP TAG 来刻意违反层次划分原则。
