什么是FreeMaker？

FreeMarker是什么 ？
一款模板引擎： 即一种基于模板和要改变的数据，
并用来生成输出文本（HTML网页、电子邮件、配置文件、源代码等）的通用工具。
它不是面向最终用户的，而是一个Java类库，
是一款程序员可以嵌入他们所开发产品的组件。

FreeMarker模板文件主要由如下4个部分组成:
1、文本:直接输出的部分
2、,注释:<#– … –>格式部分,不会输出
3、插值:即${…}或#{…}格式的部分,将使用数据模型中的部分替代输出
4、FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出

介绍-FreeMarker能做什么
MVC框架中的View层组件
Html页面静态化
代码生成工具
CMS模板引擎
页面栏目动态定制

模板 + 数据模型 = 输出

工作原理

模板文件存放在Web服务器上，当有人来访问这个页面，
FreeMarker就会介入执行，然后动态转换模板，
用最新的数据内容替换模板中${...}的部分，
之后将结果发送到访问者的Web浏览器中。
访问者的Web浏览器就会接收到例如第一个HTML示例那样的内容（也就是没有FreeMarker指令的HTML代码），访问者也不会察觉到服务器端使用的FreeMarker。
（存储在Web服务器端的模板文件是不会被修改的；替换也仅仅出现在Web服务器的响应中。）

---

web.xml配置

<servlet>  
   <description>This is the description of my J2EE componentdescription>  
   <display-name>This is the display name of my J2EE componentdisplay-name>  
   <servlet-name>Indexservlet-name>  
   <servlet-class>com.ajun.template.servlet.Indexservlet-class>  
   <init-param>  
    <param-name>templateDirparam-name>模板存放位置，是基于app的根目录的  
    <param-value>/templatesparam-value>  
   init-param>  
   <load-on-startup>3load-on-startup>为了启动的时候初始化模板配置  
 servlet>  

 <servlet-mapping>  
   <servlet-name>Indexservlet-name>  
   <url-pattern>/Index.dourl-pattern>  
 servlet-mapping> 

---

FTL指令规则

在FreeMarker中,使用FTL标签来使用指令,
FreeMarker有3种FTL标签,这和HTML标签是完全类似的.

1,开始标签:<#directivename parameter>
2,结束标签:#directivename>
3,空标签:<#directivename parameter/> 

插值规则
FreeMarker的插值有如下两种类型:1,
通用插值${expr};2,数字格式化插值:#{expr}或#{expr;format}

通用插值

