简介

FreeMarker是一个广泛使用的Java模板引擎，它可以用来生成Java对象、XML、HTML等格式的内容。在Java开发中，FreeMarker常用于生成动态网页或构建邮件内容。本文将带你从入门到实战，快速掌握FreeMarker的使用。

环境准备

1. 安装Java开发环境

确保你的开发环境中安装了Java Development Kit (JDK)。你可以从Oracle官网下载适合你操作系统的JDK。

2. 创建Maven项目

如果你使用Maven作为项目管理工具，可以创建一个新的Maven项目。以下是创建Maven项目的命令：

mvn archetype:generate -DgroupId=com.example -DartifactId=freemarker-example -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4

3. 添加FreeMarker依赖

在pom.xml文件中添加FreeMarker的依赖：

org.freemarker

freemarker

2.3.31

入门指南

1. 简单的模板

创建一个名为template.ftl的FreeMarker模板文件，内容如下：

${header}

${content}

这里的${title}、${header}和${content}是模板变量，它们将在运行时被替换。

2. 编写Java代码

在Java代码中，你需要创建一个freemarker.template.Template对象，并使用它来渲染模板：

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.io.Writer;

import java.util.HashMap;

import java.util.Map;

public class FreeMarkerExample {

public static void main(String[] args) {

try {

// 创建配置对象

Configuration cfg = new Configuration();

// 设置模板所在的目录

cfg.setClassForTemplateLoading(FreeMarkerExample.class, "/");

// 获取模板对象

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

// 创建数据模型

Map dataModel = new HashMap<>();

dataModel.put("title", "Hello FreeMarker");

dataModel.put("header", "Welcome to FreeMarker");

dataModel.put("content", "This is a simple example of FreeMarker.");

// 创建输出文件

Writer fileWriter = new FileWriter(new File("output.html"));

// 输出模板

template.process(dataModel, fileWriter);

// 关闭文件

fileWriter.close();

} catch (IOException | TemplateException e) {

e.printStackTrace();

}

}

}

这段代码将创建一个名为output.html的文件，其中包含渲染后的HTML内容。

实战演练

1. 复杂模板

FreeMarker支持复杂的模板，包括嵌套、循环、条件判断等。以下是一个使用循环的例子：

${header}

<#list items as item>

• ${item}

2. 数据模型

在Java代码中，你可以创建一个复杂的数据模型来传递给模板：

Map dataModel = new HashMap<>();

dataModel.put("title", "List Example");

dataModel.put("header", "List of Items");

List items = Arrays.asList("Item 1", "Item 2", "Item 3");

dataModel.put("items", items);

3. 高级功能

FreeMarker还支持宏、自定义函数等高级功能，这些功能可以让你构建更加灵活和强大的模板。

总结

通过本文的介绍，你应该已经掌握了FreeMarker的基本使用方法。FreeMarker是一个功能强大的模板引擎，可以帮助你轻松构建各种模板应用。在实践中，你可以根据需求不断学习和探索FreeMarker的高级功能。