FreeMarker 的入门应用-基础篇

一.简介

FreeMarker 是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯 Java 编写，FreeMarker 被设计用来生成 HTML Web 页面，特别是基于 MVC 模式的应用程序，虽然 FreeMarker 具有一些编程的能力，但通常由 Java 程序准备要显示的数据，由FreeMarker 生成页面，通过模板显示准备的数据

FreeMarker 不是一个 Web 应用框架，而适合作为 Web 应用框架一个组件。FreeMarker 与容器无关，因为它并不知道 HTTP 或 Servlet；FreeMarker 同样可以应用于非Web应用程序环境，FreeMarker 更适合作为 Model2 框架（如 Struts）的视图组件，你也可以在模板中使用 JSP标记库。另外，FreeMarker是免费的。

2.应用场景

比较适合运用在访问量大（或页面数据量大），但是数据很少与后台进行交互（即对实时性要求不是很高的）的页面，比如商品网站上的商品详情页等。

3.前期准备

要想使用freemarker，首先必须要有freemarker的jar包，这个互联网上随处可以下载，这边就不多说

1. <dependency>

2. <groupId>freemarker</groupId>

3. <artifactId>freemarker</artifactId>

4. <version>2.3.9</version>

5. </dependency>

 

4.入门demo

(1)创建一个testFreemarker类

1. import java.io.File;

2. import java.io.FileWriter;

3. import java.io.Writer;

4. import java.util.HashMap;

5. import java.util.Map;

6. import freemarker.template.Configuration;

7. import freemarker.template.Template;

10. /**

11. * @作者：JackHisen(GWD)

12. * @项目名：freemarker

13. * @时间：2017-7-25 下午2:39:45

14. * @version 1.0

15. */

16. public class testFreemarker {

17. public static void main(String[] args) throws Exception {

18. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

19. Configuration conf = new Configuration();

20. //加载模板文件(模板的路径)

21. conf.setDirectoryForTemplateLoading(new File(dir));

22. // 加载模板

23. Template template = conf.getTemplate("/freemarker-demo.ftl");

24. // 定义数据

26. Map root = new HashMap();

27. root.put("world", "Hello World");

28. // 定义输出

29. Writer out = new FileWriter(dir + "/freemarker.html");

30. template.process(root, out);

31. System.out.println("转换成功");

32. out.flush();

33. out.close();

34. }

35. }

项目目录如下，其中freemarker.html文件是运行main函数后自动生成的，freemarker-demo.ftl为模板

(2)freemarker模板中写入内容

(3)生成的html页面：

5.其他数据类型

1.实体bean

（1）创建Person类

1. public class Person {

2. private int id;

3. private String name;

4. public int getId() {

5. return id;

6. }

7. public void setId(int id) {

8. this.id = id;

9. }

10. public String getName() {

11. return name;

12. }

13. public void setName(String name) {

14. this.name = name;

15. }

16. }

（2）testFreemarker

1. public class testFreemarker {

2. public static void main(String[] args) throws Exception {

3. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

4. Configuration conf = new Configuration();

5. //加载模板文件(模板的路径)

6. conf.setDirectoryForTemplateLoading(new File(dir));

7. // 加载模板

8. Template template = conf.getTemplate("/freemarker-demo.ftl");

9. // 定义数据

11. Person person=new Person();

12. person.setId(1);

13. person.setName("小明");

14. Map root = new HashMap();

15. root.put("person", person);

16. // 定义输出

17. Writer out = new FileWriter(dir + "/freemarker.html");

18. template.process(root, out);

19. System.out.println("转换成功");

20. out.flush();

21. out.close();

22. }

23. }

（3）Freemarker模板

${person.id}
${person.name}

（4）生成的html页面

2.List集合

（1）testFreemarker

