使用 Spring MVC 提供 Web 内容 - springboot guide中文文档

本指南将引导您完成使用 Spring 创建一个“Hello, World”网站的过程。

你将构建什么

您将构建一个应用程序，该应用程序具有静态主页，并且还将在以下地址接受 HTTP GET 请求：http://localhost:8080/greeting。

它会响应一个显示 HTML 的网页。HTML 的主体将包含一个问候语：“Hello, World!”

您可以通过查询字符串中的可选 name 参数来自定义问候语。URL 可能会变成 http://localhost:8080/greeting?name=User。

name 参数值会覆盖默认值 World，并在响应中反映出来，内容将变为 “Hello, User!”。

所需条件

大约 15 分钟
一个喜欢的文本编辑器或集成开发环境
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您也可以直接将代码导入到您的 IDE 中：

如何完成本指南

与大多数 Spring 入门指南一样，您可以从头开始并完成每个步骤，也可以跳过您已经熟悉的基本设置步骤。无论哪种方式，您最终都能获得可运行的代码。

要从头开始，请继续阅读从 Spring Initializr 开始。

要跳过基础部分，请执行以下操作：

下载并解压本指南的源码仓库，或使用 Git 克隆它：git clone https://github.com/spring-guides/gs-serving-web-content.git
进入 gs-serving-web-content/initial 目录
直接跳转到创建 Web 控制器。

完成后，您可以将您的结果与 gs-serving-web-content/complete 中的代码进行对比。

从 Spring Initializr 开始

您可以使用这个预初始化项目，然后点击生成以下载一个 ZIP 文件。该项目已配置为适合本教程中的示例。

要手动初始化项目：

访问 https://start.spring.io。该服务会拉取应用程序所需的所有依赖项，并为您完成大部分设置工作。
选择 Gradle 或 Maven 以及您想要使用的语言。本指南假设您选择了 Java。
点击 Dependencies，然后选择 Spring Web、Thymeleaf 和 Spring Boot DevTools。
点击 Generate。
下载生成的 ZIP 文件，这是一个根据您的选择配置好的 Web 应用程序的压缩包。

如果您的 IDE 集成了 Spring Initializr，您可以直接在 IDE 中完成此过程。

您也可以从 Github 上 fork 该项目，并在您的 IDE 或其他编辑器中打开它。

创建一个Web控制器

在 Spring 构建网站的方法中，HTTP 请求由控制器处理。您可以通过 @Controller 注解轻松识别控制器。在以下示例中，GreetingController 通过返回 View 的名称（在本例中为 greeting）来处理 /greeting 的 GET 请求。View 负责渲染 HTML 内容。以下代码清单（来自 src/main/java/com/example/servingwebcontent/GreetingController.java）展示了控制器：

package com.example.servingwebcontent;

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 GreetingController {

    @GetMapping("/greeting")
    public String greeting(@RequestParam(name="name", required=false, defaultValue="World") String name, Model model) {
        model.addAttribute("name", name);
        return "greeting";
    }

}

这个控制器简洁而简单，但其中有很多细节。我们逐步分解它。

@GetMapping 注解确保对 /greeting 的 HTTP GET 请求会映射到 greeting() 方法。

@RequestParam 将查询字符串参数 name 的值绑定到 greeting() 方法的 name 参数上。这个查询字符串参数不是 required 的。如果请求中没有提供该参数，则使用默认值 World。name 参数的值被添加到一个 Model 对象中，最终使其可以在视图模板中访问。

方法体的实现依赖于一种视图技术（在本例中是 Thymeleaf）来执行 HTML 的服务器端渲染。Thymeleaf 解析 greeting.html 模板并评估 th:text 表达式，以渲染在控制器中设置的 ${name} 参数的值。以下清单（来自 src/main/resources/templates/greeting.html）展示了 greeting.html 模板：

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head> 
    <title>Getting Started: Serving Web Content</title> 
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
    <p th:text="|Hello, ${name}!|" />
</body>
</html>

确保您的 classpath 中包含了 Thymeleaf（依赖坐标：org.springframework.boot:spring-boot-starter-thymeleaf）。在 Github 上的“initial”和“complete”示例中已经包含了它。

