原文：http://zetcode.com/java/freemarker/

这是 FreeMarker Java 模板引擎的入门教程。 我们介绍了 FreeMarker 模板引擎，并创建了几个控制台和 Web 应用。 Maven 用于构建我们的示例。 NetBeans 用于管理应用。

目录

  1. FreeMarker 模板引擎
  2. 控制台应用
  3. FreeMarker 指令
  4. Servlet 和 FreeMarker
  5. Spark 和 FreeMarker
  6. Spring 和 FreeMarker

FreeMarker 是 Java 编程语言的模板引擎。 模板以 FreeMarker 模板语言（FTL）编写。 FreeMarker 的主页是 freemarker.org 。

FreeMarker 模板引擎

模板引擎将静态数据与动态数据结合起来以产生内容。 模板是内容的中间表示。 它指定如何生成输出。

模板引擎的优点是：

  • 关注点分离，
  • 避免重复代码，
  • 更容易在视图之间切换，
  • 可重用性。

按照惯例，FreeMarker 模板文件的扩展名为.ftl。

FreeMarker 不仅限于 HTML 页面的模板； 它可以用于生成电子邮件，配置文件，源代码等。

FreeMarker 控制台应用

前两个应用是控制台应用。 我们在 NetBeans 中创建新的 Maven Java 应用。 他们使用以下 Maven 构建文件：

  1. <dependency>
  2.     <groupId>org.freemarker</groupId>
  3.     <artifactId>freemarker</artifactId>
  4.     <version>2.3.23</version>
  5. </dependency>

在 Maven pom.xml文件中，我们指定 FreeMarker 依赖项。

FreeMarker 插值

插值是放在${ }字符之间的表达式。 FreeMarker 会将输出中的插值替换为大括号内表达式的实际值。

在下面的示例中，我们使用 FreeMarker 模板文件来生成简单的文本输出。

FreeMarker 教程 - 图1

图：NetBeans 中的 Java 控制台项目结构

这是 NetBeans 中的项目结构。

FreeMarkerConsoleEx.java

  1. package com.zetcode;
  3. import freemarker.template.Configuration;
  4. import freemarker.template.Template;
  5. import freemarker.template.TemplateException;
  6. import freemarker.template.Version;
  7. import java.io.IOException;
  8. import java.io.StringWriter;
  9. import java.util.HashMap;
  10. import java.util.Map;
  12. public class FreeMarkerConsoleEx {
  14.     public static void main(String[] args) throws IOException,
  15.             TemplateException {
  17.         Configuration cfg = new Configuration(new Version("2.3.23"));
  19.         cfg.setClassForTemplateLoading(FreeMarkerConsoleEx.class, "/");
  20.         cfg.setDefaultEncoding("UTF-8");
  22.         Template template = cfg.getTemplate("test.ftl");
  24.         Map<String, Object> templateData = new HashMap<>();
  25.         templateData.put("msg", "Today is a beautiful day");
  27.         try (StringWriter out = new StringWriter()) {
  29.             template.process(templateData, out);
  30.             System.out.println(out.getBuffer().toString());
  32.             out.flush();
  33.         }
  34.     }
  35. }

该示例将简单文本打印到控制台。 最终文本由模板引擎处理。

  1. Configuration cfg = new Configuration(new Version("2.3.23"));

Configuration用于设置 FreeMarker 设置； 它以 FreeMarker 库的版本为参数。

  1. cfg.setClassForTemplateLoading(FreeMarkerConsoleEx.class, "/");

setClassForTemplateLoading()设置将使用其方法来加载模板的类。

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

使用getTemplate()方法，我们检索test.ftl模板文件。

  1. Map<String, Object> templateData = new HashMap<>();
  2. templateData.put("msg", "Today is a beautiful day");

数据模型已创建。 来自模型的数据将被动态放置到 FreeMarker 模板文件中。

  1. try (StringWriter out = new StringWriter()) {
  3.     template.process(templateData, out);
  4.     System.out.println(out.getBuffer().toString());
  6.     out.flush();
  7. }

process()方法使用提供的数据模型执行模板，并将生成的输出写入提供的写入器。

test.ftl

  1. The message is: ${msg}

test.ftl模板文件包含一个插值； 它将替换为生成的字符串。

  1. The message is: Today is a beautiful day

这是应用的输出。

用 FreeMarker 列出一个集合

#list指令列出了数据集合。

