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

您将构建什么

您将使用 Spring HATEOAS 构建一个超媒体驱动的 REST 服务：这是一个 API 库，您可以使用它创建指向 Spring MVC 控制器的链接、构建资源表示形式，并控制它们如何渲染成受支持的超媒体格式（例如 HAL）。

该服务将接受对 http://localhost:8080/greeting 的 HTTP GET 请求。

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

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

响应已经表明您可以通过查询字符串中的可选 name 参数来自定义问候语，如下列表所示

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

name 参数值会覆盖默认值 World 并反映在响应中，如下列表所示

{
  "content":"Hello, User!",
  "_links":{
    "self":{
      "href":"http://localhost: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
进入 gs-rest-hateoas/initial 目录
跳至创建资源表示类。

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

从 Spring Initializr 开始

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

手动初始化项目

访问 https://start.spring.io。此服务会为您拉取应用程序所需的所有依赖项，并完成大部分设置。
选择 Gradle 或 Maven，以及您想使用的语言。本指南假定您选择了 Java。
点击 Dependencies 并选择 Spring HATEOAS。
点击 Generate。
下载生成的 ZIP 文件，这是一个根据您的选择配置好的 Web 应用程序归档。

如果您的 IDE 集成了 Spring Initializr，您可以直接在 IDE 中完成此过程。

您还可以从 Github 上 Fork 项目，然后在您的 IDE 或其他编辑器中打开。

创建资源表示类

现在您已经设置好了项目和构建系统，可以创建您的 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 实例，并确保它们像之前所示那样渲染。

创建一个继承 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。如果在请求中缺失，则使用 defaultValue 的 World。

由于类上存在 @RestController 注解，因此隐式地为 greeting 方法添加了 @ResponseBody 注解。这使得 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 文件。

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

测试服务

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

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

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

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

这一变化表明 GreetingController 中的 @RequestParam 配置按预期工作。name 参数被赋予了默认值 World，但始终可以通过查询字符串显式覆盖。

总结

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

另请参阅

以下指南可能也很有帮助

想撰写新指南或贡献现有指南？请查看我们的贡献指南。

所有指南的代码均以 ASLv2 许可证发布，而文字内容则以署名-禁止演绎创意共享许可协议发布。

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