Spring mvc整合freemarker详解

清疚 2022-04-11 06:11 252阅读 0赞

# 1.什么是FreeMarker #

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

# 2.FreeMarker特性 #

能够生成各种文本：HTML、XML、RTF、Java源代码等等  
易于嵌入到你的产品中：轻量级；不需要Servlet环境  
插件式模板载入器：可以从任何源载入模板，如本地文件、数据库等等  
你可以按你所需生成文本：保存到本地文件；作为Email发送；从Web应用程序发送它返回给Web浏览器

# 3. springMVC整合Freemarker #

## 1.添加jar包 ##

添加freemarker的jar，还需要额外添加spring-content-support的jar包，不然会报错。

## 2.然后再Spring的配置文件中添加对freemarker的配置 ##

<bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer"> 
 <property name="templateLoaderPath" value="WEB-INF/ftl/" /> 
 <property name="defaultEncoding" value="UTF-8" /> 
 </bean> 
  
 <bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver"> 
 <property name="suffix" value=".html" /> 
 <property name="contentType" value="text/html;charset=UTF-8" /> 
  
 <property name="requestContextAttribute" value="rc" /> 
 </bean>

## 3.写一个User类： ##

package com.my.springmvc.bean;
    
    public class User {
        private String username;
        private String password;
        public String getUsername() {
            return username;
        }
        public void setUsername(String username) {
            this.username = username;
        }
        public String getPassword() {
            return password;
        }
        public void setPassword(String password) {
            this.password = password;
        }
    
    }

## 4.一个FreeMarkerController类： ##

@Controller
 @RequestMapping("/home")
 public class FreeMarkerController {
 
 @RequestMapping("/index")
 public ModelAndView Add(HttpServletRequest request,HttpServletResponse response){
 User user = new User();
 user.setUsername("sg");
 user.setPassword("1234");
 List<User> users = new ArrayList<User>();
 users.add(user);
 
 ModelAndView mv = new ModelAndView();
 mv.setViewName("index");
 mv.addObject("users",users);
 return mv;
 }
 }

## 5.然后再WEB-INF/ftl目录下创建一个index.html文件： ##

\#\#

<!DOCTYPE html>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>another</title>
 </head>
 <body> 
 <#list users as user> 
 username : ${user.username} 
 password : ${user.password} 
 </#list> 
 </body> 
 </html>

## 结果： ##

![这里写图片描述][20160713220156728]

# 4.freemarker语法介绍： #

## 1. FreeMarker模板文件主要由如下4个部分组成 ##

文本：直接输出的部分 
注释：<\#– … –> 格式部分，不会输出 
插值：即 $\{…\} 或 \#\{…\} 格式的部分，将使用数据模型中的部分替代输出 
指令：FreeMarker 指定，和 HTML 标记类似，名字前加 \# 予以区分，不会输出

<html>
 <head>
 <title>Welcome!</title>
 </head>
 <body>
 <#-- 注释部分 -->
 <#-- 下面使用插值 -->
 <h1>Welcome ${username} !</h1>
 
 We have these animals:
 <u1>
 
 <#list animals as animal>
 <li>${animal.name} for ${animal.price} Euros</li>
 </#list>
 </u1>
 </body>
 </html

## 2.控制语句 ##

<#if condition> 
 ... 
 <#elseif condition2> 
 ... 
 <#elseif condition3> 
 ... 
 <#else>
 <#switch value> 
 <#case refValue1> 
 ... 
 <#break> 
 <#case refValue2> 
 ... 
 <#break> 
 <#case refValueN> 
 ... 
 <#break> 
 <#default> 
 ... 
 </#switch>

## 3判断变量是否存在 ##

<#if readonly??></#if>

## 4.防止空指针报错 ##

变量名后用 ! 加默认值：$\{foo!”Default”\}，如果 foo 为 null 则输出 Default

## 5.普通的变量 ##

这是最简单的情况，直接变量名称，如<script type="math/tex" id="MathJax-Element-1">\{变量名称\} ，如</script>\{name\}

需要注意的是有的变量是需要转义的如双引号

## 6..遍历List集合 ##

<#list ["克里斯埃文斯", "斯嘉丽约翰逊", "小罗伯特唐尼"] as x> 
 ${x} 
 </#list>

此外,迭代集合对象时,还包含两个特殊的循环变量: 
item\_index:当前变量的索引值 
item\_has\_next:是否存在下一个对象 
也可以使用<\#break>指令跳出迭代

## 7.运算符 ##

FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括:+, - , \* , / , %  
比较运算符

