FreeMarker 是一个用 Java 语言编写的模板引擎，它基于模板来生成文本输出。FreeMarker 与 Web 容器无关，即在 Web 运行时，它并不知道 Servlet 或 HTTP。它不仅可以用作表现层的实现技术，而且还可以用于生成 XML，JSP 或 Java 等。

一、Freemarker 的介绍

​ Freemarker 是一款模板引擎，是一种基于模版生成静态文件的通用 工具，它是为 java 程序员提供的一个开发包，或者说是一个类库，它不是面向最终用户的，而是为程序员提供了一款可以嵌入他们开发产品的应用程序。

​ Freemarker 是使用纯 java 编写的，为了提高页面的访问速度，需要把页面静态化， 那么 Freemarker 就是被用来生成 html 页面。

​ 到目前为止，Freemarker 使用越来越广泛，不光光只是它强大的生成技术，而且它能够与 spring 进行很好的集成。

​ 现在开始一层层揭开它的神秘面纱。。

二、Freemarker 的准备条件

​ freemarker.2.3.16.jar

三、Freemarker 生成静态页面的原理

​ Freemarker 生成静态页面，首先需要使用自己定义的模板页面，这个模板页面可以是最最普通的 html，也可以是嵌套 freemarker 中的 取值表达式， 标签或者自定义标签等等，然后后台读取这个模板页面，解析其中的标签完成相对应的操作， 然后采用键值对的方式传递参数替换模板中的的取值表达式，做完之后 根据配置的路径生成一个新的 html 页面， 以达到静态化访问的目的。

四、Freemarker 提供的标签

Freemarker 提供了很多有用 常用的标签，Freemarker 标签都是 <# 标签名称> 这样子命名的，${value} 表示输出变量名的内容 ，具体如下：

list：该标签主要是进行迭代服务器端传递过来的 List 集合，比如：

<#list nameList as names>

  ${names}

</#list>

​ name 是 list 循环的时候取的一个循环变量，freemarker 在解析 list 标签的时候，等价于：

for (String names : nameList) {

        System.out.println(names);

    }

if： 该标签主要是做 if 判断用的，比如：

<#if (names=="陈靖仇")>

 他的武器是: 十五~~

</#if>

​ 这个是条件判断标签，要注意的是条件等式必须用括号括起来， 等价于：

if(names.equals("陈靖仇")){

        System.out.println("他的武器是: 十五~~");

    }

include：该标签用于导入文件用的。

<#include "include.html"/>

​ 这个导入标签非常好用，特别是页面的重用。

另外在静态文件中可以使用 ${} 获取值，取值方式和 el 表达式一样，非常方便。

​ 下面举个例子（static.html）：

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<title>Insert title here</title>

</head>

<body>

描述：${description}

<br/>

集合大小:${nameList?size}

<br/>

迭代list集合：

<br/>

<#list nameList as names>

这是第${names_index+1}个人，叫做：<label style="color:red">${names}</label>

if判断：

<br/>

<#if (names=="陈靖仇")>

 他的武器是: 十五~~

<#elseif (names=="宇文拓")>       <#--注意这里没有返回而是在最后面-->

 他的武器是: 轩辕剑~·

<#else>

她的绝招是：蛊毒~~

</#if>

<br/>

</#list>

迭代map集合：

<br/>

<#list weaponMap?keys as key>

key--->${key}<br/>

value----->${weaponMap[key]!("null")}

<#--

fremarker 不支持null, 可以用！ 来代替为空的值。

其实也可以给一个默认值

value-----${weaponMap[key]?default("null")}

还可以 在输出前判断是否为null

<#if weaponMap[key]??></#if>都可以

-->

<br/>

</#list>

include导入文件：

<br/>

<#include "include.html"/>

</body>

</html>

​ 实际代码：

package com.chenghui.test;

import java.io.File;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.OutputStreamWriter;

import java.io.Writer;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import freemarker.template.Configuration;

import freemarker.template.DefaultObjectWrapper;

import freemarker.template.Template;

import freemarker.template.TemplateException;

public class CreateHtml {

