SpringBoot-整合freemarker实例

最新推荐文章于 2021-05-07 18:23:33 发布

黄大胖子

最新推荐文章于 2021-05-07 18:23:33 发布

阅读量608

点赞数

分类专栏： SpringBoot 文章标签：黄大胖子 freemarker SpringBoot

本文链接：https://blog.csdn.net/u010508829/article/details/84338048

版权

SpringBoot 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

FreeMarker 是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

FreeMarker的工作原理图

SpringBoot整合FreeMarker

pom文件加入依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

配置文件application.yml

spring:
  freemarker:
    # 设置模板后缀名
    suffix: .ftl
    # 设置文档类型
    content-type: text/html
    # 设置页面编码格式
    charset: UTF-8
    # 设置页面缓存
    cache: false
  # 设置静态文件路径，js,css等
  mvc:
    static-path-pattern: /static/**

Controller方法如下

public class indexController {
	@RequestMapping("/index")
	public String toIndex(Model model) {
		model.addAttribute("text", "Hello world FreeMarker");
		return "index";
	}
}

index.ftl文件放在templates下

<!DOCTYPE>
<html>
	<head>
		<title>freemark</title>
	</head>
	<body>
    	<h1>${text}</h1>
	</body>
</html>

访问该项目http://localhost:8080/index

FreeMarker的常用语法

字符输出

${emp.name?if_exists}　　　　　  　// 变量存在，输出该变量，否则不输出
${emp.name!}　　　　　　　　　　    // 变量存在，输出该变量，否则不输出
${emp.name?default("xxx")}        // 变量不存在，取默认值xxx  
${emp.name!"xxx"}    　　　　　　  // 变量不存在，取默认值xxx
${"123<br>456"?html}    　　	// 对字符串进行HTML编码，对html中特殊字符进行转义    
${"str"?cap_first}    　　  	// 使字符串第一个字母大写     
${"Str"?lower_case}        	// 将字符串转换成小写     
${"Str"?upper_case}        	// 将字符串转换成大写    
${"str"?trim}              	// 去掉字符串前后的空白字符   
${"你好$ {emp.name!}"} 		//输出你好+变量名  
${"hello"+ emp.name!} 		//使用+号来连接，输出你好+变量名

// 以下是字符串截取 str ="abcdefghijklmn"
$ {str?substring（0,4）} 	//输出abcd
$ {str[0]}${str[4]} 		//结果是ae
$ {str[1..4]} 			//结果是bcde
$ {str?index_of("n")}		//返回指定字符的索引

日期输出

${emp.date?string('yyyy-MM-dd')} 	//日期格式

数字输出（以数字20为例）

$ {emp.name?string.number} 	//输出20  
$ {emp.name?string.currency} 	//¥20.00  
$ {emp.name?string.percent} 	// 20％  
$ {1.222？int} 			//将小数转为int，输出1

申明变量

<#assign foo = false /> 	//声明变量，插入布尔值进行显示，注意不要用引号
$ {foo?string（"yes"，"no"）} 	//当为真时输出“yes”，否则输出“no”   
申明变量的几种方式
<#assign name = value> 
<#assign name1 = value1 name2 = value2 ... nameN = valueN> 
<#assign same as above... in namespacehash> 

<#assign name>
 capture this 
</＃assign> 

<#assign name in namespacehash> 
capture this 
</＃assign>

比较运算算符

表达式中支持的比较运算符符如下几个：
=或== 	:判断两个值是否相等。
!=  	:判断两个值是否不等。
> 或gt	:判断左边值是否大于右边值>
<=或lte	:判断左边值是否小于等于右边值

算术运算符

FreeMarker表达式中完全支持算术运算，
FreeMarker支持的算术运算符包括：+， - ，*，/，％
注意：
（1）运算符两边必须是数字
（2）使用+运算符时，如果一边是数字，一边是字符串，就会自动将数字转换为字符串再连接，
     如：$ {3 +“5”}，结果是：35

逻辑运算符

逻辑运算符有如下几个：
逻辑与：&& 
逻辑或：|| 
逻辑非：！
逻辑运算符只能作用于布尔值，否则将产生错误

FreeMarker中的运算符优先级如下（由高到低排列）：

①，一元运算符：！
②，内建函数：
③，乘除法：*，/，％
④，加减法： - ，+ 
⑤，比较：>，<，> =，<=（lt，lte，gt，gte）
⑥，相等：==，=， ！= 
⑦，逻辑与：&& 
⑧，逻辑或：|| 
⑨，数字范围：.. 实际上，我们在开发过程中应该使用括号来严格区分，这样的可读性好，出错少

if逻辑判断（注意：elseif不加空格）

<#if condition>
...
<#elseif condition2>
...
<#elseif condition3>
...
<#else>
...
</#if>

if 空值判断

// 当 photoList 不为空时
<#if photoList??>...</#if> 

值得注意的是,${..}只能用于文本部分,不能用于表达式,下面的代码是错误的:
<#if ${isBig}>Wow!</#if>
<#if "${isBig}">Wow!</#if>

// 正确写法
<#if isBig>Wow!</#if>

switch (条件可为数字，可为字符串)

<#switch value> 
<#case refValue1> 
....
<#break> 
<#case refValue2> 
....
<#break> 
<#case refValueN> 
....
<#break> 
<#default> 
.... 
</#switch>

集合 & 循环

// 遍历集合:
<#list empList! as emp> 
    ${emp.name!}
</#list>

// 可以这样遍历集合:
<#list 0..(empList!?size-1) as i>
    ${empList[i].name!}
</#list>

// 与jstl循环类似,也可以访问循环的状态。

empList?size 　　　// 取集合的长度
emp_index: 　　　　// int类型，当前对象的索引值 
emp_has_next:     // boolean类型，是否存在下一个对象

// 使用<#break>跳出循环
<#if emp_index = 0><#break></#if>

// 集合长度判断 
<#if empList?size != 0></#if> // 判断=的时候,注意只要一个=符号,而不是==

<#assign l=0..100/>    // 定义一个int区间的0~100的集合，数字范围也支持反递增,如100..2
<#list 0..100 as i> 　　// 等效于java for(int i=0; i <= 100; i++)
　　${i}
</#list>

// 截取子集合：
empList[3..5] //返回empList集合的子集合,子集合中的元素是empList集合中的第4-6个元素

// 创建集合：
<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x>

// 集合连接运算,将两个集合连接成一个新的集合
<#list ["星期一","星期二","星期三"] + ["星期四","星期五","星期六","星期天"] as x>

// 除此之外,集合元素也可以是表达式,例子如下:
[2 + 2, [1, 2, 3, 4], "whatnot"]

// seq_contains：判断序列中的元素是否存在
<#assign x = ["red", 16, "blue", "cyan"]> 
${x?seq_contains("blue")?string("yes", "no")}    // yes
${x?seq_contains("yellow")?string("yes", "no")}  // no
${x?seq_contains(16)?string("yes", "no")}        // yes
${x?seq_contains("16")?string("yes", "no")}      // no

// seq_index_of：第一次出现的索引
<#assign x = ["red", 16, "blue", "cyan", "blue"]> 
${x?seq_index_of("blue")}  // 2

// sort_by：排序（升序）
<#list movies?sort_by("showtime") as movie></#list>

// sort_by：排序（降序）
<#list movies?sort_by("showtime")?reverse as movie></#list>

// 具体介绍：
// 不排序的情况：
<#list movies as moive>
　　<a href="${moive.url}">${moive.name}</a>
</#list>

//要是排序，则用
<#list movies?sort as movie>
　　<a href="${movie.url}">${movie.name}</a>
</#list>

// 这是按元素的首字母排序。若要按list中对象元素的某一属性排序的话，则用
<#list moives?sort_by(["name"]) as movie>
　　<a href="${movie.url}">${movie.name}</a>
</#list>

//这个是按list中对象元素的[name]属性排序的，是升序，如果需要降序的话，如下所示：
<#list movies?sort_by(["name"])?reverse as movie>
　　<a href="${movie.url}">${movie.name}</a>
</#list>

Map对象

// 创建map
<#assign scores = {"语文":86,"数学":78}>

// Map连接运算符
<#assign scores = {"语文":86,"数学":78} + {"数学":87,"Java":93}>

// Map元素输出
emp.name       // 全部使用点语法
emp["name"]    // 使用方括号

//遍历集合：
<＃list empList！as emp>     
	${emp.name!}
</#list>

FreeMarker支持如下转义字符:

\" ：双引号(u0022)
\' ：单引号(u0027)
\\ ：反斜杠(u005C)
\n ：换行(u000A)
\r ：回车(u000D)
\t ：Tab(u0009)
\b ：退格键(u0008)
\f ：Form feed(u000C)
\l ：<
\g ：>
\a ：&
\{ ：{
\xCode ：直接通过4位的16进制数来指定Unicode码,输出该unicode码对应的字符.

// 如果某段文本中包含大量的特殊符号,FreeMarker提供了另一种特殊格式:可以在指定字符串内容的引号前增加r标记,在r标记后的文件将会直接输出.看如下代码
${r"${foo}"} // 输出 ${foo}
${r"C:/foo/bar"} // 输出 C:/foo/bar

include指令

// include指令的作用类似于JSP的包含指令:
<#include "/test.ftl" encoding="UTF-8" parse=true>

// 在上面的语法格式中,两个参数的解释如下:
encoding="GBK"  // 编码格式
parse=true 　　 // 是否作为ftl语法解析,默认是true，false就是以文本方式引入

注意:在ftl文件里布尔值都是直接赋值的如parse=true,而不是parse=“true”

import指令

// 类似于jsp里的import,它导入文件，然后就可以在当前文件里使用被导入文件里的宏组件
<#import "/libs/mylib.ftl" as my>
// 上面的代码将导入/lib/common.ftl模板文件中的所有变量,交将这些变量放置在一个名为com的Map对象中，"my"在freemarker里被称作namespace

compress 压缩

// 用来压缩空白空间和空白的行 
<#compress> 
    ... 
</#compress>
<#t> // 去掉左右空白和回车换行 

<#lt>// 去掉左边空白和回车换行 

<#rt>// 去掉右边空白和回车换行 

<#nt>// 取消上面的效果

escape,noescape 对字符串进行HTML编码

// escape指令导致body区的插值都会被自动加上escape表达式,但不会影响字符串内的插值,
    只会影响到body内出现的插值,使用escape指令的语法格式如下:
<#escape x as x?html> 
　　First name: ${firstName} 
<#noescape>Last name: ${lastName}</#noescape> 
　　Maiden name: ${maidenName} 
</#escape>

// 相同表达式
First name: ${firstName?html} 
Last name: ${lastName} 
Maiden name: ${maidenName?html}