下一个示例生成汽车列表。

Car.java

  1. package com.zetcode.bean;
  3. public class Car {
  5.     private String name;
  6.     private int price;
  8.     public Car() {
  9.     }
  11.     public Car(String name, int price) {
  13.         this.name = name;
  14.         this.price = price;
  15.     }
  17.     public String getName() {
  18.         return name;
  19.     }
  21.     public void setName(String name) {
  22.         this.name = name;
  23.     }
  25.     public int getPrice() {
  26.         return price;
  27.     }
  29.     public void setPrice(int price) {
  30.         this.price = price;
  31.     }
  32. }

我们有一个Car bean。 它具有两个属性：名称和价格。

FreeMarkerConsoleEx2.java

  1. package com.zetcode;
  3. import com.zetcode.bean.Car;
  4. import freemarker.template.Configuration;
  5. import freemarker.template.Template;
  6. import freemarker.template.TemplateException;
  7. import freemarker.template.Version;
  8. import java.io.IOException;
  9. import java.io.StringWriter;
  10. import java.util.ArrayList;
  11. import java.util.HashMap;
  12. import java.util.List;
  13. import java.util.Map;
  15. public class FreeMarkerConsoleEx2 {
  17.     public static void main(String[] args) throws IOException,
  18.             TemplateException {
  20.         Configuration cfg = new Configuration(new Version("2.3.23"));
  22.         cfg.setClassForTemplateLoading(FreeMarkerConsoleEx2.class, "/");
  23.         cfg.setDefaultEncoding("UTF-8");
  25.         Template template = cfg.getTemplate("test.ftl");
  27.         Map<String, Object> templateData = new HashMap<>();
  29.         Car c1 = new Car("Audi", 52642);
  30.         Car c2 = new Car("Volvo", 29000);
  31.         Car c3 = new Car("Skoda", 9000);
  33.         List<Car> cars = new ArrayList<>();
  34.         cars.add(c1);
  35.         cars.add(c2);
  36.         cars.add(c3);        
  38.         templateData.put("cars", cars);
  40.         try (StringWriter out = new StringWriter()) {
  42.             template.process(templateData, out);
  43.             System.out.println(out.getBuffer().toString());
  45.             out.flush();
  46.         }
  47.     }
  48. }

此示例是一个 Java 控制台程序，该程序使用 FreeMarker 动态创建包含汽车列表的文本输出。

  1. Map<String, Object> templateData = new HashMap<>();
  3. Car c1 = new Car("Audi", 52642);
  4. Car c2 = new Car("Volvo", 29000);
  5. Car c3 = new Car("Skoda", 9000);
  7. List<Car> cars = new ArrayList<>();
  8. cars.add(c1);
  9. cars.add(c2);
  10. cars.add(c3);        
  12. templateData.put("cars", cars);

在这里，我们创建Car对象的ArrayList并将其放入数据模型。

test.ftl

  1. <#list cars as car>
  2. ${car.name}: ${car.price}
  3. </#list>

模板文件包含一个#list指令，该指令打印汽车对象的属性。 使用点字符访问属性。

  1. Audi: 52,642
  2. Volvo: 29,000
  3. Skoda: 9,000

这是示例的输出。

FreeMarker 指令

FreeMarker 指令是执行动作的特殊标记。 指令有两种：内置指令和自定义指令。

<#assign>标签创建一个新的普通变量。 可以使用${}构造对其进行访问。 变量在模板中创建。 如果数据模型中有一个同名变量，则模板变量会将其隐藏。

assignment.ftl

  1. <#assign name = "Robert">
  3. His name is ${name}.

<#assign>指令创建一个新的name变量。 变量的值使用${name}语法打印。

  1. His name is Robert.

该示例打印此行。

可以使用<#if>，<#elseif>和<#else>伪指令完成模板节的条件处理。

conditions.ftl

  1. <#assign value = 4>
  3. <#if value < 0>
  4.   The number is negative
  5. <#elseif value == 0>  
  6.   The number is zero
  7. <#else>
  8.   The number is positive
  9. </#if>

该示例创建一个新的value变量，并使用条件指令来测试该值。

  1. The number is positive

这是输出。

<#list>指令用于遍历序列。

listing.ftl

  1. <#assign colours = ["red", "green", "blue", "yellow"]>
  3. <#list colours as col>
  4. ${col}
  5. </#list>

