关于spring:Spring认证指南了解如何使用-Spring-创建超媒体驱动的-RESTful-Web-服务

Spring认证指南-理解如何应用 Spring 创立超媒体驱动的 RESTful Web 服务。（Spring中国教育管理中心）

Spring认证：理解如何应用 Spring 创立超媒体驱动的 RESTful Web 服务
构建超媒体驱动的 RESTful Web 服务
本指南将疏导您实现应用 Spring 创立“Hello, World”超媒体驱动的 REST Web 服务的过程。

超媒体是 REST 的一个重要方面。它使您能够构建在很大水平上解耦客户端和服务器的服务，并让它们独立倒退。为 REST 资源返回的示意不仅蕴含数据，还蕴含指向相干资源的链接。因而，示意的设计对于整体服务的设计至关重要。

你将建造什么
您将应用 Spring HATEOAS 构建一个超媒体驱动的 REST 服务：一个 API 库，可用于创立指向 Spring MVC 控制器的链接、构建资源示意并管制如何将它们出现为反对的超媒体格式（例如 HAL ）。

该服务将承受 HTTP GET 申请
http://localhost:8080/greeting。

它将以 JSON 示意的问候进行响应，该问候富含最简略的超媒体元素，即指向资源自身的链接。以下清单显示了输入：

{
"content":"Hello, World!",
"_links":{

"self":{  "href":"http://localhost:8080/greeting?name=World"}

}
}
响应曾经表明您能够应用name查问字符串中的可选参数自定义问候语，如以下清单所示：

http://localhost:8080/greetin...
name参数值笼罩默认值World并反映在响应中，如以下清单所示：

{
"content":"Hello, User!",
"_links":{

"self":{  "href":"http://localhost:8080/greeting?name=User"}

}
}
你须要什么
约15分钟
最喜爱的文本编辑器或 IDE
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+
您还能够将代码间接导入 IDE：
弹簧工具套件 (STS)
IntelliJ IDEA
如何实现本指南
像大多数 Spring入门指南一样，您能够从头开始并实现每个步骤，也能够绕过您曾经相熟的根本设置步骤。无论哪种形式，您最终都会失去工作代码。

要从头开始，请持续从 Spring Initializr 开始。

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

下载并解压本指南的源代码库，或应用Git克隆它：git clone https://github.com/spring-gui...
光盘进入gs-rest-hateoas/initial
持续创立资源示意类。
实现后，您能够对照中的代码查看后果gs-rest-hateoas/complete。

从 Spring Initializr 开始
您能够应用这个事后初始化的我的项目并单击 Generate 下载 ZIP 文件。此我的项目配置为适宜本教程中的示例。

手动初始化我的项目：

导航到https://start.spring.io。该服务提取应用程序所需的所有依赖项，并为您实现大部分设置。
抉择 Gradle 或 Maven 以及您要应用的语言。本指南假设您抉择了 Java。
单击Dependencies并抉择Spring HATEOAS。
单击生成。
下载生成的 ZIP 文件，该文件是依据您的抉择配置的 Web 应用程序的存档。
如果您的 IDE 具备 Spring Initializr 集成，您能够从您的 IDE 实现此过程。

你也能够从 Github 上 fork 我的项目并在你的 IDE 或其余编辑器中关上它。

增加 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.6.3</version>    <relativePath/> <!-- lookup parent from repository --></parent><groupId>com.example</groupId><artifactId>rest-hateoas-complete</artifactId><version>0.0.1-SNAPSHOT</version><name>rest-hateoas-complete</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-hateoas</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 构建中蕴含该库，请将以下依赖项增加到您的build.gradle文件中：

testCompile 'com.jayway.jsonpath:json-path'复制
以下清单显示了实现的build.gradle文件：

plugins {

id 'org.springframework.boot' version '2.6.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-hateoas'testImplementation 'org.springframework.boot:spring-boot-starter-test'

}

test {

useJUnitPlatform()

}
创立资源示意类
当初您曾经设置了我的项目和构建零碎，您能够创立您的 Web 服务。

从思考服务交互开始这个过程。

该服务将公开一个资源/greeting来解决GET申请，能够抉择name在查问字符串中应用一个参数。该GET申请应200 OK在注释中返回带有 JSON 的响应以示意问候。

除此之外，资源的 JSON 示意将通过_links属性中的超媒体元素列表进行丰盛。最根本的模式是指向资源自身的链接。该示意应相似于以下列表：

{
"content":"Hello, World!",
"_links":{

"self":{  "href":"http://localhost:8080/greeting?name=World"}

}
}
content是问候语的文本示意。该_links元素蕴含一个链接列表（在这种状况下，正是一个具备关系类型rel和href指向所拜访资源的属性的链接）。

