本指南将引导您完成使用 Spring 创建“Hello, World”超媒体驱动的 REST Web 服务的过程。

Hypermedia 是 REST 的一个重要方面。它允许您构建在很大程度上解耦客户端和服务器的服务，并让它们独立发展。为 REST 资源返回的表示不仅包含数据，还包含相关资源的链接。因此，表示的设计对于整体服务的设计至关重要。

你将构建什么

您将使用 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分钟

• 常用的文本编辑器或集成开发环境

• Java 17 或更高版本

• Gradle 7.5+ 或 Maven 3.5+

• 您还可以直接将代码导入到您的 IDE 中：

  • Spring Tool Suite (STS)

  • IntelliJ IDEA

  • VSCode

如何完成本指南

与大多数 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 开始

您可以使用这个预初始化的项目并点击生成以下载一个 ZIP 文件。该项目已配置为适合本教程中的示例。

要手动初始化项目：

1. 访问 https://start.spring.io。该服务会为您拉取应用程序所需的所有依赖项，并完成大部分设置工作。

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

3. 点击 Dependencies 并选择 Spring HATEOAS。

4. 点击 Generate。

5. 下载生成的 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。如果请求中未提供该参数，将使用默认值 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 服务。

另请参阅

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

• 构建 RESTful Web 服务

• 使用 REST 访问 GemFire 数据

• 使用 REST 访问 MongoDB 数据

• 使用 MySQL 访问数据

• 使用 REST 访问 JPA 数据

• 使用 REST 访问 Neo4j 数据

• 消费 RESTful Web 服务

• 使用 AngularJS 消费 RESTful Web 服务

• 使用 jQuery 消费 RESTful Web 服务

• 使用 rest.js 消费 RESTful Web 服务

• 保护 Web 应用程序

• 使用 Spring 构建 REST 服务

• React.js 与 Spring Data REST

• 使用 Spring Boot 构建应用程序

• 使用 Restdocs 创建 API 文档

• 为 RESTful Web 服务启用跨域请求