Freemarker实例教程

2022-10-20 13:06:29

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

一、Freemarker的介绍

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

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

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

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

二、Freemarker的准备条件

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

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

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

四、Freemarker提供的标签

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

1、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. System.out.println("他的武器是: 十五~~");
  3. }

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

实际代码：

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

附：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. </body>
  18. </html>

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

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

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

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

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

上一篇：攻防靶场｜Vulnstack2靶场之CS实战


下一篇：解决kylin查询报错：org.apache.kylin.rest.exception.InternalErrorException