Spring Boot和Spring Data REST –通过REST公开存储库

logo-spring-io

使用Spring Boot和Spring Data REST，通过REST公开Spring Data存储库非常容易。使用最少的代码，您可以创建遵循HATEOAS原理的JPA实体的REST表示。我决定重用Spring PetClinic的JPA实体（业务层）作为本文的基础。

应用基础

PetClinic的模型相对简单，但是它包含一些单向和双向关联以及基本继承：

sbdr-petclinic图

此外，Spring的PetClinic为HSQLDB提供了SQL脚本，这使得在我的新应用程序中生成模式并用示例数据填充它非常容易。

项目依赖

作为配置的基础，我使用了Spring Initializr并生成了一个基本的Gradle项目。为了在Spring Boot应用程序中利用Spring Data REST，我添加了以下Boot Starters：

compile("org.springframework.boot:spring-boot-starter-web")
compile("org.springframework.boot:spring-boot-starter-data-jpa")
compile("org.springframework.boot:spring-boot-starter-data-rest")

另外，我在项目中添加了HSQLDB依赖项：

compile("org.hsqldb:hsqldb:2.3.2")

原始项目使用org.joda.time.DateTime作为日期字段，并使用org.jadira.usertype.dateandtime.joda.PersistentDateTime将其与Hibernate持久化。为了能够在新项目中使用它，我需要添加以下依赖项：

compile("joda-time:joda-time:2.4")
compile("org.jadira.usertype:usertype.jodatime:2.0.1")

使用API时，我注意到尽管原始项目中的date字段使用Spring的@DateTimeFormat进行了注释， @DateTimeFormat它们并未正确序列化。我发现我需要使用@JsonFormatter ，因此另一个依赖项被添加到build.gradle ：

compile("com.fasterxml.jackson.datatype:jackson-datatype-joda:2.4.2");

进入类路径后，Spring Boot将通过org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration自动配置com.fasterxml.jackson.datatype.joda.JodaModule 。

请注意，如果要正确序列化Java 8日期和时间类型，则需要向项目添加Jackson数据类型JSR310依赖项。

初始化数据库

为了初始化数据源，我在src/main/resources添加了schema-hsqldb.sql和data-hsqldb.sql文件。最后，我将几个属性添加到application.properties ：

spring.datasource.platform = hsqldbspring.jpa.generate-ddl = falsespring.jpa.hibernate.ddl-auto = none

现在，在应用程序启动时，将自动拾取文件，并初始化数据源，并且由于有数据，发现 API会容易得多！

储存库

Spring Data REST的一般思想是在Spring Data存储库的基础上构建并自动将其导出为REST资源 。我创建了几个存储库，每个实体一个（ OwnerRepository ， PetRepository等）。所有存储库都是从PagingAndSortingRepository扩展的Java接口。

在此阶段不需要其他代码：不需要@Controller ，不需要配置（除非需要自定义）。 Spring Boot将自动为我们配置所有内容。

运行应用程序

有了整个配置，就可以执行项目（您将在文章底部找到指向整个项目的链接）。如果幸运的话，该应用程序将启动，您可以导航到http://localhost:8080 ，它指向指向所有可用资源（ 根资源 ）的链接的集合。响应的内容类型为。

哈尔

资源以Hypermedia样式实现，默认情况下，Spring Data REST使用HAL和内容类型为application/hal+json来呈现响应。 HAL是一种简单的格式，提供了一种链接资源的简便方法。例：

$ curl localhost:8080/owners/1
{"firstName" : "George","lastName" : "Franklin","_links" : {"self" : {"href" : "http://localhost:8080/owners/1"},"pets" : {"href" : "http://localhost:8080/owners/1/pets"}}
}

就Spring Data REST而言，有几种类型的资源：集合，项目，搜索，查询方法和关联，并且都在响应中利用了application/hal+json内容类型。

馆藏和物品资源

集合资源支持GET和POST方法。项目资源通常支持GET ， PUT ， PATCH和DELETE方法。注意， PATCH应用随请求主体发送的值，而PUT替换资源。

搜索和查找方法资源

