处理表单提交 - springboot guide中文文档

本指南将引导您使用 Spring 创建并提交一个网页表单的过程。

你将构建什么

在本指南中，您将构建一个网页表单，该表单可以通过以下 URL 访问：http://localhost:8080/greeting。

在浏览器中查看此页面将显示该表单。您可以通过填写 id 和 content 表单字段来提交问候语。当表单提交时，将显示结果页面。

所需内容

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

如何完成本指南 {#_how_to_complete_this_guide}

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

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

要跳过基础知识，请执行以下操作：

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

完成之后，您可以将您的结果与 gs-handling-form-submission/complete 中的代码进行对比。

从 Spring Initializr 开始

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

要手动初始化项目：

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

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

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

创建一个Web控制器

在 Spring 构建网站的方法中，HTTP 请求由控制器处理。这些组件可以通过 @Controller 注解轻松识别。下面列表中的 GreetingController（来自 src/main/java/com/example/handlingformsubmission/GreetingController.java）通过返回 View 的名称来处理 /greeting 的 GET 请求（在这种情况下，greeting）。以下 View 负责渲染 HTML 内容：

package com.example.handlingformsubmission;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;

@Controller
public class GreetingController {

  @GetMapping("/greeting")
  public String greetingForm(Model model) {
    model.addAttribute("greeting", new Greeting());
    return "greeting";
  }

  @PostMapping("/greeting")
  public String greetingSubmit(@ModelAttribute Greeting greeting, Model model) {
    model.addAttribute("greeting", greeting);
    return "result";
  }

}

这个控制器简洁而简单，但其中包含了很多内容。本节将逐步分析它。

映射注解允许您将 HTTP 请求映射到特定的控制器方法。这个控制器中的两个方法都映射到了 /greeting。您可以使用 @RequestMapping（默认情况下，它会映射所有 HTTP 操作，如 GET、POST 等）。然而，在这个例子中，greetingForm() 方法通过使用 @GetMapping 专门映射到了 GET，而 greetingSubmit() 则通过 @PostMapping 映射到了 POST。这种映射使得控制器能够区分对 /greeting 端点的请求。

greetingForm() 方法使用了一个 Model 对象来向视图模板暴露一个新的 Greeting。以下代码中的 Greeting 对象（来自 src/main/java/com/example/handlingformsubmission/Greeting.java）包含诸如 id 和 content 这样的字段，这些字段与 greeting 视图中的表单字段相对应，并用于捕获表单中的信息：

package com.example.handlingformsubmission;

public class Greeting {

  private long id;
  private String content;

  public long getId() {
    return id;
  }

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

  public String getContent() {
    return content;
  }

  public void setContent(String content) {
    this.content = content;
  }

}

方法体的实现依赖于视图技术，通过将视图名称（greeting）转换为模板来执行 HTML 的服务器端渲染。在本例中，我们使用 Thymeleaf，它解析 greeting.html 模板并评估各种模板表达式以渲染表单。以下清单（来自 src/main/resources/templates/greeting.html）展示了 greeting 模板：

<!DOCTYPE HTML>
<html xmlns:th="https://www.thymeleaf.org">
<head> 
    <title>Getting Started: Handling Form Submission</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
    <h1>Form</h1>
    <form action="#" th:action="@{/greeting}" th:object="${greeting}" method="post">
        <p>Id: <input type="text" th:field="*{id}" /></p>
        <p>Message: <input type="text" th:field="*{content}" /></p>
        <p><input type="submit" value="Submit" /> <input type="reset" value="Reset" /></p>
    </form>
</body>
</html>

th:action="@{/greeting}" 表达式指示表单以 POST 方式提交到 /greeting 端点，而 th:object="${greeting}" 表达式声明了用于收集表单数据的模型对象。两个表单字段 th:field="*{id}" 和 th:field="*{content}" 对应于 Greeting 对象中的字段。

以上涵盖了用于呈现表单的控制器、模型和视图部分。现在我们可以回顾表单提交的过程。如前所述，表单通过 POST 请求提交到 /greeting 端点。greetingSubmit() 方法接收由表单填充的 Greeting 对象。由于 Greeting 是一个 @ModelAttribute，因此它会绑定到传入的表单内容。此外，提交的数据可以通过名称（默认情况下是方法参数的名称，因此这里是 greeting）在 result 视图中呈现。id 在 <p th:text="'id: ' + ${greeting.id}" /> expression. Likewise, the content is rendered in the <p th:text="'content: ' + ${greeting.content}" /> 表达式中呈现。以下清单（来自 src/main/resources/templates/result.html）展示了结果模板：

<!DOCTYPE HTML>
<html xmlns:th="https://www.thymeleaf.org">
<head> 
    <title>Getting Started: Handling Form Submission</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
    <h1>Result</h1>
    <p th:text="'id: ' + ${greeting.id}" />
    <p th:text="'content: ' + ${greeting.content}" />
    <a href="/greeting">Submit another message</a>
</body>
</html>

为了清晰起见，这个示例使用了两个独立的视图模板来渲染表单和显示提交的数据。然而，您可以只使用一个视图来完成这两个目的。

使应用程序可执行

虽然您可以将此服务打包为传统的 WAR 文件以部署到外部应用服务器，但更简单的方法是创建一个独立的应用。您将所有内容打包到一个可执行的 JAR 文件中，由一个经典的 Java main() 方法驱动。在此过程中，您使用 Spring 对嵌入 Tomcat servlet 容器作为 HTTP 运行时的支持，而不是部署到外部实例。以下清单（来自 src/main/java/com/example/handlingformsubmission/HandlingFormSubmissionApplication.java）展示了应用类：

package com.example.handlingformsubmission;

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

@SpringBootApplication
public class HandlingFormSubmissionApplication {

  public static void main(String[] args) {
    SpringApplication.run(HandlingFormSubmissionApplication.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-handling-form-submission-0.1.0.jar

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

java -jar target/gs-handling-form-submission-0.1.0.jar

这里描述的步骤将创建一个可运行的 JAR 文件。您也可以构建一个传统的 WAR 文件。

日志输出已显示。服务应在几秒内启动并运行。

测试服务

现在网站已经运行起来了，请访问 http://localhost:8080/greeting，您将看到以下表单：

提交一个 ID 和消息以查看结果：

摘要

恭喜！您刚刚使用 Spring 创建并提交了一个表单。

另请参阅

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