1. public class testFreemarker {

2. public static void main(String[] args) throws Exception {

3. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

4. Configuration conf = new Configuration();

5. //加载模板文件(模板的路径)

6. conf.setDirectoryForTemplateLoading(new File(dir));

7. // 加载模板

8. Template template = conf.getTemplate("/freemarker-demo.ftl");

9. // 定义数据

11. Person p1=new Person();

12. p1.setId(1);

13. p1.setName("小明");

14. Person p2=new Person();

15. p2.setId(2);

16. p2.setName("小华");

17. List<Person> person=new ArrayList<Person>();

18. person.add(p1);

19. person.add(p2);

20. Map root = new HashMap();

21. root.put("person", person);

22. // 定义输出

23. Writer out = new FileWriter(dir + "/freemarker.html");

24. template.process(root, out);

25. System.out.println("转换成功");

26. out.flush();

27. out.close();

28. }

29. }

（2）模板

1. <#list person as p>

2. ${p.id}/${p.name}

3. </#list>

（3）生成的html文件

3.Map集合

1.testFreemarker

1. public class testFreemarker {

2. public static void main(String[] args) throws Exception {

3. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

4. Configuration conf = new Configuration();

5. //加载模板文件(模板的路径)

6. conf.setDirectoryForTemplateLoading(new File(dir));

7. // 加载模板

8. Template template = conf.getTemplate("/freemarker-demo.ftl");

9. // 定义数据

11. Map root = new HashMap();

12. Map mxs = new HashMap();

13. mxs.put("fbb","范冰冰");

14. mxs.put("lbb","李冰冰");

16. root.put("mxs",mxs);

18. // 定义输出

19. Writer out = new FileWriter(dir + "/freemarker.html");

20. template.process(root, out);

21. System.out.println("转换成功");

22. out.flush();

23. out.close();

24. }

25. }

2.模板（两种写法）

1. ${mxs.fbb}/${mxs.lbb}

4. <#list mxs?keys as k>

5. ${mxs[k]}

6. </#list>

3.生成的html

4.List<Map>集合

1.testFreemarker

1. public class testFreemarker {

2. public static void main(String[] args) throws Exception {

3. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

4. Configuration conf = new Configuration();

5. //加载模板文件(模板的路径)

6. conf.setDirectoryForTemplateLoading(new File(dir));

7. // 加载模板

8. Template template = conf.getTemplate("/freemarker-demo.ftl");

9. // 定义数据

11. Map root = new HashMap();

12. List<Map> maps = new ArrayList<Map>();

13. Map pms1 = new HashMap();

14. pms1.put("id1", "范冰冰");

15. pms1.put("id2", "李冰冰");

16. Map pms2 = new HashMap();

17. pms2.put("id1", "曾志伟");

18. pms2.put("id2", "何炅");

19. maps.add(pms1);

20. maps.add(pms2);

21. root.put("maps", maps);

23. // 定义输出

24. Writer out = new FileWriter(dir + "/freemarker.html");

25. template.process(root, out);

26. System.out.println("转换成功");

27. out.flush();

28. out.close();

29. }

30. }

2.模板（2种）

1. <#list maps as m>

2. ${m.id1}/${m.id2}

3. </#list>

6. <#list maps as m>

7. <#list m?keys as k>

8. ${m[k]}

9. </#list>

10. </#list>

3.生成的html

5.获得当前迭代的索引

(1)testFreemarker

1. public class testFreemarker {

2. public static void main(String[] args) throws Exception {

3. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

4. Configuration conf = new Configuration();

5. //加载模板文件(模板的路径)

6. conf.setDirectoryForTemplateLoading(new File(dir));

7. // 加载模板

8. Template template = conf.getTemplate("/freemarker-demo.ftl");

9. // 定义数据

11. Map root = new HashMap();

12. Person p1=new Person();

13. p1.setId(1);

14. p1.setName("李冰冰");

15. Person p2=new Person();

16. p2.setId(2);

17. p2.setName("范冰冰");

18. Person p3=new Person();

19. p3.setId(3);

20. p3.setName("沙冰冰");

21. List<Person> list = new ArrayList<Person>();

22. list.add(p1);

23. list.add(p2);

24. list.add(p3);

25. root.put("persons", list);

27. // 定义输出

28. Writer out = new FileWriter(dir + "/freemarker.html");

29. template.process(root, out);

30. System.out.println("转换成功");

31. out.flush();

32. out.close();

33. }

34. }

(2)模板

1. <#list persons as p>

2. ${p_index}

3. </#list>

(3)生成的html文件

