使用 Neo4j 访问数据 - springboot guide中文文档

本指南将引导您使用 Spring Data Neo4j 构建一个应用程序，该应用程序在基于图的数据库 Neo4j 中存储数据并从中检索数据。

您将构建什么

您将使用 Neo4j 的 NoSQL 图数据库来构建一个嵌入式 Neo4j 服务器，存储实体和关系，并开发查询。

您需要什么

大约 15 分钟
一个常用的文本编辑器或IDE
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您也可以直接将代码导入到您的 IDE 中：

如何完成本指南

与大多数 Spring 入门指南类似，您可以从头开始并完成每个步骤，也可以跳过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到可运行的代码。

要从头开始，请继续阅读使用 Spring Initializr 开始。

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

下载并解压本指南的源代码仓库，或者使用 Git 克隆它：git clone https://github.com/spring-guides/gs-accessing-data-neo4j.git
进入 gs-accessing-data-neo4j/initial 目录
跳转到定义一个简单的实体。

完成后，您可以将您的结果与 gs-accessing-data-neo4j/complete 中的代码进行对比。

从 Spring Initializr 开始

您可以使用这个预初始化项目，并点击生成以下载一个 ZIP 文件。该项目已配置为适合本教程中的示例。

要手动初始化项目：

进入 https://start.spring.io。该服务会拉取应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您想要使用的语言。本指南假设您选择了 Java。
点击 Dependencies 并选择 Spring Data Neo4j。
点击 Generate。
下载生成的 ZIP 文件，这是一个根据您的选择配置好的 Web 应用程序的归档文件。

如果您的 IDE 集成了 Spring Initializr，您可以直接在 IDE 中完成这个过程。

您还可以从 GitHub 上 fork 该项目，并在您的 IDE 或其他编辑器中打开它。

启动 Neo4j 服务器

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

Neo4j 有一个可以免费安装的开源服务器，或者您可以使用 Docker 运行它。

要在已安装 Homebrew 的 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 Docker 镜像运行。您可以通过 NEO4J_AUTH 环境变量更改密码。

docker run \
  *-publish=7474:7474 --publish=7687:7687 \
  *-volume=$HOME/neo4j/data:/data \
  *-env NEO4J_AUTH=neo4j/password
  neo4j

定义一个简单实体

Neo4j 捕获实体及其关系，这两个方面同等重要。假设您正在建模一个系统，其中为每个人存储一条记录。然而，您还想跟踪一个人的同事（在本例中为 teammates）。通过 Spring Data Neo4j，您可以使用一些简单的注解来捕获所有这些信息，如下面的代码清单（位于 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;

@Node
public 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。

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

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

通过 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 扩展了 Neo4jRepository 接口，并指定了它操作的类型：Person。这个接口提供了许多操作，包括标准的 CRUD（创建、读取、更新和删除）操作。

但您也可以通过声明方法签名来定义其他查询。在这个例子中，您添加了 findByName，它查找类型为 Person 的节点，并找到与 name 匹配的节点。您还有 findByTeammatesName，它查找 Person 节点，深入到 teammates 字段的每个条目，并根据队友的 name 进行匹配。

访问 Neo4j 的权限

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

spring.neo4j.uri=bolt://localhost:7687
spring.neo4j.authentication.username=neo4j
spring.neo4j.authentication.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;

@SpringBootApplication
public class AccessingDataNeo4jApplication {

  public static void main(String[] args) {
    SpringApplication.run(AccessingDataNeo4jApplication.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 的，您无需处理任何配置或基础设施。

只要这些仓库包含在您的 @SpringBootApplication 类所在的包（或子包）中，Spring Boot 就会自动处理这些仓库。为了对注册过程进行更多控制，您可以使用 @EnableNeo4jRepositories 注解。

默认情况下，@EnableNeo4jRepositories 会扫描当前包中所有扩展了 Spring Data 仓库接口的接口。如果您的项目布局包含多个项目，并且无法找到您的仓库，您可以使用 basePackageClasses=MyRepository.class 来安全地告诉 Spring Data Neo4j 按类型扫描不同的根包。

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

现在自动装配您之前定义的 PersonRepository 实例。Spring Data Neo4j 动态地实现了该接口，并插入了所需的查询代码以满足接口的要求。

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

在这个例子中，您创建了三个本地的 Person 实例：Greg、Roy 和 Craig。最初，它们只存在于内存中。请注意，目前还没有任何人是其他人的队友。

首先，您找到 Greg，指出他与 Roy 和 Craig 一起工作，然后再次持久化他。记住，队友关系被标记为 UNDIRECTED（即双向的）。这意味着 Roy 和 Craig 也已经被更新。

这就是为什么在您需要更新 Roy 时，首先从 Neo4j 中获取该记录是至关重要的。在将 Craig 添加到列表之前，您需要了解 Roy 的队友的最新状态。

为什么没有获取 Craig 并添加任何关系的代码？因为您已经拥有了它！Greg 之前将 Craig 标记为队友，Roy 也是如此。这意味着不需要再次更新 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
@EnableNeo4jRepositories
public 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，可以通过 ./gradlew bootRun 运行应用程序。或者，您可以使用 ./gradlew build 构建 JAR 文件，然后运行该 JAR 文件，如下所示：

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

如果您使用 Maven，可以通过运行 ./mvnw spring-boot:run 来启动应用程序。或者，您可以使用 ./mvnw clean package 构建 JAR 文件，然后按如下方式运行该 JAR 文件：

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 数据。

另请参阅

以下指南可能也会有所帮助：