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

本指南将引导您完成使用Spring创建“ Hello World” Hypermedia Driven REST Web服务的过程。

超媒体是REST的重要方面。它使您可以构建使客户端和服务器在很大程度上分离并允许它们独立发展的服务。为REST资源返回的表示形式不仅包含数据，还包含指向相关资源的链接。因此，表示的设计对于整体服务的设计至关重要。

你会建立什么

您将使用Spring HATEOAS构建超媒体驱动的REST服务，这是一个API库，可用于轻松创建指向Spring MVC控制器的链接，建立资源表示并控制如何将它们呈现为受支持的超媒体格式，例如哈尔

该服务将在以下位置接受HTTP GET请求：

http://localhost:8080/greeting

并以问候语的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
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+
您还可以将代码直接导入到IDE中：
- Spring Tool Suite (STS)
- IntelliJ IDEA

如何完成本指南

像大多数Spring 入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都可以使用工作代码。

要从头开始 ，请继续使用Gradle构建。

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

下载并解压缩本指南的源存储库，或使用Git对其进行克隆：git clone https://github.com/spring-guides/gs-rest-hateoas.git
光盘进入gs-rest-hateoas/initial
继续创建资源表示形式类。

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

用Gradle构建

首先，您设置一个基本的构建脚本。在使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含使用Gradle和Maven所需的代码。如果您都不熟悉，请参阅使用Gradle 构建Java项目或使用Maven构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

创建一个Gradle构建文件

以下是最初的Gradle构建文件。

build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.1.6.RELEASE")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

bootJar {
    baseName = 'gs-rest-hateoas'
    version =  '0.1.0'
}

repositories {
    mavenCentral()
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile("org.springframework.boot:spring-boot-starter-hateoas")
    testCompile("com.jayway.jsonpath:json-path")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

Spring Boot gradle插件提供了许多方便的功能：

它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。
它搜索public static void main()标记为可运行类的方法。
它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

用Maven构建

首先，您设置一个基本的构建脚本。使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含了使用Maven所需的代码。如果您不熟悉Maven，请参阅使用Maven 构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

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>

    <groupId>org.springframework</groupId>
    <artifactId>gs-rest-hateoas</artifactId>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <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>
        <dependency>
            <groupId>com.jayway.jsonpath</groupId>
            <artifactId>json-path</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <properties>
        <java.version>1.8</java.version>
    </properties>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Spring Boot Maven插件提供了许多方便的功能：

它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。
它搜索public static void main()标记为可运行类的方法。
它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

使用您的IDE进行构建

阅读如何将本指南直接导入Spring Tool Suite中。
在IntelliJ IDEA中阅读如何使用本指南。

创建资源表示形式类

现在您已经设置了项目和构建系统，您可以创建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附带一个基类ResourceSupport允许您添加的实例Link并确保如上所示渲染它们。

因此，您只需创建一个简单的旧Java对象扩展ResourceSupport并添加内容的字段和访问器以及构造函数：

src/main/java/hello/Greeting.java

package hello;

import org.springframework.hateoas.ResourceSupport;

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

public class Greeting extends ResourceSupport {

    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。

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

创建一个RestController

在Spring构建RESTful Web服务的方法中，HTTP请求由控制器处理。组件很容易通过@RestController注释，它结合了@Controller和@ResponseBody注释。的GreetingController把手下面GET要求/greeting通过返回新的实例Greeting类：

src/main/java/hello/GreetingController.java

package hello;

import static org.springframework.hateoas.mvc.ControllerLinkBuilder.*;

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", required = false, 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()方法。

上面的例子没有指定GET与PUT ， POST ，依此类推，因为@RequestMapping默认情况下映射所有 HTTP操作。使用@RequestMapping(path="/greeting", method=RequestMethod.GET)缩小此映射。在这种情况下，您也想import org.springframework.web.bind.annotation.RequestMethod; 。

@RequestParam绑定查询字符串参数的值name进入name的参数greeting()方法。此查询字符串参数不是required ;如果请求中不存在，则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表示模型。

使应用程序可执行

尽管可以将该服务打包为传统的Web应用程序归档文件或WAR文件，以部署到外部应用程序服务器，但是下面演示的更简单的方法创建了一个独立的应用程序 。您将所有内容打包在一个可运行的JAR文件中，由一个好的旧Java驱动main()方法。在此过程中，您将使用Spring的支持将Tomcat servlet容器作为HTTP运行时嵌入，而不是部署到外部实例。

src/main/java/hello/Application.java

package hello;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

@SpringBootApplication是一个方便注释，它添加了以下所有内容：

@Configuration ：将类标记为应用程序上下文的Bean定义的源。
@EnableAutoConfiguration ：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。例如，如果spring-webmvc在类路径上，此注释将应用程序标记为Web应用程序并激活关键行为，例如设置DispatcherServlet 。
@ComponentScan ：告诉Spring在其中寻找其他组件，配置和服务hello包，让它找到控制器。

的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 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"
    }
  }
}

提供一个name使用http：// localhost：8080 / greeting？name = User查询字符串参数。请注意， content属性从“您好，世界！”到“您好，用户！和href的属性self链接也反映了这一变化：

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

此更改表明@RequestParam安排在GreetingController正在按预期工作。的name参数的默认值为“世界”，但始终可以通过查询字符串显式覆盖。

摘要

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

也可以看看

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

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

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创作共用许可证发布。