Java使用Freemarker模板引擎生成动态内容

介绍

Freemarker是一款强大的模板引擎，它可以将动态生成的数据填充到HTML、XML、Markdown等文档中，并以静态的形式输出。Java语言可以轻松地与Freemarker集成，实现动态内容的生成和展示。本文将详细介绍Java中使用Freemarker模板引擎的相关知识和示例代码。

安装

首先，你需要在项目中添加Freemarker的依赖。可以通过Maven或者Gradle等方式将以下依赖添加到项目的配置文件中：

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

创建模板文件

在使用Freemarker之前，我们需要准备一个模板文件，用于定义动态生成内容的结构和格式。Freemarker支持多种文档类型，比如HTML、XML、Markdown等。在本文中，我们以HTML为例。

首先，在项目中创建一个文件夹用于存放模板文件。然后，新建一个以.ftl为后缀名的文件，可以取名为template.ftl。以下是一个简单的模板示例：

<!DOCTYPE html>
<html>
<head>
    <title>Welcome Page</title>
</head>
<body>
    <h1>Welcome, ${user.name}!</h1>
    <p>This is a dynamic page generated by Freemarker.</p>
</body>
</html>

在这个模板中，使用${user.name}来引用动态生成的数据。

准备数据

在Java代码中，我们需要准备数据以填充到模板中。通常，我们可以使用JavaBean或者java.util.Map来存储动态数据。在本文中，我们使用java.util.Map来进行演示。

首先，创建一个Map对象，并存储需要动态生成的数据。以下是一个示例代码：

import java.util.HashMap;
import java.util.Map;

public class Main {
    public static void main(String[] args) {
        // 创建数据模型
        Map<String, Object> dataModel = new HashMap<>();
        dataModel.put("user", new User("Alice"));

        // TODO: 使用Freemarker生成动态内容
    }
}

class User {
    private String name;

    public User(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

在上述代码中，我们创建了一个名为dataModel的Map对象，并将一个User对象存储在其中。User对象具有一个name属性，用于在模板中进行引用。

使用Freemarker生成动态内容

接下来，我们需要编写Java代码，以及集成Freemarker模板引擎，将动态数据填充到模板中，并输出为静态的HTML文件。以下是一个示例代码：

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

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Map;

public class Main {
    public static void main(String[] args) {
        // 创建数据模型
        Map<String, Object> dataModel = new HashMap<>();
        dataModel.put("user", new User("Alice"));

        // 使用Freemarker生成动态内容
        generateHtml(dataModel, "template.ftl", "output.html");
    }

    public static void generateHtml(Map<String, Object> dataModel, String templateName, String outputName) {
        try {
            // 创建Freemarker配置
            Configuration configuration = new Configuration(Configuration.VERSION_2_3_31);
            configuration.setDefaultEncoding("UTF-8");

            // 加载模板文件
            Template template = configuration.getTemplate(templateName);

            // 创建输出文件
            File outputFile = new File(outputName);
            FileWriter fileWriter = new FileWriter(outputFile);

            // 填充模板并输出到文件
            template.process(dataModel, fileWriter);

            // 关闭文件流
            fileWriter.close();

            System.out.println("Dynamic content generated successfully!");
        } catch (IOException e) {
            e.printStackTrace();
        } catch (TemplateException e) {
            e.printStackTrace();
        }
    }
}

在上述代码中，我们首先通过Configuration类创建Freemarker的配置。然后，使用getTemplate方法加载模板文件。接下来，创建输出文件的FileWriter对象，并使用process方法填充模板并输出至文件。最后，关闭文件流。

运行结果

当我们运行上述示例代码后，会在项目根目录生成一个名为output.html的文件。打开该文件可以看到以下内容：

<!DOCTYPE html>
<html>
<head>
    <title>Welcome Page</title>
</head>
<body>
    <h1>Welcome, Alice!</h1>
    <p>This is a dynamic page generated by Freemarker.</p>
</body>
</html>

在这个文件中，我们可以看到${user.name}被替换为了Alice，实现了动态内容的生成和展示。