Demo代码已上传至Github
地址:https://github.com/ylw-github/FreeMarker-Demo.git
下面来讲解FreeMarker的集成步骤。
1.工程依赖引入
<dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</version> </dependency>
2. 创建模板文件(ftl文件)
模板文件中四种元素
- 文本,直接输出的部分
- 注释,即<#–…-->格式不会输出
- 插值(Interpolation):即${…}部分,将使用数据模型中的部分替代输出。
- FTL 指令:FreeMarker 指令,和 HTML 标记类似,名字前加#予以区分,不会输出。
现在创建一个简单的创建模板文件 test.ftl
<html> <head> <meta charset="utf-8"> <title>Freemarker 入门小 DEMO </title> </head> <body> <#--我只是一个注释,我不会有任何输出 --> ${name},你好。${message} </body> </html>
这里有文本、插值和注释
3.生成文件
使用步骤:
- 创建一个 Configuration 对象,直接 new 一个对象。构造方法的参数就是freemarker 的版本号。
- 设置模板文件所在的路径。
- 设置模板文件使用的字符集。一般就是 utf-8
- 加载一个模板,创建一个模板对象。
- 创建一个模板使用的数据集,可以是 pojo 也可以是 map。一般是 Map。
- 创建一个 Writer 对象,一般创建一 FileWriter 对象,指定生成的文件名。
- 调用模板对象的 process 方法输出文件。
- 关闭流。
代码:
创建 Test 类 main 方法如下:
//1.创建配置类 Configuration configuration=new Configuration(Configuration.getVersion()); //2.设置模板所在的目录 configuration.setDirectoryForTemplateLoading(newFile("D:/pinyougou_work/freemarkerDemo/src/main/resources/")); //3.设置字符集 configuration.setDefaultEncoding("utf-8"); //4.加载模板 Template template = configuration.getTemplate("test.ftl"); //5.创建数据模型 Map map=new HashMap();map.put("name", "张三 ");map.put("message", "欢迎来到神奇的品优购世界!"); //6.创建 Writer 对象 Writer out =new FileWriter(new File("d:\\test.html")); //7.输出 template.process(map, out);//8.关闭 Writer 对象out.close();
执行后,在 D 盘根目录即可看到生成的 test.html ,打开看看