在您的 Java 应用程序中嵌入 Neo4j

在选择适合您平台的版本之后，您可以通过在构建中包含 Neo4j 库 JAR 文件，将 Neo4j 嵌入您的 Java 应用程序。以下部分将展示如何通过直接更改构建路径或使用依赖项管理来实现。

添加 Neo4j 作为依赖项

您可以选择使用顶级工件或直接包含各个组件。以下示例使用顶级工件方法。

[企业版]

这些示例仅适用于 Neo4j 社区版。要将 Neo4j 企业版添加为依赖项，请联系Neo4j 专业服务。有关社区版和企业版的详细信息，请参阅操作手册 → 简介。

Maven

将依赖项添加到您的项目，类似于以下代码段。这通常在项目根目录中找到的 pom.xml 文件中完成。

<project>
...
 <dependencies>
  <dependency>
   <groupId>org.neo4j</groupId>
   <artifactId>neo4j</artifactId>
   <version>5.25.1</version>
  </dependency>
  ...
 </dependencies>
...
</project>

其中 artifactId 可以在版本表中找到。

Eclipse 和 Maven

对于Eclipse 中的开发，建议安装m2e 插件并让 Maven 管理项目构建类路径。这还增加了通过命令行使用 Maven 构建项目的可能性，并且拥有用于开发的有效 Eclipse 设置。

Ivy

确保从 Maven Central 解析依赖项。您可以在您的 ivysettings.xml 文件中使用此配置

<ivysettings>
  <settings defaultResolver="main"/>
  <resolvers>
    <chain name="main">
      <filesystem name="local">
        <artifact pattern="${ivy.settings.dir}/repository/[artifact]-[revision].[ext]" />
      </filesystem>
      <ibiblio name="maven_central" root="http://repo1.maven.org/maven2/" m2compatible="true"/>
    </chain>
  </resolvers>
</ivysettings>

有了这些配置，可以通过将以下依赖项添加到您的 ivy.xml 文件中来添加 Neo4j

..
<dependencies>
  ..
  <dependency org="org.neo4j" name="neo4j" rev="5.25.1"/>
  ..
</dependencies>
..

name 可以版本表中找到。

Gradle

包含 Neo4j 库的 Gradle 构建脚本示例

def neo4jVersion = "5.25.1"
apply plugin: 'java'
repositories {
   mavenCentral()
}
dependencies {
   implementation "org.neo4j:neo4j:${neo4jVersion}"
}

坐标（示例中的 org.neo4j:neo4j）可以在版本表中找到。

启动和停止

要启动嵌入式 DBMS，请实例化一个org.neo4j.dbms.DatabaseManagementService 并获取org.neo4j.graphdb.GraphDatabaseService，如下所示

managementService = new DatabaseManagementServiceBuilder( databaseDirectory ).build();
graphDb = managementService.database( DEFAULT_DATABASE_NAME );
registerShutdownHook( managementService );

如果您在嵌入模式下使用 Neo4j 企业版，则必须使用com.neo4j.dbms.api.EnterpriseDatabaseManagementServiceBuilder 创建您的数据库以启用企业版功能。如果您打算运行嵌入式集群，则需要为创建的实例提供相应的配置（例如端口和发现端点）。为了可维护性，您可以在neo4j.conf 文件中定义您的嵌入式 DBMS 配置，如下所示

server.default_advertised_address=core01.example.com
server.default_listen_address=0.0.0.0
dbms.cluster.discovery.type=LIST
dbms.cluster.discovery.endpoints=core01.example.com,core02.example.com,core03.example.com
server.bolt.enabled=true
server.http.enabled=true

var managementService = new EnterpriseDatabaseManagementServiceBuilder( homeDirectory )
    .loadPropertiesFromFile( Path.of( "/path/to/neo4j.conf" ) )
    .build();

也可以使用构建器并在代码中指定所有参数

var defaultAdvertised = new SocketAddress( "core01.example.com" );
var defaultListen = new SocketAddress( "0.0.0.0" );

var initialMembers = List.of(
    new SocketAddress( "core01.example.com" ),
    new SocketAddress( "core02.example.com" ),
    new SocketAddress( "core03.example.com" )
);

