Spring Boot で Neo4j へのアクセス、データ取得(組み込みNeo4jドライバーを使用)

組み込みNeo4jドライバーを使用して Spring Boot で Neo4j からデータ取得して画面表示させてみたました。本記事では、サンプルコードとその解説を記載します。

Neo4J の公式サイトの次の内容を参考にしました。

Neo4j Java Driver Spring Boot Starter – Neo4J

Neo4J 接続方式

Neo4J には、HTTP接続と組み込みドライバでの接続があります。今回は組み込みドライバを使用して接続します。

HTTP接続時のURI
neo4j://localhost:7687

組み込みドライバでの接続時のURI
bolt://localhost:7687

pom.xmlの設定

Neo4j組み込みドライバーを使用するにあたり、必須なライブラリは次のとおりです。

<dependency>
  <groupId>org.neo4j.driver</groupId>
  <artifactId>neo4j-java-driver-spring-boot-starter</artifactId>
  <version>4.0.1.1</version>
</dependency>

全体は次のとおりです。今回のサンプルではブラウザからアクセスするためのライブラリや、ソースコードを修正したら自動でコンパイルしてくれるライブラリが入っています。これらは必須ではありません、作業効率を上げるためのものなので無くてもいいです。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.7.RELEASE</version>
    <relativePath /> <!-- lookup parent from repository -->
  </parent>
  <groupId>com.demo</groupId>
  <artifactId>app</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>Neo4jSample</name>
  <description>Demo project for Spring Boot</description>

  <properties>
    <java.version>1.8</java.version>
    <maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.neo4j.driver</groupId>
      <artifactId>neo4j-java-driver-spring-boot-starter</artifactId>
      <version>4.0.1.1</version>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-devtools</artifactId>
      <scope>runtime</scope>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
      <exclusions>
        <exclusion>
          <groupId>org.junit.vintage</groupId>
          <artifactId>junit-vintage-engine</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

</project>

application.propertiesの設定

設定ファイルで記述が必要なのは3つです。

org.neo4j.driver.uri=bolt://localhost:7687

org.neo4j.driver.authentication.username=neo4j

org.neo4j.driver.authentication.password=secret

username と password は、Neo4jに設定しているものを使用します。

ソースコード

ソースコードのファイルは1つのみです。ブラウザからのアクセスを受け付けて、JSON形式で返却します。公式サイトのサンプルでは、データに依存した記載になっていてデータを修正するのが面倒だったので一部改修しました。

今回のサンプルではNeo4jにある全データを取得してブラウザに表示するようにしています。これならデータに依存することなく処理することが出来ます。

Neo4jSampleController.java

package com.demo.app;

import java.util.List;

import org.neo4j.driver.Driver;
import org.neo4j.driver.Session;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class Neo4jSampleController {

  private final Driver driver;

  public Neo4jSampleController(Driver driver) {
    this.driver = driver;
  }

  @GetMapping(path = "/", produces = MediaType.APPLICATION_JSON_VALUE)
  public List<String> getMovieTitles() {

    try (Session session = driver.session()) {

      return session.run("MATCH (n) RETURN n ORDER BY n.name ASC")
          .list(r -> r.get("n").asNode().get("name").asString());
    }
  }
}

以上、Spring Boot で Neo4j へのアクセス、データ取得(組み込みNeo4jドライバーを使用)でした。




Let's share SNS