使用 REST 访问 JPA 数据

时间：2022-12-22 18:04:21

使用 REST 访问 JPA 数据

本指南将引导您完成创建应用程序的过程，该应用程序通过基于超媒体​ 宁静前端。

您将构建什么

您将构建一个 Spring 应用程序，该应用程序允许您使用 Spring Data REST 创建和检索存储在数据库中的对象。 Spring Data REST 具有以下功能：​​Person​​春天的哈特亚斯和春季数据 JPA并自动将它们组合在一起。

Spring Data REST 还支持弹簧数据 Neo4j,春天数据宝石火和春季数据 MongoDB作为后端数据存储，但这些不是本指南的一部分。

你需要什么

  • 约15分钟
  • 最喜欢的文本编辑器或 IDE
  • JDK 1.8或以后
  • 格拉德尔 4+​或梅文 3.2+
  • 您也可以将代码直接导入到 IDE 中：
  • 弹簧工具套件 （STS）
  • 智能理念
  • VSCode

如何完成本指南

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

要从头开始，请继续从 Spring 初始化开始.

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

  • 下载​并解压缩本指南的源存储库，或使用吉特:git clone https://github.com/spring-guides/gs-accessing-data-rest.git
  • 光盘成gs-accessing-data-rest/initial
  • 跳转到创建域对象.

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

从 Spring 初始化开始

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

手动初始化项目：

  1. 导航到https://start.spring.io.此服务拉入应用程序所需的所有依赖项，并为您完成大部分设置。
  2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
  3. 单击依赖关系，然后选择休息存储库、Spring 数据 JPA 和 H2 数据库。
  4. 单击生成。
  5. 下载生成的 ZIP 文件，该文件是配置了您选择的 Web 应用程序的存档。

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

您也可以从 Github 分叉项目，然后在 IDE 或其他编辑器中打开它。

创建域对象

创建一个新的域对象来呈现人员，如以下清单（在 中）所示：​​src/main/java/com/example/accessingdatarest/Person.java​​

package com.example.accessingdatarest;

import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;

@Entity
public class Person {

  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  private long id;

  private String firstName;
  private String lastName;

  public String getFirstName() {
    return firstName;
  }

  public void setFirstName(String firstName) {
    this.firstName = firstName;
  }

  public String getLastName() {
    return lastName;
  }

  public void setLastName(String lastName) {
    this.lastName = lastName;
  }
}

对象具有名字和姓氏。（还有一个配置为自动生成的 ID 对象，因此您无需处理它。​​Person​​

创建个人存储库

接下来，您需要创建一个简单的存储库，如以下列表 （in ） 所示：​​src/main/java/com/example/accessingdatarest/PersonRepository.java​​

package com.example.accessingdatarest;

import java.util.List;

import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

@RepositoryRestResource(collectionResourceRel = "people", path = "people")
public interface PersonRepository extends PagingAndSortingRepository<Person, Long>, CrudRepository<Person,Long> {

  List<Person> findByLastName(@Param("name") String name);

}

此存储库是一个界面，可让您执行涉及对象的各种操作。它通过扩展​​Person​​PagingAndSortingRepository在 Spring 数据共享中定义的接口。

在运行时，Spring Data REST 会自动创建此接口的实现。然后它使用@RepositoryRestResource注释以指示 Spring MVC 在 创建 RESTful 端点。​​/people​​

​​@RepositoryRestResource​​​不是要导出的存储库所必需的。它仅用于更改导出详细信息，例如使用 而不是默认值 。​​/people​​​​/persons​​

在这里，您还定义了一个自定义查询，以检索基于 .您可以在本指南的后面部分了解如何调用它。​​Person​​​​lastName​​

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

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

该方法使用 Spring Boot 的方法启动应用程序。您是否注意到没有一行 XML？也没有文件。此 Web 应用程序是 100% 纯 Java，您无需处理配置任何管道或基础结构。​​main()​​​​SpringApplication.run()​​​​web.xml​​

Spring Boot 会自动启动 Spring Data JPA 以创建 的具体实现，并将其配置为使用 JPA 与后端内存数据库通信。​​PersonRepository​​

Spring Data REST建立在Spring MVC之上。它创建了一个Spring MVC控制器，JSON转换器和其他bean的集合，以提供RESTful前端。这些组件链接到Spring Data JPA后端。当您使用 Spring 引导时，这一切都是自动配置的。如果你想研究它是如何工作的，通过查看Spring Data REST。​​RepositoryRestMvcConfiguration​​

构建可执行的 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必需依赖项、类和资源的可执行 JAR 文件并运行该文件。通过构建可执行 jar，可以轻松地在整个开发生命周期中跨不同环境等将服务作为应用程序进行交付、版本控制和部署。

如果使用 Gradle，则可以使用 .或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：​​./gradlew bootRun​​​​./gradlew build​​

java -jar build/libs/gs-accessing-data-rest-0.1.0.jar

如果使用 Maven，则可以使用 运行应用程序。或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：​​./mvnw spring-boot:run​​​​./mvnw clean package​​

java -jar target/gs-accessing-data-rest-0.1.0.jar

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

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

测试应用程序

现在应用程序正在运行，您可以对其进行测试。您可以使用任何您想要的 REST 客户端。以下示例使用 *nix 工具 .​​curl​​

首先，您希望查看*服务。以下示例演示如何执行此操作：

$ curl http://localhost:8080
{
  "_links" : {
    "people" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    }
  }
}