var managementService = new EnterpriseDatabaseManagementServiceBuilder( homeDirectory )
    .setConfig( GraphDatabaseSettings.default_advertised_address, defaultAdvertised )
    .setConfig( GraphDatabaseSettings.default_listen_address, defaultListen )
    .setConfig( ClusterSettings.discovery_type, DiscoveryType.LIST )
    .setConfig( ClusterSettings.discovery_endpoints, initialMembers )
    .setConfig( EnterpriseEditionSettings.initial_default_primaries_count, 3 )
    .setConfig( BoltConnector.enabled, true )
    .setConfig( HttpConnector.enabled, true )
    .build();

务必仔细考虑要启用的服务以及在哪些端口和接口上启用。如果您不需要 Bolt 或 HTTP，那么最好将它们禁用。

DatabaseManagementService 和 GraphDatabaseService 实例可以在多个线程之间共享。但是请注意，您不能创建指向同一数据库的多个服务。

要停止数据库，请调用 shutdown() 方法

managementService.shutdown();

为了确保 Neo4j 正确关闭，请添加一个关闭钩子

private static void registerShutdownHook( final DatabaseManagementService managementService )
{
    // Registers a shutdown hook for the Neo4j instance so that it
    // shuts down nicely when the VM exits (even if you "Ctrl-C" the
    // running application).
    Runtime.getRuntime().addShutdownHook( new Thread()
    {
        @Override
        public void run()
        {
            managementService.shutdown();
        }
    } );
}

使用配置设置启动嵌入式数据库

要使用配置设置启动 Neo4j，可以按如下方式加载 Neo4j 属性文件

DatabaseManagementService managementService = new DatabaseManagementServiceBuilder( directory )
    .loadPropertiesFromFile( Path.of( pathToConfig + "neo4j.conf" ) ).build();
GraphDatabaseService graphDb = managementService.database( DEFAULT_DATABASE_NAME );

配置设置也可以在代码中应用，如下所示

DatabaseManagementService managementService = new DatabaseManagementServiceBuilder( directory )
    .setConfig( GraphDatabaseSettings.pagecache_memory, ByteUnit.mebiBytes( 512 ) )
    .setConfig( GraphDatabaseSettings.transaction_timeout, Duration.ofSeconds( 60 ) )
    .setConfig( GraphDatabaseSettings.preallocate_logical_logs, true ).build();
GraphDatabaseService graphDb = managementService.database( DEFAULT_DATABASE_NAME );

启动嵌入式只读实例

如果您想要数据库的只读视图，请使用 read_only_database_default 配置设置设置为 true 创建一个实例

managementService = new DatabaseManagementServiceBuilder( dir ).setConfig( GraphDatabaseSettings.read_only_database_default, true ).build();
graphDb = managementService.database( DEFAULT_DATABASE_NAME );

在这种情况下，数据库必须已经存在。

不支持由多个（只读或写入）实例对同一数据库文件进行并发访问。

将 Neo4j 添加到构建路径

从以下来源之一获取 Neo4j 库

解压缩Neo4j zip/tarball 并使用 lib/ 目录中的 JAR 文件。
使用Maven Central 存储库中提供的 JAR 文件。

将 JAR 文件添加到您的项目

JDK 工具

附加到 -classpath

Eclipse

右键单击项目，然后转到构建路径 → 配置构建路径。在对话框中，选择添加外部 JAR，浏览 Neo4j lib/ 目录，然后选择所有 JAR 文件。
另一个选择是使用用户库。

IntelliJ IDEA

请参阅库、全局库和配置库对话框。

NetBeans

右键单击项目的库节点，选择添加 JAR/文件夹，浏览 Neo4j lib/ 目录并选择所有 JAR 文件。
您也可以从项目节点处理库，请参阅管理项目的类路径。

版本

下表概述了可用的版本及其用于依赖项管理工具的名称。

请按照表中的链接，了解有关使用 Apache Maven、Apache Buildr、Apache Ivy、Groovy Grape、Grails 和 Scala SBT 进行依赖项配置的详细信息。

表 1. Neo4j 版本
Neo4j 版本	依赖项	描述
社区版	org.neo4j:neo4j	一个高性能、完全 ACID 事务图形数据库。
企业版	org.neo4j:neo4j-enterprise	添加高级监控、在线备份和集群功能。

请注意，列出的依赖项不包含实现，但会以传递方式提取它。

有关许可的详细信息，请参阅许可指南。

Javadoc 可以从 Maven Central 以 JAR 文件形式下载，或在Neo4j Javadocs 中阅读。