# FreeMarker 教程 原文：http://zetcode.com/java/freemarker/ 這是 FreeMarker Java 模板引擎的入門教程。 我們介紹了 FreeMarker 模板引擎，并創建了幾個控制臺和 Web 應用。 Maven 用于構建我們的示例。 NetBeans 用于管理應用。 ## 目錄 1. [FreeMarker 模板引擎](#free) 2. [控制臺應用](#cons) 3. [FreeMarker 指令](#dire) 4. [Servlet 和 FreeMarker](#serv) 5. [Spark 和 FreeMarker](#spark) 6. [Spring 和 FreeMarker](#spring) FreeMarker 是 Java 編程語言的模板引擎。 模板以 FreeMarker 模板語言（FTL）編寫。 FreeMarker 的主頁是 [freemarker.org](http://freemarker.org) 。 ## FreeMarker 模板引擎 模板引擎將靜態數據與動態數據結合起來以產生內容。 模板是內容的中間表示。 它指定如何生成輸出。 模板引擎的優點是： * 關注點分離， * 避免重復代碼， * 更容易在視圖之間切換， * 可重用性。 按照慣例，FreeMarker 模板文件的擴展名為`.ftl`。 FreeMarker 不僅限于 HTML 頁面的模板； 它可以用于生成電子郵件，配置文件，源代碼等。 ## FreeMarker 控制臺應用 前兩個應用是控制臺應用。 我們在 NetBeans 中創建新的 Maven Java 應用。 他們使用以下 Maven 構建文件： ```java <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</version> </dependency> ``` 在 Maven `pom.xml`文件中，我們指定 FreeMarker 依賴項。 ### FreeMarker 插值 插值是放在`${ }`字符之間的表達式。 FreeMarker 會將輸出中的插值替換為大括號內表達式的實際值。 在下面的示例中，我們使用 FreeMarker 模板文件來生成簡單的文本輸出。  圖：NetBeans 中的 Java 控制臺項目結構 這是 NetBeans 中的項目結構。 `FreeMarkerConsoleEx.java` ```java package com.zetcode; import freemarker.template.Configuration; import freemarker.template.Template; import freemarker.template.TemplateException; import freemarker.template.Version; import java.io.IOException; import java.io.StringWriter; import java.util.HashMap; import java.util.Map; public class FreeMarkerConsoleEx { public static void main(String[] args) throws IOException, TemplateException { Configuration cfg = new Configuration(new Version("2.3.23")); cfg.setClassForTemplateLoading(FreeMarkerConsoleEx.class, "/"); cfg.setDefaultEncoding("UTF-8"); Template template = cfg.getTemplate("test.ftl"); Map<String, Object> templateData = new HashMap<>(); templateData.put("msg", "Today is a beautiful day"); try (StringWriter out = new StringWriter()) { template.process(templateData, out); System.out.println(out.getBuffer().toString()); out.flush(); } } } ``` 該示例將簡單文本打印到控制臺。 最終文本由模板引擎處理。 ```java Configuration cfg = new Configuration(new Version("2.3.23")); ``` `Configuration`用于設置 FreeMarker 設置； 它以 FreeMarker 庫的版本為參數。 ```java cfg.setClassForTemplateLoading(FreeMarkerConsoleEx.class, "/"); ``` `setClassForTemplateLoading()`設置將使用其方法來加載模板的類。 ```java Template template = cfg.getTemplate("test.ftl"); ``` 使用`getTemplate()`方法，我們檢索`test.ftl`模板文件。 ```java Map<String, Object> templateData = new HashMap<>(); templateData.put("msg", "Today is a beautiful day"); ``` 數據模型已創建。 來自模型的數據將被動態放置到 FreeMarker 模板文件中。 ```java try (StringWriter out = new StringWriter()) { template.process(templateData, out); System.out.println(out.getBuffer().toString()); out.flush(); } ``` `process()`方法使用提供的數據模型執行模板，并將生成的輸出寫入提供的寫入器。 `test.ftl` ```java The message is: ${msg} ``` `test.ftl`模板文件包含一個插值； 它將替換為生成的字符串。 ```java The message is: Today is a beautiful day ``` 這是應用的輸出。 ### 用 FreeMarker 列出一個集合 `#list`指令列出了數據集合。 下一個示例生成汽車列表。 `Car.java` ```java package com.zetcode.bean; public class Car { private String name; private int price; public Car() { } public Car(String name, int price) { this.name = name; this.price = price; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getPrice() { return price; } public void setPrice(int price) { this.price = price; } } ``` 我們有一個`Car` bean。 它具有兩個屬性：名稱和價格。 `FreeMarkerConsoleEx2.java` ```java package com.zetcode; import com.zetcode.bean.Car; import freemarker.template.Configuration; import freemarker.template.Template; import freemarker.template.TemplateException; import freemarker.template.Version; import java.io.IOException; import java.io.StringWriter; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; public class FreeMarkerConsoleEx2 { public static void main(String[] args) throws IOException, TemplateException { Configuration cfg = new Configuration(new Version("2.3.23")); cfg.setClassForTemplateLoading(FreeMarkerConsoleEx2.class, "/"); cfg.setDefaultEncoding("UTF-8"); Template template = cfg.getTemplate("test.ftl"); Map<String, Object> templateData = new HashMap<>(); Car c1 = new Car("Audi", 52642); Car c2 = new Car("Volvo", 29000); Car c3 = new Car("Skoda", 9000); List<Car> cars = new ArrayList<>(); cars.add(c1); cars.add(c2); cars.add(c3); templateData.put("cars", cars); try (StringWriter out = new StringWriter()) { template.process(templateData, out); System.out.println(out.getBuffer().toString()); out.flush(); } } } ``` 此示例是一個 Java 控制臺程序，該程序使用 FreeMarker 動態創建包含汽車列表的文本輸出。 ```java Map<String, Object> templateData = new HashMap<>(); Car c1 = new Car("Audi", 52642); Car c2 = new Car("Volvo", 29000); Car c3 = new Car("Skoda", 9000); List<Car> cars = new ArrayList<>(); cars.add(c1); cars.add(c2); cars.add(c3); templateData.put("cars", cars); ``` 在這里，我們創建`Car`對象的`ArrayList`并將其放入數據模型。 `test.ftl` ```java <#list cars as car> ${car.name}: ${car.price} </#list> ``` 模板文件包含一個`#list`指令，該指令打印汽車對象的屬性。 使用點字符訪問屬性。 ```java Audi: 52,642 Volvo: 29,000 Skoda: 9,000 ``` 這是示例的輸出。 ## FreeMarker 指令 FreeMarker 指令是執行動作的特殊標記。 指令有兩種：內置指令和自定義指令。 `<#assign>`標簽創建一個新的普通變量。 可以使用`${}`構造對其進行訪問。 變量在模板中創建。 如果數據模型中有一個同名變量，則模板變量會將其隱藏。 `assignment.ftl` ```java <#assign name = "Robert"> His name is ${name}. ``` `<#assign>`指令創建一個新的`name`變量。 變量的值使用`${name}`語法打印。 ```java His name is Robert. ``` 該示例打印此行。 可以使用`<#if>`，`<#elseif>`和`<#else>`偽指令完成模板節的條件處理。 `conditions.ftl` ```java <#assign value = 4> <#if value < 0> The number is negative <#elseif value == 0> The number is zero <#else> The number is positive </#if> ``` 該示例創建一個新的`value`變量，并使用條件指令來測試該值。 ```java The number is positive ``` 這是輸出。 `<#list>`指令用于遍歷序列。 `listing.ftl` ```java <#assign colours = ["red", "green", "blue", "yellow"]> <#list colours as col> ${col} </#list> ``` 在示例中，我們將新的顏色名稱序列分配給`colours`變量。 `<#list>`指令遍歷集合并打印每個項目。 ```java red green blue yellow ``` 該示例給出了此輸出。 `listing2.ftl` ```java <#assign items = {"pens": 3, "cups": 2, "tables": 1}> <#list items?values as v> ${v} </#list> <#list items?keys as k> ${k} </#list> ``` 在此示例中，我們創建一個哈希變量，并使用`<#list>`輸出哈希的值和鍵。 ```java 3 2 1 pens cups tables ``` The example gives this output. 當我們使用對空格不敏感的格式（例如 HTML 或 XML）時，`<#compress>`指令會刪除多余的空格 `compressing.ftl` ```java <#assign value="\t\tweather\n\n"> <#compress> ${value} Today is a wonderful day. 1 2 3 4 5 </#compress> ``` 我們的文本帶有空格，制表符和換行符。 ```java weather Today is a wonderful day. 1 2 3 4 5 ``` 該程序刪除了所有多余的空白。 ## FreeMarker Servlet 示例 在下面的示例中，我們在標準 Java Web 應用中使用 FreeMarker。 該應用打包到`war`文件中，并部署在 NetBeans 的內置 Tomcat 服務器上。 在 NetBeans 中，我們創建一個新的 Maven Web 應用。  圖：NetBeans 中的 FreeMarker servlet 項目結構 這是 NetBeans 中 FreeMarker servlet 示例的項目結構。 ```java <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</version> </dependency> <dependency> <groupId>javax</groupId> <artifactId>javaee-web-api</artifactId> <version>7.0</version> <scope>provided</scope> </dependency> ``` 在`pom.xml`文件中，我們具有這兩個依賴關系。 `context.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <Context path="/FreemarkerServletEx"/> ``` 這是`context.xml`文件。 `web.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <web-app version="3.1" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"> <servlet> <servlet-name>freemarker</servlet-name> <servlet-class>freemarker.ext.servlet.FreemarkerServlet</servlet-class> <init-param> <param-name>TemplatePath</param-name> <param-value>/</param-value> </init-param> <init-param> <param-name>NoCache</param-name> <param-value>true</param-value> </init-param> <init-param> <param-name>ResponseCharacterEncoding</param-name> <param-value>fromTemplate</param-value> </init-param> <init-param> <param-name>ExceptionOnMissingTemplate</param-name> <param-value>true</param-value> </init-param> <init-param> <param-name>incompatible_improvements</param-name> <param-value>2.3.23</param-value> </init-param> <init-param> <param-name>template_exception_handler</param-name> <param-value>html_debug</param-value> </init-param> <init-param> <param-name>template_update_delay</param-name> <param-value>0 s</param-value> </init-param> <init-param> <param-name>default_encoding</param-name> <param-value>UTF-8</param-value> </init-param> <init-param> <param-name>output_encoding</param-name> <param-value>UTF-8</param-value> </init-param> <init-param> <param-name>locale</param-name> <param-value>en_US</param-value> </init-param> <init-param> <param-name>number_format</param-name> <param-value>0.##########</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>freemarker</servlet-name> <url-pattern>*.ftl</url-pattern> </servlet-mapping> <security-constraint> <web-resource-collection> <web-resource-name>FreeMarker MVC Views</web-resource-name> <url-pattern>*.ftl</url-pattern> </web-resource-collection> <auth-constraint> </auth-constraint> </security-constraint> <session-config> <session-timeout> 30 </session-timeout> </session-config> </web-app> ``` 在`web.xml`文件中，我們設置并配置了 FreeMarker servlet。 有關每個選項的說明，請參考 FreeMarker 文檔。 `Car.java` ```java package com.zetcode.bean; public class Car { private String name; private int price; public Car() { } public Car(String name, int price) { this.name = name; this.price = price; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getPrice() { return price; } public void setPrice(int price) { this.price = price; } } ``` 這是`Car` bean，具有有關汽車對象的基本數據。 `MyServlet.java` ```java package com.zetcode.web; import com.zetcode.bean.Car; import java.io.IOException; import java.util.ArrayList; import java.util.List; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @WebServlet(name = "MyServlet", urlPatterns = {"/"}) public class MyServlet extends HttpServlet { @Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { response.setContentType("text/html;charset=UTF-8"); Car c1 = new Car("Audi", 52642); Car c2 = new Car("Volvo", 29000); Car c3 = new Car("Skoda", 9000); List<Car> cars = new ArrayList<>(); cars.add(c1); cars.add(c2); cars.add(c3); request.setAttribute("cars", cars); request.getRequestDispatcher("/index.ftl").forward(request, response); } } ``` 我們設置 servlet 并將其分發到模板文件。 我們創建了一個`ArrayList`汽車并將其設置為請求。 `index.ftl` ```java <!DOCTYPE html> <html> <head> <title>FreeMarker test</title> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <table> <tr> <th>Name</th> <th>Price</th> </tr> <#list cars as car> <tr> <td>${car.name}</td> <td>${car.price}</td> </tr> </#list> </table> </body> </html> ``` `index.ftl`文件位于`src/main/webapp`目錄中。 使用`#list`指令，我們顯示了`cars`系列的所有元素。  圖：FreeMarker servlet 示例 我們在 Opera 網絡瀏覽器中顯示應用輸出。 NetBeans 中的內置 Tomcat 在 8084 端口上運行。 ## FreeMarker 與 Spark Spark 是為快速開發而構建的簡單輕便的 Java Web 框架。 默認情況下，Spark 在嵌入式 Jetty Web 服務器上運行，但可以配置為在其他 Web 服務器上運行。 為了將 FreeMarker 與 Spark 集成，我們使用`spark-template-freemarker`，這是 Spark 的 Freemarker 模板引擎實現。 ```java $ tree . ├── pom.xml └── src ├── main │ ├── java │ │ └── com │ │ └── zetcode │ │ └── SparkFreeMarker.java │ └── resources │ └── views │ └── hello.ftl └── test └── java ``` 這是項目結構。 `pom.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>SparkFreeMarker</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>com.sparkjava</groupId> <artifactId>spark-template-freemarker</artifactId> <version>2.5.5</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.7.24</version> </dependency> <dependency> <groupId>com.sparkjava</groupId> <artifactId>spark-core</artifactId> <version>2.5.5</version> </dependency> </dependencies> <build> <finalName>SparkFreeMarker</finalName> <plugins> <plugin> <artifactId>maven-assembly-plugin</artifactId> <executions> <execution> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> <configuration> <archive> <manifest> <addClasspath>true</addClasspath> <mainClass>com.zetcode.SparkFreeMarker</mainClass> </manifest> </archive> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> </configuration> </plugin> </plugins> </build> </project> ``` `pom.xml`文件包含 Spark 模塊和 FreeMarker 的依賴項。 `SparkFreeMarker.java` ```java package com.zetcode; import freemarker.template.Configuration; import freemarker.template.Version; import java.io.IOException; import java.util.HashMap; import java.util.Map; import spark.ModelAndView; import spark.Request; import spark.Response; import static spark.Spark.get; import spark.template.freemarker.FreeMarkerEngine; public class SparkFreeMarker { public static void main(String[] args) throws IOException { Configuration conf = new Configuration(new Version(2, 3, 23)); conf.setClassForTemplateLoading(SparkFreeMarker.class, "/views"); get("/hello/:name", SparkFreeMarker::message, new FreeMarkerEngine(conf)); } public static ModelAndView message(Request req, Response res) { Map<String, Object> params = new HashMap<>(); params.put("name", req.params(":name")); return new ModelAndView(params, "hello.ftl"); } } ``` 我們為 FreeMarker 設置了相同的應用。 ```java Configuration conf = new Configuration(new Version(2, 3, 23)); conf.setClassForTemplateLoading(SparkFreeMarker.class, "/views"); ``` 我們用`Configuration`類配置 FreeMarker。 模板文件將放置在`views`目錄中，該目錄必須位于類路徑上。 ```java get("/hello/:name", SparkFreeMarker::message, new FreeMarkerEngine(conf)); ``` `FreeMarkerEngine`傳遞給`get()`方法。 ```java public static ModelAndView message(Request req, Response res) { Map<String, Object> params = new HashMap<>(); params.put("name", req.params(":name")); return new ModelAndView(params, "hello.ftl"); } ``` `ModelAndView`用于設置視圖名稱和要渲染的模型對象。 `hello.ftl` ```java <!DOCTYPE html> <html> <head> <title>Home page</title> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <p>Hello ${name}</p> </body> </html> ``` 這是`hello.ftl`模板文件； 它引用隨`ModelAndView`對象傳遞的名稱變量。 ```java $ mvn package ``` 我們使用`mvn package`命令構建項目。 ```java $ java -jar target/SparkFreeMarkejar-with-dependencies.jar ``` 我們運行程序。 `maven-assembly-plugin`允許創建具有所有依賴項的可執行 JAR。 ```java $ curl localhost:4567/hello/Thomas <!DOCTYPE html> <html> <head> <title>Home page</title> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <p>Hello Thomas</p> </body> </html> ``` 這是輸出。 ## FreeMarker 與 Spring Spring 是流行的 Java 應用框架。 Spring Boot 是通過最小的努力來創建獨立的，生產級的基于 Spring 的應用的產物。 ### 經典 Spring 應用 在以下示例中，我們將 FreeMarker 集成到經典的 Spring 應用中。 ```java ├── pom.xml └── src ├── main │ ├── java │ │ └── com │ │ └── zetcode │ │ ├── service │ │ │ ├── IVersionService.java │ │ │ └── VersionService.java │ │ └── web │ │ └── MyController.java │ ├── resources │ │ └── my.properties │ └── webapp │ ├── META-INF │ │ └── context.xml │ └── WEB-INF │ ├── spring-servlet.xml │ ├── views │ │ ├── index.ftl │ │ └── version.ftl │ └── web.xml └── test └── java ``` 這是我們經典的 Spring 應用的項目結構。 `pom.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>ClassicSpringFreeMarker</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <name>ClassicSpringFreeMarker</name> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>4.3.6.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>4.3.6.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>4.3.6.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>4.3.6.RELEASE</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>2.3</version> <configuration> <failOnMissingWebXml>false</failOnMissingWebXml> </configuration> </plugin> </plugins> </build> </project> ``` `pom.xml`文件包含 Spring 模塊和 FreeMarker 的依賴項。 `web.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1"> <servlet> <servlet-name>spring</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet </servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>spring</servlet-name> <url-pattern>*.html</url-pattern> </servlet-mapping> <session-config> <session-timeout> 30 </session-timeout> </session-config> </web-app> ``` 在`web.xml`文件中，我們定義了 Spring `DispatcherServlet`，它是 HTTP 請求處理器的中央調度器。 `spring-servlet.xml` ```java <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd"> <context:component-scan base-package="com.zetcode"/> <context:property-placeholder location="classpath*:my.properties"/> <!--freemarker config--> <bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer"> <property name="templateLoaderPath" value="/WEB-INF/views/"/> </bean> <bean id="viewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver"> <property name="cache" value="true"/> <property name="prefix" value=""/> <property name="suffix" value=".ftl"/> </bean> </beans> ``` 在 spring servlet 上下文 XML 文件中，我們定義了兩個 bean：`freemarkerConfig`和`viewResolver`。 這些是 FreeMarker 的配置 bean。 `spring-servlet.xml`位于`WEB-INF`中。 ```java <context:component-scan base-package="com.zetcode" /> ``` Spring 將掃描`com.zetcode`包中的組件。 ```java <context:property-placeholder location="classpath*:my.properties"/> ``` `<context:property-placeholder>`元素注冊一個`PropertySourcesPlaceholderConfigurer`，該元素允許使用`@Value`注解設置屬性。 `location`屬性指示在哪里查找屬性。 `my.properties` ```java app.version: "1.0" ``` 在`my.properties`文件中，我們有一個鍵/值對。 該值是應用的版本。 該文件位于`usr/main/resources`目錄中。 `IVersionService.java` ```java package com.zetcode.service; public interface IVersionService { public String getVersion(); } ``` `IVersionService`接口包含一個方法協定：`getVersion()`。 `VersionService.java` ```java package com.zetcode.service; import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Service; @Service public class VersionService implements IVersionService { @Value("${app.version}") private String appVersion; @Override public String getVersion() { return appVersion; } } ``` `VersionService`返回應用的版本。 ```java @Value("${app.version}") private String appVersion; ``` 位于`my.properties`文件中的`app.version`鍵的值被注入到`appVersion`屬性中。 `MyController.java` ```java package com.zetcode.web; import com.zetcode.service.VersionService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.servlet.ModelAndView; @Controller public class MyController { @Autowired private VersionService versionService; @RequestMapping("/index") public String index(Model model) { return "index"; } @RequestMapping(value = "/version", method = RequestMethod.GET) public ModelAndView version() { String version = versionService.getVersion(); ModelAndView model = new ModelAndView("version"); model.addObject("version", version); return model; } } ``` 這是控制器類。 ```java @RequestMapping(value = "/version", method = RequestMethod.GET) public ModelAndView version() { String version = versionService.getVersion(); ModelAndView model = new ModelAndView("version"); model.addObject("version", version); return model; } ``` 在`version`方法（當帶有`/version` URL 的請求到達時被調用）中，我們調用`VersionService`的`getVersion()`方法并將該值傳遞到`ModelAndView`中。 處理將分派到`version.ftl`模板文件，在該文件中插入版本值。 `index.ftl` ```java <!DOCTYPE html> <html> <head> <title>Home page</title> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <p>Show application version <a href="version.html">version</a></p> </body> </html> ``` 這是`index.ftl`文件。 它具有一個鏈接，該鏈接向服務器發送請求以獲取應用的版本。 `version.ftl` ```java <!DOCTYPE html> <html> <head> <title>Home page</title> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <p>Application version: ${version}</p> </body> </html> ``` `version.ftl`模板文件用于建立服務器對客戶端的響應。 ### 使用 FreeMarker 的 Spring Boot Web 應用 在下一個應用中，我們將 FreeMarker 集成到 Spring Boot Web 應用中。  圖：NetBeans 中的 Spring Boot Web 項目結構 這是在 NetBeans 中使用 FreeMarker 的 Spring Boot Web 應用的項目結構。 請注意，我們正在 NetBeans 中創建 Java SE Maven 應用，而不是 Java Web Maven 應用。 這是因為我們已將 Tomcat 嵌入到我們的 JAR 文件中。 `pom.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>SpringBootFreemarkerEx</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.4.2.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ``` 這是 Maven 構建文件。 它包括 Spring Boot 和 FreeMarker 的依賴項。 無需在 Spring Boot 中配置 FreeMarker。 在 POM 文件中找到 FreeMarker 依賴關系后，Spring Boot 會自動進行配置。 `spring-boot-maven-plugin`創建帶有嵌入式容器（默認為 Tomcat）的可執行 JAR。 `SpringBootClient.java` ```java package com.zetcode.web; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` `Application`設置 Spring Boot 應用。 `@SpringBootApplication`注解執行三件事：1）將類定義為配置類，2）啟用自動配置，3）啟用組件掃描。 `MyController.java` ```java package com.zetcode.web; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestParam; @Controller public class MyController { @GetMapping("/") public String index(Model model) { return "index"; } @GetMapping("/hello") public String hello(Model model, @RequestParam(value="msg", required=false, defaultValue="Freemarker") String msg) { model.addAttribute("message", msg); return "hello"; } } ``` 這是 Spring Boot Web 應用的控制器類。 控制器具有兩個映射。 第一個映射解析為`index.ftl`文件，第二個映射解析為`hello.ftl`文件。 `index.ftl` ```java <!DOCTYPE html> <html> <head> <title>Spring Boot Form</title> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <form action="/hello" method="get"> <p>Message: <input type="text" name="msg"></p> <p> <input type="submit" value="Submit"> <input type="reset" value="Reset"> </p> </form> </body> </html> ``` 這是`index.ftl`文件。 它具有 HTML 表單，可將??消息發送到服務器。 `hello.ftl` ```java <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Freemarker example</title> </head> <body> <p>${message}<p> </body> </html> ``` 服務器以一條消息回應給客戶端。 響應是從`hello.ftl`模板文件創建的。  圖：Spring Boot Web 示例 Spring Boot 啟動一個嵌入式 Tomcat 服務器，監聽端口 8080。 本教程專門針對 FreeMarker 模板引擎。 您可能也對相關教程感興趣： [Servlet FreeMarker `JDBCTemplate`教程](/articles/servletfreemarker/)， [Spring Boot Groovy CLI 教程](/springboot/groovycli/)， [Jtwig 教程](/java/jtwig/)， [Java 教程](/lang/java/) ，[游戲簡介](/java/play/)， [Spark 簡介](/java/spark/)或 [Stripes 簡介](/java/stripes/)。