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>

原理：
使用步骤：
第一步：创建一个Configuration对象，直接new一个对象。构造方法的参数就是freemarker对于的版本号。

// 第一步：创建一个Configuration对象，直接new一个对象。构造方法的参数就是freemarker对于的版本号。
Configuration configuration = new Configuration(Configuration.getVersion());

第二步：设置模板文件所在的路径。
后序的所有模板文件都放在此目录下

// 第二步：设置模板文件所在的路径。
		configuration.setDirectoryForTemplateLoading(
				new File("F:/dianshang/e3-item-web/src/main/webapp/WEB-INF/ftl"));

第三步：设置模板文件使用的字符集。一般就是utf-8.

// 第三步：设置模板文件使用的字符集。一般就是utf-8.
		configuration.setDefaultEncoding("utf-8");

第四步：加载一个模板，创建一个模板对象。

// 第四步：加载一个模板，创建一个模板对象。
		Template template = configuration.getTemplate("hello.ftl");

第五步：创建一个模板使用的数据集，可以是pojo也可以是map。一般是Map。

// 第五步：创建一个模板使用的数据集，可以是pojo也可以是map。一般是Map。
		Map dataModel = new HashMap<>();
		// 向数据集中添加数据
		dataModel.put("hello", "this is my first freemarker test.");

第六步：创建一个Writer对象，一般创建一FileWriter对象，指定生成的文件名。
在本地磁盘上创建一个文件夹，用来保存生成的文件

// 第六步：创建一个Writer对象，一般创建一FileWriter对象，指定生成的文件名。
		Writer out = new FileWriter(new File("F:/test/freemarker/hello.txt"));

第七步：调用模板对象的process方法输出文件。

// 第七步：调用模板对象的process方法输出文件。
		template.process(dataModel, out);

第八步：关闭流。

// 第八步：关闭流。
		out.close();

查看结果

三、freemarker模板的语法

3.1 访问map中的key

${key}
案例如上

3.2 访问pojo中的属性

创建pojo实体

public class Student {

	private Integer id;
	private String name;
	private Integer age;
	private String address;
	
	。。。 get set方法
	
	public Student(Integer id, String name, Integer age, String address) {
		super();
		this.id = id;
		this.name = name;
		this.age = age;
		this.address = address;
	}
	public Student(){
		
	}
}

创建模板对象
代码：

	@Test
	public void testFreeMarkerPojo() throws Exception {
		// 第一步：创建一个Configuration对象，直接new一个对象。构造方法的参数就是freemarker对于的版本号。
		Configuration configuration = new Configuration(Configuration.getVersion());
		// 第二步：设置模板文件所在的路径。
		configuration.setDirectoryForTemplateLoading(
				new File("F:/dianshang/e3-item-web/src/main/webapp/WEB-INF/ftl"));
		// 第三步：设置模板文件使用的字符集。一般就是utf-8.
		configuration.setDefaultEncoding("utf-8");
		// 第四步：加载一个模板，创建一个模板对象。
		Template template = configuration.getTemplate("student.ftl");
		// 第五步：创建一个模板使用的数据集，可以是pojo也可以是map。一般是Map。
		Map dataModel = new HashMap<>();
		// 向数据集中添加数据
		//创建一个pojo对象
		Student student = new Student(1,"小明",18,"北京");
		dataModel.put("student", student);
		
		// 第六步：创建一个Writer对象，一般创建一FileWriter对象，指定生成的文件名。
		Writer out = new FileWriter(new File("F:/test/freemarker/student.html"));
		// 第七步：调用模板对象的process方法输出文件。
		template.process(dataModel, out);
		// 第八步：关闭流。
		out.close();
	}

结果：

3.3 取集合中的数据

<#list studentList as student>
${student.id}/${studnet.name}
</#list>

3.4 日期类型格式化

3.5 Null值的处理

3.6 引入其他模板Include标签