作者： ​​永恒の_☆​​ 


一、Freemarker的介绍

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

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

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

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

二、Freemarker的准备条件

freemarker.2.3.16.jar ​​ (这个jar包其实在struts2里面)

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

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

四、Freemarker提供的标签

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

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

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


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


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

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

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


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


1. if(names.equals("陈靖仇")){  
2. "他的武器是: 十五~~");  
3. }


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



1. <#include "include.html"/>


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

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

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



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}  
10. <br/>  
11. 集合大小:${nameList?size}  
12. <br/>  
13. 迭代list集合：  
14. <br/>  
15. <#list nameList as names>  
16. 这是第${names_index+1}个人，叫做：<label style="color:red">${names}</label>  
17. if判断：  
18. <br/>  
19. <#if (names=="陈靖仇")>  
20.  他的武器是: 十五~~  
21. <#elseif (names=="宇文拓")>       <#--注意这里没有返回而是在最后面-->   
22.  他的武器是: 轩辕剑~·  
23. <#else>  
24. 她的绝招是：蛊毒~~  
25. </#if>  
26. <br/>  
27. </#list>  
28. 迭代map集合：  
29. <br/>  
30. <#list weaponMap?keys as key>  
31. key--->${key}<br/>  
32. value----->${weaponMap[key]!("null")}  
33. <#--   
34. fremarker 不支持null, 可以用！ 来代替为空的值。  
35. 其实也可以给一个默认值    
36. value-----${weaponMap[key]?default("null")}  
37. 还可以 在输出前判断是否为null  
38. <#if weaponMap[key]??></#if>都可以  
39. -->  
40.   
41. <br/>  
42. </#list>  
43. include导入文件：  
44. <br/>  
45. <#include "include.html"/>  
46.   
47. </body>  
48. </html>


实际代码：



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. new Configuration();  
23. new File("D:\\project\\webProject\\WebContent\\WEB-INF\\template"));  
24. new DefaultObjectWrapper());  
25. "UTF-8");   //这个一定要设置，不然在生成的页面中 会乱码  
26. //获取或创建一个模版。  
27. "static.html");  
28. new HashMap<String, Object>();  
29. "description", "我正在学习使用Freemarker生成静态文件！");  
30.               
31. new ArrayList<String>();  
32. "陈靖仇");  
33. "玉儿");  
34. "宇文拓");  
35. "nameList", nameList);  
36.               
37. new HashMap<String, Object>();  
38. "first", "轩辕剑");  
39. "second", "崆峒印");  
40. "third", "女娲石");  
41. "fourth", "神农鼎");  
42. "fifth", "伏羲琴");  
43. "sixth", "昆仑镜");  
44. "seventh", null);  
45. "weaponMap", weaponMap);  
46.               
47. new OutputStreamWriter(new FileOutputStream("success.html"),"UTF-8");  
48.             template.process(paramMap, writer);  
49.               
50. "恭喜，生成成功~~");  
51. catch (IOException e) {  
52.             e.printStackTrace();  
53. catch (TemplateException e) {  
54.             e.printStackTrace();  
55.         }  
56.           
57.     }  
58. }

附：​​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的例子：


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. <#assign num='hehe'/>  
10. ${num}  
11. <br/>  
12. 自定义标签  
13. <@content name="chenghui" age="120">  
14.     ${output}  
15.     ${append}  
16. </@content>  
17.     
18. </body>  
19. </html>



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



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. 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. "output", DEFAULT_WRAPPER.wrap("从ContentDirective解析类中获得的参数是："+name+", "));  
40.             }  
41. if(age!=null){  
42. "append", DEFAULT_WRAPPER.wrap("年龄："+age));  
43.             }  
44.             Writer out = env.getOut();  
45. "从这里输出可以再页面看到具体的内容，就像document.writer写入操作一样。<br/>");  
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. }


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



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

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