本指南将引导您完成使用Spring创建和提交Web表单的过程。

你会建立什么

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

在浏览器中查看此页面将显示该表单。您可以通过填充idcontent表单字段来提交问候语。提交表单后将显示结果页面。

你需要什么

如何完成本指南

像大多数Spring入门指南一样,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都可以使用代码。

从头开始,请继续进行“从Spring Initializr开始”

跳过基础知识,请执行以下操作:

完成后,您可以根据中的代码检查结果gs-handling-form-submission/complete

从Spring Initializr开始

如果您使用Maven,请访问Spring Initializr以生成具有所需依赖项(Spring Web和Thymeleaf)的新项目。

以下清单显示了pom.xml选择Maven时创建的文件:

<?xml版本=“ 1.0”编码=“ 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 https://maven.apache.org/xsd/maven-4.0.0.xsd”>
	<modelVersion> 4.0.0 </ modelVersion>
	<父母>
		<groupId> org.springframework.boot </ groupId>
		<artifactId> spring-boot-starter-parent </ artifactId>
		<version> 2.4.3 </ version>
		<relativePath /> <!-从存储库中查找父级->
	</ parent>
	<groupId> com.example </ groupId>
	<artifactId>处理表单提交</ artifactId>
	<version> 0.0.1-SNAPSHOT </ version>
	<名称>处理表格提交</名称>
	<description> Spring Boot的演示项目</ description>
	<属性>
		<java.version> 1.8 </java.version>
	</ properties>
	<依赖项>
		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-thymeleaf </ artifactId>
		</ dependency>
		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-web </ artifactId>
		</ dependency>

		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-test </ artifactId>
			<scope>测试</ scope>
		</ dependency>
	</ dependencies>

	<内部版本>
		<插件>
			<插件>
				<groupId> org.springframework.boot </ groupId>
				<artifactId> spring-boot-maven-plugin </ artifactId>
			</ plugin>
		</ plugins>
	</ build>

</ project>

如果您使用Gradle,请访问Spring Initializr以生成具有所需依赖项(Spring Web和Thymeleaf)的新项目。

以下清单显示了build.gradle选择Gradle时创建的文件:

插件{
	id'org.springframework.boot'版本'2.4.3'
	id'io.spring.dependency-management'版本'1.0.11.RELEASE'
	id'java'
}

组='com.example'
版本='0.0.1-SNAPSHOT'
sourceCompatibility ='1.8'

储存库{
	mavenCentral()
}

依赖项{
	实现'org.springframework.boot:spring-boot-starter-thymeleaf'
	实现'org.springframework.boot:spring-boot-starter-web'
	testImplementation'org.springframework.boot:spring-boot-starter-test'
}

测试 {
	useJUnitPlatform()
}

手动初始化(可选)

如果要手动初始化项目而不是使用前面显示的链接,请按照以下步骤操作:

  1. 导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系,并为您完成大部分设置。

  2. 选择Gradle或Maven以及您要使用的语言。本指南假定您选择了Java。

  3. 单击Dependencies,然后选择Spring WebThymeleaf

  4. 点击生成

  5. 下载生成的ZIP文件,该文件是使用您的选择配置的Web应用程序的存档。

如果您的IDE集成了Spring Initializr,则可以从IDE中完成此过程。

创建一个Web控制器

在Spring建立网站的方法中,HTTP请求由控制器处理。这些组件可以通过@Controller注释轻松识别。在GreetingController下面的清单(自src/main/java/com/example/handlingformsubmission/GreetingController.java)控GET请求/greeting通过返回的名称View(在这种情况下,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操作,例如GETPOST等等)。但是,在这种情况下,该greetingForm()方法是使用专门映射到GET@GetMappinggreetingSubmit()而是通过映射到POST@PostMapping。该映射使控制器可以区分对/greeting端点的请求。

greetingForm()方法使用一个Model对象向Greeting视图模板公开新对象。Greeting以下代码(来自中的src/main/java/com/example/handlingformsubmission/Greeting.java)中的对象包含诸如idcontentgreeting视图中的表单字段相对应的字段,并用于从表单中捕获信息:

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

涵盖了控制器,模型和用于显示表单的视图。现在,我们可以回顾提交表单的过程。如前所述,该表单/greeting通过使用POST调用提交给端点。该greetingSubmit()方法接收Greeting由表单填充的对象。的Greeting是一个@ModelAttribute,因此它被绑定到传入的形式的内容。同样,可以result通过按名称引用提交的数据(在默认情况下为method参数的名称)来在视图中呈现提交的数据greeting。将id<p th:text="'id: ' + ${greeting.id}" />表达式中呈现。同样,content会在<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文件中,该文件由一个好的旧Javamain()方法驱动。在此过程中,您将使用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。或者,您可以使用来构建JAR文件./gradlew build,然后运行JAR文件,如下所示:

java -jar build / libs / gs-handling-form-submission-0.1.0.jar

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

java -jar target / gs-handling-form-submission-0.1.0.jar
此处描述的步骤将创建可运行的JAR。您还可以构建经典的WAR文件

显示日志记录输出。该服务应在几秒钟内启动并运行。

测试服务

现在该网站正在运行,请访问http:// localhost:8080 / greeting,在其中您可以看到以下形式:

形式

提交ID和消息以查看结果:

结果

概括

恭喜你!您刚刚使用Spring来创建和提交表单。

也可以看看

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

是否要编写新指南或为现有指南做出贡献?查看我们的贡献准则

所有指南均以代码的ASLv2许可证和写作的Attribution,NoDerivatives创用CC许可证发布。