Java FreeMarker 语法简介

FreeMarker是一个Java模板引擎，用于在Java应用程序中生成文本输出。它将模板和数据结合起来，生成最终的输出结果。本文将介绍FreeMarker的基本语法和用法，并提供示例代码进行说明。

安装和配置

要使用FreeMarker，首先需要将其添加到Java项目的依赖中。如果使用Maven，可以在pom.xml文件中添加以下依赖：

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

安装完成后，需要对FreeMarker进行配置。可以通过创建一个Configuration对象来完成配置：

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

上述代码中，首先创建了一个Configuration对象，并设置了FreeMarker的版本号。然后，通过setClassForTemplateLoading方法指定了模板文件所在的包路径，以及模板文件的编码方式。

模板语法

FreeMarker使用一种类似HTML的标记语言作为模板语法。下面是一些常用的模板语法示例：

输出变量

可以使用${}语法来输出变量的值：

<p>Welcome, ${user}!</p>

上述代码中，${user}将会被替换为变量user的值。

条件语句

使用<#if>标签来实现条件语句：

<#if age &gt;= 18>
  <p>You are an adult.</p>
<#else>
  <p>You are a minor.</p>
</#if>

上述代码中，如果变量age的值大于等于18，则会输出"You are an adult."，否则输出"You are a minor."。

循环语句

使用<#list>标签来实现循环语句：

<ul>
<#list users as user>
  <li>${user}</li>
</#list>
</ul>

上述代码中，将会迭代变量users中的每个元素，并输出到一个无序列表中。

导入和包含其他模板

可以使用<#import>标签来导入其他模板，并使用<#include>标签来包含其他模板：

<#import "header.ftl" as header>

<html>
<head>
  <title>My Page</title>
</head>
<body>
  <header>${header.title}</header>
</body>
</html>

上述代码中，<#import>标签将会导入名为header.ftl的模板，并将其命名为header。然后，在<body>标签内使用${header.title}来输出导入模板中的变量。

示例

下面是一个使用FreeMarker生成HTML的示例代码：

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

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

public class FreeMarkerExample {

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

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

    Map<String, Object> data = new HashMap<>();
    data.put("user", "John Doe");
    data.put("age", 25);

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

    System.out.println(out.toString());
  }
}

上述代码中，首先创建了一个Configuration对象并进行配置。然后，通过getTemplate方法获取名为example.ftl的模板。接下来，创建一个Map对象来存储模板中需要的变量。最后，通过process方法将数据和模板进行合并，结果输出到一个StringWriter对象中。

总结

FreeMarker是一个强大的Java模板引擎，可以方便地生成各种文本输出。本文介绍了FreeMarker的基本语法和用法，并提供了示例代码进行说明。希望本文能够帮助读者更好地理解和使用FreeMarker。