在示例中，我们将新的颜色名称序列分配给colours变量。 <#list>指令遍历集合并打印每个项目。

  1. red
  2. green
  3. blue
  4. yellow

该示例给出了此输出。

listing2.ftl

  1. <#assign items = {"pens": 3, "cups": 2, "tables": 1}>
  3. <#list items?values as v>
  4. ${v}
  5. </#list>
  7. <#list items?keys as k>
  8. ${k}
  9. </#list>

在此示例中，我们创建一个哈希变量，并使用<#list>输出哈希的值和键。

  1. 3
  2. 2
  3. 1
  5. pens
  6. cups
  7. tables

The example gives this output.

当我们使用对空格不敏感的格式（例如 HTML 或 XML）时，<#compress>指令会删除多余的空格

compressing.ftl

  1. <#assign value="\t\tweather\n\n">
  3. <#compress>
  4. ${value}
  5.         Today is a wonderful day.
  6.    1 2   3       4     5     
  7. </#compress>

我们的文本带有空格，制表符和换行符。

  1. weather
  2. Today is a wonderful day.
  3. 1 2 3 4 5

该程序删除了所有多余的空白。

FreeMarker Servlet 示例

在下面的示例中，我们在标准 Java Web 应用中使用 FreeMarker。 该应用打包到war文件中，并部署在 NetBeans 的内置 Tomcat 服务器上。

在 NetBeans 中，我们创建一个新的 Maven Web 应用。

FreeMarker 教程 - 图2

图：NetBeans 中的 FreeMarker servlet 项目结构

这是 NetBeans 中 FreeMarker servlet 示例的项目结构。

  1. <dependency>
  2.     <groupId>org.freemarker</groupId>
  3.     <artifactId>freemarker</artifactId>
  4.     <version>2.3.23</version>
  5. </dependency>
  7. <dependency>
  8.     <groupId>javax</groupId>
  9.     <artifactId>javaee-web-api</artifactId>
  10.     <version>7.0</version>
  11.     <scope>provided</scope>
  12. </dependency>

在pom.xml文件中，我们具有这两个依赖关系。

context.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Context path="/FreemarkerServletEx"/>

这是context.xml文件。

web.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app version="3.1" xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  4.     xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd">
  6.     <servlet>
  7.         <servlet-name>freemarker</servlet-name>
  8.         <servlet-class>freemarker.ext.servlet.FreemarkerServlet</servlet-class>
  10.         <init-param>
  11.             <param-name>TemplatePath</param-name>
  12.             <param-value>/</param-value>
  13.         </init-param>
  14.         <init-param>
  15.             <param-name>NoCache</param-name>
  16.             <param-value>true</param-value>
  17.         </init-param>
  18.         <init-param>
  19.             <param-name>ResponseCharacterEncoding</param-name>
  20.             <param-value>fromTemplate</param-value>
  21.         </init-param>
  22.         <init-param>
  23.             <param-name>ExceptionOnMissingTemplate</param-name>
  24.             <param-value>true</param-value>
  25.         </init-param>
  26.         <init-param>
  27.             <param-name>incompatible_improvements</param-name>
  28.             <param-value>2.3.23</param-value>
  29.         </init-param>
  30.         <init-param>
  31.             <param-name>template_exception_handler</param-name>
  32.             <param-value>html_debug</param-value>
  33.         </init-param>
  34.         <init-param>
  35.             <param-name>template_update_delay</param-name>
  36.             <param-value>0 s</param-value>
  37.         </init-param>
  38.         <init-param>
  39.             <param-name>default_encoding</param-name>
  40.             <param-value>UTF-8</param-value>
  41.         </init-param>
  42.         <init-param>
  43.             <param-name>output_encoding</param-name>
  44.             <param-value>UTF-8</param-value>
  45.         </init-param>
  46.         <init-param>
  47.             <param-name>locale</param-name>
  48.             <param-value>en_US</param-value>
  49.         </init-param>
  50.         <init-param>
  51.             <param-name>number_format</param-name>
  52.             <param-value>0.##########</param-value>
  53.         </init-param>
  54.         <load-on-startup>1</load-on-startup>
  55.     </servlet>
  57.     <servlet-mapping>
  58.         <servlet-name>freemarker</servlet-name>
  59.         <url-pattern>*.ftl</url-pattern>
  60.     </servlet-mapping>
  62.     <security-constraint>
  63.         <web-resource-collection>
  64.             <web-resource-name>FreeMarker MVC Views</web-resource-name>
  65.             <url-pattern>*.ftl</url-pattern>
  66.         </web-resource-collection>
  67.         <auth-constraint>
  68.         </auth-constraint>
  69.     </security-constraint>
  71.     <session-config>
  72.         <session-timeout>
  73.             30
  74.         </session-timeout>
  75.     </session-config>
  76. </web-app>

