此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Data Neo4j 7.5.2！spring-doc.cadn.net.cn

开始

我们为 SDN 提供了一个 Spring Boot Starters。 请通过依赖项管理包含入门模块，并配置要使用的 Bolt URL，例如spring.neo4j.uri=bolt://localhost:7687. Starters假定服务器已禁用身份验证。 由于 SDN Starters依赖于 Java 驱动程序的Starters，因此此处所说的所有有关配置的内容也适用于此处。 有关可用属性的参考，请在spring.neo4jNamespace。spring-doc.cadn.net.cn

SDN 支持spring-doc.cadn.net.cn

这些都包含在同一个二进制文件中。 另一方面，响应式编程模型需要数据库端的 4+ Neo4j 服务器和响应式 Spring。spring-doc.cadn.net.cn

准备数据库

对于这个例子，我们停留在电影图中，因为它在每个 Neo4j 实例中都是免费提供的。spring-doc.cadn.net.cn

如果您没有正在运行的数据库但安装了 Docker，请运行：spring-doc.cadn.net.cn

在 Docker 中启动本地 Neo4j 实例。
docker run --publish=7474:7474 --publish=7687:7687 -e 'NEO4J_AUTH=neo4j/secret' neo4j:5

您现在可以访问 http://localhost:7474。 上述命令将服务器的密码设置为secret. 请注意在提示符 （:play movies). 执行它以用一些测试数据填充您的数据库。spring-doc.cadn.net.cn

创建一个新的 Spring Boot 项目

设置 Spring Boot 项目的最简单方法是 start.spring.io（如果您不想使用该网站，它也集成在主要 IDE 中）。spring-doc.cadn.net.cn

选择“Spring Web Starter”以获取创建基于 Spring 的 Web 应用程序所需的所有依赖项。 Spring Initializr 将负责为您创建有效的项目结构，并为所选构建工具提供所有文件和设置。spring-doc.cadn.net.cn

使用 Maven

您可以针对 Spring Initializer 发出 curl 请求以创建一个基本的 Maven 项目：spring-doc.cadn.net.cn

使用 Spring Initializr 创建一个基本的 Maven 项目
curl https://start.spring.io/starter.tgz \
  -d dependencies=webflux,data-neo4j  \
  -d bootVersion=3.2.0 \
  -d baseDir=Neo4jSpringBootExample \
  -d name=Neo4j%20SpringBoot%20Example | tar -xzvf -

这将创建一个新文件夹Neo4jSpringBootExample. 由于此Starters尚未在初始化器上，因此您必须手动将以下依赖项添加到pom.xml:spring-doc.cadn.net.cn

在Maven项目中包含spring-data-neo4j-spring-boot-starter
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-data-neo4j</artifactId>
</dependency>

如果是现有项目，您还可以手动添加依赖项。spring-doc.cadn.net.cn

使用 Gradle

思路是一样的，只需生成一个 Gradle 项目：spring-doc.cadn.net.cn

使用 Spring Initializr 创建基本 Gradle 项目
curl https://start.spring.io/starter.tgz \
  -d dependencies=webflux,data-neo4j \
  -d type=gradle-project \
  -d bootVersion=3.2.0 \
  -d baseDir=Neo4jSpringBootExampleGradle \
  -d name=Neo4j%20SpringBoot%20Example | tar -xzvf -

Gradle 的依赖项如下所示，必须添加到build.gradle:spring-doc.cadn.net.cn

在 Gradle 项目中包含 spring-data-neo4j-spring-boot-starter
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-neo4j'
}

如果是现有项目，您还可以手动添加依赖项。spring-doc.cadn.net.cn

配置项目

现在，在您最喜欢的 IDE 中打开这些项目中的任何一个。 找到application.properties并配置您的 Neo4j 凭据：spring-doc.cadn.net.cn

spring.neo4j.uri=bolt://localhost:7687
spring.neo4j.authentication.username=neo4j
spring.neo4j.authentication.password=verysecret

这是连接到 Neo4j 实例所需的最低限度。spring-doc.cadn.net.cn

使用此Starters时，无需添加驱动程序的任何编程配置。 此Starters将自动启用 SDN 存储库。

配置 Neo4j Cypher-DSL

根据您运行应用程序时使用的 Neo4j 版本， 建议配置运行 Neo4j Cypher-DSL 的方言。 使用的默认方言是针对 Neo4j 4.4。作为 Neo4j 的 LTS 版本。 这可以通过定义 Cypher-DSL 来更改Configuration豆。spring-doc.cadn.net.cn

让 Cypher-DSL 使用 Neo4j 5 方言
@Bean
Configuration cypherDslConfiguration() {
	return Configuration.newConfig()
                .withDialect(Dialect.NEO4J_5).build();
}
尽管 Spring Data Neo4j 尽最大努力与 Neo4j 5 和默认方言的组合兼容， 始终建议明确定义方言。 例如，它将导致更优化的查询并利用elementId()对于较新的 Neo4j 版本。

在模块路径上运行

Spring Data Neo4j 可以在模块路径上运行。它的自动模块名称是spring.data.neo4j. 由于当前 Spring Data 构建设置中的限制，它本身不提供模块。 因此，它使用自动但稳定的模块名称。但是，它确实取决于 模块化库（Cypher-DSL）。没有module-info.java由于 上述限制，我们无法代表您表达对该库的要求。spring-doc.cadn.net.cn

