利用 Java 和 FTL 模板实现方框打钩功能

在现代应用程序开发中，模板引擎能够帮助我们快速构建动态的 Web 应用。本文将通过一个具体示例——实现“方框打钩”功能，来介绍如何在 Java 中使用 FreeMarker (FTL) 模板。

任务流程

下面是实现“方框打钩”功能的基本流程：

步骤 操作 说明
1 创建 Java 类 定义模型
2 准备数据 准备要传递给模板的变量
3 编写 FTL 模板 创建前端显示的模板
4 生成最终页面 使用 FreeMarker 生成 HTML 页

步骤一：创建 Java 类

首先，我们需要创建一个用于表示方框及其状态的 Java 类。你可以在 src/main/java/com/example/ 目录下创建一个名为 Checkbox.java 的类。

package com.example;

/**
 * Checkbox 类表示一个复选框的状态
 */
public class Checkbox {
    private String label; // 复选框的标签
    private boolean checked; // 标示复选框是否被选中

    // 构造函数
    public Checkbox(String label, boolean checked) {
        this.label = label;
        this.checked = checked;
    }

    // Getter 方法
    public String getLabel() {
        return label;
    }

    public boolean isChecked() {
        return checked;
    }
}

步骤二：准备数据

在 src/main/java/com/example/ 目录下创建一个名为 Main.java 的文件，用于准备数据并填充模板。

package com.example;

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

import java.io.*;
import java.util.*;

public class Main {
    public static void main(String[] args) throws IOException {
        // 创建 FreeMarker 配置
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);
        cfg.setClassForTemplateLoading(Main.class, "/");
        cfg.setDefaultEncoding("UTF-8");
        cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);

        // 创建复选框数据
        List<Checkbox> checkboxes = new ArrayList<>();
        checkboxes.add(new Checkbox("选项 A", true));
        checkboxes.add(new Checkbox("选项 B", false));

        // 渲染模板
        Template template = cfg.getTemplate("checkbox_template.ftl");
        try (Writer out = new OutputStreamWriter(System.out)) {
            Map<String, Object> model = new HashMap<>();
            model.put("checkboxes", checkboxes);
            template.process(model, out);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

在这段代码中：

  • 我们首先配置 FreeMarker。
  • 创建了一个包含不同复选框的列表，其中包含每个复选框的标签和状态（是否被选中）。
  • 使用模板和数据创建了输出。

步骤三：编写 FTL 模板

现在，创建一个名为 checkbox_template.ftl 的 FreeMarker 模板文件。

<!DOCTYPE html>
<html lang="zh">
<head>
    <meta charset="UTF-8">
    <title>复选框示例</title>
</head>
<body>
    复选框列表
    <form>
        <#list checkboxes as checkbox>
            <label>
                <input type="checkbox" ${checkbox.checked?string("checked", "")}> ${checkbox.label}
            </label><br>
        </#list>
    </form>
</body>
</html>

在这个模板中：

  • 我们使用 #list 指令遍历复选框数据。
  • 判断复选框的状态，并通过 ${} 语法动态生成复选框的 checked 属性。

步骤四：生成最终页面

如上所述，最终页面已经在 Main.java 的 template.process(model, out); 行进行生成。

序列图

下面是整个程序的序列图，展示了各个组件之间的交互。

sequenceDiagram
    participant User
    participant Main
    participant FreeMarker
    participant Template

    User->>Main: 启动程序
    Main->>FreeMarker: 配置模板
    Main->>Checkbox: 创建复选框数据
    FreeMarker->>Template: 渲染模板
    Template-->>Main: 返回渲染结果
    Main-->>User: 输出 HTML

类图

下图展示了我们的类结构。

classDiagram
    class Checkbox {
        - String label
        - boolean checked
        + Checkbox(String label, boolean checked)
        + String getLabel()
        + boolean isChecked()
    }
    
    class Main {
        + static void main(String[] args)
    }

结尾

通过上述步骤，我们实现了一个简单的 Java 应用，利用 FreeMarker 模板引擎生成动态的复选框。你可以根据这个示例进一步扩展功能，尝试不同的控件或者数据来源。掌握模板引擎的使用将极大地提高你的开发效率。希望这篇文章能帮助你更好地理解这一过程！如果你有任何疑问或希望深入讨论相关内容，欢迎随时提问。