使用 Neo4j 访问数据

本指南将引导您完成使用过程弹簧数据 Neo4j​构建一个存储数据并从中检索数据的应用程序Neo4j，一个基于图形的数据库。

您将构建什么

您将使用 Neo4j 的NoSQL基于图形的数据存储，用于构建嵌入式 Neo4j 服务器、存储实体和关系以及开发查询。

你需要什么

• 约15分钟
• 最喜欢的文本编辑器或 IDE
• JDK 1.8或以后
• 格拉德尔 4+​或梅文 3.2+
• 您也可以将代码直接导入到 IDE 中：

• 弹簧工具套件 （STS）
• 智能理念
• VSCode

如何完成本指南

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

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

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

• 下载​并解压缩本指南的源存储库，或使用吉特:git clone https://github.com/spring-guides/gs-accessing-data-neo4j.git
• 光盘成gs-accessing-data-neo4j/initial
• 跳转到定义简单实体.

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

从 Spring 初始化开始

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

手动初始化项目：

导航到https://start.spring.io.此服务拉入应用程序所需的所有依赖项，并为您完成大部分设置。

选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。

单击依赖关系，然后选择Spring Data Neo4j。

单击生成。

下载生成的 ZIP 文件，该文件是配置了您选择的 Web 应用程序的存档。

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

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

建立 Neo4j 服务器

在构建此应用程序之前，您需要设置 Neo4j 服务器。

Neo4j有一个开源服务器，你可以免费安装。

在安装了自制软件的 Mac 上，运行以下命令：

$ brew install neo4j

有关其他选项，请访问https://neo4j.com/download/community-edition/.

安装后，通过运行以下命令以默认设置启动它：

$ 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 POST localhost:7474/user/neo4j/password -H "Content-type:application/json" -d "{\"password\":\"secret\"}"

这会将密码从 更改为 — 在生产中不要做的事情！完成该步骤后，您应该准备好运行本指南的其余部分。​​neo4j​​​​secret​​

定义简单实体

Neo4j捕获实体及其关系，这两个方面同等重要。假设您正在建模一个系统，您可以在其中存储每个人的记录。但是，您还希望跟踪某人的同事（在此示例中）。使用Spring Data Neo4j，您可以使用一些简单的注释来捕获所有这些内容，如以下清单（在）中所示：​​teammates​​​​src/main/java/com/example/accessingdataneo4j/Person.java​​

