Freemarker简单入门指南

Freemarker入门指南

一、什么是FreeMarker？

  FreeMarker是一个用Java语言编写的模板引擎，它基于模板来生成文本输出。

  所谓模板，就是一份已经写好了基本内容，有着固定格式的文本。其中空出或者用占位符标识的的内容，由模板引擎加载和解析后，并采用动态数据替代。

  Freemarker在我们的应用中仅仅只是一个组件，并不知道什么Http协议或者Servlet。仅仅是用于生成文本内容而已。

二、模板 + 数据模型 = 输出

 

1、模板文件同样是静态的HTML代码，但是除了这些HTML代码外，代码中还包括了一些FreeMarker指令，这些指令就能够做到动态效果。

2、数据模型基本结构是树状的。

a）.标量存储单一的值，这种类型的值可以是字符串，数字，日期/ 时间或者是布尔值。

b）.哈希表是存储变量和与其相关且有唯一标识名称变量的容器。序列是存储有序变量的容器。

c).存储的变量可以通过数字索引来检索，索引通常从零开始。

 

三、示例：

模板文件示例 数据模型示例

        

   

输出

 

四、freemarker指令:

1、使用FTL标签来调用directives指令

2、标签分为两种：

 开始标签：<#directivename parametes>

 结束标签：</#directivename>

例：<#if something>...</#if>

如果标签没有嵌套内容（在开始标签和结束标签之内的内容），那么可以只使用开始标签。

五、常用指令：

if指令  list指令  include指令  macro指令

 

1、If指令示例：

使用if指令可以有条件地跳过模板的一部分，这和程序语言中if是相似的。

格式：

<#if condition>

...

<#elseif condition2>

...

<#elseif condition3>

...

...

<#else>

...

</#if>

这里：  condition，condition2等：表达式将被计算成布尔值。

2、list指令：

list指令来处理模板的一个部分中的一个序列中包含的各个变量

格式：

<#list sequence as item>

...

</#list>

这里：

sequence：表达式将被算作序列或集合

item：循环变量（不是表达式）的名称

3、include指令：

模板中插入另外一个FreeMarker模板文件（由path参数指定）。被包含模板的输出格式是在include标签出现的位置插入的

格式：

<#include path> or <#include path options>

path：要包含文件的路径；一个算作是字符串的表达式。（用其他话说，它不用是一个固定的字符串，它也可以是像profile.baseDir +“/menu.ftl”这样的东西。）

options：一个或多个这样的选项：encoding=encoding,parse=parse

encoding：算作是字符串的表达式

parse：算作是布尔值的表达式（为了向下兼容，也接受一部分字符串值）

4、macro指令：

宏变量存储模板片段（称为宏定义体）可以被用作自定义指令，调用方式为<@name param1 =  …/>

格式：

<#macro name param1 param2 ... paramN>

...

</#macro>

name：宏变量的名称，它不是表达式。

param1，param2等： 局部变量的名称，存储参数的值（不是表达式）

 

 

案例：

 

 

package demotest;

 

import java.io.File;

import java.io.OutputStreamWriter;

import java.util.HashMap;

import java.util.Random;

import freemarker.template.Configuration;

import freemarker.template.Template;

 

public class FreemarkerTest {

 

public static void main(String[] args) throws Exception {

//创建freemarker配置实例

Configuration cfg = new Configuration();

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

//创建数据模板

HashMap<Object,Integer> map = new HashMap<>();

map.put("random", new Random().nextInt(10000));

//加载模板文件

Template template = cfg.getTemplate("b.ftl");

//显示生成的数据

OutputStreamWriter out = new OutputStreamWriter(System.out);

template.process(map, out);

out.flush();

out.close();

}

}

b.ftl文件

${random}

 

package demotest;

 

import java.io.File;

import java.io.OutputStreamWriter;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Random;

 

import freemarker.template.Configuration;

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"));

//创建数据模型

HashMap map = new HashMap();

map.put("user", "张小亮");

map.put("random",new Random().nextInt(100));

ArrayList<Object> list = new ArrayList<>();

list.add(2);

list.add(3);

list.add(4);

list.add(5);

list.add(6);

map.put("lis",list);

//加载模板文件

Template tl = cfg.getTemplate("a.ftl");

//显示生成的数据

OutputStreamWriter out = new OutputStreamWriter(System.out);

tl.process(map, out);

out.flush();

out.close();

}

}

 

a.ftl文件

你好啊！${user}今天天气不错...

<#if random gt 60 >

不及格！

<#else>

及格！

</#if>

=============================

<#list lis as a>

${a}

</#list>