freemarker简介

Bertha 。 2022-06-17 06:37 166阅读 0赞

转自：(http://blog.csdn.net/chenghui0317/article/details/7832474)作者：永恒の\_☆

原创作品，允许转载，转载时请务必以超链接形式标明文章 [ 原始出处][Link 1] 、作者信息和本人声明。否则将追究法律责任。  
作者： [永恒の\_☆][Link 2] 地址： [http://blog.csdn.net/chenghui0317/article/details/7832474][Link 1]

## 一、Freemarker的介绍 ##

Freemarker 是一款模板引擎，是一种基于模版生成静态文件的通用 工具，它是为[Java][]程序员提供的一个开发包，或者说是一个类库，它不是面向最终用户的，而是为程序员提供了一款可以嵌入他们开发产品的应用程序。

Freemarker 是使用纯java编写的，为了提高页面的访问速度，需要把页面静态化， 那么Freemarker就是被用来生成html页面。

到目前为止，Freemarker使用越来越广泛，不光光只是它强大的生成技术，而且它能够与[spring][]进行很好的集成。

现在开始一层层揭开它的神秘面纱。。

## 二、Freemarker的准备条件 ##

freemarker.2.3.16.jar 下载地址：[http://download.csdn.net/detail/ch656409110/4494067][http_download.csdn.net_detail_ch656409110_4494067] (这个jar包其实在struts2里面)

## 三、Freemarker生成静态页面的原理    ##

Freemarker 生成静态页面，首先需要使用自己定义的模板页面，这个模板页面可以是最最普通的html，也可以是嵌套freemarker中的 取值表达式， 标签或者自定义标签等等，然后后台读取这个模板页面，解析其中的标签完成相对应的操作， 然后采用键值对的方式传递参数替换模板中的的取值表达式，做完之后 根据配置的路径生成一个新的html页面， 以达到静态化访问的目的。

## 四、Freemarker提供的标签 ##

Freemarker提供了很多有用 常用的标签，Freemarker标签都是<\#标签名称>这样子命名的，$\{value\} 表示输出变量名的内容 ，具体如下：

1、list：该标签主要是进行迭代服务器端传递过来的List集合，比如：

**\[html\]** view plain copy

print ?

1. <\#list nameList as names>
2. $\{names\}
3. </\#list>

![save_snippets.png][]

<#list nameList as names>  
 ${names} 
 </#list>

name是list循环的时候取的一个循环变量，freemarker在解析list标签的时候，等价于：

**\[java\]** view plain copy

print ?

1.  for (String names : nameList) \{
2.  System.out.println(names);
3.  \}

![save_snippets.png][]

for (String names : nameList) {
                    System.out.println(names);
                }

2、 if： 该标签主要是做if判断用的，比如：

**\[html\]** view plain copy

print ?

1. <\#if (names==”陈靖仇”)>
2. 他的武器是: 十五~~
3. </\#if>

![save_snippets.png][]

<#if (names=="陈靖仇")>
 他的武器是: 十五~~
 </#if>

这个是条件判断标签，要注意的是条件等式必须用括号括起来， 等价于：

**\[java\]** view plain copy

print ?

1.  if(names.equals(“陈靖仇”))\{
2.  System.out.println(”他的武器是: 十五~~”);
3.  \}

![save_snippets.png][]

if(names.equals("陈靖仇")){
                    System.out.println("他的武器是: 十五~~");
                }

3、 include：该标签用于导入文件用的。

**\[html\]** view plain copy

print ?

1. <\#include “include.html”/>

![save_snippets.png][]

<#include "include.html"/>

这个导入标签非常好用，特别是页面的重用。

另外在静态文件中可以使用$\{\} 获取值，取值方式和el表达式一样，非常方便。

下面举个例子（static.html）：

**\[html\]** view plain copy

print ?

1. <!DOCTYPE html PUBLIC ”-//W3C//DTD HTML 4.01 Transitional//EN” “http://www.w3.org/TR/html4/loose.dtd”>
2. <html>
3. <head>
4. <meta http-equiv=“Content-Type” content=“text/html; charset=UTF-8”>
5. <title>Insert title here</title>
6. </head>
7. <body>
8. 
9. 描述：\{description\}&nbsp;&nbsp;</li><li class=""><br/>&nbsp;&nbsp;</li><li class="alt">集合大小:\{nameList?size\}
10. 
11. 迭代list集合：
12. 
13. <\#list nameList as names>
14. 这是第\{names\_index+1\}个人，叫做：<label&nbsp;style="color:red">\{names\}</label>
15. if判断：
16. 
17. <\#if (names==”陈靖仇”)>
18. 他的武器是: 十五~~
19. <\#elseif (names==”宇文拓”)> <\#–注意这里没有返回而是在最后面–>
20. 他的武器是: 轩辕剑~·
21. <\#else>
22. 她的绝招是：蛊毒~~
23. </\#if>
24. 
25. </\#list>
26. 迭代map集合：
27. 
28. <\#list weaponMap?keys as key>
29. key—>\{key\}<br/>&nbsp;&nbsp;</li><li class="">value----->\{weaponMap\[key\]!(“null”)\}
30. <\#–
31. fremarker 不支持null, 可以用！ 来代替为空的值。
32. 其实也可以给一个默认值
33. value—–$\{weaponMap\[key\]?default(“null”)\}
34. 还可以 在输出前判断是否为null
35. <\#if weaponMap\[key\]??></\#if>都可以
36. –>
37. 
38. 
39. </\#list>
40. include导入文件：
41. 
42. <\#include “include.html”/>
43. 
44. </body>
45. </html>

![save_snippets.png][]

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Insert title here</title>
 </head>
 <body>
 
 描述：${description}
 
 集合大小:${nameList?size}
 
 迭代list集合：
 
 <#list nameList as names>
 这是第${names_index+1}个人，叫做：<label style="color:red">${names}</label>
 if判断：
 
 <#if (names=="陈靖仇")>
 他的武器是: 十五~~
 <#elseif (names=="宇文拓")> <#--注意这里没有返回而是在最后面--> 
 他的武器是: 轩辕剑~·
 <#else>
 她的绝招是：蛊毒~~
 </#if>
 
 </#list>
 迭代map集合：
 
 <#list weaponMap?keys as key>
 key--->${key} 
 value----->${weaponMap[key]!("null")}
 <#-- 
 fremarker 不支持null, 可以用！ 来代替为空的值。
 其实也可以给一个默认值 
 value-----${weaponMap[key]?default("null")}
 还可以 在输出前判断是否为null
 <#if weaponMap[key]??></#if>都可以
 -->
 
 
 </#list>
 include导入文件：
 
 <#include "include.html"/>
 
 </body>
 </html>

实际代码：

**\[java\]** view plain copy

print ?

1. package com.chenghui.test;
2. 
3. import java.io.File;
4. import java.io.FileOutputStream;
5. import java.io.IOException;
6. import java.io.OutputStreamWriter;
7. import java.io.Writer;
8. import java.util.ArrayList;
9. import java.util.HashMap;
10. import java.util.List;
11. import java.util.Map;
12. 
13. import freemarker.template.Configuration;
14. import freemarker.template.DefaultObjectWrapper;
15. import freemarker.template.Template;
16. import freemarker.template.TemplateException;
17. 
18. public class CreateHtml \{
19. public static void main(String\[\] args) \{
20. try \{
21. //创建一个合适的Configration对象
22. Configuration configuration = new Configuration();
23. configuration.setDirectoryForTemplateLoading(new File(“D:\\\\project\\\\webProject\\\\WebContent\\\\WEB-INF\\\\template”));
24. configuration.setObjectWrapper(new DefaultObjectWrapper());
25. configuration.setDefaultEncoding(”UTF-8”); //这个一定要设置，不然在生成的页面中 会乱码
26. //获取或创建一个模版。
27. Template template = configuration.getTemplate(”static.html”);
28. Map<String, Object> paramMap = new HashMap<String, Object>();
29. paramMap.put(”description”, “我正在学习使用Freemarker生成静态文件！”);
30. 
31. List<String> nameList = new ArrayList<String>();
32. nameList.add(”陈靖仇”);
33. nameList.add(”玉儿”);
34. nameList.add(”宇文拓”);
35. paramMap.put(”nameList”, nameList);
36. 
37. Map<String, Object> weaponMap = new HashMap<String, Object>();
38. weaponMap.put(”first”, “轩辕剑”);
39. weaponMap.put(”second”, “崆峒印”);
40. weaponMap.put(”third”, “女娲石”);
41. weaponMap.put(”fourth”, “神农鼎”);
42. weaponMap.put(”fifth”, “伏羲琴”);
43. weaponMap.put(”sixth”, “昆仑镜”);
44. weaponMap.put(”seventh”, null);
45. paramMap.put(”weaponMap”, weaponMap);
46. 
47. Writer writer = new OutputStreamWriter(new FileOutputStream(“success.html”),“UTF-8”);
48. template.process(paramMap, writer);
49. 
50. System.out.println(”恭喜，生成成功~~”);
51. \} catch (IOException e) \{
52. e.printStackTrace();
53. \} catch (TemplateException e) \{
54. e.printStackTrace();
55. \}
56. 
57. \}
58. \}

![save_snippets.png][]

package com.chenghui.test;
 
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import freemarker.template.Configuration;
 import freemarker.template.DefaultObjectWrapper;
 import freemarker.template.Template;
 import freemarker.template.TemplateException;
 
 public class CreateHtml {
 public static void main(String[] args) {
 try {
 //创建一个合适的Configration对象
 Configuration configuration = new Configuration();
 configuration.setDirectoryForTemplateLoading(new File("D:\\project\\webProject\\WebContent\\WEB-INF\\template"));
 configuration.setObjectWrapper(new DefaultObjectWrapper());
 configuration.setDefaultEncoding("UTF-8"); //这个一定要设置，不然在生成的页面中 会乱码
 //获取或创建一个模版。
 Template template = configuration.getTemplate("static.html");
 Map<String, Object> paramMap = new HashMap<String, Object>();
 paramMap.put("description", "我正在学习使用Freemarker生成静态文件！");
 
 List<String> nameList = new ArrayList<String>();
 nameList.add("陈靖仇");
 nameList.add("玉儿");
 nameList.add("宇文拓");
 paramMap.put("nameList", nameList);
 
 Map<String, Object> weaponMap = new HashMap<String, Object>();
 weaponMap.put("first", "轩辕剑");
 weaponMap.put("second", "崆峒印");
 weaponMap.put("third", "女娲石");
 weaponMap.put("fourth", "神农鼎");
 weaponMap.put("fifth", "伏羲琴");
 weaponMap.put("sixth", "昆仑镜");
 weaponMap.put("seventh", null);
 paramMap.put("weaponMap", weaponMap);
 
 Writer writer = new OutputStreamWriter(new FileOutputStream("success.html"),"UTF-8");
 template.process(paramMap, writer);
 
 System.out.println("恭喜，生成成功~~");
 } catch (IOException e) {
 e.printStackTrace();
 } catch (TemplateException e) {
 e.printStackTrace();
 }
 
 }
 }

附：[freemarker教程][freemarker]

这样子基本上可以算的上可以简单的去做一点简单的生成了，但是要在实际中去运用，还是差的很远的，因为freemarker给的标签完全满足不了我们的需要，这时候就需要自定义标签来完成我们的需求了。。

## 五、Freemarker自定义标签 ##

Freemarker自定义标签就是自己写标签，然后自己解析，完全由自己来控制标签的输入输出，极大的为程序员提供了很大的发挥空间。

基于步骤：

以前写标签需要在<后加\# ，但是freemarker要识别自定义标签需要在后面加上@，然后后面可以定义一些参数，当程序执行template.process(paramMap, out);,就会去解析整个页面的所有的freemarker标签。

自定义标签 需要自定义一个类，然后实现TemplateDirectiveModel，重写execute方法，完成获取参数，根据参数do something等等。。

将自定义标签与解析类绑定在一起需要在paramMap中放入该解析类的实例，存放的key与自定义标签一致即可。。

注意：在自定义标签中，如果标签内什么也没有，开始标签和结束标签绝对不能再同一行，不然会报错 freemarker.log.JDK14LoggerFactory$JDK14Logger error

我曾经上当过，这是freemarker 存在的bug。

下面是static.html的例子：

**\[html\]** view plain copy

print ?

![save_snippets.png][]

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Insert title here</title>
 </head>
 <body>
 <#--自定义变量-->
 <#assign num='hehe'/>
 ${num}
 
 自定义标签
 <@content name="chenghui" age="120">
 ${output}
 ${append}
 </@content>
 
 </body>
 </html>

下面是上面的static.html模板的解析类：

**\[java\]** view plain copy

print ?

1. package com.chenghui.test;
2. 
3. import static freemarker.template.ObjectWrapper.DEFAULT\_WRAPPER;
4. 
5. import java.io.IOException;
6. import java.io.Writer;
7. import java.util.Map;
8. 
9. 
10. import freemarker.core.Environment;
11. import freemarker.template.TemplateDirectiveBody;
12. import freemarker.template.TemplateDirectiveModel;
13. import freemarker.template.TemplateException;
14. import freemarker.template.TemplateModel;
15. import freemarker.template.TemplateModelException;
16. import freemarker.template.TemplateNumberModel;
17. import freemarker.template.TemplateScalarModel;
18. 
19. /\*\*
20. \* 自定义标签解析类
21. \* @author Administrator
22. \*
23. \*/
24. public class ContentDirective implements TemplateDirectiveModel\{
25. 
26. private static final String PARAM\_NAME = “name”;
27. private static final String PARAM\_AGE = “age”;
28. 
29. @Override
30. public void execute(Environment env, Map params,TemplateModel\[\] loopVars,
31. TemplateDirectiveBody body) throws TemplateException, IOException \{
32. if(body==null)\{
33. throw new TemplateModelException(“null body”);
34. \}else\{
35. String name = getString(PARAM\_NAME, params);
36. Integer age = getInt(PARAM\_AGE, params);
37. //接收到参数之后可以根据做具体的操作，然后将数据再在页面中显示出来。
38. if(name!=null)\{
39. env.setVariable(”output”, DEFAULT\_WRAPPER.wrap(“从ContentDirective解析类中获得的参数是：”\+name+“, ”));
40. \}
41. if(age!=null)\{
42. env.setVariable(”append”, DEFAULT\_WRAPPER.wrap(“年龄：”\+age));
43. \}
44. Writer out = env.getOut();
45. out.write(”从这里输出可以再页面看到具体的内容，就像document.writer写入操作一样。 ”);
46. body.render(out);
47. 
48. /\*
49. 如果细心的话，会发现页面上是显示out.write（）输出的语句，然后再输出output的内容，
50. 可见 在body在解析的时候会先把参数放入env中，在页面遇到对应的而来表单时的才会去取值
51. 但是，如果该表单时不存在，就会报错， 我觉得这里freemarker没有做好，解析的时候更加会把错误暴露在页面上。
52. 可以这样子弥补$\{output!”null”\},始终感觉没有el表达式那样好。
53. \*/
54. \}
55. \}
56. 
57. /\*\*
58. \* 获取String类型的参数的值
59. \* @param paramName
60. \* @param paramMap
61. \* @return
62. \* @throws TemplateModelException
63. \*/
64. public static String getString(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException\{
65. TemplateModel model = paramMap.get(paramName);
66. if(model == null)\{
67. return null;
68. \}
69. if(model instanceof TemplateScalarModel)\{
70. return ((TemplateScalarModel)model).getAsString();
71. \}else if (model instanceof TemplateNumberModel) \{
72. return ((TemplateNumberModel)model).getAsNumber().toString();
73. \}else\{
74. throw new TemplateModelException(paramName);
75. \}
76. \}
77. 
78. /\*\*
79. \* 
80. \* 获得int类型的参数
81. \* @param paramName
82. \* @param paramMap
83. \* @return
84. \* @throws TemplateModelException 
85. \*/
86. public static Integer getInt(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException\{
87. TemplateModel model = paramMap.get(paramName);
88. if(model==null)\{
89. return null;
90. \}
91. if(model instanceof TemplateScalarModel)\{
92. String str = ((TemplateScalarModel)model).getAsString();
93. try \{
94. return Integer.valueOf(str);
95. \} catch (NumberFormatException e) \{
96. throw new TemplateModelException(paramName);
97. \}
98. \}else if(model instanceof TemplateNumberModel)\{
99. return ((TemplateNumberModel)model).getAsNumber().intValue();
100. \}else\{
101. throw new TemplateModelException(paramName);
102. \}
103. \}
104. \}

![save_snippets.png][]

package com.chenghui.test;
 
 import static freemarker.template.ObjectWrapper.DEFAULT_WRAPPER;
 
 import java.io.IOException;
 import java.io.Writer;
 import java.util.Map;
 
 
 import freemarker.core.Environment;
 import freemarker.template.TemplateDirectiveBody;
 import freemarker.template.TemplateDirectiveModel;
 import freemarker.template.TemplateException;
 import freemarker.template.TemplateModel;
 import freemarker.template.TemplateModelException;
 import freemarker.template.TemplateNumberModel;
 import freemarker.template.TemplateScalarModel;
 
 /**
 * 自定义标签解析类
 * @author Administrator
 *
 */
 public class ContentDirective implements TemplateDirectiveModel{
 
 private static final String PARAM_NAME = "name";
 private static final String PARAM_AGE = "age";
 
 @Override
 public void execute(Environment env, Map params,TemplateModel[] loopVars,
 TemplateDirectiveBody body) throws TemplateException, IOException {
 if(body==null){
 throw new TemplateModelException("null body");
 }else{
 String name = getString(PARAM_NAME, params);
 Integer age = getInt(PARAM_AGE, params);
 //接收到参数之后可以根据做具体的操作，然后将数据再在页面中显示出来。
 if(name!=null){
 env.setVariable("output", DEFAULT_WRAPPER.wrap("从ContentDirective解析类中获得的参数是："+name+", "));
 }
 if(age!=null){
 env.setVariable("append", DEFAULT_WRAPPER.wrap("年龄："+age));
 }
 Writer out = env.getOut();
 out.write("从这里输出可以再页面看到具体的内容，就像document.writer写入操作一样。 ");
 body.render(out);
 
 /*
 如果细心的话，会发现页面上是显示out.write（）输出的语句，然后再输出output的内容，
 可见 在body在解析的时候会先把参数放入env中，在页面遇到对应的而来表单时的才会去取值
 但是，如果该表单时不存在，就会报错， 我觉得这里freemarker没有做好，解析的时候更加会把错误暴露在页面上。
 可以这样子弥补${output!"null"},始终感觉没有el表达式那样好。
 */
 }
 }
 
 /**
 * 获取String类型的参数的值
 * @param paramName
 * @param paramMap
 * @return
 * @throws TemplateModelException
 */
 public static String getString(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{
 TemplateModel model = paramMap.get(paramName);
 if(model == null){
 return null;
 }
 if(model instanceof TemplateScalarModel){
 return ((TemplateScalarModel)model).getAsString();
 }else if (model instanceof TemplateNumberModel) {
 return ((TemplateNumberModel)model).getAsNumber().toString();
 }else{
 throw new TemplateModelException(paramName);
 }
 }
 
 /**
 * 
 * 获得int类型的参数
 * @param paramName
 * @param paramMap
 * @return
 * @throws TemplateModelException 
 */
 public static Integer getInt(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{
 TemplateModel model = paramMap.get(paramName);
 if(model==null){
 return null;
 }
 if(model instanceof TemplateScalarModel){
 String str = ((TemplateScalarModel)model).getAsString();
 try {
 return Integer.valueOf(str);
 } catch (NumberFormatException e) {
 throw new TemplateModelException(paramName);
 }
 }else if(model instanceof TemplateNumberModel){
 return ((TemplateNumberModel)model).getAsNumber().intValue();
 }else{
 throw new TemplateModelException(paramName);
 }
 }
 }

然后再前面的实际代码中加上：

**\[java\]** view plain copy

print ?

1.  //自定义标签解析
2.  paramMap.put(”content”, new ContentDirective());

![save_snippets.png][]

//自定义标签解析
         paramMap.put("content", new ContentDirective());

这样子基本上可以使用，freemarker完成自定义标签了，解决一写简单的业务逻辑， 但是在实际的项目中不可能这样子去做，因为还没有和spring进行集成使用，每次都需要在解析的时候把解析类的实例放进去。。

[Link 1]: http://blog.csdn.net/chenghui0317/article/details/7832474
[Link 2]: http://blog.csdn.net/chenghui0317
[Java]: http://lib.csdn.net/base/javase
[spring]: http://lib.csdn.net/base/javaee
[http_download.csdn.net_detail_ch656409110_4494067]: http://download.csdn.net/detail/ch656409110/4494067
[save_snippets.png]: /images/20220617/806c776aeaad4bbba13707ff7f31f792.png
[freemarker]: http://download.csdn.net/detail/ch656409110/4494063