在web.xml文件中，我们设置并配置了 FreeMarker servlet。 有关每个选项的说明，请参考 FreeMarker 文档。

Car.java

  1. package com.zetcode.bean;
  3. public class Car {
  5.     private String name;
  6.     private int price;
  8.     public Car() {
  9.     }
  11.     public Car(String name, int price) {
  13.         this.name = name;
  14.         this.price = price;
  15.     }
  17.     public String getName() {
  18.         return name;
  19.     }
  21.     public void setName(String name) {
  22.         this.name = name;
  23.     }
  25.     public int getPrice() {
  26.         return price;
  27.     }
  29.     public void setPrice(int price) {
  30.         this.price = price;
  31.     }
  32. }

这是Car bean，具有有关汽车对象的基本数据。

MyServlet.java

  1. package com.zetcode.web;
  3. import com.zetcode.bean.Car;
  4. import java.io.IOException;
  5. import java.util.ArrayList;
  6. import java.util.List;
  7. import javax.servlet.ServletException;
  8. import javax.servlet.annotation.WebServlet;
  9. import javax.servlet.http.HttpServlet;
  10. import javax.servlet.http.HttpServletRequest;
  11. import javax.servlet.http.HttpServletResponse;
  13. @WebServlet(name = "MyServlet", urlPatterns = {"/"})
  14. public class MyServlet extends HttpServlet {
  16.     @Override
  17.     protected void doGet(HttpServletRequest request, HttpServletResponse response)
  18.             throws ServletException, IOException {
  20.         response.setContentType("text/html;charset=UTF-8");
  22.         Car c1 = new Car("Audi", 52642);
  23.         Car c2 = new Car("Volvo", 29000);
  24.         Car c3 = new Car("Skoda", 9000);
  26.         List<Car> cars = new ArrayList<>();
  27.         cars.add(c1);
  28.         cars.add(c2);
  29.         cars.add(c3);
  31.         request.setAttribute("cars", cars);
  33.         request.getRequestDispatcher("/index.ftl").forward(request, response);
  35.     }
  36. }

我们设置 servlet 并将其分发到模板文件。 我们创建了一个ArrayList汽车并将其设置为请求。

index.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>FreeMarker test</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.         </head>
  8.     <body>
  10.         <table>
  11.             <tr>
  12.                 <th>Name</th>  
  13.                 <th>Price</th>
  14.             </tr>        
  16.             <#list cars as car>
  17.                 <tr>
  18.                     <td>${car.name}</td> 
  19.                     <td>${car.price}</td>
  20.                 </tr>
  21.             </#list>        
  22.         </table>                
  23.     </body>
  24. </html>

index.ftl文件位于src/main/webapp目录中。 使用#list指令，我们显示了cars系列的所有元素。

FreeMarker 教程 - 图3

图：FreeMarker servlet 示例

我们在 Opera 网络浏览器中显示应用输出。 NetBeans 中的内置 Tomcat 在 8084 端口上运行。

FreeMarker 与 Spark

Spark 是为快速开发而构建的简单轻便的 Java Web 框架。 默认情况下，Spark 在嵌入式 Jetty Web 服务器上运行，但可以配置为在其他 Web 服务器上运行。 为了将 FreeMarker 与 Spark 集成，我们使用spark-template-freemarker，这是 Spark 的 Freemarker 模板引擎实现。

  1. $ tree
  2. .
  3. ├── pom.xml
  4. └── src
  5.     ├── main
  6.     │   ├── java
  7.     │   │   └── com
  8.     │   │       └── zetcode
  9.     │   │           └── SparkFreeMarker.java
  10.     │   └── resources
  11.     │       └── views
  12.     │           └── hello.ftl
  13.     └── test
  14.         └── java

