飞道的博客

FreeMarker使用说明

333人阅读  评论(0)
  • 这是一份经过个人理解的FreeMarker使用说明。

  • 原文地址:在线手册

FreeMarker是什么呢?先输入数据,再用.ftl文件搭好架子,再用工具把这俩翻译成静态html页面。

初步介绍

  • 这是一段网页代码:

  
  1. <html>
  2. <head>
  3. <title>Welcome! </title>
  4. </head>
  5. <body>
  6. <h1>Welcome John Doe!</h1>
  7. <p>Our latest product:
  8. <a href="products/greenmouse.html">green mouse</a>!
  9. </body>
  10. < /html>

我们现在要用freemarker修改它


  
  1. <html>
  2. <head>
  3. <title>Welcome! </title>
  4. </head>
  5. <body>
  6. <h1>Welcome ${user}!</h1>
  7. <p>Our latest product:
  8. <a href="${latestProduct.url}">${latestProduct.name}</a>!
  9. </body>
  10. < /html>

那有什么好处呢? 第一版页面,Welcome" 谁"是写死了的,而第二版,我们可以动态地指定user和url等

模板文件存放在Web服务器上就像通常存放静态HTML页面一样。当有人来访问这个页面,FreeMarker将会介入执行,然后动态转换模板,用最新的数据内容替换模板中$ { }的部分,之后将结果发送到访问者的web浏览器中。而访问者并不会察觉到服务端使用的FreeMarker。(当然,存储在Web服务端的模板文件是不会被修改的,替换也仅仅出现在web服务器的响应中。)

为模板准备的数据整体被称为数据模型,模板作者要关心的是,数据模型是一个树形结构

使用方法

  • new一个Configuration对象。构造方法的参数就是FreeMarker的版本号。

  
  1. @Test
  2. public void test2() throws IOException, TemplateException {
  3. //创建一个Configuration对象
  4. Configuration configuration = new Configuration(Configuration.getVersion());
  5. //设置模板文件所在的路径
  6. configuration.setDirectoryForTemplateLoading( new File( "C:/Users/Bam/workspace/SpringMVC/freemaker/src"));
  7. //设置模板文件所使用的字符集,一般是utf-8
  8. configuration.setDefaultEncoding( "utf-8");
  9. //加载一个模板,创建一个模板对象
  10. Template template = configuration.getTemplate( "hello.ftl");
  11. //创建一个模板使用的数据集,可以是pojo也可以是map,一般是map
  12. Map dataMap = new HashMap<String,String>();
  13. dataMap.put( "hello", "world");
  14. //创建一个writer对象,一般创建一个FileWriter对象,指定生成的文件名。
  15. Writer writer = new FileWriter( new File( "hello.html"));
  16. //调用模板对象的process方法输出文件
  17. template.process(dataMap,writer);
  18. //关闭流
  19. writer.close();
  20. }

FreeMarker与JSP


相同点
可以动态生成不同页面
支持表达式语言


不同点
jsp是java类,使用时候生成对象
FreeMarker仅仅是模板技术。访问时可以做到不占用jvm内存


FreeMarker的优点
不需要web容器
一次生成的静态页面可以重复使用

 

FreeMarker基本语法

基本指令

  • if指令:使用if可以有条件的跳过模板的一些片段
    (如果user=Big Joe的话就把,our beloved leader打出来)

  
  1. <html>
  2. <head>
  3. <title>Welcome! </title>
  4. </head>
  5. <body>
  6. <h1>
  7. Welcome ${user} <#if user == "Big Joe">, our beloved leader </#if>!
  8. </h1>
  9. <p>Our latest product:
  10. <a href="${latestProduct.url}">${latestProduct.name}</a>!
  11. </body>
  12. < /html>