要对问候示意建模，请创立一个资源示意类。因为该_links属性是示意模型的根本属性，因而 Spring HATEOAS 附带了一个基类（称为RepresentationModel），它容许您增加实例Link并确保它们如前所示出现。

创立一个一般的旧 java 对象，该对象扩大RepresentationModel和增加内容的字段和拜访器以及构造函数，如以下清单（来自
src/main/java/com/example/resthateoas/Greeting.java）所示：

package com.example.resthateoas;

import org.springframework.hateoas.RepresentationModel;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

public class Greeting extends RepresentationModel<Greeting> {

private final String content;@JsonCreatorpublic Greeting(@JsonProperty("content") String content) {    this.content = content;}public String getContent() {    return content;}

}
@JsonCreator：批示杰克逊如何创立此 POJO 的实例。
@JsonProperty：标记杰克逊应该将此结构函数参数放入的字段。
正如您将在本指南前面看到的那样，Spring 将应用 Jackson JSON 库将类型的实例主动编组Greeting为 JSON。

接下来，创立将提供这些问候语的资源控制器。

创立 REST 控制器
在 Spring 构建 RESTful Web 服务的办法中，HTTP 申请由控制器解决。组件由@RestController正文标识，该正文联合了@Controller和@ResponseBody正文。以下GreetingController（来自）通过返回类的新实例来
src/main/java/com/example/resthateoas/GreetingController.java解决GET申请：/greetingGreeting

package com.example.resthateoas;

import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.*;

import org.springframework.http.HttpEntity;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

@RestController
public class GreetingController {

private static final String TEMPLATE = "Hello, %s!";@RequestMapping("/greeting")public HttpEntity<Greeting> greeting(    @RequestParam(value = "name", defaultValue = "World") String name) {    Greeting greeting = new Greeting(String.format(TEMPLATE, name));    greeting.add(linkTo(methodOn(GreetingController.class).greeting(name)).withSelfRel());    return new ResponseEntity<>(greeting, HttpStatus.OK);}

}
这个控制器简洁明了，然而有很多事件要做。咱们一步一步合成。

@RequestMapping正文确保 HTTP 申请/greeting映射到greeting()办法。

下面的例子没有指定GETvs. PUT,POST等等，因为默认@RequestMapping映射所有的 HTTP 操作。用于@GetMapping("/greeting")放大此映射。在这种状况下，您还想import
org.springframework.web.bind.annotation.GetMapping;.

@RequestParam将查问字符串参数的值绑定name到办法的name参数中greeting()。这个查问字符串参数隐含不是required因为应用了defaultValue属性。如果申请中不存在，则应用defaultValueof World。

因为@RestController正文存在于类上，所以将隐式@ResponseBody正文增加到greeting办法中。这会导致 Spring MVC 将返回HttpEntity的及其无效负载 (the Greeting) 间接出现给响应。

办法实现中最乏味的局部是如何创立指向控制器办法的链接以及如何将其增加到示意模型中。两者linkTo(…)和methodOn(…)都是静态方法，ControllerLinkBuilder可让您伪造控制器上的办法调用。返回的LinkBuilder将查看控制器办法的映射正文以精确构建该办法映射到的 URI。

Spring HATEOAS 尊重各种X-FORWARDED-标头。如果您将 Spring HATEOAS 服务放在代理前面并应用标头正确配置它X-FORWARDED-HOST，则生成的链接将被正确格式化。

调用withSelfRel()创立Link您增加到Greeting示意模型的实例。

@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-hateoas-0.1.0.jar
如果您应用 Maven，则能够应用./mvnw spring-boot:run. 或者，您能够应用构建 JAR 文件，./mvnw clean package而后运行该 JAR 文件，如下所示：

java -jar 指标/gs-rest-hateoas-0.1.0.jar
此处形容的步骤创立了一个可运行的 JAR。您还能够构建经典的 WAR 文件。

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

测试服务
当初服务曾经启动，拜访
http://localhost:8080/greeting，您应该会看到以下内容：

{
"content":"Hello, World!",
"_links":{

"self":{  "href":"http://localhost:8080/greeting?name=World"}

}
}
name通过拜访以下 URL提供查问字符串参数：
http://localhost:8080/greetin...。请留神属性的值如何content从Hello, World!to更改，Hello, User!并且链接的href属性也self反映了该更改，如以下清单所示：

{
"content":"Hello, User!",
"_links":{

"self":{  "href":"http://localhost:8080/greeting?name=User"}

}
}
这一变动表明，@RequestParam安顿GreetingController按预期工作。该name参数已被赋予默认值，World但始终能够通过查问字符串显式笼罩。

概括
祝贺！您刚刚应用 Spring HATEOAS 开发了一个超媒体驱动的 RESTful Web 服务。