这是项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" 
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
  5.         http://maven.apache.org/xsd/maven-4.0.0.xsd">
  7.     <modelVersion>4.0.0</modelVersion>
  8.     <groupId>com.zetcode</groupId>
  9.     <artifactId>SparkFreeMarker</artifactId>
  10.     <version>1.0-SNAPSHOT</version>
  11.     <packaging>jar</packaging>
  12.     <properties>
  13.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  14.         <maven.compiler.source>1.8</maven.compiler.source>
  15.         <maven.compiler.target>1.8</maven.compiler.target>
  16.     </properties>
  18.     <dependencies>
  20.         <dependency>
  21.             <groupId>com.sparkjava</groupId>
  22.             <artifactId>spark-template-freemarker</artifactId>
  23.             <version>2.5.5</version>
  24.         </dependency>
  26.         <dependency>
  27.             <groupId>org.slf4j</groupId>
  28.             <artifactId>slf4j-simple</artifactId>
  29.             <version>1.7.24</version>
  30.         </dependency>
  32.         <dependency>
  33.             <groupId>com.sparkjava</groupId>
  34.             <artifactId>spark-core</artifactId>
  35.             <version>2.5.5</version>
  36.         </dependency>
  38.     </dependencies>
  40.     <build>
  41.         <finalName>SparkFreeMarker</finalName>
  43.         <plugins>
  44.             <plugin>
  45.                 <artifactId>maven-assembly-plugin</artifactId>
  46.                 <executions>
  47.                     <execution>
  48.                         <phase>package</phase>
  49.                         <goals>
  50.                             <goal>single</goal>
  51.                         </goals>
  52.                     </execution>
  53.                 </executions>
  54.                 <configuration>
  55.                     <archive>
  56.                         <manifest>
  57.                             <addClasspath>true</addClasspath>
  58.                             <mainClass>com.zetcode.SparkFreeMarker</mainClass>
  59.                         </manifest>
  60.                     </archive>
  61.                     <descriptorRefs>
  62.                         <descriptorRef>jar-with-dependencies</descriptorRef>
  63.                     </descriptorRefs>
  64.                 </configuration>
  65.             </plugin>
  66.         </plugins> 
  68.     </build>
  70. </project>

pom.xml文件包含 Spark 模块和 FreeMarker 的依赖项。

SparkFreeMarker.java

  1. package com.zetcode;
  3. import freemarker.template.Configuration;
  4. import freemarker.template.Version;
  5. import java.io.IOException;
  6. import java.util.HashMap;
  7. import java.util.Map;
  8. import spark.ModelAndView;
  9. import spark.Request;
  10. import spark.Response;
  11. import static spark.Spark.get;
  12. import spark.template.freemarker.FreeMarkerEngine;
  14. public class SparkFreeMarker {
  16.     public static void main(String[] args) throws IOException {
  18.         Configuration conf = new Configuration(new Version(2, 3, 23));
  19.         conf.setClassForTemplateLoading(SparkFreeMarker.class, "/views");
  21.         get("/hello/:name", SparkFreeMarker::message, new FreeMarkerEngine(conf));
  22.     }
  24.     public static ModelAndView message(Request req, Response res) {
  26.         Map<String, Object> params = new HashMap<>();
  27.         params.put("name", req.params(":name"));
  28.         return new ModelAndView(params, "hello.ftl");
  29.     }
  30. }

我们为 FreeMarker 设置了相同的应用。

  1. Configuration conf = new Configuration(new Version(2, 3, 23));
  2. conf.setClassForTemplateLoading(SparkFreeMarker.class, "/views");

我们用Configuration类配置 FreeMarker。 模板文件将放置在views目录中，该目录必须位于类路径上。

  1. get("/hello/:name", SparkFreeMarker::message, new FreeMarkerEngine(conf));

FreeMarkerEngine传递给get()方法。

  1. public static ModelAndView message(Request req, Response res) {
  3.     Map<String, Object> params = new HashMap<>();
  4.     params.put("name", req.params(":name"));
  5.     return new ModelAndView(params, "hello.ftl");
  6. }

ModelAndView用于设置视图名称和要渲染的模型对象。

hello.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>Home page</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <p>Hello ${name}</p>
  10.     </body>
  11. </html>

这是hello.ftl模板文件； 它引用随ModelAndView对象传递的名称变量。

  1. $ mvn package

我们使用mvn package命令构建项目。

  1. $ java -jar target/SparkFreeMarkejar-with-dependencies.jar

