`
zyslovely
  • 浏览: 231193 次
  • 性别: Icon_minigender_1
  • 来自: 杭州
社区版块
存档分类
最新评论

freemarker 宏

阅读更多
Freemarker宏

还在抄,原文:www.softleader.com.tw:8668/space/FreeMarker+3+%E5%AE%8F

                                                  Freemarker宏

一.什么是宏:macro

宏是在模板中使用macro指令定义

   基本用法

宏是和某个变量关联的模板片断,以便在模板中通过用户定义指令使用该变量,

Java代码

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

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



   调用宏时,与使用FreeMarker的其他指令类似,只是使用@替代FTL标记中的#。

<@greet></@greet> <#--<@greet/>-->
在macro指令中可以在宏变量之后定义参数,如:
Java代码

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

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



可以这样使用这个宏变量:

<@greet person="Fred"/>

但是下面的代码具有不同的意思:
<@greet person=Fred/>

这意味着将Fred变量的值传给person参数,该值不仅是字符串,还可以是其它类型,甚至是复杂的表达式。





宏可以有多参数,下面是一个例子:

Java代码

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

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



可以这样使用该宏变量,其中参数的次序是无关的:

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



    可以在定义参数时指定缺省值,否则,在调用宏的时候,必须对所有参数赋值:

<#macro greet person color="black">
    <font size="+2" color="${color}">Hello ${person}!</font>
  </#macro>
注意:宏的参数是局部变量,只能在宏定义中有效。
嵌套内容
FreeMarker的宏可以有嵌套内容,<#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>

FMPP 输出结果:

Anything.
   Anything.
   Anything.

嵌套内容可以是有效的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>

  <table border=4 cellspacing=0 cellpadding=4><tr><td>
宏定义中的局部变量对嵌套内容是不可见的,例如:

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



在宏定义中使用循环变量

nestted指令也可以有循环变量(循环变量的含义见下节),调用宏的时候在宏指令的参数后面依次列出循环变量的名字,格式如下:

<@ macro_name paramter list; loop variable list[,]>

例如:

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

这里count是宏的参数,c, halfc,last则为循环变量,输出结果:

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

循环变量和宏标记指定的不同不会有问题,如果调用时少指定了循环变量,那么多余的值不可见。调用时多指定了循环变量,多余的循环变量不会被创建:

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



在模版中定义变量

在模板中定义的变量有三种类型:


  
plain变量:可以在模板的任何地方访问,包括使用include指令插入的模板,使用assign指令创建和替换。

  
局部变量:在宏定义体中有效,使用local指令创建和替换。

  
循环变量:只能存在于指令的嵌套内容,由指令(如list)自动创建;宏的参数是局部变量,而不是循环变量





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


<#assign x = "plain">
  ${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 -->



名字空间



通常情况,只使用一个名字空间,称为主名字空间,但为了创建可重用的宏、变换器或其它变量的集合(通常称库),必须使用多名字空间,其目的是防止同名冲突



创建库

下面是一个创建库的例子(假设保存在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指令中指定的散列变量访问库中的变量:

  <#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宏 和 Jquery 做树(Hbiernate和JDBC版)

    标题 "原创 用FreeMarker宏 和 Jquery 做树(Hbiernate和JDBC版)" 描述了如何使用FreeMarker模板引擎的宏功能,结合jQuery库,创建一个可展示层次结构数据的树形视图。在这个过程中,可能涉及了两个主要的技术:...

    freemarker 实现宏分页

    首先,理解FreeMarker宏的概念。在FreeMarker模板语言中,宏类似于HTML中的自定义标签,可以复用和封装复杂的逻辑。通过定义宏,我们可以创建一个通用的分页组件,便于在多个页面上重复使用。 1. **宏定义**: 在...

    s2sh+freemarker+jquery+jquery-treeview 无限级树形菜单.rar

    本项目“s2sh+freemarker+jquery+jquery-treeview 无限级树形菜单”就是这样一个解决方案,它整合了多种技术来实现这一功能。 首先,我们来看“s2sh”。这是Struts2、Spring和Hibernate三者的简称,它们分别是MVC...

    Freemarker分页

    4. **Freemarker模板**:在Freemarker模板中,你可以使用Struts2提供的`&lt;s:iterator&gt;`标签遍历当前页的数据,同时使用自定义的Freemarker宏或Struts2的`&lt;s:url&gt;`标签生成分页链接。例如,可以创建一个`pagination....

    FreeMarker技术资料大集合包括宏以及一些列中文开发手册和技术文档

    FreeMarker技术资料大集合包括宏以及一些列中文开发手册和技术文档其中包括:FreeMarker2.3.7_Manual_zh_CN,Freemarker-2.3.16 API,FreeMarker详细讲解,FreeMarker宏和freemarker中文手册。对新手学习freemarker...

    FreeMarker页面制作规范

    ** 使用FreeMarker宏的主要好处包括: - **统一风格**:通过宏可以确保页面中重复出现的部分具有一致的样式。 - **代码复用**:避免重复编写相同的代码,减少错误发生的可能性。 - **易于维护**:只需要更新宏的...

    FreeMarker分页宏模板freemarker-pagenav.zip

    好用的 freemarker 分页宏模板dom结构比较主流的一个分页一排显示10个分页按钮(想定制的话把页码提取出来做为参数即可)pagenav.previousPage 存着上一页pagenav.totalPage 总页数pagenav.pageNo 当前页面页码page...

    freemarker自定义分页标签宏

    在这个主题“freemarker自定义分页标签宏”中,我们将深入探讨如何在FreeMarker中创建自定义的分页标签宏,以便更有效地管理和展示大量数据。 首先,分页是一种常见的网页设计技术,用于将大量数据分割成小块,使...

    FreeMarkermacro宏的使用.doc

    以下是对FreeMarker宏的详细解释: **宏的定义:** 在FreeMarker中,你可以通过`&lt;#macro&gt;`标签来定义一个宏。例如: ```ftl ; charset=GBK" /&gt; ${title} ``` 这段代码定义了一个名为`html`的宏,...

    freemarker Demo 适用于freemarker初学

    Freemarker支持丰富的表达式,如`${user.name}`用来获取user对象的name属性,`&lt;@util.formatDate date='yyyy-MM-dd'/&gt;`调用自定义宏进行日期格式化。 8. **控制结构** Freemarker提供了条件语句(`&lt;#if&gt;`, `...

    FreeMarker通用的分页

    FreeMarker中的宏允许我们封装可重用的代码块,这在实现通用分页时显得尤为重要。宏`genPagination`是为分页而创建的核心组件,其参数包括: - `url`:指定的URL,用于构建页面链接。 - `totalPages`:总页数。 - `...

    freemarker-2.3.28.jar

    7. **宏与导入**: 它允许用户定义可重用的代码块,称为宏,并通过`&lt;@import&gt;`指令引入其他模板,提高了代码的复用性和组织性。 8. **条件语句和循环结构**: 如`&lt;#if&gt;`, `&lt;#else&gt;`, `&lt;#elseif&gt;`用于条件判断,`...

    FreeMarker2.3.23官方中文文档

    3. **模板继承与导入**:FreeMarker支持模板的继承,通过`&lt;#macro&gt;`定义宏,可以在多个模板间共享代码段。`&lt;#import&gt;`则可以导入其他模板中的变量和宏。 4. **日期和数字格式化**:FreeMarker提供了丰富的内置函数...

    FreeMarker 写的一个分页macro(宏)测试

    在这个"FreeMarker 写的一个分页macro(宏)测试"中,我们可以看到如何使用FreeMarker来实现一个简单的分页功能。下面我们将深入探讨这一主题。 首先,`PaginationUtil.java`可能是实现分页逻辑的工具类。在Java中,...

    freemarker

    这个压缩包文件“freemarker练习”很可能是为了帮助初学者理解并熟悉Freemarker的基本用法和核心概念。 首先,让我们深入了解一下Freemarker的核心概念: 1. **模板(Template)**:模板是Freemarker的灵魂,它...

    FreeMarker

    6. **宏**:宏是可重用的模板片段,类似于函数。通过`&lt;#macro&gt;`定义,然后在模板中用 `&lt;#call&gt;` 调用。这有助于创建模块化的代码,提高代码复用性。 7. **错误处理与调试**:FreeMarker 提供了错误处理机制,当模板...

    freemarker官方中文帮助文档

    Freemarker是一款强大的模板引擎,常用于Web应用中的视图层渲染,比如Java Web开发。它的设计理念是将数据模型和展现逻辑分离,让开发者专注于HTML或者其他格式的模板设计,而不用关心具体的业务逻辑。这份...

    freemarker基本语法整理

    本文将对 Freemarker 的基本语法进行整理,涵盖输出、逻辑判断、循环遍历、宏等方面的知识点。 输出 在 Freemarker 中,输出变量的值可以使用 `${}` 语法,例如 `${student.name}`。如果变量为空,可以使用 `?if_...

    freemarker编辑插件

    在实际开发中,我们还应了解Freemarker的基本语法,如变量表达式、控制结构(if、else、foreach)、导入模板、宏定义等。同时,熟悉如何将Freemarker与后端数据模型绑定,以及如何在Spring MVC或其他Web框架中配置和...

    Velocity 和 FreeMarker区别

    - **FreeMarker**支持定义宏`&lt;@macro name&gt;`,并可以指定参数,方便复用。 - **Velocity**也有类似的宏定义`#macro(name param1 param2) ... #end`,但功能相对有限。 5. **转义**: - **FreeMarker**内置了多种...

Global site tag (gtag.js) - Google Analytics