freemarker
文章目录
官网: Freemarker官网
1、freemarker 介绍
FreeMarker 是一款 模板引擎: 即一种基于模板和要改变的数据, 并用来生成输出文本(HTML网页,电子邮件,配置文件,源代码等)的通用工具。 它不是面向最终用户的,而是一个Java类库,是一款程序员可以嵌入他们所开发产品的组件。
模板编写为FreeMarker Template Language (FTL)。它是简单的,专用的语言, 不是 像PHP那样成熟的编程语言。 那就意味着要准备数据在真实编程语言中来显示,比如数据库查询和业务运算, 之后模板显示已经准备好的数据。在模板中,你可以专注于如何展现数据, 而在模板之外可以专注于要展示什么数据。
这种方式通常被称为 MVC (模型 视图 控制器) 模式,对于动态网页来说,是一种特别流行的模式。 它帮助从开发人员(Java 程序员)中分离出网页设计师(HTML设计师)。设计师无需面对模板中的复杂逻辑, 在没有程序员来修改或重新编译代码时,也可以修改页面的样式。
而FreeMarker最初的设计,是被用来在MVC模式的Web开发框架中生成HTML页面的,它没有被绑定到 Servlet或HTML或任意Web相关的东西上。它也可以用于非Web应用环境中。
FreeMarker 是 免费的, 基于Apache许可证2.0版本发布。
上述解释源于:FreeMarker中文官方参考手册
常用的java模板引擎还有哪些?
Jsp、Freemarker、Thymeleaf 、Velocity 等。
技术 | 说明 |
---|---|
Jsp | Jsp 为 Servlet 专用,不能单独进行使用 |
Velocity | Velocity从2010年更新完2.0版本后,7年没有更新。Spring Boot 官方在1.4版本后对此也不在支持 |
thmeleaf | 新技术,功能较为强大,但是执行的效率比较低 |
freemarker | 性能好,强大的模板语言、轻量 |
2、freemarker 快速入门
-
导入依赖
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <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: 8881 #服务端口 spring: application: name: freemarker freemarker: cache: false #关闭模板缓存,方便测试 settings: template_update_delay: 0 #检查模板更新延迟时间,设置为0表示立即检查,如果时间大于0会有缓存不方便进行模板测试 suffix: .ftl #指定Freemarker模板文件的后缀名
-
引入模版名为01-basic.ftl
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Hello World!</title> </head> <body> <b>普通文本 String 展示:</b><br><br> Hello ${name!'-----------'} <br> <hr> <b>对象Student中的数据展示:</b><br/> 姓名:${(stu.name)!''}<br/> 年龄:${stu.age} <hr> </body> </html>
-
编写实体类
package org.example.freemarker.entity; import lombok.Data; import java.util.Date; @Data public class Student { private String name;//姓名 private int age;//年龄 private Date birthday;//生日 private Float money;//钱包 }
-
编写Controller接口
@Controller public class FreemarkerController { @GetMapping("/basic") public String hello(Model model) { Student student = new Student(); student.setName("张三"); student.setAge(18); model.addAttribute("stu", student); return "01-basic"; } }
-
启动项目,访问接口http://localhost:8881/basic
3、Freemarker指令语法
3.1、注释 (Comments)
FreeMarker 支持两种类型的注释:
-
单行注释:
<#-- 这是一个单行注释 -->
-
多行注释:
<#-- 这是一个 多行注释 -->
3.2、插值 (Interpolation)
插值用于在模板中输出变量的值。使用 ${}
语法来进行插值。例如:
Hello, ${name}!
如果 name
的值是 “Alice”,输出将是 “Hello, Alice!”。
支持简单的表达式插值:
${user.age + 1}
如果 user.age
是 30,输出将是 31。
3.3、FTL 指令
if 指令
用于条件判断。
<#if user.age >= 18>
You are an adult.
<#else>
You are a minor.
</#if>
list 指令
用于遍历集合。
<#list users as user>
<p>${user.name}</p>
</#list>
include 指令
用于包含其他模板文件的内容。
<#include "header.ftl">
assign 指令
用于赋值操作。
<#assign fullName = user.firstName + " " + user.lastName>
macro 指令
定义和调用宏。
<#macro greet name>
Hello, ${name}!
</#macro>
<@greet name="Alice"/>
function 指令
定义和调用自定义函数。
<#function square x>
${x * x}
</#function>
${square(4)}
3.4、文本 (Text)
FreeMarker 模板中的文本可以是普通的静态文本,也可以包含动态内容。
普通文本:
This is a static text.
动态文本:
Hello, ${name}!
静态文本与动态文本可以混合使用,生成最终的输出。例如:
Hello, ${name}! Today is ${date?date}.
如果 name
是 “Alice” 且 date
是当前日期,输出将是类似 “Hello, Alice! Today is 2024-06-13.”。
3.5、条件运算符
FreeMarker 提供了几种条件运算符,用于逻辑判断和条件处理。
-
if-else 语句:
<#if user.age >= 18> You are an adult. <#else> You are a minor. </#if>
-
三元运算符:
ftl 复制代码 ${user.age >= 18 ? "You are an adult." : "You are a minor."}
-
switch-case 语句:
<#switch user.role> <#case "admin"> You are an admin. <#case "user"> You are a regular user. <#default> Unknown role. </#switch>
3.6、空值处理
- 判断某变量是否存在使用"??“
用法为:variable??,如果该变量存在,返回true,否则返回false
<#if stus??>
<#list stus as stu>
</#list>
</#if>
-
缺失变量默认值使用“!”
姓名:${(stu.name)!'---'}<br/> 姓名:${name!''}<br/>
当(stu.name)为空的时候,替换为—,或者什么也不填则为空串
嵌套对象使用()包起来。
3.7、内建函数
FreeMarker 内建函数是预定义的用于处理数据的函数。常用的内建函数包括:
-
字符串函数:
-
length
:获取字符串长度。${"hello"?length} <!-- 输出: 5 -->
-
upper_case
和lower_case
:将字符串转换为大写或小写。${"hello"?upper_case} <!-- 输出: HELLO --> ${"HELLO"?lower_case} <!-- 输出: hello -->
-
substring
:获取子字符串。ftl 复制代码 ${"hello"?substring(0, 2)} <!-- 输出: he -->
-
-
日期函数:
-
date
:格式化日期。${.now?date("yyyy-MM-dd")}
-
time
和datetime
:格式化时间和日期时间。显示年月日:${today?date} 显示时分秒:${today?time} 显示日期+时间:${today?datetime} 自定义格式化:${today?string(“yyyy年MM月")}
-
-
数字函数:
-
number
:格式化数字。
${12345.678?number} <!-- 输出: 12,345.678 -->
-
-
集合函数:
-
size
:获取集合的大小。${users?size}
-
sort
:对集合进行排序。<#list users?sort_by("name") as user> ${user.name} </#list>
-
-
长数值
//长数值 model.addAttribute("point",38473897438743L);
-
${point}
-
${point?c}
-
-
将json字符串转成对象
其中用到了 assign标签,assign的作用是定义一个变量。
<#assign text="{'bank':'工商银行','account':'10101920201920212'}" /> <#assign data=text?eval /> 开户行:${data.bank} 账号:${data.account}
3.8、静态文件生成
FreeMarker 常用于生成静态文件,如 HTML、XML、JSON 等。以下是生成静态 HTML 文件的示例:
1. 配置 FreeMarker
首先,确保你已经正确配置了 FreeMarker。以下是一个简单的 Spring Boot 配置示例:
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer;
@Configuration
public class FreeMarkerConfig {
@Bean
public FreeMarkerConfigurer freeMarkerConfigurer() {
FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
configurer.setTemplateLoaderPath("classpath:/templates");
return configurer;
}
}
2. 定义模板文件
在 src/main/resources/templates
目录下创建一个模板文件,例如 example.ftl
:
<!DOCTYPE html>
<html>
<head>
<title>${title}</title>
</head>
<body>
<h1>${header}</h1>
<p>${content}</p>
</body>
</html>
3. 生成静态文件的控制器
创建一个控制器来生成静态文件:
import freemarker.template.Configuration;
import freemarker.template.Template;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import java.io.FileWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
@Controller
public class FreemarkerController {
@Autowired
private Configuration freemarkerConfig;
@GetMapping("/generate")
public String generateStaticFile() throws Exception {
Template template = freemarkerConfig.getTemplate("example.ftl");
Map<String, Object> model = new HashMap<>();
model.put("title", "Static HTML Example");
model.put("header", "Welcome to FreeMarker!");
model.put("content", "This is a static HTML file generated by FreeMarker.");
try (Writer fileWriter = new FileWriter("output.html")) {
template.process(model, fileWriter);
}
return "File generated successfully";
}
}
这个控制器读取 example.ftl
模板,填充数据模型,然后生成一个静态的 output.html
文件。
也可以将文件进行修改:这样就会将生成的文件存储在d盘下。
package com.heima.freemarker;
import com.heima.freemarker.FreemarkerApplication;
import com.heima.freemarker.entity.Student;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import java.io.FileWriter;
import java.io.IOException;
import java.util.*;
@SpringBootTest(classes = FreemarkerApplication.class)
@RunWith(SpringRunner.class)
public class FreemarkerTest {
@Autowired
private Configuration configuration;
@Test
public void test() throws IOException, TemplateException {
//freemarker的模板对象,获取模板
Template template = configuration.getTemplate("02-list.ftl");
Map params = getData();
//合成
//第一个参数 数据模型
//第二个参数 输出流
template.process(params, new FileWriter("d:/list.html"));
}
private Map getData() {
Map<String, Object> map = new HashMap<>();
//小强对象模型数据
Student stu1 = new Student();
stu1.setName("小强");
stu1.setAge(18);
stu1.setMoney(1000.86f);
stu1.setBirthday(new Date());
//小红对象模型数据
Student stu2 = new Student();
stu2.setName("小红");
stu2.setMoney(200.1f);
stu2.setAge(19);
//将两个对象模型数据存放到List集合中
List<Student> stus = new ArrayList<>();
stus.add(stu1);
stus.add(stu2);
//向map中存放List集合数据
map.put("stus", stus);
//创建Map数据
HashMap<String, Student> stuMap = new HashMap<>();
stuMap.put("stu1", stu1);
stuMap.put("stu2", stu2);
//向map中存放Map数据
map.put("stuMap", stuMap);
//返回Map
return map;
}
}