（6）在模板中进行赋值

（1）testFreemarker

1. package com.gwd.freemarker;

3. import java.io.File;

4. import java.io.FileWriter;

5. import java.io.Writer;

6. import java.util.ArrayList;

7. import java.util.HashMap;

8. import java.util.List;

9. import java.util.Map;

11. import freemarker.template.Configuration;

12. import freemarker.template.Template;

15. /**

16. * @作者：JackHisen(GWD)

17. * @项目名：freemarker

18. * @时间：2017-7-25 下午2:39:45

19. * @version 1.0

20. */

21. public class testFreemarker {

22. public static void main(String[] args) throws Exception {

23. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

24. Configuration conf = new Configuration();

25. //加载模板文件(模板的路径)

26. conf.setDirectoryForTemplateLoading(new File(dir));

27. // 加载模板

28. Template template = conf.getTemplate("/freemarker-demo.ftl");

29. // 定义数据

31. Map root = new HashMap();

33. root.put("world","hello world");

35. // 定义输出

36. Writer out = new FileWriter(dir + "/freemarker.html");

37. template.process(root, out);

38. System.out.println("转换成功");

39. out.flush();

40. out.close();

41. }

42. }

（2）模板

1. <#assign x="${world}" />

2. ${x}

4. <#assign x>

5. <#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as n>

6. ${n}

7. </#list>

8. </#assign>

9. ${x}

(3)生成的html

7.if语句

(1)申明：一般情况下模板中的数据来源于后台，但是这边为了方便演示，所以数据都在模板中写死了，后台testFreemarker可以同上，但实际上map可以为空，只要确保能生成html页面即可

(2)模板

1. <#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as n>

2. <#if n != "星期一">

3. ${n}

4. </#if>

5. </#list>

 

(3)生成的html文件

8.else语句

(1)模板

1. <#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as n>

2. <#if (n_index == 1) || (n_index == 3)>

3. ${n} --红色

4. <#else>

5. ${n} --绿色

6. </#if>

7. </#list>

(2)生成的html

9.格式化日期

(1)testFreemarker

1. public class testFreemarker {

2. public static void main(String[] args) throws Exception {

3. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

4. Configuration conf = new Configuration();

5. //加载模板文件(模板的路径)

6. conf.setDirectoryForTemplateLoading(new File(dir));

7. // 加载模板

8. Template template = conf.getTemplate("/freemarker-demo.ftl");

9. // 定义数据

11. Map root = new HashMap();

13. root.put("cur_time",new Date());

15. // 定义输出

16. Writer out = new FileWriter(dir + "/freemarker.html");

17. template.process(root, out);

18. System.out.println("转换成功");

19. out.flush();

20. out.close();

21. }

22. }

(2)日期模板

${cur_time?date}

生成html

(3)日期时间模板

${cur_time?datetime}

生成html

(4)时间模板

${cur_time?time}

生成html

10.对null的处理

(1)testFreemarker

1. public class testFreemarker {

2. public static void main(String[] args) throws Exception {

3. String dir="H:\\Java-EE Workspace\\freemarker\\src\\com\\gwd\\freemarker";

4. Configuration conf = new Configuration();

5. //加载模板文件(模板的路径)

6. conf.setDirectoryForTemplateLoading(new File(dir));

7. // 加载模板

8. Template template = conf.getTemplate("/freemarker-demo.ftl");

9. // 定义数据

11. Map root = new HashMap();

13. root.put("world",null);

15. // 定义输出

16. Writer out = new FileWriter(dir + "/freemarker.html");

17. template.process(root, out);

18. System.out.println("转换成功");

19. out.flush();

20. out.close();

21. }

22. }

(2)null为空模板

${world!}         ——前面有个null

生成html

(3)为null时给默认值模板

${world!"如果world为null，我就会显示"}

生成的html

11.宏定义

(1)普通宏定义

模板：

1. <#macro table u>

2. ${u}

3. </#macro>

4. <@table u="这个是宏定义" />

生成的html

(2)扩展宏定义

模板：

1. <#macro table u>

2. ${u}

3. <#nested/>

4. </#macro>

5. <@table u=8 >我是扩展的宏定义</@table>

生成的html