Freemarker使用记录

Freemarker介绍

freemarker官网：http://freemarker.foofun.cn/
简单理解：是通过freemaker的配置语言配置相应的模板（可以是配置或者文件），动态的生成一些文件、内容。在网上看到可以生成java文件、前端文件等等。

优缺点

优点：
1、freemarker的模板语言非常丰富和完善，使得模板可以应用在很多领域。
2、可以将freemarker模板做成配置项存在数据库中，可以灵活修改模板达到灵活配置的效果。例如可以利用freemarker来计算一个书籍的评分，可以通过配置模板灵活修改评分的规则。
3、本身使用起来非常简单，复杂的是对模板的配置

缺点：
1、在修改模板后，可能会看到已经过期的数据。页面一旦生成，不会自动根据模板的变化而变化
2、对不存在的对象操作时，易抛出异常，需要开发人员在模板里额外注意

Freemarker的使用

官网的教程非常清楚，这里稍微说说。
freemarker API：https://freemarker.apache.org/docs/api/index.html

1、引入jar包，这里用的是2.3.30版本

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

2、创建Configuration实例

// DEFAULT_INCOMPATIBLE_IMPROVEMENTS这里为默认版本，也可以指定版本
Configuration cfg = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS);
// Configuration cfg = new Configuration(Configuration.VERSION_2_3_30);

3、创建数据模型，为一个Map，key为字符串格式，value可以使用 java.lang 和 java.util 包中的类或者自己定义的bean

Map dataModel = new HashMap<>();
dataModel.put("hello", "1000");

4、获取模板，里面为模板语言自定义内容

// 模板内容${hello}
Template temp = cfg.getTemplate("test.ftl");

5、获得结果，模板和数据模型结合的结果

Writer out = new OutputStreamWriter(System.out);
temp.process(root, out);
// out为结合后的结果
System.out.println(out);
out.close();

可以看出，freemaker的使用非常简单，数据模型实际使用中一般都为bean，主要是对freemaker模板的配置

不使用模板文件使用freemarker

实际使用中，可能不想使用类似于test.ftl来存放freemaker模板吗，而是想将模板配置在数据库中或自动生成。这时候可以借助StringTemplateLoader类来完成

Configuration cfg = new Configuration(Configuration.VERSION_2_3_30);
StringTemplateLoader stl = new StringTemplateLoader();
stl.putTemplate("templateName","模板内容${hello}");
cfg.setTemplateLoader(stl);

结果输出也可以使用StringWriter

下面是代码实例：

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

import java.io.IOException;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Map;

public class FreemakerTest {
    public static void main(String[] args) throws IOException, TemplateException {
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_30);
        StringTemplateLoader stl = new StringTemplateLoader();
        stl.putTemplate("templateName","模板内容${hello}");
        cfg.setTemplateLoader(stl);
        Template template = cfg.getTemplate("templateName");
        StringWriter result = new StringWriter();
        Map dataModel = new HashMap<>();
        dataModel.put("hello", "1000");
        template.process(dataModel,result);
        System.out.println(result);
        result.flush();
        result.close();
    }
}

模板语言简介

模板语言介绍：http://freemarker.foofun.cn/ref.html