你会建立什么
您将构建一个Spring应用程序,用于创建和检索Person
使用Spring Data REST存储在数据库中的对象。 Spring Data REST具有Spring HATEOAS和Spring Data JPA的功能,并将它们自动组合在一起。
Spring Data REST还支持将Spring Data Neo4j , Spring Data Gemfire和Spring Data MongoDB作为后端数据存储,但是这些都不属于本指南的一部分。 |
你需要什么
-
约15分钟
-
最喜欢的文本编辑器或IDE
-
JDK 1.8或更高版本
-
您还可以将代码直接导入到IDE中:
如何完成本指南
像大多数Spring 入门指南一样,您可以从头开始并完成每个步骤,也可以绕过您已经熟悉的基本设置步骤。无论哪种方式,您最终都可以使用工作代码。
要从头开始 ,请继续进行“ 从Spring Initializr开始” 。
要跳过基础知识 ,请执行以下操作:
-
下载并解压缩本指南的源存储库,或使用Git对其进行克隆:
git clone https://github.com/spring-guides/gs-accessing-data-rest.git
-
光盘进入
gs-accessing-data-rest/initial
-
继续创建域对象 。
完成后 ,您可以根据中的代码检查结果gs-accessing-data-rest/complete
。
从Spring Initializr开始
对于所有Spring应用程序,您应该从Spring Initializr开始。Initializr提供了一种快速的方法来提取应用程序所需的所有依赖关系,并为您完成了许多设置。此示例需要其余存储库,Spring Data JPA和H2依赖项。下图显示了此示例项目的Initializr设置:

上图显示了选择Maven作为构建工具的Initializr。您也可以使用Gradle。它还显示了com.example 和accessing-data-rest 分别是Group和Artifact。在本示例的其余部分中,将使用这些值。 |
以下清单显示了pom.xml
选择Maven时创建的文件:
<?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> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.7.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.example</groupId> <artifactId>accessing-data-rest</artifactId> <version>0.0.1-SNAPSHOT</version> <name>accessing-data-rest</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-rest</artifactId> </dependency> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
以下清单显示了build.gradle
选择Gradle时创建的文件:
plugins { id 'org.springframework.boot' version '2.1.7.RELEASE' id 'io.spring.dependency-management' version '1.0.8.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-data-jpa' implementation 'org.springframework.boot:spring-boot-starter-data-rest' runtimeOnly 'com.h2database:h2' testImplementation 'org.springframework.boot:spring-boot-starter-test' }
创建一个域对象
创建一个新的域对象来呈现一个人,如下清单(在src/main/java/com/example/accessingdatarest/Person.java
)显示:
package com.example.accessingdatarest;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.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;
}
}
的Person
对象具有名字和姓氏。(还有一个配置为自动生成的ID对象,因此您无需进行处理。)
创建个人资料库
接下来,您需要创建一个简单的存储库,如下清单(在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.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
@RepositoryRestResource(collectionResourceRel = "people", path = "people")
public interface PersonRepository extends PagingAndSortingRepository<Person, Long> {
List<Person> findByLastName(@Param("name") String name);
}
该存储库是一个界面,可让您执行各种操作,包括Person
对象。它通过扩展PagingAndSortingRepository
Spring Data Commons中定义的接口。
在运行时,Spring Data REST自动创建此接口的实现。然后,它使用@RepositoryRestResource批注指示Spring MVC在以下位置创建RESTful端点/people
。
@RepositoryRestResource 不需要导出存储库。它仅用于更改导出详细信息,例如使用/people 而不是默认值/persons 。 |
在这里,您还定义了一个自定义查询来检索以下内容的列表Person
基于的对象lastName
。您可以在本指南的后面部分中看到如何调用它。
@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,因此您无需处理任何管道或基础结构。
Spring Boot自动启动Spring Data JPA,以创建PersonRepository
并将其配置为使用JPA与后端内存数据库进行对话。
Spring Data REST建立在Spring MVC之上。它创建了Spring MVC控制器,JSON转换器和其他bean的集合,以提供RESTful前端。这些组件链接到Spring Data JPA后端。当您使用Spring Boot时,这些都是自动配置的。如果您想查看其工作原理,请查看RepositoryRestMvcConfiguration
在Spring Data REST中。
构建可执行的JAR
您可以使用Gradle或Maven从命令行运行该应用程序。您还可以构建一个包含所有必需的依赖项,类和资源的可执行JAR文件,然后运行该文件。构建可执行的jar使得在整个开发生命周期中,跨不同环境等等的情况下,可以轻松地将服务作为应用程序进行发布,版本化和部署。
如果您使用Gradle,则可以使用./gradlew bootRun
。或者,您可以通过使用以下命令构建JAR文件: ./gradlew build
然后运行JAR文件,如下所示:
如果使用Maven,则可以通过使用以下命令运行应用程序./mvnw spring-boot:run
。或者,您可以使用以下命令构建JAR文件: ./mvnw clean package
然后运行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 { "_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 -X POST -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
:确保您可以看到包含标题的响应消息。新创建的URIPerson
显示。 -
-X POST
:向其发出信号以通知您用于创建新条目的POST。 -
-H "Content-Type:application/json"
:设置内容类型,以便应用程序知道有效负载包含JSON对象。 -
-d '{"firstName": "Frodo", "lastName": "Baggins"}'
:正在发送数据。
注意前面的POST 操作包括Location 标头。它包含新创建资源的URI。Spring Data REST也有两种方法( 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" : { "persons" : [ { "firstName" : "Frodo", "lastName" : "Baggins", "_links" : { "self" : { "href" : "http://localhost:8080/people/1" } } } ] }, "page" : { "size" : 20, "totalElements" : 1, "totalPages" : 1, "number" : 0 } }
的persons
对象包含一个列表,该列表包括Frodo
。注意它如何包含一个self
链接。Spring Data REST还使用Evo Inflector来对实体名称进行复数以进行分组。
您可以直接查询单个记录,如下所示:
$ curl http://localhost:8080/people/1 { "firstName" : "Frodo", "lastName" : "Baggins", "_links" : { "self" : { "href" : "http://localhost:8080/people/1" } } }
这似乎纯粹是基于网络的。但是,在后台有一个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
要返回的对象。由于这可能是不可预测的,因此对于可能返回多个条目的查询,您可能不想这样做。
您也可以发出PUT
, PATCH
和DELETE
REST调用分别替换,更新或删除现有记录。以下示例使用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" } } }
以下示例使用PUT
呼叫:
$ 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的后端的应用程序。
也可以看看
以下指南也可能会有所帮助:
是否要编写新指南或为现有指南做出贡献?查看我们的贡献准则 。
所有指南均以代码的ASLv2许可证和写作的Attribution,NoDerivatives创作共用许可证发布 。 |