Spring学习【1】Build a Restful Web Service

最新推荐文章于 2024-07-19 17:37:28 发布

xxx_Sandra

最新推荐文章于 2024-07-19 17:37:28 发布

阅读量101

点赞数

文章标签： java spring maven

原文链接：https://spring.io/guides/gs/rest-service/

版权

这篇文章将完成使用Spring创建“Hello，World” restfulweb服务的过程。

使用IDEA作为开发工具，使用Maven进行项目管理。

导航到https://start.spring.io。该服务提取应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
单击Dependencies并选择Spring Web和Thymeleaf。
单击生成。

创建 Web 控制器

在 Spring 构建网站的方法中，HTTP 请求由控制器处理。这些组件很容易通过@Controller注释识别。以下GreetingController清单中的 (from )通过返回 a 的名称（在本例中 src/main/java/com/example/handlingformsubmission/GreetingController.java为）来处理 GET 请求。以下负责呈现 HTML 内容：/greetingViewgreetingView

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()方法具体映射到GETusing @GetMapping，而greetingSubmit()映射到POSTwith @PostMapping。此映射使控制器能够区分对/greeting端点的请求。

该greetingForm()方法使用一个对象向视图模板Model公开一个新对象。以下代码中的对象 (from Greeting)包含与视图中的表单字段相对应的字段，例如和，用于从表单中捕获信息： Greetingsrc/main/java/com/example/handlingformsubmission/Greeting.javaidcontentgreeting

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解析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是 a ，因此@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 文件中，由一个很好的旧 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 目标/gs-handling-form-submission-0.1.0.jar

此处描述的步骤创建了一个可运行的 JAR。您还可以构建经典的 WAR 文件。

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

测试服务

现在网站正在运行，访问 http://localhost:8080/greeting，您会看到以下表单：

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

xxx_Sandra

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Spring学习【1】Build a Restful Web Service

这篇文章将完成使用Spring创建“Hello，World” restfulweb服务的过程。使用IDEA作为开发工具，使用Maven进行项目管理。
复制链接

扫一扫