我们运行程序。 maven-assembly-plugin允许创建具有所有依赖项的可执行 JAR。

  1. $ curl localhost:4567/hello/Thomas
  2. <!DOCTYPE html>
  3. <html>
  4.     <head>
  5.         <title>Home page</title>
  6.         <meta charset="UTF-8">
  7.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8.     </head>
  9.     <body>
  10.         <p>Hello Thomas</p>
  11.     </body>
  12. </html>

这是输出。

FreeMarker 与 Spring

Spring 是流行的 Java 应用框架。 Spring Boot 是通过最小的努力来创建独立的，生产级的基于 Spring 的应用的产物。

经典 Spring 应用

在以下示例中，我们将 FreeMarker 集成到经典的 Spring 应用中。

  1. ├── pom.xml
  2. └── src
  3.     ├── main
  4.     │   ├── java
  5.     │   │   └── com
  6.     │   │       └── zetcode
  7.     │   │           ├── service
  8.     │   │           │   ├── IVersionService.java
  9.     │   │           │   └── VersionService.java
  10.     │   │           └── web
  11.     │   │               └── MyController.java
  12.     │   ├── resources
  13.     │   │   └── my.properties
  14.     │   └── webapp
  15.     │       ├── META-INF
  16.     │       │   └── context.xml
  17.     │       └── WEB-INF
  18.     │           ├── spring-servlet.xml
  19.     │           ├── views
  20.     │           │   ├── index.ftl
  21.     │           │   └── version.ftl
  22.     │           └── web.xml
  23.     └── test
  24.         └── java

这是我们经典的 Spring 应用的项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" 
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
  5.                              http://maven.apache.org/xsd/maven-4.0.0.xsd">
  7.     <modelVersion>4.0.0</modelVersion>
  9.     <groupId>com.zetcode</groupId>
  10.     <artifactId>ClassicSpringFreeMarker</artifactId>
  11.     <version>1.0-SNAPSHOT</version>
  12.     <packaging>war</packaging>
  14.     <name>ClassicSpringFreeMarker</name>
  16.     <properties>
  17.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  18.         <maven.compiler.source>1.8</maven.compiler.source>
  19.         <maven.compiler.target>1.8</maven.compiler.target>    
  20.     </properties>
  22.     <dependencies>
  24.         <dependency>
  25.             <groupId>org.freemarker</groupId>
  26.             <artifactId>freemarker</artifactId>
  27.             <version>2.3.23</version>
  28.         </dependency>         
  30.         <dependency>
  31.             <groupId>org.springframework</groupId>
  32.             <artifactId>spring-context-support</artifactId>
  33.             <version>4.3.6.RELEASE</version>
  34.         </dependency>           
  36.         <dependency>
  37.             <groupId>org.springframework</groupId>
  38.             <artifactId>spring-webmvc</artifactId>
  39.             <version>4.3.6.RELEASE</version>
  40.         </dependency>
  42.         <dependency>
  43.             <groupId>org.springframework</groupId>
  44.             <artifactId>spring-web</artifactId>
  45.             <version>4.3.6.RELEASE</version>
  46.         </dependency>
  48.         <dependency>
  49.             <groupId>org.springframework</groupId>
  50.             <artifactId>spring-core</artifactId>
  51.             <version>4.3.6.RELEASE</version>
  52.         </dependency>  
  53.     </dependencies>
  55.     <build>
  56.         <plugins>
  58.             <plugin>
  59.                 <groupId>org.apache.maven.plugins</groupId>
  60.                 <artifactId>maven-war-plugin</artifactId>
  61.                 <version>2.3</version>
  62.                 <configuration>
  63.                     <failOnMissingWebXml>false</failOnMissingWebXml>
  64.                 </configuration>
  65.             </plugin>
  67.         </plugins>
  68.     </build>
  70. </project>

pom.xml文件包含 Spring 模块和 FreeMarker 的依赖项。

web.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  4.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5.          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
  6.                              http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  7.          version="3.1">
  9.     <servlet>
  10.         <servlet-name>spring</servlet-name>
  11.         <servlet-class>
  12.             org.springframework.web.servlet.DispatcherServlet
  13.         </servlet-class>
  14.         <load-on-startup>1</load-on-startup>
  15.     </servlet>
  17.     <servlet-mapping>
  18.         <servlet-name>spring</servlet-name>
  19.         <url-pattern>*.html</url-pattern>
  20.     </servlet-mapping>    
  22.     <session-config>
  23.         <session-timeout>
  24.             30
  25.         </session-timeout>
  26.     </session-config>
  27. </web-app>

