要求
-
JDK 17+(可以是 OpenJDK 或 Oracle JDK)
-
Maven 3.8.5 (我们提供了 Maven 包装器,分别见项目根目录;包装器会自动下载相应的 Maven 版本)
mvnw
mvnw.cmd
-
Neo4j 5.+ 数据库
-
在本地运行
-
或间接通过 Testcontainers 和 Docker
-
运行生成
以下部分是替代方法,大致按增加的工作量排序。
所有生成都需要项目的本地副本:
$ git clone [email protected]:spring-projects/spring-data-neo4j.git
在继续操作之前,请验证本地安装的 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 是一种工具,可帮助您在所谓的容器中使用操作系统级虚拟化来运行轻量级软件映像。
我们的构建使用 Testcontainers Neo4j 来启动数据库实例。
$ ./mvnw clean verify
在 Windows 计算机上,使用
$ mvnw.cmd clean verify
输出应类似。
针对本地运行的数据库
对本地运行的数据库运行将擦除其完整内容。 |
针对本地运行的数据库进行构建速度更快,因为它不会每次都重新启动容器。 我们在开发过程中经常这样做。
您可以在我们的下载中心免费获得 Neo4j 的副本。
请下载适用于您的操作系统的版本,然后按照说明启动它。
必需的步骤是在启动数据库后打开浏览器并转到 localhost:7474,并将默认密码从您喜欢的密码更改为您喜欢的密码。neo4j
之后,您可以通过指定本地 URL 来运行完整的构建:bolt
$ SDN_NEO4J_URL=bolt://localhost:7687 SDN_NEO4J_PASSWORD=verysecret ./mvnw clean verify
对本地运行的数据库运行将擦除其完整内容。 |
控制生成的环境变量摘要
名字 | 默认值 | 意义 |
---|---|---|
|
5.3.0 |
要使用的 Neo4j docker 镜像版本,参见 Neo4j Docker 官方镜像 |
|
不 |
某些测试可能需要 Neo4j 的企业版。 我们在内部针对企业版进行构建和测试,但我们不会强迫您 如果您不想接受许可证,请接受许可证。 |
|
未设置 |
设置此环境允许连接到本地运行的 Neo4j 实例。 我们在开发过程中经常使用它。 |
|
未设置 |
配置了 的实例用户的密码。 |
您需要同时设置并使用本地实例。SDN_NEO4J_URL SDN_NEO4J_PASSWORD |
名字 | 默认值 | 意义 |
---|---|---|
|
5.3.0 |
要使用的 Neo4j docker 镜像版本,参见 Neo4j Docker 官方镜像 |
|
不 |
某些测试可能需要 Neo4j 的企业版。 我们在内部针对企业版进行构建和测试,但我们不会强迫您 如果您不想接受许可证,请接受许可证。 |
|
未设置 |
设置此环境允许连接到本地运行的 Neo4j 实例。 我们在开发过程中经常使用它。 |
|
未设置 |
配置了 的实例用户的密码。 |
您需要同时设置并使用本地实例。SDN_NEO4J_URL SDN_NEO4J_PASSWORD |
Checkstyle和朋友们
目前没有质量门槛来确保代码/测试比率保持不变,但请考虑将测试添加到您的贡献中。
我们有一些相当温和的检查样式规则,或多或少地强制执行默认的 Java 格式规则。 您的构建将因格式错误或未使用的导入等原因而中断。