搜索资源返回存储库公开的所有查询方法的链接，而查询方法资源执行通过存储库界面上的单个查询方法公开的查询。两者都是只读的，因此仅支持GET方法。

为了可视化，我向OwnerRepository添加了find方法：

List<Owner> findBylastName(@Param("lastName") String lastName);

然后在http://localhost:8080/owners/search下公开：

$ curl http://localhost:8080/owners/search                                     
{                                                                              "_links" : {                                                                 "findBylastName" : {                                                       "href" : "http://localhost:8080/owners/search/findBylastName{?lastName}","templated" : true                                                       }                                                                          }                                                                            
}

协会资源

Spring Data REST自动公开子资源。关联资源支持GET ， POST和PUT方法。

并允许对其进行管理。使用关联时，您需要了解文本/ uri-list内容类型。具有这种内容类型的请求包含一个或多个URI（ 每个URI应该出现在一行中，并且只有一行 ）要添加到关联中的资源。

在第一个示例中，我们将研究Vet类中的单向关系：

@ManyToMany(fetch = FetchType.EAGER)
@JoinTable(name = "vet_specialties", joinColumns = @JoinColumn(name = "vet_id"),inverseJoinColumns = @JoinColumn(name = "specialty_id"))
private Set<Specialty> specialties;

为了将现有的专业添加到兽医的专业集合中，必须执行PUT请求：

curl -i -X PUT -H "Content-Type:text/uri-list" -d $'http://localhost:8080/specialties/1\nhttp://localhost:8080/specialties/2' http://localhost:8080/vets/1/specialties

可以使用DELETE方法删除关联，如下所示：

curl -i -X DELETE http://localhost:8080/vets/1/specialties/2

让我们看另一个例子：

// Owner
@OneToMany(mappedBy = "owner", cascade = CascadeType.ALL, orphanRemoval = true)
private Set<Pet> pets;// Pet
@ManyToOne(cascade = CascadeType.ALL, optional = false)
@JoinColumn(name = "owner_id")
private Owner owner;

设置宠物主人可以通过以下请求完成：

curl -i -X PUT -H "Content-Type:text/uri-list" -d "http://localhost:8080/owners/1" http://localhost:8080/pets/2/owner

但是如何移除所有者呢？由于必须始终为宠物设置所有者，因此在尝试使用以下命令取消设置时，我们会收到HTTP/1.1 409 Conflict ：

curl -i -X DELETE http://localhost:8080/pets/2/owner

整合测试

使用Spring Boot，可以在测试中启动Web应用程序，并使用Spring Boot的@IntegrationTest对其进行验证。我们将使用RestTemplate及其Spring Boot的实现来验证实际的REST调用，而不是使用MockMvc服务器端Web应用程序上下文（ MockMvc ）。

众所周知，资源的类型为application/hal+json 。因此实际上，将它们直接反序列化为实体对象（例如Owner ）是不可能的。相反，必须将其反序列化为org.springframework.hateoas.Resource ，以包装实体并为其添加链接。而且，由于Resource是一个通用型ParameterizedTypeReference必须使用RestTemplate 。

以下示例将其可视化：

private RestTemplate restTemplate = new TestRestTemplate();@Test
public void getsOwner() {String ownerUrl = "http://localhost:9000/owners/1";ParameterizedTypeReference<Resource<Owner>> responseType = new ParameterizedTypeReference<Resource<Owner>>() {};ResponseEntity<Resource<Owner>> responseEntity =restTemplate.exchange(ownerUrl, GET, null, responseType);Owner owner = responseEntity.getBody().getContent();assertEquals("George", owner.getFirstName());// more assertions}

下一篇文章对此方法进行了很好的描述：使用Spring RestTemplate和Super类型令牌使用Spring-hateoas Rest服务

摘要

通过几个步骤以及Spring Boot和Spring Data REST的强大功能，我为现有PetClinic的数据库创建了API。使用Spring Data REST可以做更多的事情（例如自定义），除了文档不多，与其他Spring项目相比，Spring Data REST似乎可以大大加快开发速度。我认为，这是一个需要快速原型制作的好项目。