转 freemarker macro(宏)的使用

有人说用freemarker，但没有用到它的宏（macro），就＝没有真正用过freemarker。说的就是宏是freemarker的一大特色。

宏的定义可以查看相关的文档，里面介绍得很清楚，下面来看看它的一个用法。

/WEB-INF/template/common/common.ftl：

<#macro html title>
        <head>
        <meta http-equiv="Content-Type" content="text/html; charset=GBK" />
        <title>${title}</title>
        <link rel="stylesheet" rev="stylesheet" href="/oa/file/css.css" type="text/css" media="all" />
        </head>

</html>
</#macro>

然后在freemarker.properties里定义：
auto_import=/WEB-INF/template/common/common.ftl as c

然后其他的ftl文件就可以使用它了

test.ftl：
    <@c.html title="OA">
      你的内容
    </@c.html>

如果不在freemarker.properties里定义，可以在每个文件里包含这个ftl：
<#import "/WEB-INF/template/common/common.ftl" as c>

不同的场合有不同的运用。使用得好的话，将会大大节省你的开发时间。

macro, nested, return
语法

<#macro name param1 param2 ... paramN>
...
<#nested loopvar1, loopvar2, ..., loopvarN>
...
<#return>
...
</#macro>
用例
<#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>

包含body的宏

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

--------------------------------------------------------------------------------

注意在使用的时候：别忘了双引号。

<#import "/pagelibs/book.ftl" as book>

<@workorder.price value="${book.price}" />

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

l.1 基本用法

宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量，下面是一个例子：

<#macro greet> <font size="+2">Hello Joe!</font></#macro>
调用宏时，与使用FreeMarker的其他指令类似，只是使用@替代FTL标记中的#。

<@greet></@greet> <#--<@greet/>-->
在macro指令中可以在宏变量之后定义参数，如：

<#macro greet person> <font size="+2">Hello ${person}!</font></#macro>
可以这样使用这个宏变量：

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

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

宏可以有多参数，下面是一个例子：

<#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> </td></tr></table></#macro>
执行宏调用：

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

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>

宏定义中的局部变量对嵌套内容是不可见的，例如：

<#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}
输出结果：

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

jsmith@acme.comjsmith@other.com
数据模型中的变量任何地方都可见，也包括不同的名字空间，下面是修改的库：

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

除开FreeMarker内建的Velocity所没有的强大函数外，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来刻意违反层次划分原则。

转 freemarker macro(宏)的使用的更多相关文章

freemarker macro 使用
转载... macro, nested, return语法 <#macro name param1 param2 ... paramN>...<#nested loopvar1, l ...
uboot中的中断macro宏
目录 uboot中的中断macro宏引入内存分配流程概览普通中断保存现场中断函数打印具体寄存器恢复现场软中断空间获取保存现场附录速记疑惑待解 title: uboot中的中断m ...
用freemarker定义宏实现自定义公用控件
参考文章: Freemarker自定义标签的简单分析定义一个基本的文本框:传入参数为:resourceName idName resourceVal="" idVal=" ...
[Umbraco] macro(宏)在umbraco中的作用
macro在umbraco中是一个核心的应用,它是模板页中用于动态加载内容的标签(模板指令),宏可以是基于XSLT文件创建,亦可以是基于ASP.NET用户控件创建在develop下的Macros中创 ...
Rust 1.7.0 macro宏的复用 #[macro_use]的使用方法
Rust 1.7.0 中的宏使用范围包含三种情况: 第一种情况是宏定义在当前文件里.这个文件可能是 crate 默认的 module,也可能是随意的 module 模块. 另外一种情况是宏定义在当前 ...
FreeMarker教程
一.什么是模板引擎,为什么要用模板引擎在B/S程式设计中,常常有美工和程序员二个角色,他们具有不同专业技能:美工专注于表现——创建页面.风格.布局.效果等等可视元素:而程序员则忙于创建程式的商业流程 ...
FreeMarker学习（宏<#macro>的使用）
原文链接:https://my.oschina.net/weiweiblog/blog/506301?p=1 用户定义指令-使用@符合来调用有两种不同的类型:Macro(宏)和transform( ...
使用Freemarker宏进行可扩展式模块化编程
作者:Chu Lung 原文链接:http://blog.chulung.com/article/13 本文由MetaCLBlog于2016-07-08 14:42:10自动同步至cnblogs 一. ...
FreeMarker基础语法，宏，引用等
FreeMarker的插值有如下两种类型: 1,通用插值${expr}; 2,数字格式化插值:#{expr}或#{expr;format} ${book.name?if_exists } //用于判断 ...

随机推荐

CONTRO4 系列
软件下载 https://getcomposer.org/download/ 0技术手册 https://wenku.baidu.com/view/4b511ead376baf1ffd4fad36.h ...
深入解读RabbitMQ工作原理及简单使用
RabbitMQ系列目录 RabbitMQ在Ubuntu上的环境搭建深入解读RabbitMQ工作原理及简单使用 Rabbit的几种工作模式介绍与实践 Rabbit事务与消息确认 Rabbit集群搭建 ...
springboot打包去除资源文件，启动时指定配置文件位置，使用log4j2替换默认logback
springboot打包时,去掉资源文件 <build> <resources> <resource> <directory>src/main/reso ...
后端list集合中的数据传递到前台HTML中显示（表格形式）
关键字:web项目中前后台数据传递问题在学习web项目的过程中,我们肯定会遇到前后台数据交换问题.这个问题我也思考了很久,今天借此总结一下.由于博主水平有限,如有不当之处,还请大家多多指正,,废话不 ...
Tomcat完美配置多个HOST主机,域名,SSL
这里是Tomcat9版本,其它版本基本一致! 1.配置多个主机域名 1.打开conf文件夹下的server.xml 复制官方提供的HOST配置,修改为你的域名,appBase路径(相对路径) 2.新建 ...
初步学习Xamarin的感受
一直仰慕Xamarin的大名,最近抽空去浅学了一下. 最后有一种这东西不咋地,又有一种这东西还不错的感觉先说下为什么不咋地? 如果在公司项目使用Xamarin.forms这个东西.按照国内APP设计 ...
Pandas基础使用
Pandas是基于NumPy的一种工具,该工具是为了解决数据分析任务而创建的. 1.导入pandas import pandas as pd 2.pandas数据类型: 1)Series:一维数据类型 ...
mockjs使用
/** * 使用mockjs来mock数据, 提供mock数据API接口 */ import Mock from 'mockjs' import data from './data.json' //注 ...
docker容器与宿主交互数据
1.查看容器 [root@localhost ~]# docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES cd6957191 ...
如何命名Java变量
如同酒店会给每个房间起个性化的名字一样,程序中的变量也需要用合理的名字进行管理--变量名! 需要注意,给酒店房间起名字时可以是数字,如“802”,也可以是有趣的名字,如“牡丹”.“美国总统”.“水帘洞 ...

转 freemarker macro(宏)的使用

转 freemarker macro(宏)的使用的更多相关文章

随机推荐

热门专题