# 使用REST访问Neo4j数据
本指南将引导您完成创建通过基于超媒体的RESTful前端访问基于图的数据的应用程序的过程。
## 你会建立什么
您将构建一个Spring应用程序，使您可以创建和检索 `Person`存储在 中的对象 [Neo4j](https://www.neo4j.org/) 使用Spring Data REST NoSQL数据库 。 Spring Data REST具有 的功能， [Spring HATEOAS](https://projects.spring.io/spring-hateoas) 和 [Spring Data Neo4j](https://projects.spring.io/spring-data-neo4j) 并将它们自动组合在一起。
Spring Data REST还支持将 Spring Data JPA ， Spring Data Gemfire 和 Spring Data MongoDB 作为后端数据存储，但是本指南涉及Neo4j。
## 你需要什么
* 约15分钟
* 最喜欢的文本编辑器或IDE
* [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本
* [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi)
* 您还可以将代码直接导入到IDE中：
* [弹簧工具套件（STS）](https://spring.io/guides/gs/sts)
* [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/)
## 如何完成本指南
像大多数Spring 一样 [入门指南](https://spring.io/guides) ，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。 无论哪种方式，您最终都可以使用代码。
要 **从头开始** ，请继续至 [\[scratch\]](https://spring.io/guides/gs/accessing-neo4j-data-rest/#scratch) 。
要 **跳过基础知识** ，请执行以下操作：
* [下载](https://github.com/spring-guides/gs-accessing-neo4j-data-rest/archive/master.zip) 并解压缩本指南的源存储库，或使用 对其进行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-accessing-neo4j-data-rest.git](https://github.com/spring-guides/gs-accessing-neo4j-data-rest.git)`
* 光盘进入 `gs-accessing-neo4j-data-rest/initial`
* 跳至 [访问Neo4j的权限](https://spring.io/guides/gs/accessing-neo4j-data-rest/#initial) 。
**完成后** ，您可以根据中的代码检查结果 `gs-accessing-neo4j-data-rest/complete`.
## 站起来Neo4j服务器
在构建此应用程序之前，您需要设置Neo4j服务器。
Neo4j有一个开源服务器，您可以免费安装。
在安装了Homebrew的Mac上，可以在终端窗口中键入以下内容：
~~~
$ brew install neo4j
~~~
有关其他选项，请参见 [https://neo4j.com/download/community-edition/](https://neo4j.com/download/community-edition/)
安装Neo4j后，可以通过运行以下命令以默认设置启动它：
~~~
$ neo4j start
~~~
您应该看到类似于以下内容的消息：
~~~
Starting Neo4j.
Started neo4j (pid 96416). By default, it is available at http://localhost:7474/
There may be a short delay until the server is ready.
See /usr/local/Cellar/neo4j/3.0.6/libexec/logs/neo4j.log for current status.
~~~
默认情况下，Neo4j的用户名和密码为 `neo4j` 和 `neo4j`。 但是，它要求更改新的帐户密码。 为此，请运行以下命令：
~~~
$ curl -v -u neo4j:neo4j -X POST localhost:7474/user/neo4j/password -H "Content-type:application/json" -d "{\"password\":\"secret\"}"
~~~
这会将密码从 `neo4j` 到 `secret`（有些事情在生产中不做！）完成后，您应该准备运行本指南。
## 从Spring Initializr开始
如果您使用Maven，请访问 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=accessing-neo4j-data-rest&name=accessing-neo4j-data-rest&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.accessing-neo4j-data-rest&dependencies=data-rest,data-neo4j) 以生成具有所需依赖项（Rest Repositories和Spring Data Neo4j）的新项目。
以下清单显示了 `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.4.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>accessing-neo4j-data-rest</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>accessing-neo4j-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-neo4j</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.neo4j.test</groupId>
<artifactId>neo4j-harness</artifactId>
<version>4.2.2</version>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-nop</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
~~~
如果您使用Gradle，请访问 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=accessing-neo4j-data-rest&name=accessing-neo4j-data-rest&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.accessing-neo4j-data-rest&dependencies=data-rest,data-neo4j) 以生成具有所需依赖项（Rest Repositories和Spring Data Neo4j）的新项目。
以下清单显示了 `build.gradle`选择Gradle时创建的文件：
~~~
plugins {
id 'org.springframework.boot' version '2.4.3'
id 'io.spring.dependency-management' version '1.0.11.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-neo4j'
implementation 'org.springframework.boot:spring-boot-starter-data-rest'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
test {
useJUnitPlatform()
}
~~~
### 手动初始化（可选）
如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：
1. 导航到 [https://start.spring.io](https://start.spring.io) 。 该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
2. 选择Gradle或Maven以及您要使用的语言。 本指南假定您选择了Java。
3. 单击 **Dependencies，** 然后选择 **Rest Repositories** 和 **Spring Data Neo4j** 。
4. 点击 **生成** 。
5. 下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。
如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。
## 访问Neo4j的权限
Neo4j Community Edition需要凭据才能访问它。 您可以通过在以下位置设置属性来配置凭据 `src/main/resources/application.properties`， 如下：
~~~
spring.neo4j.uri=bolt://localhost:7687
spring.data.neo4j.username=neo4j
spring.data.neo4j.password=secret
~~~
这包括默认的用户名（ `neo4j`）和新设置的密码（ `secret`）您之前设置的。
不要在源存储库中存储真实凭证。 而是在您的运行时中通过使用 配置它们 Spring Boot的属性overrides 。
## 创建一个域对象
您需要创建一个新的域对象来呈现一个人，如下面的示例（在 `src/main/java/com/example/accessingneo4jdatarest/Person.java`）显示：
~~~
package com.example.accessingneo4jdatarest;
import org.springframework.data.neo4j.core.schema.Id;
import org.springframework.data.neo4j.core.schema.Node;
import org.springframework.data.neo4j.core.schema.GeneratedValue;
@Node
public class Person {
@Id @GeneratedValue 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对象，该对象被配置为自动生成，因此您无需这样做。
## 创建一个 `Person` 资料库
接下来，您需要创建一个简单的存储库，如以下示例（在 `src/main/java/com/example/accessingneo4jdatarest/PersonRepository.java`）显示：
~~~
package com.example.accessingneo4jdatarest;
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`对象。 它通过扩展 [`PagingAndSortingRepositry`](https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/PagingAndSortingRepository.html) Spring Data Commons中定义的接口。
在运行时，Spring Data REST自动创建此接口的实现。 然后使用 [`@RepositoryRestResource`](https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest/core/annotation/RepositoryRestResource.html) 注释以指导Spring MVC在以下位置创建RESTful端点 `/people`.
@RepositoryRestResource不需要导出存储库。 它仅用于更改导出详细信息，例如使用 /people 而不是默认值 /persons.
在这里，您还定义了一个自定义查询来检索以下内容的列表 `Person` 基于的对象 `lastName`价值。 您可以在本指南的后面部分中看到如何调用它。
## 查找应用程序类别
当您使用Spring Initializr创建项目时，它会创建一个应用程序类。 你可以在 `src/main/java/com/example/accessingneo4jdatarest/Application.java`。 请注意，Spring Initializr会串联（并正确更改大小写）程序包名称并将其添加到 `Application`创建应用案例名称。 在这种情况下，我们得到 `AccessingNeo4jDataRestApplication`，如以下清单所示：
~~~
package com.example.accessingneo4jdatarest;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.neo4j.repository.config.EnableNeo4jRepositories;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@EnableTransactionManagement
@EnableNeo4jRepositories
@SpringBootApplication
public class AccessingNeo4jDataRestApplication {
public static void main(String[] args) {
SpringApplication.run(AccessingNeo4jDataRestApplication.class, args);
}
}
~~~
在此示例中，您无需对此应用程序类进行任何更改
`@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，因此您无需处理任何管道或基础结构。
这 `@EnableNeo4jRepositories`批注激活Spring Data Neo4j。 Spring Data Neo4j创建了具体的实现 `PersonRepository` 并使用Cypher查询语言将其配置为与嵌入式Neo4j数据库对话。
### 建立可执行的JAR
您可以使用Gradle或Maven从命令行运行该应用程序。 您还可以构建一个包含所有必需的依赖项，类和资源的可执行JAR文件，然后运行该文件。 生成可执行jar使得在整个开发生命周期中，跨不同环境等等的情况下，都可以轻松地将服务作为应用程序进行发布，版本控制和部署。
如果您使用Gradle，则可以通过使用以下命令运行该应用程序 `./gradlew bootRun`。 或者，您可以通过使用以下命令构建JAR文件： `./gradlew build` 然后运行JAR文件，如下所示：
~~~
java -jar build/libs/gs-accessing-neo4j-data-rest-0.1.0.jar
~~~
如果您使用Maven，则可以通过使用以下命令运行该应用程序 `./mvnw spring-boot:run`。 或者，您可以使用以下命令构建JAR文件： `./mvnw clean package` 然后运行JAR文件，如下所示：
~~~
java -jar target/gs-accessing-neo4j-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](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/0
Content-Length: 0
Date: Wed, 26 Feb 2014 20:26:55 GMT
~~~
* `-i`确保您可以看到包含标题的响应消息。 新创建的URI `Person` 显示
* `-X POST` 发出信号 `POST` 用于创建新条目
* `-H "Content-Type:application/json"` 设置内容类型，以便应用程序知道有效负载包含JSON对象
* `-d '{ "firstName" : "Frodo", "lastName" : "Baggins" }'` 是正在发送的数据
注意前一个 POST 操作包括 Location标头。 它包含新创建的资源的URI。 Spring Data REST也有两种方法（ RepositoryRestConfiguration.setReturnBodyOnCreate(…) 和 setReturnBodyOnCreate(…)），您可以将其配置为立即返回刚刚创建的资源的表示形式的框架。
通过运行以下命令（显示其输出），您可以从中查询所有人员：
~~~
$ 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/0"
}
}
} ]
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
~~~
这 `people`对象包含带有Frodo的列表。 请注意，它如何包含一个 `self`关联。 Spring Data REST还使用 [Evo Inflector](https://www.atteo.org/2011/12/12/Evo-Inflector.html) 库来对实体名称进行复数以进行分组。
您可以通过运行以下命令（及其输出显示）直接查询单个记录：
~~~
$ curl http://localhost:8080/people/0
{
"firstName" : "Frodo",
"lastName" : "Baggins",
"_links" : {
"self" : {
"href" : "http://localhost:8080/people/0"
}
}
}
~~~
这似乎纯粹是基于Web的，但是在后台有一个嵌入式Neo4j图形数据库。 在生产中，您可能会连接到独立的Neo4j服务器。
在本指南中，只有一个域对象。 在域对象相互关联的更复杂的系统中，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" : {
"people" : [ {
"firstName" : "Frodo",
"lastName" : "Baggins",
"_links" : {
"self" : {
"href" : "http://localhost:8080/people/0"
},
"person" : {
"href" : "http://localhost:8080/people/0"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "http://localhost:8080/people/search/findByLastName?name=Baggins"
}
}
}
~~~
因为您将其定义为返回 `List<Person>`在代码中，它返回所有结果。 如果您已将其定义为仅返回 `Person`，它将选择其中之一 `Person`要返回的对象。 由于这可能是不可预测的，因此对于可能返回多个条目的查询，您可能不想这样做。
您也可以发出 `PUT`, `PATCH`， 和 `DELETE`REST调用以替换，更新或删除现有记录。 以下示例（及其输出显示）显示了 `PUT` 称呼：
~~~
$ curl -X PUT -H "Content-Type:application/json" -d '{ "firstName": "Bilbo", "lastName": "Baggins" }' http://localhost:8080/people/0
$ curl http://localhost:8080/people/0
{
"firstName" : "Bilbo",
"lastName" : "Baggins",
"_links" : {
"self" : {
"href" : "http://localhost:8080/people/0"
}
}
}
~~~
以下示例（及其输出显示）显示了 `PATCH` 称呼：
~~~
$ curl -X PATCH -H "Content-Type:application/json" -d '{ "firstName": "Bilbo Jr." }' http://localhost:8080/people/0
$ curl http://localhost:8080/people/0
{
"firstName" : "Bilbo Jr.",
"lastName" : "Baggins",
"_links" : {
"self" : {
"href" : "http://localhost:8080/people/0"
}
}
}
~~~
PUT替换整个记录。 未提供的字段将替换为 null. PATCH 可用于更新项的子集。
您还可以删除记录，如以下示例（及其输出所示）所示：
~~~
$ curl -X DELETE http://localhost:8080/people/0
$ 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端点。 您无需与客户交换正式的合同或接口文档。
## 概括
恭喜你！ 您刚刚开发了一个具有基于 的应用程序 [超媒体的](https://spring.io/guides/gs/rest-hateoas) RESTful前端和基于Neo4j的后端 。
- springboot概述
- springboot构建restful服务
- spring构建一个RESTful Web服务
- spring定时任务
- 消费RESTful Web服务
- gradle构建项目
- maven构建项目
- springboot使用jdbc
- springboot应用上传文件
- 使用LDNA验证用户
- 使用 spring data redis
- 使用 spring RabbitTemplate消息队列
- 用no4j访问nosql数据库
- springboot验证web表单
- Spring Boot Actuator构j建服务
- 使用jms传递消息
- springboot创建批处理服务
- spring security保护web 安全
- 在Pivotal GemFire中访问数据
- 使用Spring Integration
- 使用springboot jpa进行数据库操作
- 数据库事务操作
- 操作mongodb
- springmvc+tymleaf创建web应用
- 将Spring Boot JAR应用程序转换为WAR
- 创建异步服务
- spring提交表单
- 使用WebSocket构建交互式Web应用程序
- 使用REST访问Neo4j数据
- jquery消费restful
- springboot跨域请求
- 消费SOAP Web服务
- springboot使用缓存
- 使用Vaadin创建CRUD UI
- 使用REST访问JPA数据
- 使用REST访问Pivotal GemFire中的数据
- 构建soap服务
- 使用rest访问mongodb数据
- 构建springboot应用docker镜像
- 从STS部署到Cloud Foundry
- springboot测试web应用
- springboot访问mysql
- springboot编写自定义模块并使用
- 使用Google Cloud Pub / Sub进行消息传递
- 构建反应式RESTful Web服务
- 使用Redis主动访问数据
- Spring Boot 部署到Kubernetes
- 使用反应式协议R2DBC访问数据
- Spring Security架构
- spring构建Docker镜像详解
- Spring Boot和OAuth2
- springboot应用部署到k8s
- spring构建rest服务详解