Java中的FreeMarker模板引擎|极客教程

Java中的FreeMarker模板引擎

FreeMarker是一个流行的Java模板引擎，用于生成动态内容，通常用于Web应用程序中的视图层。它允许开发人员将静态模板与动态数据结合在一起，以便动态生成网页、电子邮件、文档等内容。在本文中，我们将深入探讨FreeMarker模板引擎的基本概念、语法和用法。

什么是FreeMarker模板引擎？

FreeMarker是一个Java模板引擎，旨在简化将数据与模板结合以生成输出的过程。它允许开发人员使用特定的语法来定义模板并将动态数据填充到其中。这些模板可以是HTML、XML、文本文件等，可以灵活地适应各种需求。

FreeMarker的基本语法

变量

在FreeMarker中，使用${}语法来表示变量。例如，${user.name}表示访问user对象的name属性。如果变量不存在或为null，FreeMarker会输出一个空字符串。

<#assign user = {"name": "Alice", "age": 30}>
Hello,  ${user.name}! You are$ {user.age} years old.

输出：

Hello, Alice! You are 30 years old.

指令

FreeMarker支持多种指令，如if、else、elseif、list等。这些指令可以控制模板的流程和逻辑。

<#if user.age > 18>
    You are an adult.
<#else>
    You are a minor.
</#if>

循环

使用<#list>标签可以循环遍历集合或数组。

<#list users as user>
    ${user.name}
</#list>

宏

宏类似于函数，可以在模板中定义和调用。

<#macro helloUser user>
    Hello, ${user.name}!
</#macro>

<@helloUser user=user />

注释

在FreeMarker模板中，可以使用<#-- -->语法注释掉代码。

<#-- This is a comment -->

在Java中使用FreeMarker

添加FreeMarker依赖

要在Java项目中使用FreeMarker，首先需要将FreeMarker的依赖项添加到项目中。可以通过Maven或手动添加jar包的方式引入依赖。

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

创建Configuration对象

在Java代码中，需要创建一个Configuration对象来初始化FreeMarker模板引擎。

Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);
cfg.setClassForTemplateLoading(Main.class, "/");
cfg.setDefaultEncoding("UTF-8");

获取模板对象

使用Configuration对象可以获取模板对象。

Template template = cfg.getTemplate("hello.ftl");

创建数据模型

为模板提供数据模型。

Map<String, Object> data = new HashMap<>();
data.put("user", new HashMap<String, Object>() {{
    put("name", "Alice");
    put("age", 30);
}});

处理模板

将数据模型填充到模板中并输出。

StringWriter out = new StringWriter();
template.process(data, out);
System.out.println(out.toString());

示例

模板文件hello.ftl

<#assign user = {"name": "Alice", "age": 30}>
Hello,  ${user.name}! You are$ {user.age} years old.

Java代码

import freemarker.template.Configuration;
import freemarker.template.Template;

import java.io.StringWriter;
import java.util.HashMap;
import java.util.Map;

public class Main {
    public static void main(String[] args) throws Exception {
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);
        cfg.setClassForTemplateLoading(Main.class, "/");
        cfg.setDefaultEncoding("UTF-8");

        Template template = cfg.getTemplate("hello.ftl");

        Map<String, Object> data = new HashMap<>();
        data.put("user", new HashMap<String, Object>() {{
            put("name", "Alice");
            put("age", 30);
        }});

        StringWriter out = new StringWriter();
        template.process(data, out);
        System.out.println(out.toString());
    }
}