本指南将引导您完成使用Spring创建和提交Web表单的过程。
你会建立什么
在本指南中,您将构建一个Web表单,该表单可通过以下URL访问:http://localhost:8080/greeting
在浏览器中查看此页面将显示该表单。您可以通过填充id
和content
表格栏位。提交表单后将显示结果页面。
你需要什么
-
约15分钟
-
最喜欢的文本编辑器或IDE
-
JDK 1.8或更高版本
-
您还可以将代码直接导入到IDE中:
如何完成本指南
像大多数Spring 入门指南一样,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都可以使用工作代码。
要从头开始 ,请继续进行[scratch] 。
要跳过基础知识 ,请执行以下操作:
-
下载并解压缩本指南的源存储库,或使用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开始
对于所有Spring应用程序,您应该从Spring Initializr开始。Initializr提供了一种快速的方法来提取应用程序所需的所有依赖关系,并为您完成了许多设置。此示例需要Spring Web和Thymeleaf依赖项。下图显示了此示例项目的Initializr设置:

上图显示了选择Maven作为构建工具的Initializr。您也可以使用Gradle。它还显示了com.example 和handling-form-submission 分别是Group和Artifact。在本示例的其余部分中,将使用这些值。 |
以下清单显示了pom.xml
选择Maven时创建的文件:
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.8.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.example</groupId> <artifactId>handling-form-submission</artifactId> <version>0.0.1-SNAPSHOT</version> <name>handling-form-submission</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
以下清单显示了build.gradle
选择Gradle时创建的文件:
plugins { id 'org.springframework.boot' version '2.1.8.RELEASE' id 'io.spring.dependency-management' version '1.0.8.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-thymeleaf' implementation 'org.springframework.boot:spring-boot-starter-web' testImplementation 'org.springframework.boot:spring-boot-starter-test' }
创建一个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) {
return "result";
}
}
该控制器简洁明了,但仍在继续。本节的其余部分将逐步对其进行分析。
映射注释使您可以将HTTP请求映射到特定的控制器方法。此控制器中的两个方法都映射到/greeting
。您可以使用@RequestMapping
(默认情况下,它映射所有HTTP操作,例如GET
, POST
,依此类推)。但是,在这种情况下, greetingForm()
方法专门映射到GET
通过使用@GetMapping
,而greetingSubmit()
映射到POST
与@PostMapping
。通过此映射,控制器可以区分对/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;
}
}
方法主体的实现依赖于视图技术来通过转换视图名称来执行HTML的服务器端呈现( greeting
)转换成模板进行渲染。在这种情况下,我们使用Thymeleaf来解析greeting.html
模板并评估各种模板表达式以呈现表单。以下清单(来自src/main/resources/templates/greeting.html
)显示greeting
模板:
<!DOCTYPE HTML>
<html xmlns:th="http://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
通过按名称引用来查看(默认情况下,方法参数的名称,因此greeting
在这种情况下)。的id
呈现在表达。同样,
content
呈现在表达。以下清单(来自
src/main/resources/templates/result.html
)显示结果模板:
<!DOCTYPE HTML>
<html xmlns:th="http://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
。或者,您可以通过使用以下命令构建JAR文件: ./gradlew build
然后运行JAR文件,如下所示:
如果使用Maven,则可以通过使用以下命令运行应用程序./mvnw spring-boot:run
。或者,您可以使用以下命令构建JAR文件: ./mvnw clean package
然后运行JAR文件,如下所示:
此处描述的步骤将创建可运行的JAR。您还可以构建经典的WAR文件 。 |
显示日志记录输出。该服务应在几秒钟内启动并运行。
测试服务
摘要
恭喜你!您刚刚使用Spring来创建和提交表单。
是否要编写新指南或为现有指南做出贡献?查看我们的贡献准则 。
所有指南均以代码的ASLv2许可证和写作的Attribution,NoDerivatives创作共用许可证发布 。 |