入门 | 构建超媒体驱动的 RESTful Web 服务

你将构建什么

你将使用 Spring HATEOAS 构建超媒体驱动的 REST 服务：一个 API 库，你可以使用它来创建指向 Spring MVC 控制器、构建资源表示以及控制如何将它们呈现为受支持的超媒体格式（例如 HAL）的链接。

该服务将在 https://127.0.0.1:8080/greeting 接受 HTTP GET 请求。

它将以 JSON 表示形式响应一个问候语，该问候语使用最简单的超媒体元素（指向资源本身的链接）进行了丰富。以下清单显示了输出

{
  "content":"Hello, World!",
  "_links":{
    "self":{
      "href":"https://127.0.0.1:8080/greeting?name=World"
    }
  }
}

响应已表明您可以使用查询字符串中的可选 name 参数自定义问候语，如下面的清单所示

https://127.0.0.1:8080/greeting?name=User

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

{
  "content":"Hello, User!",
  "_links":{
    "self":{
      "href":"https://127.0.0.1:8080/greeting?name=User"
    }
  }
}

您需要准备的

大约 15 分钟
您最喜欢的文本编辑器或 IDE
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您还可以直接将代码导入 IDE

如何完成本指南

与大多数 Spring 入门指南一样，您可以从头开始完成每一步，或者跳过您已熟悉的设置步骤。无论哪种方式，您最终都会得到可用的代码。

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

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

下载并解压本指南的源代码存储库，或使用 Git 克隆它：git clone https://github.com/spring-guides/gs-rest-hateoas.git
cd 到 gs-rest-hateoas/initial
跳转到创建资源表示类。

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

从 Spring Initializr 开始

您可以使用这个预初始化项目，然后单击生成以下载 ZIP 文件。此项目已配置为适合本教程中的示例。

要手动初始化项目

导航到 https://start.spring.io。此服务会提取应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您要使用的语言。本指南假设您选择了 Java。
单击依赖项并选择Spring HATEOAS。
单击生成。
下载生成的 ZIP 文件，该文件是根据您的选择配置的 Web 应用程序的存档。

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

您还可以从 Github 分叉项目并在 IDE 或其他编辑器中打开它。

创建资源表示类

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

从考虑服务交互开始此过程。

该服务将在 /greeting 处公开一个资源来处理 GET 请求，也可以在查询字符串中使用 name 参数。GET 请求应返回 200 OK 响应，其中正文为 JSON，以表示问候语。

除此之外，资源的 JSON 表示将通过 _links 属性中的超媒体元素列表进行丰富。最基本的格式是一个指向资源自身的链接。表示应类似于以下列表

{
  "content":"Hello, World!",
  "_links":{
    "self":{
      "href":"https://127.0.0.1:8080/greeting?name=World"
    }
  }
}

content 是问候语的文本表示。_links 元素包含一个链接列表（在本例中，恰好有一个关系类型为 rel，href 属性指向所访问的资源）。

要对问候语表示进行建模，请创建一个资源表示类。由于 _links 属性是表示模型的基本属性，因此 Spring HATEOAS 附带一个基类（称为 RepresentationModel），它允许您添加 Link 实例并确保它们按前面所示进行呈现。

创建一个扩展 RepresentationModel 的普通旧 Java 对象，并添加内容的字段和访问器以及构造函数，如下面的列表（来自 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;

	@JsonCreator
	public Greeting(@JsonProperty("content") String content) {
		this.content = content;
	}

	public String getContent() {
		return content;
	}
}

@JsonCreator：表示 Jackson 如何创建此 POJO 的实例。
@JsonProperty：标记 Jackson 应将此构造函数参数放入其中的字段。

如您在本指南的后面部分中所见，Spring 将使用 Jackson JSON 库自动将 Greeting 类型的实例编组到 JSON 中。

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

创建 REST 控制器

在 Spring 构建 RESTful Web 服务的方法中，HTTP 请求由控制器处理。组件由 @RestController 注释标识，该注释结合了 @Controller 和 @ResponseBody 注释。以下 GreetingController（来自 src/main/java/com/example/resthateoas/GreetingController.java）通过返回 Greeting 类的实例来处理 /greeting 的 GET 请求

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

上述示例未指定 GET 与 PUT、POST 等方法，因为 @RequestMapping 默认映射所有 HTTP 操作。使用 @GetMapping("/greeting") 来缩小此映射范围。在这种情况下，您还需要 import org.springframework.web.bind.annotation.GetMapping;。

@RequestParam 将查询字符串参数 name 的值绑定到 greeting() 方法的 name 参数中。由于使用了 defaultValue 属性，此查询字符串参数隐式地不是 required。如果请求中不存在此参数，则使用 World 的 defaultValue。

由于类中存在 @RestController 注释，因此会将隐式 @ResponseBody 注释添加到 greeting 方法中。这会导致 Spring MVC 将返回的 HttpEntity 及其有效负载（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 运行应用程序。或者，你可以使用 ./gradlew build 构建 JAR 文件，然后运行 JAR 文件，如下所示

java -jar build/libs/gs-rest-hateoas-0.1.0.jar

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

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

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

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

测试服务

现在服务已启动，访问 https://127.0.0.1:8080/greeting，您应该看到以下内容

{
  "content":"Hello, World!",
  "_links":{
    "self":{
      "href":"https://127.0.0.1:8080/greeting?name=World"
    }
  }
}

通过访问以下 URL 提供 name 查询字符串参数：https://127.0.0.1:8080/greeting?name=User。注意 content 属性的值如何从 Hello, World! 更改为 Hello, User!，并且 self 链接的 href 属性也反映了该更改，如下所示

{
  "content":"Hello, User!",
  "_links":{
    "self":{
      "href":"https://127.0.0.1:8080/greeting?name=User"
    }
  }
}

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

摘要

恭喜！您刚刚使用 Spring HATEOAS 开发了一个超媒体驱动的 RESTful Web 服务。

另请参阅

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

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

所有指南均针对代码发布 ASLv2 许可证，并针对写作发布署名、禁止派生作品的知识共享许可证。

构建超媒体驱动的 RESTful Web 服务