spring提交表單 · springboot官方文檔中文版

# 提交表格本指南將引導您完成使用Spring創建和提交Web表單的過程。 ## 你會建立什么在本指南中，您將構建一個Web表單，該表單可通過以下URL訪問： `[http://localhost:8080/greeting](http://localhost:8080/greeting)` 在瀏覽器中查看此頁面將顯示該表單。您可以通過填充 `id` 和 `content`表格欄位。提交表單后將顯示結果頁面。 ## 你需要什么 * 約15分鐘 * 最喜歡的文本編輯器或IDE * [JDK 11](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本 * [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi) * 您還可以將代碼直接導入到IDE中： * [彈簧工具套件（STS）](https://spring.io/guides/gs/sts) * [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/) ## 如何完成本指南像大多數Spring 一樣 [入門指南](https://spring.io/guides) ，您可以從頭開始并完成每個步驟，也可以繞過您已經熟悉的基本設置步驟。無論哪種方式，您最終都可以使用代碼。要 **從頭開始** ，請繼續進行“ [從Spring Initializr開始”](https://spring.io/guides/gs/handling-form-submission/#scratch) 。要 **跳過基礎知識** ，請執行以下操作： * [下載](https://github.com/spring-guides/gs-handling-form-submission/archive/master.zip) 并解壓縮本指南的源存儲庫，或使用對其進行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-handling-form-submission.git](https://github.com/spring-guides/gs-handling-form-submission.git)` * 光盤進入 `gs-handling-form-submission/initial` * 繼續 [創建Web控制器](https://spring.io/guides/gs/handling-form-submission/#initial) 。 **完成后** ，您可以根據中的代碼檢查結果 `gs-handling-form-submission/complete`. ## 從Spring Initializr開始如果您使用Maven，請訪問 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=handling-form-submission&name=handling-form-submission&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.handling-form-submission&dependencies=web,thymeleaf) 以生成具有所需依賴項（Spring Web和Thymeleaf）的新項目。以下清單顯示了 `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.4.3</version> <relativePath/>  </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> ~~~ 如果您使用Gradle，請訪問 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=handling-form-submission&name=handling-form-submission&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.handling-form-submission&dependencies=web,thymeleaf) 以生成具有所需依賴項（Spring Web和Thymeleaf）的新項目。以下清單顯示了 `build.gradle` 選擇Gradle時創建的文件： ~~~ plugins { id 'org.springframework.boot' version '2.4.3' id 'io.spring.dependency-management' version '1.0.11.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' } test { useJUnitPlatform() } ~~~ ### 手動初始化（可選）如果要手動初始化項目而不是使用前面顯示的鏈接，請按照以下步驟操作： 1. 導航到 [https://start.spring.io](https://start.spring.io) 。該服務提取應用程序所需的所有依賴關系，并為您完成大部分設置。 2. 選擇Gradle或Maven以及您要使用的語言。本指南假定您選擇了Java。 3. 單擊 **Dependencies，** 然后選擇 **Spring Web** 和 **Thymeleaf** 。 4. 點擊 **生成** 。 5. 下載生成的ZIP文件，該文件是使用您的選擇配置的Web應用程序的存檔。如果您的IDE集成了Spring Initializr，則可以從IDE中完成此過程。 ## 創建一個Web控制器在Spring建立網站的方法中，HTTP請求由控制器處理。這些組成部分很容易由 [`@Controller`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/stereotype/Controller.html)注解。這 `GreetingController` 在以下清單中（來自 `src/main/java/com/example/handlingformsubmission/GreetingController.java`）處理GET請求 `/greeting` 通過返回一個名稱 [`View`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/servlet/View.html) （在這種情況下， `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()` 方法專門映射到 `GET` 通過使用 `@GetMapping`，盡管 `greetingSubmit()` 映射到 `POST` 和 `@PostMapping`。通過此映射，控制器可以將請求區分為 `/greeting` 端點。這 `greetingForm()` 方法使用 [`Model`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/ui/Model.html) 對象以暴露新的 `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`）轉換成模板進行渲染。在這種情況下，我們使用 [Thymeleaf](https://www.thymeleaf.org/doc/html/Thymeleaf-Spring3.html) 來解析 `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` 通過按名稱引用來查看（默認情況下，方法參數的名稱，因此 `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文件中，由一個好的舊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文件，如下所示： ~~~ 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](http://localhost:8080/greeting) ，在其中您可以看到以下形式： ![形式](https://raw.githubusercontent.com/spring-guides/gs-handling-form-submission/master/images/form.png) 提交ID和消息以查看結果： ![結果](https://raw.githubusercontent.com/spring-guides/gs-handling-form-submission/master/images/result.png) ## 概括恭喜你！您剛剛使用Spring來創建和提交表單。