对于通用插值,又可以分为以下4种情况:
1,插值结果为字符串值:直接输出表达式结果
2,插值结果为数字值:根据默认格式(由#setting指令设置)
将表达式结果转换成文本输出.可以使用内建的字符串函数格式化单个插值。

字符串
直接指定字符串值使用单引号或双引号限定,
如果字符串值中包含特殊字符需要转义,看下面的例子:
${"我的文件保存在C:\\盘"}
${'我名字是\"annlee\"'}
输出结果是:
我的文件保存在C:\盘
我名字是"annlee"

FreeMarker支持如下转义字符:
\";双引号(u0022)
\';单引号(u0027)
\\;反斜杠(u005C)
\n;换行(u000A)
\r;回车(u000D)
\t;Tab(u0009)
\b;退格键(u0008)
\f;Form feed(u000C)
\l;<
\g;>
\a;&
\{;{
\xCode;直接通过4位的16进制数来指定Unicode码,输出该unicode码对应的字符.

如果某段文本中包含大量的特殊符号,FreeMarker提供了另一种特殊格式:可以在指定字符串内容的引号前增加r标记,在r标记后的文件将会直接输出.看如下代码:
${r"${foo}"}
${r"C:\foo\bar"}
输出结果是:
${foo}
C:\foo\bar

2,数值
表达式中的数值直接输出,不需要引号.小数点使用"."分隔,
不能使用分组","符号.FreeMarker目前还不支持科学计数法,
所以"1E3"是错误的.在FreeMarker表达式中使用数值需要注意以下几点:
1,数值不能省略小数点前面的0,所以".5"是错误的写法
2,数值8 , +8 , 8.00都是相同的

3,布尔值
直接使用true和false,不使用引号.

4,集合
集合以方括号包括,各集合元素之间以英文逗号","分隔,看如下的例子:
<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x>
${x}

输出结果是:
星期一
星期二
星期三
星期四
星期五
星期六
星期天

除此之外,集合元素也可以是表达式,例子如下:
[2 + 2, [1, 2, 3, 4], "whatnot"]

还可以使用数字范围定义数字集合,如2..5等同于[2, 3, 4, 5],
但是更有效率.注意,使用数字范围来定义集合时无需使用方括号,
数字范围也支持反递增的数字范围,如5..2

5,Map对象
Map对象使用花括号包括,Map中的key-value对之间以英文冒号":"分隔,
多组key-value对之间以英文逗号","分隔.下面是一个例子:
{"语文":78, "数学":80}
Map对象的key和value都是表达式,但是key必须是字符串 

输出Map元素
这里的Map对象可以是直接HashMap的实例,甚至包括JavaBean实例,
对于JavaBean实例而言,我们一样可以把其当成属性为key,属性值为value的Map实例.
为了输出Map元素的值,可以使用点语法或方括号语法.假如有下面的数据模型:
Map root = new HashMap();
Book book = new Book();
Author author = new Author();
author.setName("annlee");
author.setAddress("gz");
book.setName("struts2");
book.setAuthor(author);
root.put("info","struts");
root.put("book", book);

为了访问数据模型中名为struts2的书的作者的名字,可以使用如下语法:
book.author.name    //全部使用点语法
book["author"].name
book.author["name"]    //混合使用点语法和方括号语法
book["author"]["name"]   //全部使用方括号语法

使用点语法时,变量名字有顶层变量一样的限制,
但方括号语法没有该限制,因为名字可以是任意表达式的结果.

3.3, 字符串操作

FreeMarker的表达式对字符串操作非常灵活,
可以将字符串常量和变量连接起来,也可以返回字符串的子串等.

字符串连接有两种语法:
1,使用${..}或#{..}在字符串常量部分插入表达式的值,
从而完成字符串连接.
2,直接使用连接运算符+来连接字符串

例如有如下数据模型:
Map root = new HashMap(); root.put("user","annlee");
下面将user变量和常量连接起来:
${"hello, ${user}!"}   //使用第一种语法来连接
${"hello, " + user + "!"} //使用+号来连接
上面的输出字符串都是hello,annlee!,
可以看出这两种语法的效果完全一样.

值得注意的是,${..}只能用于文本部分,不能用于表达式,
下面的代码是错误的:
<#if ${isBig}>Wow!if>
<#if "${isBig}">Wow!if>
应该写成:<#if isBig>Wow!if>

截取子串可以根据字符串的索引来进行,截取子串时如果只指定了一个索引值,
则用于取得字符串中指定索引所对应的字符;如果指定两个索引值,
则返回两个索引中间的字符串子串.假如有如下数据模型:
Map root = new HashMap(); root.put("book","struts2,freemarker");
可以通过如下语法来截取子串:
${book[0]}${book[4]}   //结果是su
${book[1..4]}     //结果是tru 

如何初始化共享变量

1． 初始化全局共享数据模型
freemark在web上使用的时候对共享数据的初始化支持的不够,
不能在配置初始化的时候实现，而必须通过ftl文件来初始化全局变量。
这是不能满主需求的，我们需要在servlet init的时候留出一个接口来初始化系统的共享数据
具体到和webwork整合,因为本身webwork提供了整合servlet,
如果要增加全局共享变量，可以通过修改 com.opensymphony.webwork.views.freemarker.FreemarkerServlet来实现,
我们可以在这个 servlet初始化的时候来初始化全局共享变量
与webwork整合配置
配置web.xml
<servlet>
    <servlet-name>freemarkerservlet-name>
    <servlet-class>com.opensymphony.webwork.views.freemarker.FreemarkerServletservlet-class>
    <init-param>
      <param-name>TemplatePathparam-name>
<param-value>/param-value>
<!—模板载入文件夹，这里相对context root，递归获取该文件夹下的所有模板-->
    init-param>
    <init-param>
      <param-name>NoCacheparam-name> <!—是否对模板缓存-->
      <param-value>trueparam-value>
    init-param>
    <init-param>
      <param-name>ContentTypeparam-name>
      <param-value>text/htmlparam-value>
    init-param>
    <init-param>
<param-name>template_update_delayparam-name>
<!—模板更新时间,0表示每次都更新,这个适合开发时候-->
      <param-value>0param-value>
    init-param>
    <init-param>
      <param-name>default_encodingparam-name>
      <param-value>GBKparam-value>
    init-param>
    <init-param>
      <param-name>number_formatparam-name>
      <param-value>0.##########param-value><!—数字显示格式-->
    init-param>
    <load-on-startup>1load-on-startup>
  servlet>
  <servlet-mapping>
    <servlet-name>freemarkerservlet-name>
    <url-pattern>*.ftlurl-pattern>
  servlet-mapping>

5高级方法
自定义方法
${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)}
${timer("yyyy-MM-dd ", x)}

输出
2001-10-12 5:21:12
2001-10-12