FreeMarker设计指南(1)

来源：互联网发布：linux关闭系统命令编辑：程序博客网时间：2024/06/14 21:12

http://blog.csdn.net/liyong1115/archive/2008/01/17/2049612.aspx

概念
2指令
if, else, elseif
switch, case, default, break
list, break
include
Import
compress
escape, noescape
assign
global
setting
macro, nested, return
t, lt, rt
3一些常用方法或注意事项
表达式转换类
数字循环
对浮点取整数
给变量默认值
判断对象是不是null
常用格式化日期
添加全局共享变量数据模型
直接调用java对象的方法
字符串处理(内置方法)
在模板里对sequences和hashes初始化
注释标志
sequences内置方法
hashes内置方法
4 freemarker在web开发中注意事项
web中常用的几个对象
view中值的搜索顺序
在模板里ftl里使用标签
如何初始化共享变量
与webwork整合配置
5高级方法
自定义方法
自定义 Transforms

1概念

最常用的3个概念

sequence 序列，对应java里的list、数组等非键值对的集合

hash 键值对的集合

namespace 对一个ftl文件的引用,利用这个名字可以访问到该ftl文件的资源

2指令

if, else, elseif

语法

<#if condition>

...

<#elseif condition2>

...

<#elseif condition3>

...

<#else>

...

用例

<#if x = 1>

x is 1

<#if x = 1>

x is 1

<#else>

x is not 1

switch, case, default, break

语法

<#switch value>

<#case refValue1>

...

<#break>

<#case refValue2>

...

<#break>

...

<#case refValueN>

...

<#break>

<#default>

...

用例

字符串

<#switch being.size>

<#case "small">

This will be processed if it is small

<#break>

<#case "medium">

This will be processed if it is medium

<#break>

<#case "large">

This will be processed if it is large

<#break>

<#default>

This will be processed if it is neither

数字

<#switch x>

<#case x = 1>

<#case x = 2>

<#default>

如果x=1 输出 1 2, x=2输出 2, x=3 输出d

list, break

语法

<#list sequence as item>

...

<#if item = "spring"><#break>

...

关键字

item_index:是list当前值的下标

item_has_next:判断list是否还有值

用例

<#assign seq = ["winter", "spring", "summer", "autumn"]>

<#list seq as x>

${x_index + 1}. ${x}<#if x_has_next>,

输出

1. winter,

2. spring,

3. summer,

4. autumn

include

语法

<#include filename>

<#include filename options>

options包含两个属性

encoding=”GBK” 编码格式

parse=true 是否作为ftl语法解析,默认是true，false就是以文本方式引入.注意在ftl文件里布尔值都是直接赋值的如parse=true,而不是parse=”true”

用例

/common/copyright.ftl包含内容

模板文件

<#assign me = "Juila Smith">

Some test

Yeah.

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

<#include "/common/copyright.ftl" encoding=”GBK”>

输出结果

Some test

Yeah.

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

Import

语法

<#import path as hash>

类似于java里的import,它导入文件，然后就可以在当前文件里使用被导入文件里的宏组件

用例

假设mylib.ftl里定义了宏copyright那么我们在其他模板页面里可以这样使用

<#import "/libs/mylib.ftl" as my>

<@my.copyright date="1999-2002"/>

"my"在freemarker里被称作namespace

compress

语法

<#compress>

...

用来压缩空白空间和空白的行

用例

<#assign x = " moo ">

(<#compress>

1 2 3 4 5

${moo}

test only

I said, test only

)

输出

(1 2 3 4 5

moo

test only

I said, test only)

escape, noescape

语法

<#escape identifier as expression>

...

<#noescape>...

...

用例

主要使用在相似的字符串变量输出，比如某一个模块的所有字符串输出都必须是html安全的，这个时候就可以使用该表达式

<#escape x as x?html>

First name: ${firstName}

<#noescape>Last name: ${lastName}

Maiden name: ${maidenName}

相同表达式

First name: ${firstName?html}

