`
_与狼共舞
  • 浏览: 61585 次
  • 性别: Icon_minigender_1
  • 来自: 成都
社区版块
存档分类
最新评论

Freemarker定义宏的用法

阅读更多

一.什么是宏:macro 

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

基本用法 

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

Java代码  收藏代码
  1. <#macro greet>     
  2.      <font size="+2">Hello Joe!</font>     
  3. </#macro>    
  4. <#macro greet>  
  5.       <font size="+2">Hello Joe!</font>  
  6. </#macro>  

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

<@greet></@greet> <#--<@greet/>--> 
在macro指令中可以在宏变量之后定义参数,如: 
Java代码  收藏代码
  1. <#macro greet person>     
  2.     <font size="+2">Hello ${person}!</font>     
  3. </#macro>    
  4. <#macro greet person>  
  5.      <font size="+2">Hello ${person}!</font>  
  6. </#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>    
  4.  <#macro greet person color>  
  5.     <font size="+2" color="${color}">Hello ${person}!</font>  
  6.   </#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 实现宏分页

    通过定义宏,我们可以创建一个通用的分页组件,便于在多个页面上重复使用。 1. **宏定义**: 在FreeMarker中,宏定义通常放在`.ftl`文件的`&lt;#macro&gt;`和`&lt;/#macro&gt;`标签之间。宏的参数可以像函数参数一样定义,例如...

    原创 用FreeMarker宏 和 Jquery 做树(Hbiernate和JDBC版)

    宏是FreeMarker的一个重要特性,允许开发者定义可重用的代码块,简化模板代码,提高效率。 Hibernate是一个流行的Java ORM(对象关系映射)框架,它允许开发者使用面向对象的方式处理数据库操作,避免直接编写SQL...

    freemarker自定义分页标签宏

    总结起来,FreeMarker自定义分页标签宏的实现涉及到前端模板的宏定义与调用,以及后端的数据处理和链接生成。通过这种方式,我们可以创建出灵活且可复用的分页组件,方便地应用于各种项目中。理解并熟练掌握宏的使用...

    FreeMarker通用的分页

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

    freemarker基本语法整理

    Freemarker 的宏是和某个变量关联的模板片断,以便在模板中通过用户定义指令使用该变量。宏的基本用法如下: ```html &lt;font size="+2"&gt;Hello Joe! ``` Struts2 环境中的 Freemarker 在 Struts2 环境中,...

    freemarker

    - **宏定义和使用**:创建可重用的代码块,提高代码效率。 通过这些练习,初学者可以逐步掌握Freemarker的基本操作,并了解如何在实际项目中应用。对于刚接触Freemarker的人来说,这是一个很好的起点,能够帮助他们...

    freemarker 教程 使用手册

    2. 数据模型设置:通过`ModelAndView`或`Map`将Java对象传递到视图,供Freemarker使用。 3. 视图解析:配置`ViewResolver`,例如`FreemarkerViewResolver`,确定模板路径和渲染逻辑。 四、Freemarker高级特性 1. ...

    Freemarker分页

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

    freemarker操作手册-完整freemarker教程

    - `#macro`:定义宏,可重用的模板片段。 - `#import`:导入其他模板或库。 - `#autoesc`:自动转义HTML特殊字符,防止XSS攻击。 - `#function`:定义函数,类似于宏,但支持参数。 5. **表达式和逻辑运算** -...

    freemarker编辑插件

    对于初学者来说,使用这样的插件可以更快地掌握Freemarker语言的规则和用法。对于经验丰富的开发者,它可以帮助他们更快地完成日常编码任务,降低因为语法错误导致的问题。总的来说,"freemarker编辑插件"是提高...

    FreeMarker2.3.23官方中文文档

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

    freemarker&velocity的使用

    3. **宏库**:Velocity支持宏库(Velocity Tools),这是一组预先定义的宏,可以简化常见的Web开发任务,如导航菜单、表单处理等。 4. **模板语法**:Velocity的语法更接近自然语言,如`#foreach($item in $list)`,...

    freemarker-2.3.28.jar

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

    springboot如何使用Freemarker模版引擎

    - 创建一个控制器类,比如`TemplateController`,并定义一个处理方法来返回Freemarker模板: ```java @Controller public class TemplateController { @GetMapping("/index") public String index(Model model...

    Velocity 和 FreeMarker区别

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

    Freemarker2.3.16_带简单教程

    1. **基本语法**:Freemarker使用简单的模板语言,主要包括变量表示(${})、控制结构(if/else、foreach)、条件表达式(?)和函数调用(例如,日期和时间的格式化)。 2. **模板设计模式**:如如何定义模板布局,...

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

    开发者可以使用Freemarker语法定义动态内容,如树形菜单的数据,这些数据由后端Spring或Struts2处理并传递给前端。 然后是“jquery”,这是一个广泛使用的JavaScript库,提供了丰富的API用于操作DOM(文档对象模型...

    Spring配置Freemarker视图解析器,前台页面全部使用freemarker渲染

    3. 配置视图解析器 bean:接下来,定义一个`FreeMarkerConfigurer`实例,用于设置Freemarker的相关属性,如编码、模板路径等: ```java @Bean public FreeMarkerConfigurer freeMarkerConfigurer() { ...

Global site tag (gtag.js) - Google Analytics