转 FreeMarker一篇通

最新推荐文章于 2025-11-26 18:04:01 发布

最新推荐文章于 2025-11-26 18:04:01 发布 · 175 阅读

文章标签：

#freemarker #velocity #XML #嵌入式 #编程

java 专栏收录该内容

10 篇文章

订阅专栏

本文通过实例介绍Freemarker模板引擎的强大功能，包括过程调用、递归处理及XML风格语法等特性，展示了如何将XML文件转换为C#代码。

大家看文章标题就应该知道，我想用一篇文章，把大家从对freemaker的陌生直接带入到比较深入的境界，所以不想说一些基础性的东西，如果大家不习惯我的表达方法，大可通过google去找习惯于自己阅读方式的相关文章。

我用过velocity，最近才用freemaker，才知道我以前的选择是错了，因为velocity不支持过程的调用，所以我为velocity增加了很多的东西，写了很多代码，而且脚本也累赘得要命。freemaker首先吸引我的是它强大的过程调用和递归处理能力，其次则是xml风格的语法结构有着明显的边界，不象velocity要注意段落之间要留空格。所以我建议大家直接使用Freemaker，虽然freemaker没有.net版本，我想不嵌入程序中使用的话，freemaker是绝对的首选。（题外话，谁有兴趣移植一个NFreeMaker？）

在使用之前我们先要设置运行环境，在使用Freemaker的时候，我们需要下载相关的程序：
freemaker: http://freemarker.sourceforge.net/
fmpp: http://fmpp.sourceforge.net/

其中fmpp是一个freemaker的辅助工具，有了它，我们可以实现更多的功能。以下例子必须fmpp辅助。

这里我们首先提出问题。大家看如下的一个xml文件，虽然freemaker的能力不仅在于处理xml文件，但是用xml作为例子更直观一些：

xml version='1.0' encoding="gb2312" ?>

labels>

</labels>

</ field>

</type>

</field>

<type>

</type>

</types>

[代码1]
我们的任务是把这个文件转化为相应的C#代码。大家先看转换模板的代码：

< #ftl ns_prefixes ={"ns": "urn:DruleForm-Lite.xsd"} >
2

< #-- 定义xml namespace，以便在以下代码中使用,注意，ftl指令必须使用单独的行 -- >
3

< @pp .setOutputEncoding encoding ="gb2312" /> < #-- 使用fmpp提供的函数来设置输出编码 -- >
4

< #recurse doc > < #-- 根入口，代码1部分的xml存放在变量doc中，doc变量的填充由fmpp根据config.fmpp中的配置进行 -- >
6

< #macro "ns:types" > < #-- xslt风格的匹配处理入口 -- >
8

< #recurse > < #-- 直接进行types节点内的匹配 -- >
9 < / #macro>
10

<#macro "ns:type"> <#-- 匹配type节点 -->
12

class ${.node.@name} <#-- 其中.node是保留字，表示当前节点，引用的@name是xslt风格 -->
13

{
14

<#recurse> <#-- 继续匹配 -->
15

}
16</#macro>
17

<#macro "ns:field">
19

public ${.node.@type} ${.node.@name};
20</#macro>
21

22<#macro @element> <#-- 所有没有定义匹配的节点到这里处理 -->
23</#macro>
24

[代码2]

我们使用的配置文件设置如下：

sourceRoot: src

outputRoot: out

logFile: log.fmpp

modes: [

copy(common/**/*.* , resource/*.*)

execute(*.ftl)

ignore(templates/*.* , .project , **/*.xml , xml/*.* , *.js)

]

removeExtensions: ftl

sourceEncoding: gb2312

data: {

doc: xml(freemaker.xml)

}

[代码3]

然后我们在dos模式下运行指令：
E:\work\blogs\freemaker>f:\download\freemaker\fmpp\bin\fmpp

最后的输出结果是这样的，存放在文件out\freemaker.中：

class Type1

{

public Float Field11;

public String Field12;

public Integer Field13;

public Type2 Field14;

public Float Field15;

}

class Type3

{

public Type1 Field31;

}

[代码4]

先来解释一下freemaker的基本语法了，
<# ... > 中存放所有freemaker的内容，之外的内容全部原样输出。
<@ ... /> 是函数调用
两个定界符内的内容中，第一个符号表示指令或者函数名，其后的跟随参数。freemaker提供的控制包括如下：
<#if condition><#elseif condition><#else> 条件判断
<#list hash_or_seq as var> 遍历hash表或者collection（freemaker称作sequence）的成员
<#macro name param1 param2 ... ><#nested param> 宏，无返回参数
<#function name param1 param2><#return val>函数，有返回参数
var?member_function(...) 用函数对var进行转换，freemaker称为build-ins。实际内部实现类似member_function(var, ...)
stringA[M .. N] 取子字符串，类似substring(stringA, M, N)
{key:value, key2:value2 ...} 直接定义一个hash表
[item0, item1, item2 ...] 直接定义一个序列
hash0[key0] 存取hash表中key对应的元素
seq0[5] 存取序列指定下标的元素
<@function1 param0 param1 ... /> 调用函数function1
<@macro0 param0 param1 ; nest_param0 nest_param1 ...> nest_body </@macro> 调用宏，并处理宏的嵌套
<#assign var = value > 定义变量并初始化
<#local var = value> 在 macro 或者 function 中定义局部变量并初始化
<#global var = value > 定义全局变量并初始化
${var} 输出并替换为表达式的值
<#visit xmlnode> 调用macro匹配xmlnode本身及其子节点
<#recurse xmlnode> 调用macro匹配xmlnode的子节点