FreeMarker 入门

最近接触到cms内容管理系统，研究了一下发现里面有用到freemarker，一开始不知道是什么鬼，就去查了资料，做了个入门研究。

FreeMarker：是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写的；它用来生成HTML Web页面，尤其是基于MVC模式的应用程序。简单的说，Jsp也可以看作是一个模板，但是jsp没有显著的模板文件；所谓模板文件，就是告诉你怎么去显示内容的文件。在使用过程中，一般由Java程序提供数据，美工来设计模板页面，Java程序猿只负责数据。
freemarker可以生成HTML文件，还可以生成Java文件等，在Struts2中大量使用了freemarker。
freemarker 与容器无关，它并不知道HTTP或者是servlet，一般用于struts2，作为视图组件，同样也可以应用于非WEB应用程序环境。

我们先来了解一下freemarker的模板开发语句：
1.${…}：FreeMarker 将会输出真实的值来替换花括号内的表达式，这样的表达式被称为interpolations 插值。
2.FTL tags 标签（FreeMarker 模板的语言标签）：它们是 FreeMarker 的指令而且是不会直接输出出来的东西。一般以符号#开头。（用户自定义的 FTL 标签使用@符号来代替#）
3.Comments 注释：FreeMarker 的注释和 HTML 的注释相似，但是它用<#–和–>来分隔的。
4.directives指令：就是所指的 FTL 标签。 这些指令在 HTML 的标签中的关系是相同的。
5.其他任何不是 FTL 标签，插值或注释的内容将被视为静态文本，这些东西就不会被FreeMarker 所解析，会被按照原样输出出来。

注意：因为一些指令和HTML标签中的关系相同，意思很好理解，就不再作介绍，主要说明一下<#include >指令，用法：<#include “included.txt” />，包含指令将会（完全）输出被包含文件中的内容。
自定义指令(macro指令)：

<#macro m1>   <#--定义指令m1 -->
    <b>aaabbbccc</b>
    <b>dddeeefff</b>
</#macro>
<@m1 /><@m1 />  <#--调用上面的宏指令 -->
<#--带参的宏指令 -->
<#macro m2 a b c >
    ${a}--${b}--${c}
</#macro>
<@m2 a="老高" b="老张" c="老马" />

使用freemarker需要导入它的jar包，建立.ftl文件，以及解析的类，我们现在就简单的说一下步骤：
1.建立一个普通的java项目：testFreeMarker
2.引入freemarker.jar包
3.在项目目录下建立模板目录：templates
4.在templates目录下，建立a.ftl模板文件，内容如下：Hello，${user}，你好！
5.建立Java文件，内容如下：

import java.io.File;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import freemarker.template.Configuration;
import freemarker.template.DefaultObjectWrapper;
import freemarker.template.Template;

public class Test1 {
    public static void main(String[] args) throws Exception {
        //创建Freemarker配置实例
        Configuration cfg = new Configuration();

        cfg.setDirectoryForTemplateLoading(new File("templates")); 

        //创建数据模型
        Map root = new HashMap();
        root.put("user", "张三");

        //加载模板文件
        Template t1 = cfg.getTemplate("a.ftl");

        //显示生成的数据,//将合并后的数据打印到控制台
        Writer out = new OutputStreamWriter(System.out); 
        t1.process(root, out);
        out.flush();
        out.close();

运行Java文件，控制台就会打印出：
Hello，张三，你好！

以上是简单的freemarker小程序，类似于Hello world，但是我们一般使用freemarker是在web程序中，尤其是Struts2下，那下面讲一下Struts2整合freemarker。

1.解压struts2-core-X.X.X.jar文件，把在META-INF文件夹下面的struts-tags.tld文件复制到WEB-INF文件夹下。 将freemark的jar导入到工程中；

２.在web.xml文件中配置freemark同时启动JSPSupportServlet.代码如下：

<servlet>
        <servlet-name>freemarker</servlet-name>
        <servlet-class>
            freemarker.ext.servlet.FreemarkerServlet
        </servlet-class>
        <!--下面的配置freemarke的ftl文件的位置 ,/表示模板文件位于根目录（webroot）下 -->
        <init-param>
            <param-name>TemplatePath</param-name>
            <param-value>/</param-value>
        </init-param>
        <!-- 是否和服务器（tommcat)一起启动。表示加载顺序，大于0的会被启动-->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>freemarker</servlet-name>
        <url-pattern>*.ftl</url-pattern>
    </servlet-mapping>
 <!-- 表示freemarker里面支持jsp-->
<servlet>
  <!-- define a JspSupportServlet Object -->
  <servlet-name>JspSupportServlet</servlet-name>
  <servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class>
  <!-- setting JspSupportServlet auto start -->
  <load-on-startup>1</load-on-startup>
 </servlet>

3.struts.xml文件配置如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.1//EN" "http://struts.apache.org/dtds/struts-2.1.dtd">
<struts>
    <constant name="struts.devMode" value="true" />
    <constant name="struts.i18n.encoding" value="gbk" />
    <constant name="struts.enable.DynamicMethodInvocation" value="true" />
    <package name="default" extends="struts-default">
    <!-- action的配置，很重要，result中type要设置为freemarker-->
        <action name="test" class="com.sxt.test.TestAction">
            <result name="success" type="freemarker">test_success.ftl</result>
        </action>
    </package>
</struts>    

4.在FreeMarker模板中使用assign指令导入标签库。代码如下
<#assign s=JspTaglibs[“/WEB-INF/struts-tags.tld”] /> 注：这里我把struts-tags.tld放在WEB-INF下面，这一句是为了让Freemarker识别struts2的标签。
5.现在我们可以在FreeMarker模板中使用标签了。

可以参考我的学习资料：http://download.youkuaiyun.com/detail/zh_yy9/8987291