$ brew install neo4j
使用 Neo4j 访问数据
本指南将引导你完成使用 Spring Data Neo4j 构建一个应用程序的过程,该应用程序将数据存储在基于图的数据库 Neo4j 中并从中检索数据。
你将构建什么
你将使用 Neo4j 的 NoSQL 图数据库来构建一个嵌入式 Neo4j 服务器,存储实体和关系,并开发查询。
你需要什么
-
约 15 分钟
-
一个喜欢的文本编辑器或 IDE
-
Java 17 或更高版本
-
你也可以直接将代码导入你的 IDE
如何完成本指南
与大多数 Spring 入门指南一样,你可以从头开始并完成每个步骤,或者跳过你已经熟悉的基本设置步骤。无论哪种方式,你都能得到可以工作的代码。
要从头开始,请转到使用 Spring Initializr 入门。
要跳过基础部分,请执行以下操作
-
下载并解压本指南的源代码仓库,或者使用 Git 克隆它:
git clone https://github.com/spring-guides/gs-accessing-data-neo4j.git
-
cd 进入
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 上安装服务器,请运行以下命令
对于其他选项,请访问 https://neo4j.ac.cn/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 Community Edition 需要凭据才能访问。你可以通过设置一些属性(在 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,你无需配置任何管道或基础设施。
Spring Boot 会自动处理这些仓库,只要它们包含在你 @SpringBootApplication
类的同一包(或子包)中。为了更好地控制注册过程,你可以使用 @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 文件,如下所示
如果你使用 Maven,可以通过 ./mvnw spring-boot:run
运行应用程序。或者,你可以使用 ./mvnw clean package
构建 JAR 文件,然后运行 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 数据。 |