在web.xml文件中，我们定义了 Spring DispatcherServlet，它是 HTTP 请求处理器的中央调度器。

spring-servlet.xml

  1. <beans xmlns="http://www.springframework.org/schema/beans"
  2.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.        xmlns:context="http://www.springframework.org/schema/context"
  4.        xmlns:mvc="http://www.springframework.org/schema/mvc"
  5.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  6.         http://www.springframework.org/schema/beans/spring-beans.xsd
  7.         http://www.springframework.org/schema/context
  8.         http://www.springframework.org/schema/context/spring-context.xsd
  9.         http://www.springframework.org/schema/mvc
  10.         http://www.springframework.org/schema/mvc/spring-mvc.xsd">
  12.     <context:component-scan base-package="com.zetcode"/>
  13.     <context:property-placeholder location="classpath*:my.properties"/>
  15.     <!--freemarker config--> 
  16.     <bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
  17.         <property name="templateLoaderPath" value="/WEB-INF/views/"/>
  18.     </bean>
  20.     <bean id="viewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
  21.         <property name="cache" value="true"/>
  22.         <property name="prefix" value=""/>
  23.         <property name="suffix" value=".ftl"/>
  24.     </bean>  
  26. </beans>

在 spring servlet 上下文 XML 文件中，我们定义了两个 bean：freemarkerConfig和viewResolver。 这些是 FreeMarker 的配置 bean。 spring-servlet.xml位于WEB-INF中。

  1. <context:component-scan base-package="com.zetcode" />

Spring 将扫描com.zetcode包中的组件。

  1. <context:property-placeholder location="classpath*:my.properties"/>

<context:property-placeholder>元素注册一个PropertySourcesPlaceholderConfigurer，该元素允许使用@Value注解设置属性。 location属性指示在哪里查找属性。

my.properties

  1. app.version: "1.0"

在my.properties文件中，我们有一个键/值对。 该值是应用的版本。 该文件位于usr/main/resources目录中。

IVersionService.java

  1. package com.zetcode.service;
  3. public interface IVersionService {
  5.     public String getVersion();
  6. }

IVersionService接口包含一个方法协定：getVersion()。

VersionService.java

  1. package com.zetcode.service;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.stereotype.Service;
  6. @Service
  7. public class VersionService implements IVersionService {
  9.     @Value("${app.version}")
  10.     private String appVersion;
  12.     @Override
  13.     public String getVersion() {
  15.         return appVersion;
  16.     }
  17. }

VersionService返回应用的版本。

  1. @Value("${app.version}")
  2. private String appVersion;

位于my.properties文件中的app.version键的值被注入到appVersion属性中。

MyController.java

  1. package com.zetcode.web;
  3. import com.zetcode.service.VersionService;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.stereotype.Controller;
  6. import org.springframework.ui.Model;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RequestMethod;
  9. import org.springframework.web.servlet.ModelAndView;
  11. @Controller
  12. public class MyController {
  14.     @Autowired
  15.     private VersionService versionService;
  17.     @RequestMapping("/index")
  18.     public String index(Model model) {
  20.         return "index";
  21.     }
  23.     @RequestMapping(value = "/version", method = RequestMethod.GET)
  24.     public ModelAndView version() {
  26.         String version = versionService.getVersion();
  28.         ModelAndView model = new ModelAndView("version");
  29.         model.addObject("version", version);
  31.         return model;
  32.     }
  33. }

这是控制器类。

  1. @RequestMapping(value = "/version", method = RequestMethod.GET)
  2. public ModelAndView version() {
  4.     String version = versionService.getVersion();
  6.     ModelAndView model = new ModelAndView("version");
  7.     model.addObject("version", version);
  9.     return model;
  10. }

在version方法（当带有/version URL 的请求到达时被调用）中，我们调用VersionService的getVersion()方法并将该值传递到ModelAndView中。 处理将分派到version.ftl模板文件，在该文件中插入版本值。

index.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>Home page</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <p>Show application version <a href="version.html">version</a></p>
  10.     </body>
  11. </html>

这是index.ftl文件。 它具有一个链接，该链接向服务器发送请求以获取应用的版本。

version.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>Home page</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <p>Application version: ${version}</p>
  10.     </body>
  11. </html>

version.ftl模板文件用于建立服务器对客户端的响应。

