FreeMarker 指令

概念

基本指令

setting指令

assign指令

<#assign name=value>

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

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

<#assign name>
capture this
</#assign>

<#assign name in namespacehash>
capture this
</#assign>

<!-- 示例： -->
给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里：
<#assign x>Hello ${user}!</#assign>

同时也支持中文赋值，如：
<#assign 语法>
java
</#assign>
${语法}
<!-- 输出结果是: -->
java

if指令

<#if condition>...
<#elseif condition>...
<#else> ...
</#if>

<!-- 示例： -->
<#if animals.python.price < animals.elephant.price>
Pythons are cheaper than elephants today.
<#elseif animals.python.price > animals.elephant.price>
Elephants are cheaper than pythons today.
<#else>
Elephants and pythons cost the same today.
</#if>

list指令

<#list sequence as item>
...
</#list>

<!-- 示例： -->
<ul>
<#list misc.fruits as fruit>
<li>${fruit}
</#list>
</ul>

<#list misc.fruits>
<p>Fruits:
<ul>
<#items as fruit>
<li>${fruit}<#sep> and</#sep>
</#items>
</ul>
<#else>
<p>We have no fruits.
</#list>

include指令

<#include filename>
or
<#include filename options>

<!-- 示例： -->
File: /common/copyright.ftl
Copyright 2001-2002 ${me}<br>

<#assign me="Juila Smith">
<h1>home page</h1>
<hr>
<#include "/common/copyright.ftl" encoding="UTF-8">

<!-- 输出结果： -->
<h1>home page</h1>
<hr>
Copyright 2001-2002 Juila Smith

options包含两个属性：

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

switch指令

<#switch value>
<#case refValue1>
...
<#break>
<#case refValue2>
...
<#break>
...
<#case refValueN>
...
<#break>
<#default>
...
</#switch>

compress指令

<#compress>
...
</#compress>

<!-- 示例： -->
<#assign x = "    moo  \n\n   ">
(<#compress>
1 2  3   4    5
${moo}
test only

I said, test only

</#compress>)

<!-- 输出结果是: -->
(1 2 3 4 5
moo
test only
I said, test only)

escape, noescape指令

<#escape identifier as expression>
...
<#noescape>...</#noescape>
...
</#escape>

<!-- 示例： -->
<#escape x as x?html>
First name: ${firstName}
<#noescape>Last name: ${lastName}</#noescape>
Maiden name: ${maidenName}
</#escape>

<!-- 相同表达式： -->
First name: ${firstName?html}
Last name: ${lastName }
Maiden name: ${maidenName?html}

import指令

<#import path as hash>

假设mylib.ftl里定义了宏copyright那么我们在其他模板页面里可以这样使用
<#import "/libs/mylib.ftl" as my>

// "my"在freemarker里被称作namespace
<@my.copyright date="1999-2002"/>

内置函数

obj?html

obj?upper_case

obj?cap_first

obj?length

fruits?size

animal?index

animal?counter

animal?item_parity

animal.protected?string("Y", "N")

animal?item_cycle('lightRow', 'darkRow')

fruits?join(", ")

obj?starts_with("J")

处理遗失参数

默认值

<!--
示例：
当user参数遗失时，使用"visitor"作为默认值
-->
<h1>Welcome ${user!"visitor"}!</h1>

忽略处理

<!--
示例：
当user参数遗失时，忽略处理指令内部操作
-->
<#if user??><h1>Welcome ${user}!</h1></#if>