Freemarker是一种模板引擎,它采用一个测试驱动的数据集生成任何类型的XML(markup languages)或非XML导出。它是一款图灵奖获奖的软件,具有流行、可靠、快速和免费的特性。
一、Freemarker概述
Freemarker的基础概念是模板(template)和数据模型(data model)。模板是一个页面的框架,而数据模型定义了此页面中使用的数据。模板通过结合数据模型将数据嵌入到页面中生成最终的文本。
Freemarker模板文件使用.ftl作为文件后缀名。在模板中可以使用$和#两种语法来访问数据模型中的数据。
二、Freemarker数据模型
Freemarker的数据模型可以是一个JavaBean,Map,数组或者元素均为Java对象的List。在模板中通过使用${}和#{}访问数据模型中的数据。其中,${}访问的是数据模型中的值,而#{}是用于访问数据模型中的方法。
/** * 数据模型示例: */ public class User { private String name; private int age; //getters and setters } User user = new User("张三", 22); //生成数据模型
/** * 在.ftl模板文件中,使用${}访问数据模型中的值示例: */ ${user.name} //输出:张三 ${user.age} //输出:22
上述代码示例中的user是数据模型的一个实例,${user.name}以点号(.)形式访问了User类中的name属性。
三、Freemarker指令
在Freemarker模板文件中,#开头的语句是指令,用于对模板进行控制,例如:条件判断,循环等。
1、#if和#else
#if指令用于控制模板是否展示某一段内容,其后要跟上一个判断表达式。如果表达式为真,则展示if和else之间的内容;如果表达式为假,则展示#else和if之间的内容。
/** * #if指令的示例代码: */ #if(user.age > 18)已成年
#else未成年
在上述示例中,如果user的年龄大于18岁,则显示"已成年"这段文本;否则显示"未成年"这段文本。
2、#list
#list指令用于循环输出一组数据,并且可以使用#else指令在数据为空时输出特定文本。
/** * #list指令的示例代码: */
-
#list(users as user)
- ${user.name} #else
- 暂无用户数据 #end
在上述示例中,users是数据模型中的一组数据,通过#list指令循环遍历,并将user对象的name属性输出到li标签中。如果users为空,则输出"暂无用户数据"这段文本。
3、#include
#include指令用于将指定的模板文件包含到当前模板中,形式如下:
/** * #include指令的示例代码: */ <#include "header.ftl">
上述代码中,将头部信息模板文件header.ftl包含到了当前模板文件中。
4、#import
#import指令用于导入Java类或静态成员(方法、字段),使用#assign指令将其赋值给模板中的变量。形式如下:
/** * #import指令的示例代码: */ <#import "java.util.HashMap" as map> <#assign myMap = map.new()> ${myMap.class.simpleName} //输出:HashMap
在上述示例中,使用#import指令引入了Java的HashMap类,并使用#assign指令将其赋值给myMap变量。使用${myMap.class.simpleName}来访问myMap变量中所包含的HashMap类。
四、Freemarker常用内置函数
Freemarker提供了许多内置函数,用于对数据进行处理,例如字符串截取、日期格式化等等。下面介绍几个常用的内置函数:
1、字符串截取-?substring(start, end)
这个函数可以用于截取指定字符串的子串。其中,start参数表示起始位置,end参数表示结束位置(不包含在内)。
/** * ?substring函数示例代码: */ ${"hello world"?substring(0, 5)} //输出:hello
2、日期格式化-?string(format)
这个函数可以用于将一个日期对象格式化成指定格式的字符串。其中,format参数是一个文本模板,用于描述所需格式。
/** * ?string函数示例代码: */ ${user.birthDate?string("yyyy-MM-dd")} //输出:1998-08-12
3、集合排序-?sort
这个函数可以用于对列表或数组进行排序。默认按照自然顺序排序,也可以自定义排序规则。
/** * ?sort函数示例代码: */ <#assign users = [ {name:"张三", age:20}, {name:"李四", age:18}, {name:"王五", age:25} ]>排序前:
<#list users as user>${user.name},${user.age}岁
排序后:
<#assign sortedUsers = users?sort((a, b) -> a.age - b.age)> <#list sortedUsers as user>${user.name},${user.age}岁
在上述示例中,使用?sort函数对用户列表数据进行了按年龄从小到大的排序,排序后输出用户列表。
五、总结
在本文中,我们深入了解了Freemarker模板文件的多个方面,包括数据模型、指令、内置函数等。通过这些知识点,我们可以更高效地使用Freemarker来生成我们想要的网页、邮件或文件等。