FreeMarker入门

一、FreeMarker介绍

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

目前企业中:主要用Freemarker做静态页面或是页面展示

二、FreeMarker使用方法

把freemarker的jar包添加到工程中。

Maven工程添加依赖

<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
  <version>2.3.23</version>
</dependency>

1）创建一个模板文件

2）Java测试代码

public class TestFreeMarker {

	@Test
	public void FreeMarkerTest() throws Exception {
		//1、创建一个模板文件
		//2、创建一个Configuration对象
		Configuration configuration = new Configuration(Configuration.getVersion());
		//3、设置模板文件保存的目录
		configuration.setDirectoryForTemplateLoading(new File("E:\\freemarker"));
		//4、模板文件的编码格式，一般就是utf-8
		configuration.setDefaultEncoding("utf-8");
		//5、加载一个模板文件，创建一个模板对象。
		Template template = configuration.getTemplate("hello.ftl");
		//6、创建一个数据集。可以是pojo也可以是map。推荐使用map
		Map data = new HashMap<>();
		data.put("hello", "hello freemarker!");
		//7、创建一个Writer对象，指定输出文件的路径及文件名。
		Writer out = new FileWriter(new File("E:\\freemarker\\hello.txt"));
		//8、生成静态页面
		template.process(data, out);
		//9、关闭流
		out.close();
	}
}

三、FreeMarker语法

下面用Student对象来介绍一下FreeMarker语法

public class Student {
	private int id;
	private String name;
	private int age;
	private String address;
    //getter、setter省略
}

1）访问map中的key，得到value

${key}

2）访问pojo中的属性

语法：${pojo.property}
学生信息：
<label>学号：</label>${student.id}<br>
<label>姓名：</label>${student.name}<br>
<label>年龄：</label>${student.age}<br>
<label>住址：</label>${student.address}<br>

3）取集合中的数据（下标：index）

<#list studentList as student>
    <tr>
        <td>${student_index}</td>
        <td>${student.id}</td>
        <td>${student.name}</td>
        <td>${student.age}</td>
        <td>${student.address}</td>
    </tr>
</#list>

4）判断

<#if student_index % 2 == 0>
<#else>
</#if>

5）日期类型格式化

当前日期：${date?date}
当前时间：${date?time}
当前日期和时间：${date?datetime}
自定义日期格式：${date?string("yyyy/MM/dd HH:mm:ss")}

6）null值的处理

null值的处理：
1）若val可能为空，!给定默认值：${var!"val为空"}
2）if语句判断是否为空(??不为空)：
<#if val??>
    not null
<#else>
    null
<#/if>

7）include标签

<#include "模板文件名">

四、SpringMVC整合FreeMarker

1）引入依赖：

<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
  <version>2.3.23</version>
</dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context-support</artifactId>
  <version>4.3.12</version>
</dependency>

2）Sping配置文件里配置以下bean

<bean id="freemarkerConfig"
    class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
    <!-- 模板文件路径 -->
    <property name="templateLoaderPath" value="/WEB-INF/ftl/" />
    <property name="defaultEncoding" value="UTF-8" />
</bean>

3）创建一个Controller测试

@Controller
public class HtmlGenController {
	
	@Autowired
	private FreeMarkerConfigurer freeMarkerConfigurer;

	@RequestMapping("/genhtml")
	@ResponseBody
	public String genHtml()throws Exception {
		// 1、从spring容器中获得FreeMarkerConfigurer对象。
		// 2、从FreeMarkerConfigurer对象中获得Configuration对象。
		Configuration configuration = freeMarkerConfigurer.getConfiguration();
		// 3、使用Configuration对象获得Template对象。
		Template template = configuration.getTemplate("hello.ftl");
		// 4、创建数据集
		Map dataModel = new HashMap<>();
		dataModel.put("hello", "1000");
		// 5、创建输出文件的Writer对象。
		Writer out = new FileWriter(new File("D:\\spring-freemarker.html"));
		// 6、调用模板对象的process方法，生成文件。
		template.process(dataModel, out);
		// 7、关闭流。
		out.close();
		return "OK";
	}
}