表达式中支持的比较运算符有如下几个: 
1,=或者==:判断两个值是否相等. 
2,!=:判断两个值是否不等. 
3,>或者gt:判断左边值是否大于右边值 
4,>=或者gte:判断左边值是否大于等于右边值 
5,<或者lt:判断左边值是否小于右边值 
6,<=或者lte:判断左边值是否小于等于右边值

注意:=和!=可以用于字符串,数值和日期来比较是否相等,但=和!=两边必须是相同类型的值,否则会产生错误,而且FreeMarker是精确比较,”x”,”x “,”X”是不等的.其它的运行符可以作用于数字和日期,但不能作用于字符串,大部分的时候,使用gt等字母运算符代替>会有更好的效果,因为FreeMarker会把>解释成FTL标签的结束字符,当然,也可以使用括号来避免这种情况,如:<\#if (x>y)>

逻辑运算符

和普通程序一样，freemarker也有&&，|| ，!三种

## 8.变量的声明 ##

<\#assign num=0/>

## 9.include指令 ##

include指令的作用类似于JSP的包含指令,用于包含指定页.include指令的语法格式如下: 
<\#include filename \[options\]> 
在上面的语法格式中,两个参数的解释如下: 
filename:该参数指定被包含的模板文件 
options:该参数可以省略,指定包含时的选项,包含encoding和parse两个选项,其中encoding指定包含页面时所用的解码集,而parse指定被包含文件是否作为FTL文件来解析,如果省略了parse选项值,则该选项默认是true.

## 10.import指令 ##

该指令用于导入FreeMarker模板中的所有变量,并将该变量放置在指定的Map对象中,import指令的语法格式如下: 
<\#import “/lib/common.ftl” as com> 
上面的代码将导入/lib/common.ftl模板文件中的所有变量,交将这些变量放置在一个名为com的Map对象中.

## 11 macro的使用 ##

这个可以用来实现自定义指令，一般用来做公共组件，例如分页条  
最后说下list中含有map的遍历，这种情况可以使用点语法或方括号语法.假如有下面的数据模型:  
Map root = new HashMap();  
Book book = new Book();  
Author author = new Author();  
author.setName(“annlee”);  
author.setAddress(“gz”);  
book.setName(“struts2”);  
book.setAuthor(author);  
root.put(“info”,”struts”);  
root.put(“book”, book);

为了访问数据模型中名为struts2的书的作者的名字,可以使用如下语法:  
book.author.name //全部使用点语法  
book\[“author”\].name  
book.author\[“name”\] //混合使用点语法和方括号语法  
book\[“author”\]\[“name”\] //全部使用方括号语法

# #

参考：  
[http://blog.csdn.net/walkcode/article/details/26393211][http_blog.csdn.net_walkcode_article_details_26393211]  
[http://blog.csdn.net/win\_man/article/details/51317957][http_blog.csdn.net_win_man_article_details_51317957]  
[http://rongjih.blog.163.com/blog/static/3357446120127632757911/][http_rongjih.blog.163.com_blog_static_3357446120127632757911]  
[http://qtdebug.com/spring-web/11.%20Freemarker%20%E8%AF%AD%E6%B3%95%E7%AE%80%E4%BB%8B.html][http_qtdebug.com_spring-web_11._20Freemarker_20_E8_AF_AD_E6_B3_95_E7_AE_80_E4_BB_8B.html]  
[http://blog.csdn.net/walkcode/article/details/26393211][http_blog.csdn.net_walkcode_article_details_26393211]  
[http://blog.csdn.net/shimiso/article/details/8778793][http_blog.csdn.net_shimiso_article_details_8778793]

[20160713215630876]: /images/20220411/29e5b69dd5a04a2a9cabb754e49c91c0.png
[20160713220156728]: /images/20220411/9ae97fb42b67492db36ae431edf97694.png
[http_blog.csdn.net_walkcode_article_details_26393211]: http://blog.csdn.net/walkcode/article/details/26393211
[http_blog.csdn.net_win_man_article_details_51317957]: http://blog.csdn.net/win_man/article/details/51317957
[http_rongjih.blog.163.com_blog_static_3357446120127632757911]: http://rongjih.blog.163.com/blog/static/3357446120127632757911/
[http_qtdebug.com_spring-web_11._20Freemarker_20_E8_AF_AD_E6_B3_95_E7_AE_80_E4_BB_8B.html]: http://qtdebug.com/spring-web/11.%20Freemarker%20%E8%AF%AD%E6%B3%95%E7%AE%80%E4%BB%8B.html
[http_blog.csdn.net_shimiso_article_details_8778793]: http://blog.csdn.net/shimiso/article/details/8778793