freemarker Java 模板引擎 基本语法

0 freemarker简介

首先我们要先通过 官网：https://freemarker.apache.org/ 了解什么是freemarker 以及他的使用方法。官方介绍如下：

Apache FreeMarker™是一个模板引擎：一个Java库，用于根据模板和更改数据生成文本输出（HTML网页，电子邮件，配置文件，源代码等）。模板是用FreeMarker模板语言（FTL）编写的，这是一种简单的专用语言（不像PHP这样的完整编程语言）。通常，使用通用编程语言（如Java）来准备数据（发布数据库查询，进行业务计算）。然后，Apache FreeMarker使用模板显示准备好的数据。在模板中，您将关注如何呈现数据，而在模板之外，您将关注于要呈现的数据。

这种方法通常被称为MVC（模型视图控制器）模式，并且特别受动态网页的欢迎。它有助于将网页设计者（HTML作者）与开发人员（通常是Java程序员）分开。设计人员不会在模板中面对复杂的逻辑，并且可以在程序员不必更改或重新编译代码的情况下更改页面的外观。

虽然FreeMarker最初是为在MVC Web应用程序框架中生成HTML页面而创建的，但它并没有绑定到servlet或HTML或任何与Web相关的内容。它也用于非Web应用程序环境。

通过点击下图红色框文档手册 阅读如何使用 freemarker

接下来开始介绍freemarker 基本用法。介绍之前先说明一下我们的开发环境

0.1 版本说明

IDEA :STS

JDK：1.8

freemarker Version:2.3.28

这里将通过maven项目进行说明我们的用法。首先引入freemarker 依赖到我们的maven项目中

	 
	  org.freemarker
	  freemarker
	  2.3.28
	

1 freemarker 用法之 Hello word

在resource目录下创建template目录并添加helloworld.ftl 模板文件 内容如下：

               
  
	
 
  
	
this is ${who} hello World

  
 

 创建配置实例 并将模板和数据进行输出

package cn.lijunkui.examples;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import org.junit.Test;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

public class FreemarkerDemo {
	@Test
	public void helloWord() throws IOException, TemplateException {
		
		Configuration cfg = new Configuration(Configuration.VERSION_2_3_28);
		//指定模板文件的来源
		String path = FreemarkerDemo.class.getClassLoader().getResource("template").getPath();
		cfg.setDirectoryForTemplateLoading(new File(path));
		//这是模板的编码
		cfg.setDefaultEncoding("UTF-8");
		//获取模板
		Template template = cfg.getTemplate("helloworld.ftl"); 
		//创建FreeMarker的数据模型  
        Map root = new HashMap();  
        root.put("who","freemarker");
        //这是输出文件
        File file = new File("D://" +"helloWord.html");
		Writer out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file)));
		//将模板与数据模型合并
        template.process(root, out); 
        out.flush();  
        out.close();  
	}
}

2 data-model：数据模型

hello word的示例其实就是 Template + data-model = output 接下来我们引用一下官方的示例介绍一下数据模型

数据模型是树状结构 如下图

以上只是一个可视化; 数据模型不是文本格式，而是来自Java对象。对于Java程序员来说，root可能是带有getUser() 和getLatestProduct()方法的Java对象，或者是Map带有"user"和"latestProducts"键的Java 。同样， latestProduct也许是一个Java对象 getUrl()和getName() 方法。