Freemarker的一些常见语法

include语法

作用：include指令的作用类似于JSP的包含指令,用于包含指定页
<#include filename>or<#include filename options>
options包含两个属性
encoding=”GBK” 编码格式
parse=true 是否作为ftl语法解析,默认是true，false就是以文本方式引入.注意在ftl文件里布尔值都是直接赋值的如parse=true,而不是parse=”true”
用例:<#include "/common/copyright.ftl" encoding=”GBK”>

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语法

escape, noescape 使用

assign语法

用例1：给seasons赋予序列值
<#assign seasons = ["winter", "spring", "summer", "autumn"]>
用例2：给变量test加1    <#assign test = test + 1>

setting语法

macro, nested, return语法

<#macro name param1 param2 ... paramN>
...
<#nested loopvar1, loopvar2, ..., loopvarN>
...
<#return>

t, lt, rt语法

<#t> 去掉左右空白和回车换行
<#lt>去掉左边空白和回车换行
<#rt>去掉右边空白和回车换行
<#nt>取消上面的效果

一些常用方法或注意事项

表达式转换类

${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安全输出：“abcsdfsf”?html 返回安全的html输出,替换掉html代码
xml安全输出：var?xml
substring的用法：
    <#assign user=”hello jeen”>
    ${user[0]}${user[4]}输出 :ho
    ${user[1..4]}输出 :ello
类似String.split的用法：“abc;def;ghi”?split(“;”)返回sequence
    将字符串按空格转化成sequence,然后取sequence的长度
    var?word_list 效果同 var?split(“ ”)
    var?word_list?size
取得字符串长度：var?length
大写输出字符：var?upper_case
小写输出字符：var?lower_case
首字符大写：var?cap_first
首字符小写：var?uncap_first
去掉字符串前后空格：var?trim
每个单词的首字符大写：var?capitalize
类似String.indexof:“babcdabcd”?index_of(“abc”) 返回1 “babcdabcd”?index_of(“abc”,2) 返回5
类似String.lastIndexOf：last_index_of和String.lastIndexOf类似,同上

替换字符串 replace：${s?replace(‘ba’, ‘XY’ )}
${s?replace(‘ba’, ‘XY’ , ‘规则参数’)}将s里的所有的ba替换成xy 规则参数包含: i r m s c f 具体含义如下:
· i: 大小写不区分.
· f: 只替换第一个出现被替换字符串的字符串
· r: XY是正则表达式
· m: 正则表达式的多行模式。在多行模式下，^和$表达式分别在行结束符或字符串结尾之后或之前匹配。默认情况下，这些表达式仅在整个字符串的开头和结尾匹配。
· s: 为正则表达式启用dotall模式（与Perl单行模式相同）。在dotall模式下，表达式。匹配任何字符，包括行终止符。默认情况下，此表达式与行终止符不匹配。
· c:允许正则表达式中的空白和注释。

在模板里对sequences和hashes初始化：

sequences
1. [“you”,”me”,”he”]
2. 1..100
3. [ {“Akey”:”Avalue”},{“Akey1”:”Avalue1”},{“Bkey”:”Bvalue”},{“Bkey1”:”Bvalue1”},]
hashes ：{“you”:”a”,”me”:”b”,”he”:”c”}

注释标志：
<#--这里是注释-->
旧版本的freemarker采用的是<#comment> 注释 方法

sequences内置方法
sequence?first：返回sequence的第一个值;前提条件sequence不能是null
sequence?last：返回sequence最后一个值
sequence?reverse：反转sequence的值
sequence?size：返回sequence的大小
sequence?sort：对sequence按里面的对象toString()的结果进行排序
sequence?sort_by(value)：对sequence 按里面的对象的属性value进行排序
如: sequence里面放入的是10 个user对象，user对象里面包含name,age等属性
sequence?sort_by(name) 表示所有的user按user.name进行排序
hashes内置方法
hash?keys：返回hash里的所有keys, 返回结果类型sequence
hash?values：返回hash里的所有value, 返回结果类型sequence

在view中存在下面的对象我们可以在ftl中${req}来打印req对象

· req - the current HttpServletRequest
· res - the current HttpServletResponse
· stack - the current OgnlValueStack
· ognl - the OgnlTool instance
· webwork - an instance of FreemarkerWebWorkUtil
· action - the current WebWork action
· exception - optional the Exception instance, if the view is a JSP exception or Servlet exception view

view中值的搜索顺序
${name}将会以下面的顺序查找name值
· freemarker variables
· value stack
· request attributes
· session attributes
· servlet context attributes

在模板里ftl里使用标签
注意，如果标签的属性值是数字，那么必须采用nubmer=123方式给属性赋值

高级方法

自定义方法
${timer("yyyy-MM-dd H:mm:ss", x)}
${timer("yyyy-MM-dd ", x)}

在模板中除了可以通过对象来调用方法外（${object.methed(args)}）也可以直接调用java实现的方法，java类必须实现接口TemplateMethodModel的方法exec(List args). 下面以把毫秒的时间转换成按格式输出的时间为例子

public class LongToDate implements TemplateMethodModel {
    public TemplateModel exec(List args) throws TemplateModelException {
        SimpleDateFormat mydate = new SimpleDateFormat((String) args.get(0)));
        return mydate.format(new Date(Long.parseLong((String)args.get(1)));
    }
}

将LongToDate对象放入到数据模型中

root.put("timer", new IndexOfMethod());

ftl模板里使用
<#assign x = "123112455445">
${timer("yyyy-MM-dd H:mm:ss", x)}    输出：2001-10-12 5:21:12
${timer("yyyy-MM-dd ", x)}    输出：2001-10-12


自定义 Transforms

实现自定义的<@transform>文本或表达式的功能,允许对中间的最终文本进行解析转换

例子：实现<@upcase>str 将str转换成STR 的功能

代码如下：

import java.io.*;

import java.util.*;

import freemarker.template.TemplateTransformModel;

    class UpperCaseTransform implements TemplateTransformModel {

    public Writer getWriter(Writer out, Map args) {
        return new UpperCaseWriter(out);
    }

    private class UpperCaseWriter extends Writer {

    private Writer out;
    UpperCaseWriter (Writer out) {
        this.out = out;
    }

    public void write(char[] cbuf, int off, int len)  throws IOException {
        out.write(new String(cbuf, off, len).toUpperCase());
    }

    public void flush() throws IOException {
        out.flush();
    }

    public void close() {

    }

    }

}

然后将此对象put到数据模型中

root.put("upcase", new UpperCaseTransform());

在view(ftl)页面中可以如下方式使用

<@upcase>

hello world



打印输出:

HELLO WORLD