前面的示例提供了此服务器必须提供的功能的第一瞥。有一个链接位于 。它有一些选项，例如、 和 。​​people​​​​http://localhost:8080/people​​​​?page​​​​?size​​​​?sort​​

Spring Data REST 使用HAL 格式用于 JSON 输出。它非常灵活，并提供了一种提供与所提供数据相邻的链接的便捷方法。

以下示例演示如何查看人员记录（目前无）：

$ curl http://localhost:8080/people
{
  "_embedded" : {
    "people" : []
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

目前没有元素，因此没有页面。是时候创建一个新的 ！以下清单显示了如何执行此操作：​​Person​​

$ curl -i -H "Content-Type:application/json" -d '{"firstName": "Frodo", "lastName": "Baggins"}' http://localhost:8080/people
HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Location: http://localhost:8080/people/1
Content-Length: 0
Date: Wed, 26 Feb 2014 20:26:55 GMT
  • ​​-i​​：确保您可以看到包含标头的响应消息。将显示新创建的 URI。Person
  • ​​-H "Content-Type:application/json"​​：设置内容类型，以便应用程序知道有效负载包含 JSON 对象。
  • ​​-d '{"firstName": "Frodo", "lastName": "Baggins"}'​​：是否正在发送数据。
  • 如果您使用的是 Windows，则上面的命令将适用于唰唰��.如果无法安装 WSL，则可能需要将单引号替换为双引号并转义现有的双引号，即 .-d "{\"firstName\": \"Frodo\", \"lastName\": \"Baggins\"}"

请注意对操作的响应如何包含标头。这包含新创建的资源的 URI。Spring Data REST 还有两个方法（ 和 ），您可以使用它们来配置框架以立即返回刚刚创建的资源的表示。 是为创建和更新操作启用制图表达响应的快捷方式方法。​​POST​​​​Location​​​​RepositoryRestConfiguration.setReturnBodyOnCreate(…)​​​​setReturnBodyOnUpdate(…)​​​​RepositoryRestConfiguration.setReturnBodyForPutAndPost(…)​​

您可以查询所有人，如以下示例所示：

$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "_embedded" : {
    "people" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/1"
        }
      }
    } ]
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

该对象包含一个列表，其中包括 。请注意它如何包含一个链接。Spring Data REST 也使用​​people​​​​Frodo​​​​self​​埃沃变形器复数化分组的实体名称。

您可以直接查询单个记录，如下所示：

$ curl http://localhost:8080/people/1
{
  "firstName" : "Frodo",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/1"
    }
  }
}

这可能看起来纯粹是基于 Web 的。但是，在幕后，有一个 H2 关系数据库。在生产中，你可能会使用一个真正的，比如PostgreSQL。


在本指南中，只有一个域对象。对于更复杂的系统，其中域对象彼此相关，Spring Data REST呈现其他链接以帮助导航到连接的记录。

您可以找到所有自定义查询，如以下示例所示：

$ curl http://localhost:8080/people/search
{
  "_links" : {
    "findByLastName" : {
      "href" : "http://localhost:8080/people/search/findByLastName{?name}",
      "templated" : true
    }
  }
}

您可以看到查询的 URL，包括 HTTP 查询参数 。请注意，这与界面中嵌入的注释匹配。​​name​​​​@Param("name")​​

下面的示例演示如何使用查询：​​findByLastName​​

$ curl http://localhost:8080/people/search/findByLastName?name=Baggins
{
  "_embedded" : {
    "persons" : [ {
      "firstName" : "Frodo",
      "lastName" : "Baggins",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/people/1"
        }
      }
    } ]
  }
}

由于已将其定义为在代码中返回，因此它将返回所有结果。如果你已将其定义为仅返回，它将选取其中一个要返回的对象。由于这可能是不可预测的，因此您可能不希望对可以返回多个条目的查询执行此操作。​​List<Person>​​​​Person​​​​Person​​

您还可以发出 、 和 REST 调用来替换、更新或删除现有记录（分别）。以下示例使用调用：​​PUT​​​​PATCH​​​​DELETE​​​​PUT​​

$ curl -X PUT -H "Content-Type:application/json" -d '{"firstName": "Bilbo", "lastName": "Baggins"}' http://localhost:8080/people/1
$ curl http://localhost:8080/people/1
{
  "firstName" : "Bilbo",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/1"
    }
  }
}

以下示例使用调用：​​PATCH​​

$ curl -X PATCH -H "Content-Type:application/json" -d '{"firstName": "Bilbo Jr."}' http://localhost:8080/people/1
$ curl http://localhost:8080/people/1
{
  "firstName" : "Bilbo Jr.",
  "lastName" : "Baggins",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/1"
    }
  }
}

​​PUT​​​替换整个记录。未提供的字段将替换为 。您可以使用 更新项目的子集。​​null​​​​PATCH​​

您还可以删除记录，如以下示例所示：

$ curl -X DELETE http://localhost:8080/people/1
$ curl http://localhost:8080/people
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people{?page,size,sort}",
      "templated" : true
    },
    "search" : {
      "href" : "http://localhost:8080/people/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 0,
    "totalPages" : 0,
    "number" : 0
  }
}

这个超媒体驱动接口的一个方便的方面是，你可以使用 curl（或任何你喜欢的 REST 客户端）发现所有的 RESTful 端点。您无需与客户交换正式合同或接口文档。

总结

祝贺！您开发了一个应用程序，其中包含基于超媒体RESTful 前端和基于 JPA 的后端。

标签：

相关文章