一、Freemarker初步使用
1、freemarker 介绍
FreeMarker 是一款 模板引擎: 即一种基于模板和要改变的数据, 并用来生成输出文本(HTML网页,电子邮件,配置文件,源代码等)的通用工具。
可以直接在springboot 2.0中整合,使用起来 很方便。
2、创建web项目
本章还是以helloworld为例,引入freemarker。创建springboot的项目,选择需要导入的组件。
注意,因为是web程序,所以 spring web 必需要选择的
接下来,template engines 中选择 freemarker
自动会在pom中导入 下面的关键依赖项:
2、设置配置文件
在resources目录下新建application.yml,删除application.properties
然后添加下列配置项:
spring:
freemarker:
template-loader-path: ["classpath:/templates/"] #设置ftl文件位置,这个是默认值
cache: false #设置缓存页面,默认值
charset: utf-8 # 设置页面编码格式
check-template-location: true
content-type: text/html #设置文档类型
expose-request-attributes: false #设定所有request的属性在merge到模板的时候,是否要都添加到model中.
expose-session-attributes: false #设定所有HttpSession的属性在merge到模板的时候,是否要都添加到model中.
request-context-attribute: rc #指定RequestContext属性的名.
suffix: .ftl #设置模板后缀名
这里列出的是比较重要的几项。
3、添加模板
这里在 resources/templates目录下添加目录 user,在user目录下添加模板 hello.ftl。
这里简单添加如下:
<!DOCTYPE html>
<html lang="en">
<body>
<h1>Hello Freemarker ${name}</h1>
</body>
</html>
4、设置controller
添加HelloController 类,然后代码如下:
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class HelloController {
@GetMapping(value = "/hello")
public String hello(Model model){
model.addAttribute("name","test");
return "user/hello";
}
}
运行效果如图:
需要注意的是,这里使用了 @Controller 注解,
参数中的model 表示传递到 视图层的 对象,可以封装用于传递到视图层的属性。
通过freemarker中的 最常用语法 ${}的方式,获取了封装的属性值。
二、freemarker 语法
在freemarker 模板文件中,由四个组成部分构成:
1)html文本部分,这部分不会经过freemarker计算,就是普通的html 标签或者直接的text文本,将会直接由浏览器解析后输出,比如示例 hello.ftl 中的 <html> <body>
等标记。
2)注释部分,这里说的是 freemarker的注释,freemarker的注释是 <#--...-->
格式的
3)插值部分,就是freemarker计算部分,其实就是两种格式#{}
以及${}
4)FTL指令 FreeMarker指定,和HTML标记相似,名字前加#
予以区分
前面两个就不多说了。
第三个,插值部分是用的最为广泛的部分,大多数时候都会用到${}
,这种格式叫做通用插值
而#{}
称为数字格式化插值,通常在对数字进行限制小数位置等操作时采用
我们将 controller 类稍微改造下:
@Controller
public class HelloController {
@GetMapping(value = "/hello")
public String hello(Model model){
model.addAttribute("answer",43.2287);
return "user/hello";
}
}
输出一个小数。我们再改下 hello.ftl
<!DOCTYPE html>
<html lang="en">
<body>
<h1>通用插值 </h1>
<p>${answer}</p>
<p>${answer?string}
<p>${answer?string.number}
<p>${answer?string.currency}
<p>${answer?string.percent}
<h1> 数字格式化插值 </h1>
<p>#{answer;M2}</p>
<p>#{answer;m2}
<p>#{answer;m1M2}
<p>#{answer;m2M4}
</body>
说明:其中 m2:小数部分最少2位,而M2:小数部分最多2位
可以直观看到运行结果:
通过插值方式,可以支持多种格式的输出,包括表达式,内置函数、逻辑运算等各种形式,语法其实和java差不多,下面举例将各种类型的数据输出,
1、添加实体类
import java.util.ArrayList;
import java.util.List;
public class UserInfo {
private String name;
private int age;
private List<String> intersts;
public UserInfo(){
intersts=new ArrayList<>();
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public List<String> getIntersts() {
return intersts;
}
public void setIntersts(List<String> intersts) {
this.intersts = intersts;
}
}
2、添加controller
import com.xyzh.hellofreemarker.entity.UserInfo;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class HelloController {
@GetMapping(value = "/hello")
public String hello(Model model){
UserInfo userInfo=new UserInfo();
userInfo.setAge(25);
userInfo.setName("adrian");
userInfo.getIntersts().add("唱歌");
userInfo.getIntersts().add("跳舞");
userInfo.getIntersts().add("篮球");
userInfo.getIntersts().add("rap");
model.addAttribute("userInfo",userInfo);
return "user/hello";
}
}
3、在模板上设置输出内容
<!DOCTYPE html>
<html lang="en">
<body>
<h1>个人信息 </h1>
<p>姓名:${userInfo.name}</p>
<p>年龄:${userInfo.age}</p>
<p>爱好:</p>
<#list userInfo.intersts as interst>
<p>${interst}</p>
</#list>
</body>
</html>
运行后结果:
这里可以看到,通过 ${}的形式,可以输出数字、字符串、列表多种值,这里特别说明下,
因为字段值可能为空,所以可能会造成不必要的错误,设置默认值 ${name!""} 来避免对象为空的错误。如果name为空,就以默认值(“!”后的字符)显示。
这里用到了FTL指令,下面介绍下常用的 FTL指令。
FTL指令
if 逻辑判断
<#if condition>
…
<#elseif condition2>
…
<#elseif condition3>
…
<#else>
…
</#if>
例如:将hello.ftl改为:
<!DOCTYPE html>
<html lang="en">
<body>
<h1>个人信息 </h1>
<p>姓名:
<#if userInfo.name??>
${userInfo.name}
<#else>
匿名
</#if>
</p>
<p>年龄:${userInfo.age}</p>
<p>
<#if userInfo.age gt 30>
中年
<#else>
青年
</#if>
</p>
<p>爱好:</p>
<#list userInfo.intersts as interst>
<p>${interst}</p>
</#list>
</body>
</html>
这里用了两个if判断,首先判断 userinfo.name是否为空,下面的判断是判断userinfo.age是否大于30
switch (条件可为数字,可为字符串)
<#switch value>
<#case value1>
…
<#break>
<#case value2>
…
<#break>
<#default>
…
</#switch>
循环
示例如下:
<!DOCTYPE html>
<html lang="en">
<body>
<h1>个人信息 </h1>
<p>姓名:
<#if userInfo.name??>
${userInfo.name}
<#else>
匿名
</#if>
</p>
<p>年龄:${userInfo.age}</p>
<p>
<#if userInfo.age gt 30>
中年
<#else>
青年
</#if>
</p>
<p>爱好:</p>
<#list userInfo.intersts as interst>
<p>${interst_index+"、"} ${interst}</p>
</#list>
<#list 1..4 as t>
${t}
</#list>
</body>
</html>
这里看到,用到了两个循环,一个遍历循环,一个固定次数的循环,另外还可以看到,遍历循环中,索引 用的是${变量_index}这种方式获取。
结果如下: