ZetCode

Spring Boot FreeMarker

最后修改于 2023 年 8 月 2 日

在本文中，我们使用FreeMarker模板引擎和H2数据库创建一个简单的Spring Boot Web应用程序。

Spring 是一个流行的Java应用程序框架。Spring Boot 旨在创建一个独立的、生产级的、基于Spring的应用程序，而无需太多麻烦。

H2 是一个完全用 Java 编写的开源关系数据库管理系统。它可以嵌入到 Java 应用程序中，也可以在客户端-服务器模式下运行。它易于部署和安装，并且占用资源少。

FreeMarker

FreeMarker 是一个用于Web和独立环境的服务器端Java模板引擎。模板使用FreeMarker模板语言(FTL)编写，这是一种简单、专门的语言。

注意： Spring Boot最近将默认扩展名从 .ftl 更改为 .ftlh。
spring.freemarker.template-loader-path=classpath:/templates
spring.freemarker.suffix=.ftl

可以使用上述设置更改默认后缀和模板目录。

Spring Boot FreeMarker示例

以下示例使用FreeMarker模板引擎。

build.gradle
...
src
├── main
│  ├── java
│  │  └── com
│  │      └── zetcode
│  │          ├── Application.java
│  │          ├── controller
│  │          │  └── MyController.java
│  │          ├── model
│  │          │  └── City.java
│  │          └── service
│  │              ├── CityService.java
│  │              └── ICityService.java
│  └── resources
│      ├── application.properties
│      ├── data-h2.sql
│      ├── schema-h2.sql
│      ├── static
│      │  └── css
│      │      └── style.css
│      └── templates
│          ├── index.ftlh
│          └── showCities.ftlh
└── test
    ├── java
    └── resources

这是项目结构。FreeMarker模板文件具有 .ftlh 后缀；它们默认位于 src/main/resources/template 目录中。

build.gradle 
plugins {
    id 'org.springframework.boot' version '3.1.1'
    id 'io.spring.dependency-management' version '1.1.0'
    id 'java'
}

group = 'com.zetcode'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-freemarker'
    implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    runtimeOnly 'com.h2database:h2'
}

这是Gradle构建文件。 h2 包添加了H2数据库。 spring-boot-starter-web 用于使用Spring MVC构建Web应用程序，包括RESTful应用程序。它使用Tomcat作为默认的嵌入式容器。 spring-boot-starter-freemarker 是一个使用FreeMarker构建Spring MVC应用程序的启动器。 spring-boot-starter-jdbc 是一个在Spring Boot中使用JDBC的启动器。

com/zetcode/model/City.java 
package com.zetcode.model;

import java.util.Objects;

public class City {

    private Long id;
    private String name;
    private int population;

    public City() {
    }

    public City(Long id, String name, int population) {
        this.id = id;
        this.name = name;
        this.population = population;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPopulation() {
        return population;
    }

    public void setPopulation(int population) {
        this.population = population;
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 29 * hash + Objects.hashCode(this.id);
        hash = 29 * hash + Objects.hashCode(this.name);
        hash = 29 * hash + this.population;
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final City other = (City) obj;
        if (this.population != other.population) {
            return false;
        }
        if (!Objects.equals(this.name, other.name)) {
            return false;
        }
        if (!Objects.equals(this.id, other.id)) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("City{");
        sb.append("id=").append(id);
        sb.append(", name='").append(name).append('\'');
        sb.append(", population=").append(population);
        sb.append('}');
        return sb.toString();
    }
}

这是 City bean类。它包含项目ID、名称和人口。

resources/application.properties 
spring.main.banner-mode=off
spring.sql.init.platform=h2

application.properties 是主要的Spring Boot配置文件。使用 banner-mode 属性，我们关闭了Spring banner。平台值用于SQL初始化脚本：schema-${platform}.sql 和 data-${platform}.sql。

请注意，我们没有配置数据源；如果没有配置数据，Spring会自动在内存模式下配置H2。我们希望使用内存数据库，因此我们让Spring进行自动配置。

resources/schema-h2.sql 
CREATE TABLE cities(id INT PRIMARY KEY AUTO_INCREMENT,
        name VARCHAR(255), population INT);

此 SQL 脚本创建 cities 表。

resources/data-h2.sql 
INSERT INTO cities(name, population) VALUES('Bratislava', 432000);
INSERT INTO cities(name, population) VALUES('Budapest', 1759000);
INSERT INTO cities(name, population) VALUES('Prague', 1280000);
INSERT INTO cities(name, population) VALUES('Warsaw', 1748000);
INSERT INTO cities(name, population) VALUES('Los Angeles', 3971000);
INSERT INTO cities(name, population) VALUES('New York', 8550000);
INSERT INTO cities(name, population) VALUES('Edinburgh', 464000);
INSERT INTO cities(name, population) VALUES('Berlin', 3671000);

此脚本用数据填充表。这两个脚本都位于类路径的根目录。

com/zetcode/service/ICityService.java 
package com.zetcode.service;

import com.zetcode.model.City;
import java.util.List;

public interface ICityService {

    List<City> findAll();
}

ICityService 提供了一个契约方法，用于从数据源获取所有城市。

com/zetcode/service/CityService.java 
package com.zetcode.service;

import com.zetcode.model.City;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class CityService implements ICityService {

    private final JdbcTemplate jdbcTemplate;

    public CityService(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    @Override
    public List<City> findAll() {

        var sql = "SELECT * FROM cities";

        return jdbcTemplate.query(sql, new BeanPropertyRowMapper<>(City.class));
    }
}

CityService 包含 findAll 方法的实现。我们借助 JdbcTemplate 从 cities 表中检索所有城市。

public CityService(JdbcTemplate jdbcTemplate) {
    this.jdbcTemplate = jdbcTemplate;
}

JdbcTemplate 通过构造函数注入。

var sql = "SELECT * FROM cities";

这是要执行的SQL。我们从 cities 表中选择所有城市。

return jdbcTemplate.query(sql, new BeanPropertyRowMapper<>(City.class));

BeanPropertyRowMapper 将一行转换为指定映射目标类的新实例。

com/zetcode/controller/MyController.java 
package com.zetcode.controller;

import com.zetcode.service.ICityService;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.HashMap;

@Controller
public class MyController {

    private final ICityService cityService;

    public MyController(ICityService cityService) {
        this.cityService = cityService;
    }

    @GetMapping(value = "/")
    public String index(Model model) {

        return "index";
    }

    @GetMapping(value="/cities")
    public ModelAndView showCities() {

        var cities = cityService.findAll();

        var params = new HashMap<String, Object>();
        params.put("cities", cities);

        return new ModelAndView("showCities", params);
    }
}

这是Spring Boot Web应用程序的控制器类。控制器使用 @Controller 注解进行装饰。控制器有两个映射：一个用于主页，一个用于列出所有城市。

public MyController(ICityService cityService) {
    this.cityService = cityService;
}

我们将 ICityService 注入到 cityService 字段中。

@GetMapping(value = "/")
public String index(Model model) {

    return "index";
}

index 是位于预定义的 template 目录中的视图的名称。

@GetMapping(value="/cities")
public ModelAndView showCities() {

    var cities = cityService.findAll();

    var params = new HashMap<String, Object>();
    params.put("cities", cities);

    return new ModelAndView("showCities", params);
}

此控制器方法提供城市列表。我们从城市服务中找到所有城市对象，并将结果列表放入参数中。Spring将找到名为 showCities 的FreeMarker视图，并让引擎将模板与模型数据结合起来。

resources/static/css/style.css 
h2 {color: blue}

td:nth-child(3) {
    text-align: right;
}

style.css 是一个静态文件，位于 src/main/resources/static/css 目录中。它将H2标签设置为蓝色，并右对齐第三列的数据。

resources/templates/index.ftlh 
<!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>
        <a href="cities">Show cities</a>
    </body>

</html>

index.ftlh 模板文件是应用程序的主页。它包含一个检索所有城市的链接。

resources/templates/showCities.ftlh 
<!DOCTYPE html>
<html>
    <head>
        <title>Cities</title>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <link rel="stylesheet" href="css/style.css">
        </head>
    <body>
        <h2>List of cities</h2>

        <table>
            <tr>
                <th>Id</th>
                <th>Name</th>
                <th>Population</th>
            </tr>

            <#list cities as city>
                <tr>
                    <td>${city.id}</td>
                    <td>${city.name}</td>
                    <td>${city.population}</td>
                </tr>
            </#list>
        </table>

    </body>
</html>

showCities.ftlh 是一个FreeMarker模板文件，其中包含要使用模型中的数据填充的占位符。要访问数据，我们使用 ${} 变量表达式。

<link rel="stylesheet" href="css/style.css">

我们包含静态CSS文件。

<#list cities as city>
    <tr>
        <td>${city.id}</td>
        <td>${city.name}</td>
        <td>${city.population}</td>
    </tr>
</#list>

我们迭代城市列表，并将每个城市详细信息放入一个表格行中。 #list 指令用于列出一个数据集合。

com/zetcode/Application.java 
package com.zetcode;

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);
    }
}

我们设置Spring Boot应用程序。 @SpringBootApplication 注解启用自动配置和组件扫描。

$ ./gradlew bootRun

我们运行应用程序并导航到 localhost:8080。

在本文中，我们使用FreeMarker和H2创建了一个Spring Boot Web应用程序。

作者

我叫Jan Bodnar，是一个充满激情的程序员，拥有丰富的编程经验。自2007年以来，我一直在撰写编程文章。迄今为止，我撰写了超过1,400篇文章和8本电子书。我拥有超过十年的编程教学经验。

列出 所有 Spring Boot 教程。