SpringBoot整合FreeMarker

FreeMarker

FreeMarker 是一个模板引擎,可以将模板与数据结合生成文本输出。以下是 Java FreeMarker 常用的语法及示例:

  1. 输出变量值

使用 ${} 输出变量值,如:

${user.name}
  1. 条件判断

使用 <#if><#else> 进行条件判断,如:

<#if user.age >= 18>
  成年人
<#else>
  未成年人
</#if>
  1. 循环遍历

使用 <#list> 进行循环遍历,如:

<#list users as user>
  ${user.name}
</#list>
  1. 宏定义

使用 <#macro> 定义宏,如:

<#macro hello name>
  Hello, ${name}!
</#macro>

<@hello name="World" />
  1. 引入其他模板

使用 <#include> 引入其他模板,如:

<#include "header.ftl" />

<body>
  ...
</body>

<#include "footer.ftl" />

示例文件

以下是一个使用Java Freemarker的示例.ftl文件:

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

	<#if loggedIn>
		<p>Welcome, ${user}!</p>
	<#else>
		<p>Please log in to continue.</p>
	</#if>

	<ul>
		<#list items as item>
			<li>${item}</li>
		</#list>
	</ul>

	<#include "footer.ftl">
</body>
</html>

在这个示例中,我们使用了以下语法:

  • ${}:用于在模板中插入变量。
  • <#if>:用于条件语句,如果条件为真,就执行其中的代码块。
  • <#else>:用于条件语句,如果条件为假,就执行其中的代码块。
  • <#list>:用于循环语句,可以遍历一个集合或数组。
  • <#include>:用于将其他模板文件包含到当前模板中。

注意,示例中的变量${title}${heading}${loggedIn}${user}${items}都需要在Java代码中传递给模板引擎。另外,<#include>语法中的文件路径需要根据实际情况进行修改。

FreeMarker中的一些类

FreeMarker是一种模板引擎,用于生成动态的HTML、XML、JSON等文本格式。在Java中,我们可以使用FreeMarker模板引擎来生成HTML页面或者邮件内容等。

FreeMarkerTemplateUtils类是FreeMarker模板引擎的工具类,它提供了一些静态方法来简化模板的使用。其中常用的方法有:

- processTemplateIntoString(Configuration cfg, Map<String, ?> model, String templateName):将模板文件解析成字符串,其中cfg是Configuration对象,model是数据模型,templateName是模板文件名。
- processTemplateIntoString(Template template, Map<String, ?> model):将模板解析成字符串,其中template是Template对象,model是数据模型。

Configuration类是FreeMarker模板引擎的核心类,它负责管理模板的配置信息。常用的方法有:

- setDirectoryForTemplateLoading(File dir):设置模板文件所在的目录。
- setDefaultEncoding(String encoding):设置模板文件的默认编码。
- getTemplate(String name):获取模板文件,其中name是模板文件名。

Template类是FreeMarker模板引擎的模板类,它表示一个已经解析的模板文件。常用的方法有:

- process(Object data, Writer out):将数据模型渲染到模板中,并将结果输出到指定的Writer对象中。
- process(Object data):将数据模型渲染到模板中,并返回渲染结果的字符串。

以上是FreeMarker模板引擎中常用的类和方法

SpringBoot整合FreeMarker

引入依赖

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

示例代码1:
FreeMarkerTemplateUtils类

常用方法:

1. processTemplateIntoString(Configuration cfg, Map<String, ?> model, String templateName):将模板和模型合并,并将结果以字符串形式返回。

参数说明:

- cfg:Configuration对象,用于配置FreeMarker的环境。
- model:Map对象,用于存储模板中需要的数据。
- templateName:模板文件名。
@Autowired
private Configuration cfg;

Map<String, Object> model = new HashMap<>();
model.put("name", "小明");
model.put("age", 18);

Template template = cfg.getTemplate("hello.ftl");
String result = FreeMarkerTemplateUtils.processTemplateIntoString(template, model);
System.out.println(result);

示例代码2:
FreeMarkerTemplateUtils类

常用方法:

2. processTemplate(Template template, Map<String, ?> model, Writer writer):将模板和模型合并,并将结果写入Writer对象中。

参数说明:

- template:Template对象,表示一个已经加载的模板。
- model:Map对象,用于存储模板中需要的数据。
- writer:Writer对象,用于将结果写入到输出流中。
@Autowired
private Configuration cfg;

Map<String, Object> model = new HashMap<>();
model.put("name", "小明");
model.put("age", 18);

Template template = cfg.getTemplate("hello.ftl");
Writer writer = new StringWriter();
FreeMarkerTemplateUtils.processTemplate(template, model, writer);
System.out.println(writer.toString());

你可能感兴趣的:(spring,boot,后端)