    public static void main(String[] args) {

        try {

            //创建一个合适的Configration对象

            Configuration configuration = new Configuration();

            configuration.setDirectoryForTemplateLoading(new File("D:\\project\\webProject\\WebContent\\WEB-INF\\template"));

            configuration.setObjectWrapper(new DefaultObjectWrapper());

            configuration.setDefaultEncoding("UTF-8");   //这个一定要设置，不然在生成的页面中 会乱码

            //获取或创建一个模版。

            Template template = configuration.getTemplate("static.html");

            Map<String, Object> paramMap = new HashMap<String, Object>();

            paramMap.put("description", "我正在学习使用Freemarker生成静态文件！");

            List<String> nameList = new ArrayList<String>();

            nameList.add("陈靖仇");

            nameList.add("玉儿");

            nameList.add("宇文拓");

            paramMap.put("nameList", nameList);

            Map<String, Object> weaponMap = new HashMap<String, Object>();

            weaponMap.put("first", "轩辕剑");

            weaponMap.put("second", "崆峒印");

            weaponMap.put("third", "女娲石");

            weaponMap.put("fourth", "神农鼎");

            weaponMap.put("fifth", "伏羲琴");

            weaponMap.put("sixth", "昆仑镜");

            weaponMap.put("seventh", null);

            paramMap.put("weaponMap", weaponMap);

            Writer writer  = new OutputStreamWriter(new FileOutputStream("success.html"),"UTF-8");

            template.process(paramMap, writer);

            System.out.println("恭喜，生成成功~~");

        } catch (IOException e) {

            e.printStackTrace();

        } catch (TemplateException e) {

            e.printStackTrace();

        }

    }

}

​ 这样子基本上可以算的上可以简单的去做一点简单的生成了，但是要在实际中去运用，还是差的很远的，因为 freemarker 给的标签完全满足不了我们的需要，这时候就需要自定义标签来完成我们的需求了。。

五、Freemarker 自定义标签

Freemarker 自定义标签就是自己写标签，然后自己解析，完全由自己来控制标签的输入输出，极大的为程序员提供了很大的发挥空间。

基于步骤：

​ 以前写标签需要在 <后加# ，但是 freemarker 要识别自定义标签需要在后面加上 @，然后后面可以定义一些参数，当程序执行 template.process(paramMap, out);, 就会去解析整个页面的所有的 freemarker 标签。

​ 自定义标签 需要自定义一个类，然后实现 TemplateDirectiveModel，重写 execute 方法，完成获取参数，根据参数 do something 等等。

​ 将自定义标签与解析类绑定在一起需要在 paramMap 中放入该解析类的实例，存放的 key 与自定义标签一致即可。

​ 注意：在自定义标签中，如果标签内什么也没有，开始标签和结束标签绝对不能再同一行，不然会报错 freemarker.log.JDK14LoggerFactory$JDK14Logger error

例: static.html 模板

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<title>Insert title here</title>

</head>

<body>

<#--自定义变量-->

<#assign num='hehe'/>

${num}

<br/>

自定义标签

  <@content name="chenghui" age="120">

      ${output}

      ${append}

  </@content>

</body>

</html>

static.html 模板解析类：

​ 参数解释：

TemplateDirectiveModel 接口是 freemarker 自定标签或者自定义指令的核心处理接口。通过实现该接口，用户可以自定义标签（指令）进行任意操作， 任意文本写入模板的输出。

该接口中只定义了如下方法，当模板页面遇到用户自定义的标签指令时，该方法会被执行。

public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, IOException;

@param env：系统环境变量，通常用它来输出相关内容，如 Writer out = env.getOut();

@param params：自定义标签传过来的对象，其 key = 自定义标签的参数名，value 值是 TemplateModel 类型，而 TemplateModel 是一个接口类型，通常我们都使用 TemplateScalarModel 接口来替代它获取一个 String 值，如 TemplateScalarModel.getAsString(); 当然还有其它常用的替代接口，如 TemplateNumberModel 获取 number，TemplateHashModel 等

@param loopVars 循环替代变量

@param body 用于处理自定义标签中的内容，如 <@myDirective> 将要被处理的内容 /@myDirective；当标签是 <@myDirective /> 格式时，body=null