list指令:
list 指令的一般格式为: < #list A as B>重复这里<  /#list>。 “重复这里” 部分将会在给定的 A遍历时在每一项中重复, 从第一项开始,一个接着一个。在所有的重复中, B 将持有当前遍历项的值。 这个变量仅存在于 <#list …> 和


  
  1. <p>We have these animals:
  2. <table border=1>
  3. <#list animals as animal>
  4. <tr> <td>${animal.name} <td>${animal.price} Euros
  5. </#list>
  6. </table>

include指令
使用include指令,我们可以在模板中插入其他文件的内容


  
  1. <html>
  2. <head>
  3. <title>Test page </title>
  4. </head>
  5. <body>
  6. <h1>Test page </h1>
  7. <p>Blah blah...
  8. <#include "/copyright_footer.html">
  9. </body>
  10. </html>

(你想修改的话直接修改copyright_footer.html的值)

指令可以嵌套使用

具体实例

访问map中的key (之前举过例子了)

访问pojo中的属性


  
  1. //pojo分别是id、name、phonenumber
  2. User user=new User(1, "aaa", "222");
  3. dataMap.put( "user",user);
  4. ${user.id}
  5. ${user.name}
  6. ${user.phonenumber}

访问集合中的数据

  • java代码

  
  1. @ Test
  2. public void test2( ) throws IOException, TemplateException {
  3. //创建一个Configuration对象
  4. Configuration configuration = new Configuration(Configuration.getVersion());
  5. //设置模板文件所在的路径
  6. configuration.setDirectoryForTemplateLoading( new File( "C:/Users/Bam/workspace/SpringMVC/freemaker/src"));
  7. //设置模板文件所使用的字符集,一般是utf-8
  8. configuration.setDefaultEncoding( "utf-8");
  9. //加载一个模板,创建一个模板对象
  10. Template template = configuration.getTemplate( "hello.ftl");
  11. //创建一个模板使用的数据集,可以是pojo也可以是map,一般是map
  12. Map dataMap = new HashMap<String,String>();
  13. dataMap.put( "hello", "world");
  14. ArrayList<User> users = new ArrayList<>();
  15. users. add( new User( "zhangsan", "23"));
  16. users. add( new User( "lisi", "23"));
  17. users. add( new User( "wangwu", "23"));
  18. users. add( new User( "zhaoliu", "23"));
  19. System. out.println(users.isEmpty());
  20. Map<String,ArrayList<User>> data = new HashMap<String ,ArrayList<User>>();
  21. data.put( "users",users);
  22. System. out.println(data.isEmpty());
  23. //创建一个writer对象,一般创建一个FileWriter对象,指定生成的文件名。
  24. Writer writer = new FileWriter( new File( "hello1.html"));
  25. //调用模板对象的process方法输出文件
  26. template.process(data,writer);
  27. //关闭流
  28. writer.close();
  29. }

ftl文件


  
  1. <html>
  2. <head>
  3. <title>Welcome! </title>
  4. </head>
  5. <body>
  6. <#list users as user>
  7. ${user.username}|${user.age} <br>
  8. </#list>
  9. </body>
  10. </html>

取循环中的下标

    ${user_index}|${user.username}|${user.age}<br>

结果:
0|zhangsan |23
1|lisi |23
2|wangwu |23
3|zhaoliu |23

判断


  
  1. < #list users as user>
  2. < #if user.username=="zhangsan">
  3. <a href= "www.zhangsan.com"> ${user_index}| ${user.username} | ${user.age}</a><br>
  4. < #else >
  5. ${user_index}| ${user.username}| ${user.age}<br>
  6. </ #if >
  7. </ #list>

用法和if else没什么区别