package com.example.accessingdataneo4j;import java.util.Collections;import java.util.HashSet;import java.util.Optional;import java.util.Set;import java.util.stream.Collectors;import org.springframework.data.neo4j.core.schema.Id;import org.springframework.data.neo4j.core.schema.Node;import org.springframework.data.neo4j.core.schema.Property;import org.springframework.data.neo4j.core.schema.Relationship;import org.springframework.data.neo4j.core.schema.GeneratedValue;@Nodepublic class Person { @Id @GeneratedValue private Long id; private String name; private Person() { // Empty constructor required as of Neo4j API 2.0.5 }; public Person(String name) { this.name = name; } /** * Neo4j doesn't REALLY have bi-directional relationships. It just means when querying * to ignore the direction of the relationship. * https://dzone.com/articles/modelling-data-neo4j */ @Relationship(type = "TEAMMATE") public Set<Person> teammates; public void worksWith(Person person) { if (teammates == null) { teammates = new HashSet<>(); } teammates.add(person); } public String toString() { return this.name + "'s teammates => " + Optional.ofNullable(this.teammates).orElse( Collections.emptySet()).stream() .map(Person::getName) .collect(Collectors.toList()); } public String getName() { return name; } public void setName(String name) { this.name = name; }}

这里有一个只有一个属性的类：。​​Person​​​​name​​

该类用 .当 Neo4j 存储它时，会创建一个新节点。此类还具有标记的 .Neo4j在内部使用来跟踪数据。​​Person​​​​@NodeEntity​​​​id​​​​@GraphId​​​​@GraphId​​

下一个重要的部分是 .它很简单，但标记为 .这意味着此集合的每个成员也应作为单独的节点存在。请注意方向如何设置为 。这意味着当你查询关系时，Spring Data Neo4j会忽略关系的方向。​​teammates​​​​Set<Person>​​​​@Relationship​​​​Person​​​​UNDIRECTED​​​​TEAMMATE​​

使用该方法，您可以轻松地将人们联系在一起。​​worksWith()​​

最后，您有一种方便的方法来打印出此人的姓名和该人的同事。​​toString()​​

创建简单查询

Spring Data Neo4j专注于在Neo4j中存储数据。但它继承了Spring Data Commons项目的功能，包括派生查询的能力。从本质上讲，你不需要学习Neo4j的查询语言。相反，您可以编写一些方法，并让查询为您编写。

若要了解其工作原理，请创建一个查询节点的接口。以下清单（在 中）显示了此类查询：​​Person​​​​src/main/java/com/example/accessingdataneo4j/PersonRepository.java​​

package com.example.accessingdataneo4j;import java.util.List;import org.springframework.data.neo4j.repository.Neo4jRepository;public interface PersonRepository extends Neo4jRepository<Person, Long> { Person findByName(String name); List<Person> findByTeammatesName(String name);}

​​PersonRepository​​扩展接口并插入其操作的类型：。此接口附带许多操作，包括标准 CRUD（创建、读取、更新和删除）操作。​​Neo4jRepository​​​​Person​​

但是，您可以通过声明其方法签名来定义其他查询。在本例中，您添加了 ，它将查找类型的节点并查找与 匹配的节点。您还有 ，它查找节点，钻取字段的每个条目，并根据队友的 .​​findByName​​​​Person​​​​name​​​​findByTeammatesName​​​​Person​​​​teammates​​​​name​​

访问 Neo4j 的权限

Neo4j社区版需要凭据才能访问它。您可以通过设置几个属性 （in ） 来配置这些凭据，如以下清单所示：​​src/main/resources/application.properties​​

spring.neo4j.uri=bolt://localhost:7687spring.data.neo4j.username=neo4jspring.data.neo4j.password=secret

这包括默认用户名 （） 和我们之前选择的新设置的密码 （）。​​neo4j​​​​secret​​

不要在源存储库中存储真实凭据。相反，请在运行时使用Spring Boot 的属性覆盖.

有了这个，你可以把它连接起来，看看它是什么样子的！

创建应用程序类

Spring Initializr 为应用程序创建了一个简单的类。下面的清单显示了 Initializr 为此示例创建的类（在 中）：​​src/main/java/com/example/accessingdataneo4j/AccessingDataNeo4jApplication.java​​

package com.example.accessingdataneo4j;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic class AccessingDataNeo4jApplication { public static void main(String[] args) { SpringApplication.run(AccessingDataNeo4jApplication.class, args); }}

​​@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 会自动处理这些存储库，只要它们包含在类的同一包（或子包）中。若要更好地控制注册过程，可以使用注释。​​@SpringBootApplication​​​​@EnableNeo4jRepositories​​

默认情况下，扫描当前包以查找扩展 Spring Data 的存储库接口之一的任何接口。您可以使用它安全地告诉Spring Data Neo4j按类型扫描不同的根包，如果您的项目布局有多个项目并且找不到您的存储库。​​@EnableNeo4jRepositories​​​​basePackageClasses=MyRepository.class​​

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

现在自动连接您之前定义的实例。Spring Data Neo4j动态实现该接口并插入所需的查询代码以满足接口的义务。​​PersonRepository​​

该方法使用 Spring Boot 启动应用程序并调用构建关系的 。​​main​​​​SpringApplication.run()​​​​CommandLineRunner​​

在本例中，您将创建三个本地实例：Greg、Roy 和 Craig。最初，它们仅存在于内存中。请注意，没有人是任何人的队友（还）。​​Person​​

起初，你找到格雷格，表明他与罗伊和克雷格一起工作，然后再次坚持他。请记住，队友关系被标记为（即双向）。这意味着罗伊和克雷格也得到了更新。​​UNDIRECTED​​

这就是为什么当你需要更新罗伊时。首先从 Neo4j 获取该记录至关重要。在将克雷格添加到列表中之前，您需要罗伊队友的最新状态。

为什么没有获取 Craig 并添加任何关系的代码？因为你已经有了！格雷格早些时候将克雷格标记为队友，罗伊也是如此。这意味着没有必要再次更新克雷格的关系。当您循环访问每个团队成员并将其信息打印到控制台时，您可以看到它。

最后，查看另一个问题，您向后看，回答“谁与谁合作？

以下清单显示了已完成的类（位于）：​​AccessingDataNeo4jApplication​​​​src/main/java/com/example/accessingdataneo4j/AccessingDataNeo4jApplication.java​​

package com.example.accessingdataneo4j;import java.util.Arrays;import java.util.List;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.boot.CommandLineRunner;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.context.annotation.Bean;import org.springframework.data.neo4j.repository.config.EnableNeo4jRepositories;@SpringBootApplication@EnableNeo4jRepositoriespublic class AccessingDataNeo4jApplication { private final static Logger log = LoggerFactory.getLogger(AccessingDataNeo4jApplication.class); public static void main(String[] args) throws Exception { SpringApplication.run(AccessingDataNeo4jApplication.class, args); System.exit(0); } @Bean CommandLineRunner demo(PersonRepository personRepository) { return args -> { personRepository.deleteAll(); Person greg = new Person("Greg"); Person roy = new Person("Roy"); Person craig = new Person("Craig"); List<Person> team = Arrays.asList(greg, roy, craig); log.info("Before linking up with Neo4j..."); team.stream().forEach(person -> log.info("\t" + person.toString())); personRepository.save(greg); personRepository.save(roy); personRepository.save(craig); greg = personRepository.findByName(greg.getName()); greg.worksWith(roy); greg.worksWith(craig); personRepository.save(greg); roy = personRepository.findByName(roy.getName()); roy.worksWith(craig); // We already know that roy works with greg personRepository.save(roy); // We already know craig works with roy and greg log.info("Lookup each person by name..."); team.stream().forEach(person -> log.info( "\t" + personRepository.findByName(person.getName()).toString())); List<Person> teammates = personRepository.findByTeammatesName(greg.getName()); log.info("The following have Greg as a teammate..."); teammates.stream().forEach(person -> log.info("\t" + person.getName())); }; }}

构建可执行的 JAR

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

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

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

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

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

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

您应该看到类似于以下列表的内容（还有其他内容，例如查询）：

Before linking up with Neo4j... Greg's teammates => [] Roy's teammates => [] Craig's teammates => []Lookup each person by name... Greg's teammates => [Roy, Craig] Roy's teammates => [Greg, Craig] Craig's teammates => [Roy, Greg]

您可以从输出中看到（最初）没有人通过任何关系连接。然后，在添加人员后，他们将绑定在一起。最后，您可以看到根据队友查找人员的便捷查询。

总结

祝贺！您只需设置一个嵌入式 Neo4j 服务器，存储一些简单的相关实体，并开发一些快速查询。

如果您想毫不费力地使用基于超媒体的 RESTful 前端公开 Neo4j 存储库，请阅读使用 REST 访问 Neo4j 数据.