使用 FreeMarker 的 Spring Boot Web 应用

在下一个应用中，我们将 FreeMarker 集成到 Spring Boot Web 应用中。

FreeMarker 教程 - 图4

图：NetBeans 中的 Spring Boot Web 项目结构

这是在 NetBeans 中使用 FreeMarker 的 Spring Boot Web 应用的项目结构。 请注意，我们正在 NetBeans 中创建 Java SE Maven 应用，而不是 Java Web Maven 应用。 这是因为我们已将 Tomcat 嵌入到我们的 JAR 文件中。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" 
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  6.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>com.zetcode</groupId>
  8.     <artifactId>SpringBootFreemarkerEx</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.     <packaging>jar</packaging>
  11.     <properties>
  12.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  13.         <maven.compiler.source>1.8</maven.compiler.source>
  14.         <maven.compiler.target>1.8</maven.compiler.target>
  15.     </properties>
  17.     <parent>
  18.         <groupId>org.springframework.boot</groupId>
  19.         <artifactId>spring-boot-starter-parent</artifactId>
  20.         <version>1.4.2.RELEASE</version>
  21.     </parent>
  23.     <dependencies>
  25.         <dependency>
  26.             <groupId>org.springframework.boot</groupId>
  27.             <artifactId>spring-boot-starter-freemarker</artifactId>
  28.         </dependency>        
  30.     </dependencies>
  32.     <build>
  33.         <plugins>
  34.             <plugin>
  35.                 <groupId>org.springframework.boot</groupId>
  36.                 <artifactId>spring-boot-maven-plugin</artifactId>
  37.             </plugin>
  38.         </plugins>
  39.     </build>       
  40. </project>

这是 Maven 构建文件。 它包括 Spring Boot 和 FreeMarker 的依赖项。 无需在 Spring Boot 中配置 FreeMarker。 在 POM 文件中找到 FreeMarker 依赖关系后，Spring Boot 会自动进行配置。 spring-boot-maven-plugin创建带有嵌入式容器（默认为 Tomcat）的可执行 JAR。

SpringBootClient.java

  1. package com.zetcode.web;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class Application  {
  9.     public static void main(String[] args) {
  10.         SpringApplication.run(Application.class, args);
  11.     }
  12. }

Application设置 Spring Boot 应用。 @SpringBootApplication注解执行三件事：1）将类定义为配置类，2）启用自动配置，3）启用组件扫描。

MyController.java

  1. package com.zetcode.web;
  3. import org.springframework.stereotype.Controller;
  4. import org.springframework.ui.Model;
  5. import org.springframework.web.bind.annotation.GetMapping;
  6. import org.springframework.web.bind.annotation.RequestParam;
  8. @Controller
  9. public class MyController {
  11.     @GetMapping("/")
  12.     public String index(Model model) {
  13.         return "index";
  14.     }    
  16.     @GetMapping("/hello")
  17.     public String hello(Model model, @RequestParam(value="msg", required=false, 
  18.             defaultValue="Freemarker") String msg) {
  20.         model.addAttribute("message", msg);
  21.         return "hello";
  22.     }    
  23. }

这是 Spring Boot Web 应用的控制器类。 控制器具有两个映射。 第一个映射解析为index.ftl文件，第二个映射解析为hello.ftl文件。

index.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>Spring Boot Form</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <form action="/hello" method="get">
  10.             <p>Message: <input type="text" name="msg"></p>
  11.             <p>
  12.                 <input type="submit" value="Submit"> 
  13.                 <input type="reset" value="Reset">
  14.             </p>
  15.         </form>
  16.     </body>
  17. </html>

这是index.ftl文件。 它具有 HTML 表单，可将消息发送到服务器。

hello.ftl

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Freemarker example</title>
  6. </head>
  7. <body>
  8.     <p>${message}<p>
  9. </body>
  10. </html>

服务器以一条消息回应给客户端。 响应是从hello.ftl模板文件创建的。

FreeMarker 教程 - 图5

图：Spring Boot Web 示例

Spring Boot 启动一个嵌入式 Tomcat 服务器，监听端口 8080。

本教程专门针对 FreeMarker 模板引擎。 您可能也对相关教程感兴趣： Servlet FreeMarker JDBCTemplate教程， Spring Boot Groovy CLI 教程， Jtwig 教程， Java 教程 ，游戏简介， Spark 简介或 Stripes 简介。