日期类的处理

  • 在pojo中定义好Date类型的变量(birthday),并且设置好setter方法
    
        
    1. Map< String,User> data = new HashMap< String ,User>();
    2. User user = new User();
    3. user.setUsername( "aaa");
    4. user.setAge( "22");
    5. //Date里边可以填符合yyyy/MM/dd HH:mm:ss的值,也可以不填,那么就是当前时间。
    6. user.setBirthday( new Date( ""));
    7. data.put( "user",user);
    8. Writer writer = new FileWriter( new File( "hello1.html"));

    Null的处理
    不论在哪里引用变量,都可以指定一个默认值来避免变量丢失这种情况, 通过在变量名后面跟着一个 !和默认值。
    就像下面的这个例子,当 user 不存在于数据模型时, 模板将会将 user 的值表示为字符串 “visitor”。(当 user 存在时, 模板就会表现出 user的值):Welcomeuser的值):Welcome{user!”visitor”}

    也可以在变量名后面通过放置 ?? 来询问一个变量是否存在。将它和 if 指令合并, 那么如果 user 变量不存在的话将会忽略整个问候的代码段:
    < #if user??> Welcome ${user}

    Spring对FreeMarker的支持

1. 导包:


  
  1. spring-context-support-5 .0 .4 .RELEASE .jar
  2. com .springsource .org .apache .commons .logging-1 .1 .1 .jar

 

2. 进applicationContext.xml配置bean

 

Spring MVC多视图解析
目的:让springMVC使用模板产生一个页面

我们来串起这个流程:

在applicationContext.xml中配置好FreeMarker的FreeMarkerConfigurer/FreeMarkerViewResolver(设置和视图解析器)
模板后缀是.ftl
模板的位置是/WEB-INF/template/


  
  1. <!--FreeMarker模板的加载地址、解码方式等设置-->
  2. <bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
  3. <!--template的加载地址-->
  4. <property name="templateLoaderPath" value="/WEB-INF/template/" > </property>
  5. <!--template的默认编码-->
  6. <property name="defaultEncoding" value="utf-8"> </property>
  7. </bean>
  8. <!--FreeMarker模板的视图解析器-->
  9. <bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
  10. <!--template的后缀-->
  11. <property name="suffix" value=".ftl" > </property>
  12. <!--生成HTML的contenttype;text/html;charset=utf-8-->
  13. <property name="contentType" value="text/html;charset=utf-8"> </property>
  14. <!--优先级-->
  15. <property name="order" value="0"/>
  16. </bean>

 

配置controller

  • return的数值就是你在xml中配置的模板名,一会儿ViewResolver要用

  
  1. package com.bamzhy.Controller;
  2. import com.bamzhy.bean.User;
  3. import org.springframework.stereotype.Controller;
  4. import org.springframework.ui.Model;
  5. import org.springframework.web.bind.annotation.RequestMapping;
  6. import java.util.Date;
  7. @Controller
  8. public class FreemarkController {
  9. @RequestMapping( "/freemarker")
  10. public String freemarker(Model model){
  11. User user = new User();
  12. user.setUsername( "haha");
  13. user.setAge( "92");
  14. user.setBirthday( new Date());
  15. model.addAttribute( "user",user);
  16. //return 的东西非常重要,这个是你在xml配置中配置的ftl模板的文件名
  17. return "user";
  18. }
  19. }

写好模板并放置好


  
  1. <html>
  2. <head>
  3. <title>Welcome! </title>
  4. </head>
  5. <body>
  6. <h1>Welcome HAHA! </h1>
  7. <p>This is you INFO:
  8. ${user.username} |${user.age}|${user.birthday?string("yyyy/MM/dd HH:mm:ss")}
  9. </body>
  10. </html>

从浏览器地址栏访问http://localhost:8080/freemarker
DispatcherServlet先接收到这个请求,获取URI。HandlerAdaper会把URI定位到Controller处,Controller将往Model中填充信息,并且返回一个String对象,此时FreeMarkerConfigurer会根据这个String的内容寻找在xml中定义好的路径里的模板,读取其默认解码方式等,FreeMarkerViewResolver结合Model和ftl模板对视图进行解析,最后把解析结果返回给DispatcherServlet,DispatcherServlet再给到view进行渲染,最后给到客户端。

 


转载:https://blog.csdn.net/i_silence/article/details/106850064
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场