Spring FreeMarker 教程 · ZetCode 中文系列教程

# Spring FreeMarker 教程 > 原文： [http://zetcode.com/spring/freemarker/](http://zetcode.com/spring/freemarker/) Spring FreeMarker 教程展示了如何在 Spring 应用中使用 FreeMarker 模板引擎。 Spring 是用于创建企业应用的流行 Java 应用框架。 ## FreeMarker FreeMarker 是适用于 Web 和独立环境的服务器端 Java 模板引擎。模板使用 FreeMarker 模板语言（FTL）编写，这是一种简单的专用语言。 FreeMarker 的模板有`.ftl`扩展。 ## Spring FreeMarker 示例以下应用使用 FreeMarker 生成视图。 ```java pom.xml src ├───main │ ├───java │ │ └───com │ │ └───zetcode │ │ ├───config │ │ │ MyWebInitializer.java │ │ │ WebConfig.java │ │ ├───controller │ │ │ MyController.java │ │ └───service │ │ WordService.java │ └───resources │ │ logback.xml │ └───templates │ index.ftl │ showWords.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>springfreemarkerex</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>11</maven.compiler.source> <maven.compiler.target>11</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.3</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>5.1.3.RELEASE</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>4.0.1</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>5.1.3.RELEASE</version> </dependency> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.28</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>3.2.2</version> </plugin> <plugin> <groupId>org.eclipse.jetty</groupId> <artifactId>jetty-maven-plugin</artifactId> <version>9.4.14.v20181114</version> </plugin> </plugins> </build> </project> ``` 在`pom.xml`中，我们具有必要的依赖项。 `resources/logback.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <configuration> <logger name="org.springframework" level="ERROR"/> <logger name="com.zetcode" level="INFO"/> <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <Pattern>%d{HH:mm:ss.SSS} %blue(%-5level) %magenta(%logger{36}) - %msg %n </Pattern> </encoder> </appender> <root> <level value="INFO" /> <appender-ref ref="consoleAppender" /> </root> </configuration> ``` `logback.xml`是 Logback 日志库的配置文件。 `com/zetcode/config/MyWebInitializer.java` ```java package com.zetcode.config; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer; @Configuration public class MyWebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer { @Override protected Class<?>[] getRootConfigClasses() { return null; } @Override protected Class<?>[] getServletConfigClasses() { return new Class[]{WebConfig.class}; } @Override protected String[] getServletMappings() { return new String[]{"/"}; } } ``` `MyWebInitializer`注册 Spring `DispatcherServlet`，它是 Spring Web 应用的前端控制器。 ```java @Override protected Class<?>[] getServletConfigClasses() { return new Class[]{WebConfig.class}; } ``` `getServletConfigClasses()`返回 Web 配置类。 `com/zetcode/config/WebConfig.java` ```java package com.zetcode.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer; import org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver; @Configuration @EnableWebMvc @ComponentScan(basePackages = {"com.zetcode"}) public class WebConfig implements WebMvcConfigurer { @Bean public FreeMarkerViewResolver freemarkerViewResolver() { var resolver = new FreeMarkerViewResolver(); resolver.setCache(true); resolver.setSuffix(".ftl"); return resolver; } @Bean public FreeMarkerConfigurer freemarkerConfig() { var freeMarkerConfigurer = new FreeMarkerConfigurer(); freeMarkerConfigurer.setTemplateLoaderPath("classpath:/templates/"); return freeMarkerConfigurer; } } ``` `WebConfig`配置 FreeMarker 模板引擎。我们将模板文件的位置设置为`classpath`上的`templates`目录。（`resources`在类路径上。） `com/zetcode/service/WordService.java` ```java package com.zetcode.service; import org.springframework.stereotype.Service; import java.util.List; @Service public class WordService { private final List<String> words = List.of("pen", "sky", "rock", "forest", "falcon", "eagle"); public List<String> all() { return words; } } ``` `WordService`返回几个字。 `com/zetcode/controller/MyController.java` ```java package com.zetcode.controller; import com.zetcode.service.WordService; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.GetMapping; @Controller public class MyController { @GetMapping(value = "/") public String home() { return "index"; } @GetMapping(value = "/words") public String showWords(Model model, WordService wordService) { var words = wordService.all(); model.addAttribute("words", words); return "showWords"; } } ``` `MyController`提供请求路径和处理器方法之间的映射。我们有两个映射：`home`页面和`showWords`页面。 ```java var words = wordService.all(); model.addAttribute("words", words); ``` 我们使用`wordService`检索所有单词并将其放入模型中。该模型将传递到 FreeMarker，后者将处理模板中的数据。 `resources/templates/index.ftl` ```java <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Home page</title> </head> <body> <p> <a href="words">Show words</a> </p> </body> </html> ``` 主页包含显示所有单词的锚点。 `resources/templates/showWords.ftl` ```java <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Show words</title> </head> <body> <h2>List of words</h2> <ul> <#list words as word> <li>${word}</li> </#list> </ul> </body> </html> ``` 使用 FreeMarker 的`list`指令，我们可以显示 HTML 列表中的所有单词。 ```java $ mvn jetty:run ``` 我们运行服务器并定位到`localhost:8080`以获取具有锚点的主页。在本教程中，我们使用了`FreeMarker`模板引擎。您可能也对这些相关教程感兴趣： [Spring `@Configuration`教程](/spring/configuration/)， [Java 教程](/lang/java/)或列出[所有 Spring 教程](/all/#spring)。