Last name: ${lastName }

Maiden name: ${maidenName?html}

assign

语法

<#assign name=value>

<#assign name1=value1 name2=value2 ... nameN=valueN>

<#assign same as above... in namespacehash>

<#assign name>

capture this

<#assign name in namespacehash>

capture this

用例

生成变量,并且给变量赋值

给seasons赋予序列值

<#assign seasons = ["winter", "spring", "summer", "autumn"]>

给变量test加1

<#assign test = test + 1>

给my namespage 赋予一个变量bgColor,下面可以通过my.bgColor来访问这个变量

<#import "/mylib.ftl" as my>

<#assign bgColor="red" in my>

将一段输出的文本作为变量保存在x里

下面的阴影部分输出的文本将被赋值给x

<#assign x>

<#list 1..3 as n>

${n} <@myMacro />

Number of words: ${x?word_list?size}

${x}

<#assign x>Hello ${user}! error

<#assign x=” Hello ${user}!”> true

同时也支持中文赋值，如：

<#assign 语法>

java

${语法}

打印输出:

java

global

语法

<#global name=value>

<#global name1=value1 name2=value2 ... nameN=valueN>

<#global name>

capture this

全局赋值语法，利用这个语法给变量赋值，那么这个变量在所有的namespace中是可见的,如果这个变量被当前的assign语法覆盖如<#global x=2> <#assign x=1> 在当前页面里x=2将被隐藏，或者通过${.global.x}来访问

setting

语法

<#setting name=value>

用来设置整个系统的一个环境

locale

number_format

boolean_format

date_format, time_format, datetime_format

time_zone

classic_compatible

用例

假如当前是匈牙利的设置，然后修改成美国

${1.2}

<#setting locale="en_US">

${1.2}

输出

1,2

1.2

因为匈牙利是采用“,”作为十进制的分隔符，美国是用“.”

macro, nested, return

语法

<#macro name param1 param2 ... paramN>

...

<#nested loopvar1, loopvar2, ..., loopvarN>

...

<#return>

...

用例

<#macro test foo bar="Bar" baaz=-1>

Test text, and the params: ${foo}, ${bar}, ${baaz}

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

${title?cap_first}:

<#list items as x>

${x?cap_first}

<@list items=["mouse", "elephant", "python"] title="Animals"/>

输出结果

Animals:

Mouse

Elephant

Python

包含body的宏

<#macro repeat count>

<#list 1..count as x>

<#nested x, x/2, x==count>

<@repeat count=4 ; c halfc last>

${c}. ${halfc}<#if last> Last!

</@repeat>

输出

1. 0.5

2. 1

3. 1.5

4. 2 Last!

t, lt, rt

语法

<#t> 去掉左右空白和回车换行

<#lt>去掉左边空白和回车换行

<#rt>去掉右边空白和回车换行

<#nt>取消上面的效果

3一些常用方法或注意事项

表达式转换类

${expression}计算expression并输出

#{ expression }数字计算#{ expression ;format}安格式输出数字format为M和m

M表示小数点后最多的位数,m表示小数点后最少的位数如#{121.2322;m2M2}输出121.23

数字循环

1..5 表示从1到5，原型number..number

对浮点取整数

${123.23?int} 输出123

给变量默认值

${var?default(“hello world

”)?html}如果var is null那么将会被hello world

替代

判断对象是不是null

<#if mouse?exists>

Mouse found

<#else>

也可以直接${mouse?if_exists})输出布尔形

常用格式化日期

openingTime必须是Date型,详细查看freemarker文档 Reference->build-in referece->build-in for date

${openingTime?date}

${openingTime?date_time}

${openingTime?time}

添加全局共享变量数据模型

在代码里的实现

cfg = Configuration.getDefaultConfiguration();

cfg.setSharedVariable("global", "you good");

页面实现可以通过global指令,具体查看指令里的global部分

直接调用java对象的方法

${object.methed(args)}

字符串处理(内置方法)

html安全输出

“abc