package com.chenghui.test;

import static freemarker.template.ObjectWrapper.DEFAULT_WRAPPER;

import java.io.IOException;

import java.io.Writer;

import java.util.Map;

import freemarker.core.Environment;

import freemarker.template.TemplateDirectiveBody;

import freemarker.template.TemplateDirectiveModel;

import freemarker.template.TemplateException;

import freemarker.template.TemplateModel;

import freemarker.template.TemplateModelException;

import freemarker.template.TemplateNumberModel;

import freemarker.template.TemplateScalarModel;

/**

 * 自定义标签解析类

 * @author Administrator

 *

 */

public class ContentDirective implements TemplateDirectiveModel{

    private static final String PARAM_NAME = "name";

    private static final String PARAM_AGE = "age";

    @Override

    public void execute(Environment env, Map params,TemplateModel[] loopVars,

            TemplateDirectiveBody body) throws TemplateException, IOException {

        if(body==null){

            throw new TemplateModelException("null body");

        }else{

            String name = getString(PARAM_NAME, params);

            Integer age = getInt(PARAM_AGE, params);

            //接收到参数之后可以根据做具体的操作，然后将数据再在页面中显示出来。

            if(name!=null){

                env.setVariable("output", DEFAULT_WRAPPER.wrap("从ContentDirective解析类中获得的参数是："+name+", "));

            }

            if(age!=null){

                env.setVariable("append", DEFAULT_WRAPPER.wrap("年龄："+age));

            }

            Writer out = env.getOut();

            out.write("从这里输出可以再页面看到具体的内容，就像document.writer写入操作一样。<br/>");

            body.render(out);

            /*

              如果细心的话，会发现页面上是显示out.write（）输出的语句，然后再输出output的内容，

            可见 在body在解析的时候会先把参数放入env中，在页面遇到对应的而来表单时的才会去取值

            但是，如果该表单时不存在，就会报错，  我觉得这里freemarker没有做好，解析的时候更加会把错误暴露在页面上。

            可以这样子弥补${output!"null"},始终感觉没有el表达式那样好。

            */

        }

    }

    /**

     * 获取String类型的参数的值

     * @param paramName

     * @param paramMap

     * @return

     * @throws TemplateModelException

     */

