# 构建一个RESTful Web服务
本指南将引导您完成使用Spring创建“ Hello，World” RESTful Web服务的过程。
## 你会建立什么
您将构建一个在以下位置接受HTTP GET请求的服务： `[http://localhost:8080/greeting](http://localhost:8080/greeting)`.
它将以问候语的JSON表示形式进行响应，如以下清单所示：
~~~
{"id":1,"content":"Hello, World!"}
~~~
您可以使用可选的自定义问候语 `name` 查询字符串中的参数，如以下清单所示：
~~~
http://localhost:8080/greeting?name=User
~~~
这 `name` 参数值会覆盖默认值 `World` 并反映在响应中，如以下清单所示：
~~~
{"id":1,"content":"Hello, User!"}
~~~
## 你需要什么
* 约15分钟
* 最喜欢的文本编辑器或IDE
* [JDK 1.8](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 Initialize开始”](https://spring.io/guides/gs/rest-service/#scratch) 。
要 **跳过基础知识** ，请执行以下操作：
* [下载](https://github.com/spring-guides/gs-rest-service/archive/master.zip) 并解压缩本指南的源存储库，或使用 对其进行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-rest-service.git](https://github.com/spring-guides/gs-rest-service.git)`
* 光盘进入 `gs-rest-service/initial`
* 继续 [创建资源表示形式类](https://spring.io/guides/gs/rest-service/#initial) 。
**完成后** ，您可以根据中的代码检查结果 `gs-rest-service/complete`.
## 从Spring初始化开始
如果您使用Maven，请访问 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=rest-service&name=rest-service&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.rest-service&dependencies=web) 以生成具有所需依赖项的新项目（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](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=rest-service&name=rest-service&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.rest-service&dependencies=web) 以生成具有所需依赖项的新项目（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.spring.io](https://start.spring.io) 。 该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
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`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/bind/annotation/RestController.html) 注释，以及 `GreetingController` 在下面的清单中显示（来自 `src/main/java/com/example/restservice/GreetingController.java`）手柄 `GET` 要求 `/greeting` 通过返回一个新的实例 `Greeting` 班级：
~~~
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动词的伴随注释（例如， @PostMapping用于POST）。 还有一个 @RequestMapping 它们都源自并且可以用作同义词的注释（例如， @RequestMapping(method=GET)).
`@RequestParam` 绑定查询字符串参数的值 `name` 进入 `name` 的参数 `greeting()`方法。 如果 `name` 请求中没有参数， `defaultValue` 的 `World` 用来。
方法主体的实现创建并返回一个新的 `Greeting` 与对象 `id` 和 `content` 属性基于 `counter` 并格式化给定 `name` 通过使用问候语 `template`.
传统的MVC控制器和RESTful Web服务控制器之间的主要区别在于创建HTTP响应主体的方式。 RESTful Web服务控制器填充并返回一个 `Greeting`目的。 对象数据将作为JSON直接写入HTTP响应。
这段代码使用Spring [`@RestController`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/bind/annotation/RestController.html)批注，将类标记为控制器，其中每个方法均返回域对象而不是视图。 这是同时包含两者的简写 `@Controller` 和 `@ResponseBody`.
这 `Greeting`对象必须转换为JSON。 借助Spring的HTTP消息转换器支持，您无需手动进行此转换。 因为 [杰克逊2](https://github.com/FasterXML/jackson) 在课堂上，所以Spring的 [`MappingJackson2HttpMessageConverter`](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/http/converter/json/MappingJackson2HttpMessageConverter.html) 自动选择以转换 `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](http://localhost:8080/greeting)`，您应该在这里看到：
~~~
{"id":1,"content":"Hello, World!"}
~~~
提供一个 `name` 通过访问查询字符串参数 `[http://localhost:8080/greeting?name=User](http://localhost:8080/greeting?name=User)`。 请注意， `content` 属性更改自 `Hello, World!` 到 `Hello, User!`，如以下清单所示：
~~~
{"id":2,"content":"Hello, User!"}
~~~
此更改表明 `@RequestParam` 安排在 `GreetingController`正在按预期工作。 这 `name` 参数已赋予默认值 `World` 但可以通过查询字符串显式覆盖。
还要注意 `id` 属性已从更改 `1` 到 `2`。 这证明您正在反对同一个 `GreetingController` 跨多个请求的实例， `counter` 字段在每个呼叫上都按预期递增。
## 概括
恭喜你！ 您刚刚使用Spring开发了RESTful Web服务。
- springboot概述
- springboot构建restful服务
- spring构建一个RESTful Web服务
- spring定时任务
- 消费RESTful Web服务
- gradle构建项目
- maven构建项目
- springboot使用jdbc
- springboot应用上传文件
- 使用LDNA验证用户
- 使用 spring data redis
- 使用 spring RabbitTemplate消息队列
- 用no4j访问nosql数据库
- springboot验证web表单
- Spring Boot Actuator构j建服务
- 使用jms传递消息
- springboot创建批处理服务
- spring security保护web 安全
- 在Pivotal GemFire中访问数据
- 使用Spring Integration
- 使用springboot jpa进行数据库操作
- 数据库事务操作
- 操作mongodb
- springmvc+tymleaf创建web应用
- 将Spring Boot JAR应用程序转换为WAR
- 创建异步服务
- spring提交表单
- 使用WebSocket构建交互式Web应用程序
- 使用REST访问Neo4j数据
- jquery消费restful
- springboot跨域请求
- 消费SOAP Web服务
- springboot使用缓存
- 使用Vaadin创建CRUD UI
- 使用REST访问JPA数据
- 使用REST访问Pivotal GemFire中的数据
- 构建soap服务
- 使用rest访问mongodb数据
- 构建springboot应用docker镜像
- 从STS部署到Cloud Foundry
- springboot测试web应用
- springboot访问mysql
- springboot编写自定义模块并使用
- 使用Google Cloud Pub / Sub进行消息传递
- 构建反应式RESTful Web服务
- 使用Redis主动访问数据
- Spring Boot 部署到Kubernetes
- 使用反应式协议R2DBC访问数据
- Spring Security架构
- spring构建Docker镜像详解
- Spring Boot和OAuth2
- springboot应用部署到k8s
- spring构建rest服务详解