本指南将引导您完成使用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 Initialize开始。

要跳过基础知识，请执行以下操作：

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

从Spring初始化开始

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

以下清单显示了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/> <!-- 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>
		</dependency>
	</dependencies>

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

</project>

如果使用Gradle，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Web）。

以下清单显示了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-web'
	testImplementation('org.springframework.boot:spring-boot-starter-test')
}

test {
	useJUnitPlatform()
}

手动初始化（可选）

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

  1. 导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。

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

  3. 单击Dependencies，然后选择Spring Web。

  4. 点击生成。

  5. 下载生成的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）所示：

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。网络启动器默认包含杰克逊。

创建一个资源控制器

在Spring的构建RESTful Web服务的方法中，HTTP请求由控制器处理。这些组件由@RestController注释标识，并且GreetingController以下清单（从中src/main/java/com/example/restservice/GreetingController.java）中显示的内容通过返回该类的新实例来处理GET请求：/greetingGreeting

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注释可以确保HTTP GET请求到/greeting被映射到greeting()方法。

其他HTTP动词也有伴随注释（例如@PostMappingPOST）。@RequestMapping它们都有一个注释，它们都是从中衍生的，并且可以用作同义词（例如@RequestMapping(method=GET)）。

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

方法主体的实现根据和中的下一个值创建一个Greeting具有id和content属性的新对象，并返回一个新对象，并使用greetingcounter格式化给定name的对象template。

传统的MVC控制器和RESTful Web服务控制器之间的主要区别在于创建HTTP响应主体的方式。RESTful Web服务控制器填充并返回一个Greeting对象，而不是依赖于视图技术来执行问候语数据到HTML的服务器端渲染。对象数据将作为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。或者，您可以使用来构建JAR文件./gradlew build，然后运行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/greeting?name=User。请注意，content属性值如何从Hello, World!变为Hello, User!，如以下清单所示：

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

此更改表明@RequestParamin的安排GreetingController按预期方式工作。该name参数的默认值是，World但可以通过查询字符串显式覆盖。

还请注意，id属性是如何从更改1为的2。这证明您正在针对GreetingController多个请求处理同一个实例，并且counter在每个调用中它的字段都按预期递增。

概括

恭喜你！您刚刚使用Spring开发了RESTful Web服务。

也可以看看

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

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创用CC许可证发布。