构建一个 SpringBoot RESTful Web 服务

其他 2020-01-23 09:44:18 阅读次数: 0

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

你将会创建

你将创建一个能在以下地址接收 HTTP GET 请求的一个服务：

http://localhost:8080/greeting

它将以 JSON 表现形式的问候语进行响应，如下清单所示：

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

你可以在查询字符串中使用可选的 name 参数来自定义问候语，如下清单所示：

http://localhost:8080/greeting?name=User

name 参数值将覆盖 World 的默认值，并反映在响应中，如下清单所示：

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

你将需要准备

如何完成本指南

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

  • 要从头开始，移步至从 Spring Initializr 开始；
  • 要跳过基础，执行以下操作：
    • 下载并解压缩该指南将用到的源代码，或借助 Git 来对其进行克隆操作：git clone https://github.com/spring-guides/gs-rest-service.git
    • 切换至 gs-rest-service/initial 目录；
    • 跳转至该指南的创建资源展示类。

待一切就绪后，可以检查一下 gs-rest-service/complete 目录中的代码。
 

从 Spring Initializr 开始

对于所有的 Spring 应用来说，你应该从 Spring Initializr 开始。Initializr 提供了一种快速的方法来提取应用程序所需的依赖，并为你完成许多设置。该示例仅需要 Spring Web 依赖项。下图显示了此示例项目的 Initializr 设置：
Spring Initializr 界面

上图显示了选择 Maven 作为构建工具的 Initializr。你也可以使用 Gradle。它还将 com.example 和 rest-service 的值分别显示为 Group 和 Artifact。在本示例的其余部分，将用到这些值。

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

<?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.2.2.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>rest-service</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>rest-service</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-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

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

plugins {
	id 'org.springframework.boot' version '2.2.0.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-web'
	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	}
}

test {
	useJUnitPlatform()
}

添加一个 JSON 库

因为我们将使用 JSON 发送和接收信息，所以需要一个 JSON 库。在本指南中，将会用到 Jayway JsonPath 库。

要将库包含在 Maven 构建中，请将以下依赖项添加到 pom.xml 文件。

<dependency>
  <groupId>com.jayway.jsonpath</groupId>
  <artifactId>json-path</artifactId>
  <scope>test</scope>
</dependency>

以下清单显示了最终的 pom.xml 文件：

<?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.2.2.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>rest-service</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>rest-service</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-web</artifactId>
		</dependency>
		<dependency>
		  <groupId>com.jayway.jsonpath</groupId>
		  <artifactId>json-path</artifactId>
		  <scope>test</scope>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

要将库包含在 Gradle 构建中，请将以下依赖项添加到 build.gradle 文件中：

testCompile 'com.jayway.jsonpath:json-path'

以下清单显示了最终的 build.gradle 文件：

plugins {
	id 'org.springframework.boot' version '2.2.0.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-web'
	testCompile 'com.jayway.jsonpath:json-path'
	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	}
}

test {
	useJUnitPlatform()
}

创建一个资源展示类

现在你已经设置了项目和构建系统，可以开始创建 Web 服务了。

在开始之前来考虑一下服务的交互。

该服务将处理 /greeting 地址的 GET 请求，查询字符串中的 name 参数为可选。GET 请求应返回 200 OK 响应，并在 HTTP 正文中显示 JSON 格式的问候语。它应该类似于以下输出：

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

id 字段是问候语的唯一标识符，content 是问候语的文本表现。

要建模问候展示，创建资源展示类。为此，给经典的 Java 对象提供字段、构造函数还有 id 和 content 的存取方法，如下清单（来自 src/main/java/com/example/restservice/Greeting.java）所示：

package com.example.restservice;

public class Greeting {

	private final long id;
	private final String content;

	public Greeting(long id, String content) {
		this.id = id;
		this.content = content;
	}

	public long getId() {
		return id;
	}

	public String getContent() {
		return content;
	}
}

该应用使用 Jackson JSON 库自动将类型 Greeting 的实例转成 JSON。Web 启动器默认情况下将该库载入。

创建一个资源控制器

在 Spring 建立 RESTful Web 服务的方法中，HTTP 请求由控制器处理。这些组件由 @RestController 注解来标识，下面清单中所示的 GreetingController（来自 src/main/java/com/example/restservice/GreetingController.java）通过返回 Greeting 类的新实例来处理 /greeting 地址的 GET 请求：

package com.example.restservice;

