使用 Spring 构建 RESTful Web 服务

原标题:Spring认证|使用 Spring 构建 RESTful Web 服务

本指南将引导您完成使用 Spring 创建“Hello, World”RESTful Web 服务的过程。

你将建造什么

您将构建一个接受 HTTP GET 请求的服务http://localhost:8080/greeting

它将以问候语的 JSON 表示形式响应,如下面的清单所示:

{"id":1,"content":"Hello, World!"}

您可以使用name查询字符串中的可选参数自定义问候语,如以下清单所示:

http://localhost:8080/greetin...

的name参数值将覆盖的默认值World,并反映在响应时,如下面的列表显示:

{"id":1,"content":"Hello, User!"}

如何完成本指南

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

要从头开始,请转到从 Spring Initializr 开始。

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

下载并解压缩本指南的源代码库,或使用Git克隆它:git clone https://github.com/spring-gui...

光盘进入 gs-rest-service/initial

跳转到创建资源表示类。

完成后,您可以根据 中的代码检查结果gs-rest-service/complete。

从 Spring Initializr 开始

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

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

Unresolved directive in - include::initial/pom.xml[]

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

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

Unresolved directive in - include::initial/build.gradle[]

手动初始化(可选)

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

导航到https://start.spring.io。此服务包含应用程序所需的所有依赖项,并为您完成大部分设置。

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

单击依赖项并选择Spring Web。

单击生成。

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

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

创建资源表示类

现在您已经设置了项目和构建系统,您可以创建您的 Web 服务。

通过考虑服务交互来开始这个过程。

该服务将处理对 的GET请求/greeting,可选择name在查询字符串中使用一个参数。该GET请求应200 OK在正文中返回一个带有 JSON的响应,表示问候语。它应该类似于以下输出:

{

"id": 1,

"content": "Hello, World!"

}

该id字段是问候语的唯一标识符,是问候语content的文本表示。

要对问候表示建模,请创建一个资源表示类。为此,请提供一个普通的旧 Java 对象,其中包含id和content数据的字段、构造函数和访问器,如下面的清单(来自src/main/java/com/example/restservice/Greeting.java)所示:

Unresolved directive in - include::complete/src/main/java/com/example/restservice/Greeting.java[]

此应用程序使用Jackson JSON库自动将类型实例编组Greeting为 JSON。默认情况下,Web Starter 包含 Jackson。

创建资源控制器

在 Spring 构建 RESTful Web 服务的方法中,HTTP 请求由控制器处理。这些组件由@RestController注解标识,GreetingController下面的清单 (from src/main/java/com/example/restservice/GreetingController.java)通过返回类的新实例来处理GET请求:/greetingGreeting

Unresolved directive in - include::complete/src/main/java/com/example/restservice/GreetingController.java[]

这个控制器简洁明了,但背后有很多事情要做。我们一步一步分解。

该@GetMapping注释确保 HTTP GET 请求/greeting被映射到该greeting()方法。

有其他 HTTP 动词(例如@PostMappingPOST)的伴随注释。还有一个@RequestMapping注释,它们都源自,并且可以用作同义词(例如@RequestMapping(method=GET))。

@RequestParam将查询字符串参数的值绑定name到方法的name参数中greeting()。如果name请求中没有该参数defaultValue,World则使用of 。

方法主体的实现创建并返回一个新Greeting对象,该对象具有id和content属性,该对象基于来自counter和的下一个值,并name通过使用 greeting 来格式化给定的template。

传统 MVC 控制器和前面展示的 RESTful Web 服务控制器之间的主要区别在于 HTTP 响应主体的创建方式。这个 RESTful Web 服务控制器不依赖于视图技术来执行服务器端将问候数据呈现为 HTML,而是填充并返回一个Greeting对象。对象数据将作为 JSON 直接写入 HTTP 响应。

此代码使用 Spring@RestController注释,它将类标记为控制器,其中每个方法返回域对象而不是视图。它是同时包含@Controller和的简写@ResponseBody。

该Greeting对象必须转换为 JSON。由于 Spring 的 HTTP 消息转换器支持,您无需手动进行此转换。因为Jackson 2在类路径上,所以MappingJackson2HttpMessageConverter会自动选择Spring来将Greeting实例转换为 JSON。

@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-rest-service-0.1.0.jar

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

java -jar target/gs-rest-service-0.1.0.jar

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

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

测试服务

现在服务已启动,请访问http://localhost:8080/greeting,您应该看到:

{"id":1,"content":"Hello, World!"}

name通过访问提供查询字符串参数http://localhost:8080/greetin...。请注意content属性的值如何从Hello, World!变为Hello, User!,如下面的清单所示:

{"id":2,"content":"Hello, User!"}

此更改表明 中的@RequestParam安排GreetingController按预期工作。该name参数已被赋予默认值,World但可以通过查询字符串显式覆盖。

还要注意id属性如何从1变为2。这证明您正在GreetingController跨多个请求处理同一个实例,并且它的counter字段在每次调用时都按预期递增。

总结

恭喜!您刚刚使用 Spring 开发了一个 RESTful Web 服务。

你可能感兴趣的