zl程序教程

您现在的位置是:首页 >  其他

当前栏目

模板引擎 FreeMarker

模板引擎 freemarker
2023-06-13 09:15:29 时间

1. 概述

freemarker 是一款模板引擎,即基于模板和要改变的数据用来生成输出文本(HTML页面、电子邮件、配置文件、源码等)的通用工具。它并非面向最终用户,而是一个 java 类库。

2. 技术对比

技术

说明

jsp

servlet专用,不可单独使用

velocity

springboot 1.4之后不再支持

thymeleaf

功能强大但效率低

freemarker

性能高、轻量且强大

3. 测试工程

pom 文件中导入相关依赖

<dependencies>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-freemarker</artifactId>
  </dependency>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
  </dependency>
  <!-- lombok -->
  <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
  </dependency>
  <!-- apache 对 java io 的封装工具库 -->
  <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-io</artifactId>
      <version>1.3.2</version>
  </dependency>
</dependencies>

application.yml 文件中进行配置

server:
  port: 8080  #服务端口
spring:
  application:
      name: test-freemarker  #指定服务名
  freemarker:
      cache: false  #关闭模板缓存,方便测试
      settings:
          template_update_delay: 0  #检查模板更新延迟时间,设置为0表示立即检查,如果时间大于0会有缓存不方便进行模板测试
      suffix: .ftl  #指定Freemarker模板文件的后缀名

注:freemarker 模板文件通常都是以 ftl 作为扩展名,也可以为 htmlxmljsp

在 resources 下创建 templates ,此目录为 freemarker 的默认模板存放目录,在 templates 下创建模板文件 01-basic.ftl ,模板中的插值表达式最终会被freemarker 替换成具体的数据

同时,freemarker 作为 springmvc 一种视图格式,默认情况下 SpringMVC 支持freemarker 的视图格式,即:

4. freemarker 指令语法

基础语法 -- 注释,即<#-- -->,介于其之间的内容会被 freemarke r忽略

<#--我是一个freemarker注释-->

-- 插值(Interpolation):即 ${..} 部分,freemarker 会用真实的值代替 ${..}

Hello ${name}
```	
-- FTL指令:和 HTML 标记类似,名字前加 ``#`` 予以区分,Freemarker 会解析标签中的表达式或逻辑
```xml
<# >FTL指令</#>

-- 文本,仅文本信息,这些不是 freemarker 的注释、插值、FTL 指令的内容会被 freemarker 忽略解析,直接输出内容。

<#--freemarker中的普通文本-->
我是一个普通的文本

集合指令-List

<#list stus as stu>
       <tr>
     <td>${stu_index+1}</td>
        <td>${stu.name}</td>
        <td>${stu.age}</td>
     <td>${stu.money}</td>
       </tr>
 </#list>

注:${k_index}得到循环的下标,使用方法是在 stu 后边加 "_index",它的值是从 0 开始

集合指令-Map -- 获取 map 中的值

map['keyname'].property
map.keyname.property

-- 遍历 map

<#list userMap?keys as key>
       key:${key}--value:${userMap["${key}"]}
 </#list>

if 指令

<#if expression>
<#else>
</#if>

例:在 list 集合中判断学生为小红的数据字体显示为红色

<#if stu.name='小红'>
     <tr style="color: red">
         <td>${stu_index}</td>
         <td>${stu.name}</td>
         <td>${stu.age}</td>
         <td>${stu.money}</td>
     </tr> <#else >
     <tr>
         <td>${stu_index}</td>
         <td>${stu.name}</td>
         <td>${stu.age}</td>
         <td>${stu.money}</td>
     </tr>
 </#if>

注:在 freemarker 中,判断是否相等时= 与 == 是一样的

运算符-数学运算 FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括: 加法: + 减法: - 乘法: * 除法: / 求模 (求余): %

例: 100+5 运算: ${100 + 5 } 100 - 5 * 5运算:${100 - 5 * 5} 5 / 2运算:${5 / 2} 12 % 10运算:${12 % 10}

  • 运算符-比较运算符

比较运算符

说明

=或者==

判断两个值是否相等

!=

判断两个值是否不等

>或者gt

判断左边值是否大于右边值

>=或者gte

判断左边值是否大于等于右边值

<或者lt

判断左边值是否小于右边值

<=或者lte

判断左边值是否小于等于右边值

注: = 和 != 可以用于字符串、数值和日期来比较是否相等 = 和 != 两边必须是相同类型的值,否则会产生错误 字符串 "x" 、"x " 、"X"比较是不等的,因为FreeMarker是精确比较 gt 代替 > , FreeMarker 会把 > 解释成 FTL 标签的结束字符,可使用括号避免这种情况,如:<#if (x>y)>

运算符-逻辑运算符 -- 逻辑与:&& -- 逻辑或:|| -- 逻辑非:!

空值处理 -- 判断某变量是否存在使用 "??"

<#if stus??>
   <#list stus as stu>
     ......
   </#list>
 </#if>

-- 缺失变量默认值使用 "!"

内建函数:内建函数语法格式为 变量+?+函数名称 -- 集合的大小

${集合名?size}

-- 日期格式化

显示年月日: ${today?date}
 显示时分秒:${today?time}
 显示日期+时间:${today?datetime}
 自定义格式化:${today?string("yyyy年MM月")}

-- 内建函数c

model.addAttribute("point", 102920122)

point 是数字型,使用 ${point} 会显示这个数字的值,每三位使用逗号分隔。如果不想显示为每三位分隔的数字,可以使用 c 函数将数字型转成字符串输出

${point?c}

-- 将 json 字符串转成对象

<#assign text="{'bank':'工商银行','account':'10101920201920212'}" />
 <#assign data=text?eval />
 开户行:${data.bank} 账号:${data.account}