import java.util.concurrent.atomic.AtomicLong;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GreetingController {

	private static final String template = "Hello, %s!";
	private final AtomicLong counter = new AtomicLong();

	@GetMapping("/greeting")
	public Greeting greeting(@RequestParam(value = "name", defaultValue = "World") String name) {
		return new Greeting(counter.incrementAndGet(), String.format(template, name));
	}
}

该控制器简洁明了，但是内部却有很多事情要做。我们将其逐步分解。

@GetMapping 注解确保将访问 /greeting 地址的 HTTP GET 请求映射至 greeting() 方法。

其他 HTTP 动词也伴有注解（例如 POST 的 @PostMapping）。这些注解都是 @RequestMapping 注解的衍生物，而其可以用作同义词（例如 @RequestMapping(method=GET)）。

@RequestParam 将查询字符串参数 name 的值绑定至 greeting() 方法的 name 参数中。如果请求中不存在 name 参数，则使用 World 的 defaultValue。

方法主体的实现是创建并返回一个新的 Greeting 对象，持有 id 和 content 属性，id 是 counter 的下一个值，而 content 则是将 name 格式化入 template 变量的结果。

传统 MVC 控制器和 RESTful Web 服务控制器之间的主要区别在于创建 HTTP 响应主体的方式。此 RESTful Web 服务控制器填充并返回 Greeting 对象，而不是依赖于视图技术来通过服务器端渲染将问候数据展现到 HTML。对象数据将以 JSON 格式直接写入 HTTP 响应。

该代码使用 Spring 的 @RestController 注解，该注解将类标记为控制器，其中每个方法均返回域对象而不是视图。这是同时包含 @Controller 以及 @ResponseBody 的简写。

Greeting 对象必须转换为 JSON。借助 Spring 的 HTTP 消息转换器支持，我们无需手动进行该操作。由于 Jackson 2 位于类路径中，因此自动选择 Spring 的 MappingJackson2HttpMessageConverter 来将 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 文件。这是个百分百纯 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 来运行该用。或可以借助 ./mvnw clean package 来构建 JAR 文件，然后运行 JAR 文件，如下所示：

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

我们还可以构建一个经典的 WAR 文件。

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

测试服务

现在服务启动了，访问 http://localhost:8080/greeting，你将看到：

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

通过访问 http://localhost:8080/greeting?name=User 来提供一个查询字符串参数 name。观察 content 属性的值是怎样从 Hello, World! 变成 Hello, User! 的，如下清单所示：

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

这种变更表明 GreetingController 中安插的 @RequestParam 注解按预期工作了。name 参数的默认值为 World，但可以通过查询字符串来显式地覆盖。

还需要观察的是 id 属性怎样从 1 变成 2。这证明多个请求访问的的是同一个 GreetingController 实例，并且其 counter 字段正按预期在每次调用时递增。
 

概述

恭喜你！我们刚刚借助 Spring 开发了一款 RESTful Web 服务。
 

参见

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

Snow Hide
发布了77 篇原创文章 · 获赞 6 · 访问量 1628
私信 关注

猜你喜欢

转载自blog.csdn.net/stevenchen1989/article/details/104038823
今日推荐
火速冲上 GitHub 热榜 —— 开源编程语言、框架哪有这么可爱？
北京人形机器人创新中心发布全球首个纯电驱拟人奔跑的全尺寸人形机器人“天工”
LFOSSA 源来如此公开课 | 掌握云原生未来：CNCF 认证全面攻略与备考秘籍
国产云输入法——仅华为无云端数据上传安全问题
开源日报 | 工业开源项目OGG 1.0；姐姐，你要和我一起配置火狐吗；苹果AI遥遥落后？Fedora 40
开放签电子签章：停止新增，优化体验，前进更进（五一假期前工作）
开源日报 | 中学生开源前端动画引擎；全球首个Llama3 8B中文版开源模型；联想电脑恐出局；Linus讽刺AI炒作
周排行
浏览器对同一域名进行请求的最大并发连接数
React Hook之自定义Hook
【转】MyBatis缓存机制
-Java-泛型
自动化测试常用脚本-发送邮件
LeetCode#859: Buddy Strings
java、Python处理字符串
第二篇の博客
Hadoop伪分布式环境安装
SQL Server进阶（十一）临时表、表变量
每日归档
更多
2024-04-27(56)
2024-04-26(39)
2024-04-25(22)
2024-04-24(36)
2024-04-23(26)
2024-04-22(39)
2024-04-21(0)
2024-04-20(6)
2024-04-19(5)
2024-04-18(0)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022