    public static String getString(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{

        TemplateModel model = paramMap.get(paramName);

        if(model == null){

            return null;

        }

        if(model instanceof TemplateScalarModel){

            return ((TemplateScalarModel)model).getAsString();

        }else if (model instanceof TemplateNumberModel) {

            return ((TemplateNumberModel)model).getAsNumber().toString();

        }else{

            throw new TemplateModelException(paramName);

        }

    }

    /**

     *

     * 获得int类型的参数

     * @param paramName

     * @param paramMap

     * @return

     * @throws TemplateModelException

     */

    public static Integer getInt(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{

        TemplateModel model = paramMap.get(paramName);

        if(model==null){

            return null;

        }

        if(model instanceof TemplateScalarModel){

            String str = ((TemplateScalarModel)model).getAsString();

            try {

                return Integer.valueOf(str);

            } catch (NumberFormatException e) {

                throw new TemplateModelException(paramName);

            }

        }else if(model instanceof TemplateNumberModel){

            return ((TemplateNumberModel)model).getAsNumber().intValue();

        }else{

            throw new TemplateModelException(paramName);

        }

    }

}

​ 然后再前面的实际代码中加上：

paramMap.put("content", new ContentDirective());

这样子基本上可以使用，freemarker 完成自定义标签了，解决一写简单的业务逻辑， 但是在实际的项目中不可能这样子去做，因为还没有和 spring 进行集成使用，每次都需要在解析的时候把解析类的实例放进去。

FreeMarker 自定义 TemplateDirectiveModel(一)的更多相关文章

  1. FreeMarker自定义TemplateDirectiveModel

    [参考:http://blog.csdn.net/fangzhangsc2006/article/details/8687371] 在采用FreeMarker做前台视图模板的情况下,我们可以通过< ...

  2. 关于FreeMarker自定义TemplateDirectiveModel

    [转载来源:http://zwllxs.iteye.com/blog/2036826] java代码如下: import freemarker.core.Environment; import fre ...

  3. FreeMarker 自定义 TemplateDirectiveModel(二)

    FreeMarker 是一个用 Java 语言编写的模板引擎,它基于模板来生成文本输出.FreeMarker 与 Web 容器无关,即在 Web 运行时,它并不知道 Servlet 或 HTTP.它不 ...

  4. 基于SSM3框架FreeMarker自定义指令（标签）实现

    通过之前的Spring MVC 3.0.5+Spring 3.0.5+MyBatis3.0.4全注解实例详解系列文章,我们已经成功的整合到了一起,这次大象将在此基础上对框架中的FreeMarker模板 ...

  5. freemarker自定义标签（与java合用）

    自定义类继承FreemarkerManager类,重写protected Configuration createConfiguration(ServletContext servletContext ...

  6. OneBlog开源博客-详细介绍如何实现freemarker自定义标签

    前言 OneBlog中使用到了springboot + freemarker的技术,同时项目里多个controller中都需要查询一个公有的数据集合,一般做法是直接在每个controller的方法中通 ...

  7. freemarker 自定义标签

    1.编写标签类 package com.pccw.business.fnd.common.filegen; import java.io.IOException; import java.io.Wri ...

  8. freemarker自定义标签报错（六）

    freemarker自定义标签 1.错误描述 freemarker.core.ParseException: Encountered "\"\u4f60\u597d\uff01\& ...

  9. freemarker自定义标签报错（五）

    freemarker自定义标签 1.错误描述 六月 05, 2014 11:40:49 下午 freemarker.log.JDK14LoggerFactory$JDK14Logger error 严 ...

随机推荐

  1. php代码post请求

    <?php /** * 发送post请求 * @param string $url 请求地址 * @param array $post_data post键值对数据 * @return stri ...

  2. cordova 插件发布到 npm

    cordova 插件发布到 npm Cordova插件开发(3)- 将Cordova插件发布到npm could not find an installed version of gradle eit ...

  3. Java 基础 - 如何重写equals()

    ref:https://www.cnblogs.com/TinyWalker/p/4834685.html -------------------- 编写equals方法的建议: 显示参数命名为oth ...

  4. 单调栈——cf777E

    傻逼单调栈啊我怎么想了半天dp #include <bits/stdc++.h> using namespace std; typedef long long LL; typedef st ...

  5. Ubuntu 更新错误修复大全

    合并列表问题 当你在终端中运行更新命令时,你可能会碰到这个错误“合并列表错误”,就像下面这样: E:Encountered a section with no Package: header, E:P ...

  6. goconvey测试模块

    一.介绍 是一款针对Golang的测试框架,可以管理和运行测试用例,同时提供了丰富的断言函数,并支持很多 Web 界面特性. GoConvey 网站 : http://smartystreets.gi ...

  7. echarts renderItem-在区间段内展示连续数据

    一.需求背景: 贴图说明:要求数据在不同类型的区间段内展示. 二.实现思路及代码 实现方法: 利用echarts的自定义配置:option.series[i].type='custom'中的rende ...

  8. 命令学习_nslookup

    nslookup 域名 这是最常用最简单的用法,可以直接获得目标域名的IP地址和CNAME. 如下是A记录的返回情况 nslookup命令会采用先反向解释获得使用的DNS服务器的名称,上图中ns.gu ...

  9. SpringCloud学习笔记（九）：SpringCloud Config 分布式配置中心

    概述 分布式系统面临的-配置问题 微服务意味着要将单体应用中的业务拆分成一个个子服务,每个服务的粒度相对较小,因此系统中会出现大量的服务.由于每个服务都需要必要的配置信息才能运行,所以一套集中式的.动 ...

  10. seienium基础（测试脚本中的等待方法）

    测试脚本中的等待方法 一.加等待时间的目的 等待是为了使脚本执行更加稳定 二.常用的休眠方式 第一种  sleep(): 设置固定休眠时间.python 的 time 包提供了休眠方法 sleep() ...