此版本仍在开发中，目前尚不被视为稳定版本。如需最新稳定版本，请使用 Spring Data Neo4j 8.0.4！spring-doc.cadn.net.cn

构建 Spring Data Neo4j

要求

关于 JDK 版本

选择 JDK 17 是一个受多种因素影响的决定spring-doc.cadn.net.cn

  • SDN 是 Spring Data 项目的一部分。<br>Spring Data 公共基础版本的 JDK 基线为 17，Spring Framework 的基线同样为 17。<br>因此，保持 JDK 17 作为基线是顺理成章的。spring-doc.cadn.net.cn

运行构建

以下各节为替代方案，大致按所需工作量递增排序。spring-doc.cadn.net.cn

所有构建都需要项目的本地副本：spring-doc.cadn.net.cn

克隆 SDN
$ git clone [email protected]:spring-projects/spring-data-neo4j.git

在继续之前，请验证您本地安装的 JDK 版本。<br/>输出应类似以下内容：spring-doc.cadn.net.cn

验证您的 JDK
$ java -version
java version "18.0.1" 2022-04-19
Java(TM) SE Runtime Environment (build 18.0.1+10-24)
Java HotSpot(TM) 64-Bit Server VM (build 18.0.1+10-24, mixed mode, sharing)

已安装 Docker

使用默认图片

如果您尚未安装 Docker，请前往 Docker Desktop 进行安装。
简而言之，Docker 是一种工具，可借助操作系统级别的虚拟化技术，在所谓的容器中运行轻量级软件镜像。spring-doc.cadn.net.cn

我们的构建使用 Testcontainers Neo4j 来启动一个数据库实例。spring-doc.cadn.net.cn

在 Linux / macOS 上使用默认设置构建
$ ./mvnw clean verify

在 Windows 计算机上，请使用spring-doc.cadn.net.cn

在 Windows 上使用默认设置进行构建
$ mvnw.cmd clean verify

输出应类似。spring-doc.cadn.net.cn

使用另一张图片

可以使用环境变量来配置要使用的镜像版本，例如：spring-doc.cadn.net.cn

使用不同的 Neo4j Docker 镜像构建
$ SDN_NEO4J_VERSION=5.3.0-enterprise SDN_NEO4J_ACCEPT_COMMERCIAL_EDITION=yes ./mvnw clean verify

我们正在使用 5.3.0 企业版，并且也接受了许可协议。spring-doc.cadn.net.cn

如果内联指定环境变量不适用于您，请查阅您的操作系统或 Shell 手册，了解如何定义环境变量。spring-doc.cadn.net.cn

与本地运行的数据库相对比

运行在本地数据库上 将 清除其全部内容。

在本地运行的数据库上进行构建速度更快，因为它每次都不需要重新启动容器。我们在开发过程中经常这样做。spring-doc.cadn.net.cn

您可以在我们的下载中心免费获取Neo4j的副本。spring-doc.cadn.net.cn

Please download the version applicable to your operating system and follow the instructions to start it.
A required step is to open a browser and go to localhost:7474 after you started the database and change the default password from neo4j to something of your liking.spring-doc.cadn.net.cn

After that, you can run a complete build by specifying the local bolt URL:spring-doc.cadn.net.cn

使用本地运行的数据库构建
$ SDN_NEO4J_URL=bolt://localhost:7687 SDN_NEO4J_PASSWORD=verysecret ./mvnw clean verify

环境变量摘要 控制构建过程

姓名 默认值 含义

SDN_NEO4J_VERSIONspring-doc.cadn.net.cn

5.3.0spring-doc.cadn.net.cn

使用的是Neo4j docker镜像版本，参见Neo4j Docker官方镜像spring-doc.cadn.net.cn

SDN_NEO4J_ACCEPT_COMMERCIAL_EDITIONspring-doc.cadn.net.cn

nospring-doc.cadn.net.cn

一些测试可能需要 Neo4j 的企业版。我们内部会针对企业版进行构建和测试，但如果我们不想接受许可，我们不会强迫您接受许可。spring-doc.cadn.net.cn

SDN_NEO4J_URLspring-doc.cadn.net.cn

未设置spring-doc.cadn.net.cn

设置此环境允许连接到本地运行的Neo4j实例。 我们开发过程中使用频率很高。spring-doc.cadn.net.cn

SDN_NEO4J_PASSWORDspring-doc.cadn.net.cn

未设置spring-doc.cadn.net.cn

neo4j 实例中 neo4j 用户的密码。spring-doc.cadn.net.cn
您需要同时设置SDN_NEO4J_URL和SDN_NEO4J_PASSWORD才能使用本地实例。

Checkstyle 和伙伴们

当前没有设置质量准入机制来确保代码与测试的比例保持不变，但请考虑为您的贡献添加测试用例。spring-doc.cadn.net.cn

我们有一些相对宽松的 checkstyle 规则，在强制执行更或大致的 Java 格式化规则。 您的构建会在格式化错误或类似未使用导入的情况下失败。spring-doc.cadn.net.cn