因此，最低要求module-info.java在您的项目中，用于在模块路径上运行 Spring Data Neo4j 6.1+ 如下：spring-doc.cadn.net.cn

一个module-info.java在应该在模块路径上使用 Spring Data Neo4j 的项目中
module your.module {

	requires org.neo4j.cypherdsl.core;

	requires spring.data.commons;
	requires spring.data.neo4j;

	opens your.domain to spring.core; (1)

	exports your.domain; (2)
}
1 Spring Data Neo4j 使用 Spring Data Commons 及其反射功能，因此 您需要打开域包以spring.core至少。
2 我们在这里假设your.domain还包含存储库：这些存储库必须导出才能通过spring.beans,spring.context和spring.data.commons.如果你不想将它们出口到全世界， 您可以将它们限制为这些模块。

创建您的域

我们的域层应该完成两件事：spring-doc.cadn.net.cn

示例节点实体

SDN 完全支持不可修改的实体，适用于 Java 和dataKotlin 中的类。 因此，我们将在这里重点介绍不可变实体，MovieEntity.java显示这样一个实体。spring-doc.cadn.net.cn

SDN 支持 Neo4j Java 驱动程序支持的所有数据类型，请参阅“Cypher 类型系统”一章中的将 Neo4j 类型映射到本地语言类型。未来的版本将支持其他转换器。
MovieEntity.java
import java.util.ArrayList;
import java.util.List;

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.Relationship.Direction;

@Node("Movie") (1)
public class MovieEntity {

	@Id (2)
	private final String title;

	@Property("tagline") (3)
	private final String description;

	@Relationship(type = "ACTED_IN", direction = Direction.INCOMING) (4)
	private List<Roles> actorsAndRoles = new ArrayList<>();

	@Relationship(type = "DIRECTED", direction = Direction.INCOMING)
	private List<PersonEntity> directors = new ArrayList<>();

	public MovieEntity(String title, String description) { (5)
		this.title = title;
		this.description = description;
	}

	// Getters omitted for brevity
}
1 @Node用于将此类标记为托管实体。它还用于配置 Neo4j 标签。如果仅使用 plain@Node.
2 每个实体都必须有一个 id。此处显示的 movie 类使用title作为唯一的业务密钥。如果您没有这样的唯一密钥，则可以使用@Id和@GeneratedValue将 SDN 配置为使用 Neo4j 的内部 ID。我们还提供 UUID 的生成器。
3 这表明@Property作为对字段使用与图形属性不同的名称的一种方式。
4 这定义了与类型PersonEntity和关系类型ACTED_IN
5 这是应用程序代码要使用的构造函数。

一般来说：使用内部生成的 id 的不可变实体有点矛盾，因为 SDN 需要一种方法来使用数据库生成的值来设置字段。spring-doc.cadn.net.cn

如果您没有找到好的业务密钥或不想使用 ID 生成器，下面是使用内部生成的 ID 的同一实体以及常规构造函数和 SDN 使用的所谓 wither-Method：spring-doc.cadn.net.cn

MovieEntity.java
import org.springframework.data.neo4j.core.schema.GeneratedValue;
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.annotation.PersistenceConstructor;

@Node("Movie")
public class MovieEntity {

	@Id @GeneratedValue
	private Long id;

	private final String title;

	@Property("tagline")
	private final String description;

	public MovieEntity(String title, String description) { (1)
		this.id = null;
		this.title = title;
		this.description = description;
	}

	public MovieEntity withId(Long id) { (2)
		if (this.id.equals(id)) {
			return this;
		} else {
			MovieEntity newObject = new MovieEntity(this.title, this.description);
			newObject.id = id;
			return newObject;
		}
	}
}
1 这是应用程序代码要使用的构造函数。它将 id 设置为 null，因为永远不应作包含内部 id 的字段。
2 这就是所谓的凋灵id-属性。 它创建一个新实体并相应地设置字段，而不修改原始实体，从而使其不可变。

当然，您可以将 SDN 与 Kotlin 一起使用，并使用 Kotlin 的数据类对您的域进行建模。如果您想或需要纯粹停留在 Java 中，Project Lombok 是一种替代方案。spring-doc.cadn.net.cn

声明 Spring Data 存储库

您基本上有两个选择：您可以使用 SDN 以与商店无关的方式工作，并使您的域特定扩展以下内容之一spring-doc.cadn.net.cn

相应地选择命令式和响应式。spring-doc.cadn.net.cn

虽然从技术上讲并不禁止，但不建议在同一应用程序中混合使用命令式数据库访问和被动式数据库访问。我们不会支持此类方案。

另一种选择是选择特定于商店的实现，并获得我们支持的所有开箱即用的方法。这种方法的优点也是它最大的缺点：一旦推出，所有这些方法都将成为您的 API 的一部分。大多数时候，删除某些东西比事后添加内容更难。此外，使用商店细节会将您的商店泄漏到您的域中。从性能的角度来看，没有任何惩罚。spring-doc.cadn.net.cn

适合上述任何电影实体的响应式存储库如下所示：spring-doc.cadn.net.cn

MovieRepository.java
import reactor.core.publisher.Mono;

import org.springframework.data.neo4j.repository.ReactiveNeo4jRepository;

public interface MovieRepository extends ReactiveNeo4jRepository<MovieEntity, String> {

	Mono<MovieEntity> findOneByTitle(String title);
}
测试响应式代码是通过reactor.test.StepVerifier. 查看 Project Reactor 的相应文档或查看我们的示例代码。