Spring Boot Devtools

开发Web应用程序的一个常见特性是编写代码更改、重新启动应用程序并刷新浏览器以查看更改。整个过程可能会耗费大量时间。为了加速这个刷新周期，Spring Boot 提供了一个方便的模块，称为 spring-boot-devtools。Spring Boot Devtools:

启用热替换。
切换模板引擎以禁用缓存。
启用 LiveReload 以自动刷新浏览器。
其他基于开发而非生产环境的合理默认设置。

运行应用程序

Spring Initializr 为您创建了一个应用程序类。在这种情况下，您无需进一步修改 Spring Initializr 提供的类。以下代码片段（来自 src/main/java/com/example/servingwebcontent/ServingWebContentApplication.java）展示了该应用程序类：

package com.example.servingwebcontent;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ServingWebContentApplication {

    public static void main(String[] args) {
        SpringApplication.run(ServingWebContentApplication.class, args);
    }

}

@SpringBootApplication 是一个便捷的注解，它包含了以下所有功能：

@Configuration: 将类标记为应用程序上下文的 bean 定义来源。
@EnableAutoConfiguration: 告诉 Spring Boot 根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如，如果类路径上有 spring-webmvc，该注解会将应用程序标记为 Web 应用程序，并激活关键行为，例如设置 DispatcherServlet。
@ComponentScan: 告诉 Spring 在 com/example 包中查找其他组件、配置和服务，使其能够找到控制器。

main() 方法使用 Spring Boot 的 SpringApplication.run() 方法来启动应用程序。您是否注意到没有一行 XML 代码？也没有 web.xml 文件。这个 Web 应用程序是 100% 纯 Java 的，您无需处理任何配置管道或基础设施。

构建可执行 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的可执行 JAR 文件并运行它。构建可执行 jar 使得在整个开发生命周期、跨不同环境等情况下，将服务作为应用程序进行发布、版本控制和部署变得非常容易。

如果您使用 Gradle，可以通过 ./gradlew bootRun 来运行应用程序。或者，您可以使用 ./gradlew build 构建 JAR 文件，然后如下所示运行该 JAR 文件：

java -jar build/libs/gs-serving-web-content-0.1.0.jar

如果您使用 Maven，可以通过运行 ./mvnw spring-boot:run 来启动应用程序。或者，您可以使用 ./mvnw clean package 构建 JAR 文件，然后如下所示运行该 JAR 文件：

java -jar target/gs-serving-web-content-0.1.0.jar

这里描述的步骤创建了一个可运行的 JAR 文件。您也可以构建一个经典的 WAR 文件。

日志输出已显示。应用程序应在几秒钟内启动并运行。

测试应用程序

现在网站已经运行，请访问http://localhost:8080/greeting，您应该会看到“Hello, World!”。

通过访问http://localhost:8080/greeting?name=User，提供一个name查询字符串参数。注意消息是如何从“Hello, World!”变为“Hello, User!”的：

这一变化表明，GreetingController中的@RequestParam配置按预期工作。name参数的默认值为World，但可以通过查询字符串显式覆盖。

添加一个主页

静态资源，包括 HTML、JavaScript 和 CSS，可以通过将它们放置在源代码中的正确位置，由您的 Spring Boot 应用程序提供服务。默认情况下，Spring Boot 从类路径中的 /static（或 /public）目录提供静态内容。index.html 资源是特殊的，因为如果它存在，它将被用作“欢迎页面”，这意味着它将作为根资源提供（即在 http://localhost:8080/ 处）。因此，您需要创建以下文件（您可以在 src/main/resources/static/index.html 中找到）：

<!DOCTYPE HTML>
<html>
<head> 
    <title>Getting Started: Serving Web Content</title> 
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
    <p>Get your greeting <a href="/greeting">here</a></p>
</body>
</html>

当您重启应用程序时，您将在 http://localhost:8080/ 看到 HTML 内容。

总结

恭喜！您刚刚使用 Spring 开发了一个网页。

另请参阅

以下指南可能也会有所帮助：