`

FreeMarker学习(二)

阅读更多
用户定义指令-使用@符合来调用
有两种不同的类型:Macro(宏)和transform(传递器),Macro是在模板中使用macro指令定义,而transform是在模板外由程序定义(基本上都是基于Java的),这里通过Macro来介绍自定义指令。
例一:
<#macro greet>
  <font size="+2">Hello Joe!</font>
</#macro> 
使用:<@greet></@greet> 或 <@greet/>
结果:<font size="+2">Hello Joe!</font>

参数-在macro指令中可以在宏变量之后定义参数
例二:
<#macro greet person>
  <font size="+2">Hello ${person}!</font>
</#macro>
使用:<@greet person="Fred"/> and <@greet person="Batman"/>
结果: <font size="+2">Hello Fred!</font> and <font size="+2">Hello Batman!</font>

macro可以有多个参数,参数的次序是无关的,在macro指令中只能使用定义的参数,并且必须对所有参数赋值,可以在定义参数时指定缺省值:

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


在自定义指令嵌套内容:模板片断中使用<#nested>指令

<#macro border>
  <table border=4 cellspacing=0 cellpadding=4><tr><td>
    <#nested>
  </tr></td></table>
</#macro>
使用:<@border>The bordered text</@border>
结果:

<table border=4 cellspacing=0 cellpadding=4>
<tr><td>The bordered text
</tr></td></table>
<#nested>指令可以被多次调用:

<#macro do_thrice>
  <#nested>
  <#nested>
  <#nested>
</#macro>
使用:
<@do_thrice>Anything.</@do_thrice> 
结果:
Anything.
Anything.
Anything.

注意:嵌套内容是无法访问到macro中的局部变量的。
例如:

<#macro repeat count>
  <#local y = "test">
  <#list 1..count as x>
    ${y} ${count}/${x}: <#nested>
  </#list>
</#macro>
<@repeat count=3>${y?default("?")} ${x?default("?")} ${count?default("?")}</@repeat>
结果:
test 3/1: ? ? ?
test 3/2: ? ? ?
test 3/3: ? ? ?


下面是一个嵌套使用自定义指令的例子:

<@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中使用循环变量-作为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!

注意:循环变量和用户定义指令开始标记指定的数目可以不同,调用时少指定循环变量,则多指定的值不可见,调用时多指定循环变量,多余的循环变量不会被创建。

模板中的变量,有三种类型:
1.) plain(全局)变量:可以在模板的任何地方访问,包括使用include指令插入的模板,使用assign指令创建和替换
2.) 局部变量:在macro中有效,使用local指令创建和替换
3.) 循环变量:只能存在于指令的嵌套内容,由指令(如list)自动创建;宏的参数是局部变量,而不是循环变量

用assign指令创建和替换的例子:

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

局部变量隐藏(而不是覆盖)同名的plain变量;循环变量隐藏同名的局部变量和plain变量,下面是一个例子:

<#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

模板中的变量会隐藏(而不是覆盖)数据模型中同名变量,如果需要访问数据模型中的同名变量,使用特殊变量global,下面的例子假设数据模型中的user的值是Big Joe:

<#assign user = "Joe Hider">
${user}          <#-- prints: Joe Hider -->
${.globals.user} <#-- prints: Big Joe --> 
命名(namespaces)空间-通常情况,只使用一个命名空间,称为主命名空间(main namespace),但你是不会意识到这些的;为了创建可重用的macro、transforms或其它变量的集合(通常称库),必须使用多命名空间,为了防止同名冲突。

首先创建一个库(假设保存在lib/my_test.ftl中):

<#macro copyright date>
  <p>Copyright (C) ${date} Julia Smith. All rights reserved.
  <br>Email: ${mail}</p>
</#macro> 
<#assign mail = "jsmith@acme.com">
使用import指令导入库到模板中,Freemarker会为导入的库创建新的命名空间,并可以通过import指令中指定的hash(散列)变量访问库中的变量:

<#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 
上面的例子中使用的两个同名变量并没有冲突,因为它们位于不同的命名空间

可以使用assign指令在导入的命名空间中创建或替代变量:

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

数据模型中的变量任何地方都可见,也包括不同的命名空间,下面修改了刚才创建的库:

<#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 

分享到:
评论

相关推荐

    FreeMarker相关学习文档

    二、FreeMarker的主要特性 1. 非脚本语言:FreeMarker模板不包含执行逻辑,所有逻辑都在后端Java代码中处理,这有助于保持模板清晰,易于维护。 2. 高效性:由于模板在服务器端预编译为Java代码,因此FreeMarker执行...

    FreeMarker学习资料

    ### FreeMarker 学习资料详解 #### 一、FreeMarker 模板文件构成 FreeMarker 是一种用于生成动态文档的工具,它通过结合固定的文本、注释、变量(插值)以及指令(FTL标签)来创建动态内容。具体而言,FreeMarker ...

    FreeMarker学习代码小结

    在本篇文章中,我们将深入探讨FreeMarker的学习要点,包括其基本概念、语法以及实际应用。 一、基本概念 1. 模板(Template):FreeMarker的中心是模板文件,它是一种特殊的文本文件,包含固定文本和变量。变量是由...

    Freemarker学习总结.pdf

    二、Hash的内置函数: 1. `hash?keys`:返回Hash的所有键,形成一个Sequence。 2. `hash?values`:返回Hash的所有值,形成一个Sequence。例如: ```freemarker , "sex": "man" } /&gt; ${key}=${user[key]} `...

    FreeMarker学习笔记

    ### FreeMarker 学习笔记知识点总结 #### 一、FreeMarker 概览 FreeMarker 是一个用 Java 编写的模板引擎,它可以帮助开发者快速生成 HTML 页面或其他格式的文档。其核心概念包括模板、数据模型以及如何将两者结合...

    freemarker-2.3.22

    `freemarker.jar`是Freemarker库的二进制文件,它是实际运行时需要导入到Java项目的类路径中的,以便使用Freemarker的功能,如创建模板、解析数据模型并生成最终输出。 `source`目录可能包含了Freemarker 2.3.22的...

    freemarker入门文档及例子

    通过阅读“freemarker学习”和“freemarkerѧϰ”这两个文件,你可以深入了解Freemarker的语法和实际应用场景,逐步掌握这个强大的模板引擎。不断练习和实践,你将在不久的将来成为一名熟练的Freemarker开发者,能够...

    FreeMarker指令学习

    二、FreeMarker的主要指令 1. `&lt;#assign&gt;`:用于创建新的变量或者重定义已有的变量。例如: ```html 张三"&gt; ``` 2. `&lt;#if&gt;` 和 `&lt;#else&gt;`:条件判断指令,类似于Java中的`if...else`语句。例如: ```html ()&gt;...

    freemarker编辑器

    Freemarker的模板语言(FTL)非常简洁,易于学习,且不包含任何控制结构,这些都在Java代码中处理。 二、配置Freemarker编辑器 配置Freemarker编辑器是为了提供一个友好的开发环境,帮助开发者编写和调试模板。通常...

    freemarker代码

    二、Freemarker语法 1. 输出表达式:`${...}`用于输出变量或表达式的值。 2. 注释:`&lt;#-- ... --&gt;`用于在模板中插入注释,这些注释不会出现在生成的输出中。 3. 控制结构:Freemarker提供了`&lt;#if&gt;`、`&lt;#else&gt;`、`...

    freemarker wrod 统计图的生成

    FreeMarker 是一个强大的模板引擎,常用于动态生成HTML、Word...最后,压缩包中的"freemarker"文件可能是FreeMarker的示例代码或模板,供你参考和学习。记得根据实际情况调整和测试代码,确保其在你的项目中正常工作。

    Freemarker2.3.16_带简单教程

    《freemarker-2.3.16》可能是Freemarker 2.3.16的源码或二进制库,对于开发者来说,可以深入研究其内部机制,或者为特定需求进行定制。 通过这些资料,你可以全面了解并掌握Freemarker的使用,从基础语法到高级特性...

    学习FreeMarker入门文档

    #### 二、FreeMarker的灵活性与适用性 FreeMarker不仅限于Web应用,其独立于容器的设计使其同样适用于非Web环境下的应用程序。这意味着开发者可以在各种场景下利用FreeMarker的强大功能,无论是创建Web页面还是生成...

    FreeMarker 2.3.18

    在`FreeMarker语法之表达式(一)`和`FreeMarker语法之表达式(二)`中,详细解释了各种类型的表达式,包括访问对象属性、数组和集合等。 - **遍历List**:在`Freemarker中如何遍历List.mht`中,会讲解如何使用`...

    freemarker 学习手册

    Freemarker是一个强大的模板引擎,主要...通过深入学习和熟练运用Freemarker,开发者可以构建出高效、灵活且易于维护的Web应用视图层。在实际项目中,结合WebWork或其他MVC框架,可以充分发挥其优势,提升开发效率。

    freemarker中文手册

    综上,这份Freemarker中文手册涵盖了Freemarker的基本概念、语法、内置函数、与Java的交互方式以及高级特性和最佳实践,是学习和使用Freemarker不可或缺的参考资料。通过深入阅读和实践,开发者能够熟练地运用...

    freemarker源码.rar

    这个"freemarker源码.rar"文件包含了Freemarker的源代码,对于想要深入了解其内部工作原理或者进行二次开发的开发者来说,是一份宝贵的资料。 源码分析通常包括以下几个方面: 1. **模板语言解析**:Freemarker...

    JEECMS自学帮助集合(包括FreeMarker)

    通过这些资源,你可以系统地学习JEECMS的各个方面,从基础操作到高级开发,再到FreeMarker的运用,都能得到全面的指导。不过,请注意,由于这些资源来源于网络,可能存在版本差异或更新不及时的情况,因此在学习时...

    freemarker生成doc方案

    二、生成.doc文档流程 1. **设置模板**: 创建一个FTL(Freemarker Template Language)文件,例如`template.ftl`。在这个文件中,你可以使用Freemarker语法来定义文档的结构和内容,比如使用`&lt;#if&gt;`、`&lt;#foreach&gt;`等...

    FreeMarker中文版word文档

    #### 二、FreeMarker的版本与翻译 根据给定的部分内容,可以看出该文档是FreeMarker 2.3.18版本的手册中文翻译版,由南磊翻译完成。该手册遵循Creative Commons Attribution 3.0 Unported许可协议发布,这意味着...

Global site tag (gtag.js) - Google Analytics