Spring Data Neo4j 統合パターン

概要

Spring Boot アプリケーション向けの Spring Data Neo4j 統合パターンを提供します。@Node と @Relationship によるノードエンティティマッピング、リポジトリ設定（命令型および反応型）、@Query によるカスタム Cypher クエリ、埋め込み Neo4j データベースでの統合テストをカバーしています。

使用時期

以下の場合にこのスキルを使用してください：

• Spring Boot でのグラフデータベースと Neo4j 統合
• ノードエンティティ、関係、Cypher クエリ
• Spring Data Neo4j リポジトリ（命令型または反応型）
• 埋め込みデータベースでの Neo4j テスト

手順

1. Spring Data Neo4j のセットアップ

依存関係を追加：

Maven:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-neo4j</artifactId>
</dependency>

Gradle:

implementation 'org.springframework.boot:spring-boot-starter-data-neo4j'

application.properties で接続を設定：

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

Cypher-DSL ダイアレクトを設定（推奨）：

@Configuration
public class Neo4jConfig {
    @Bean
    Configuration cypherDslConfiguration() {
        return Configuration.newConfig()
            .withDialect(Dialect.NEO4J_5).build();
    }
}

検証チェックポイント: 進める前に、cypher-shell で MATCH (n) RETURN count(n) を実行して接続が機能することを確認します。

2. ノードエンティティを定義

1. @Node アノテーションを使用してエンティティクラスをマーク
2. ID 戦略を選択：
   • ビジネスキーを @Id として使用（不変、自然識別子）
   • 生成された @Id @GeneratedValue（Neo4j 内部 ID）
3. @Relationship アノテーションで関係を定義
4. 最終フィールドでエンティティを不変に保つ
5. **@Property**を使用してカスタムプロパティ名を指定

検証チェックポイント: エンティティの保存が失敗する場合は、制約違反を確認してください。重複した ID は一意性制約に違反します。

3. リポジトリを作成

1. リポジトリインターフェースを拡張：
   • Neo4jRepository<Entity, ID> 命令型操作用
   • ReactiveNeo4jRepository<Entity, ID> 反応型操作用
2. シンプルなクエリにクエリ導出を使用
3. 複雑な Cypher クエリに @Query アノテーションを適用
4. パラメータに $paramName 構文を使用

検証チェックポイント: まず findAll() でリポジトリをテストしてください。空の場合は、Neo4j インスタンスが実行中で認証情報が正しいか確認します。

4. 実装をテスト

1. テストスライシング用に @DataNeo4jTest をリポジトリテストで使用
2. 埋め込みデータベースとフィクスチャで Neo4j Harness をセットアップ
3. withFixture() Cypher クエリでテストデータを提供
4. テスト間でテストデータをクリーンアップ

検証チェックポイント: テストが「接続が拒否されました」で失敗する場合は、@BeforeAll で埋め込み Neo4j が正常に開始したことを確認します。

基本的なエンティティマッピング

ビジネスキー付きノードエンティティ

@Node("Movie")
public class MovieEntity {

    @Id
    private final String title;  // ID としてのビジネスキー

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

    private final Integer year;

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

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

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

生成された ID 付きノードエンティティ

@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) {
        this.id = null;  // 手動で設定しない
        this.title = title;
        this.description = description;
    }

    // 生成された ID を使用した不変性のための wither メソッド
    public MovieEntity withId(Long id) {
        if (this.id != null && this.id.equals(id)) {
            return this;
        } else {
            MovieEntity newObject = new MovieEntity(this.title, this.description);
            newObject.id = id;
            return newObject;
        }
    }
}

リポジトリパターン

基本的なリポジトリインターフェース

@Repository
public interface MovieRepository extends Neo4jRepository<MovieEntity, String> {

    // メソッド名からのクエリ導出
    MovieEntity findOneByTitle(String title);

    List<MovieEntity> findAllByYear(Integer year);

    List<MovieEntity> findByYearBetween(Integer startYear, Integer endYear);
}

反応型リポジトリ

@Repository
public interface MovieRepository extends ReactiveNeo4jRepository<MovieEntity, String> {

    Mono<MovieEntity> findOneByTitle(String title);

    Flux<MovieEntity> findAllByYear(Integer year);
}

命令型と反応型：

• ブロッキング、命令型操作には Neo4jRepository を使用
• ノンブロッキング、反応型操作には ReactiveNeo4jRepository を使用
• 同じアプリケーション内で命令型と反応型を混在させないでください
• 反応型は データベース側で Neo4j 4 以上が必要

@Query によるカスタムクエリ

@Repository
public interface AuthorRepository extends Neo4jRepository<Author, Long> {

    @Query("MATCH (b:Book)-[:WRITTEN_BY]->(a:Author) " +
           "WHERE a.name = $name AND b.year > $year " +
           "RETURN b")
    List<Book> findBooksAfterYear(@Param("name") String name,
                                   @Param("year") Integer year);

    @Query("MATCH (b:Book)-[:WRITTEN_BY]->(a:Author) " +
           "WHERE a.name = $name " +
           "RETURN b ORDER BY b.year DESC")
    List<Book> findBooksByAuthorOrderByYearDesc(@Param("name") String name);
}

カスタムクエリのベストプラクティス：

• パラメータプレースホルダーに $parameterName を使用
• メソッドパラメータ名が異なる場合は @Param アノテーションを使用
• MATCH はノードパターンと関係を指定
• WHERE 結果をフィルタリング
• RETURN は何を返すかを定義

テスト戦略

統合テスト用 Neo4j Harness

テスト設定：

@DataNeo4jTest
class BookRepositoryIntegrationTest {

    private static Neo4j embeddedServer;

    @BeforeAll
    static void initializeNeo4j() {
        embeddedServer = Neo4jBuilders.newInProcessBuilder()
            .withDisabledServer()  // HTTP アクセス不要
            .withFixture(
                "CREATE (b:Book {isbn: '978-0547928210', " +
                "name: 'The Fellowship of the Ring', year: 1954})" +
                "-[:WRITTEN_BY]->(a:Author {id: 1, name: 'J. R. R. Tolkien'}) " +
                "CREATE (b2:Book {isbn: '978-0547928203', " +
                "name: 'The Two Towers', year: 1956})" +
                "-[:WRITTEN_BY]->(a)"
            )
            .build();
    }

    @AfterAll
    static void stopNeo4j() {
        embeddedServer.close();
    }

    @DynamicPropertySource
    static void neo4jProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.neo4j.uri", embeddedServer::boltURI);
        registry.add("spring.neo4j.authentication.username", () -> "neo4j");
        registry.add("spring.neo4j.authentication.password", () -> "null");
    }

    @Autowired
    private BookRepository bookRepository;

    @Test
    void givenBookExists_whenFindOneByTitle_thenBookIsReturned() {
        Book book = bookRepository.findOneByTitle("The Fellowship of the Ring");
        assertThat(book.getIsbn()).isEqualTo("978-0547928210");
    }
}

例

例 1: エンティティの保存と取得

入力：

MovieEntity movie = new MovieEntity("The Matrix", "Welcome to the Real World", 1999);
movieRepository.save(movie);

MovieEntity found = movieRepository.findOneByTitle("The Matrix");

出力：

MovieEntity{
    title="The Matrix",
    description="Welcome to the Real World",
    year=1999,
    actorsAndRoles=[],
    directors=[]
}

例 2: カスタム Cypher クエリ

入力：

List<Book> books = authorRepository.findBooksAfterYear("J.R.R. Tolkien", 1950);

出力：

[
    Book{isbn="978-0547928210", name="The Fellowship of the Ring", year=1954},
    Book{isbn="978-0547928203", name="The Two Towers", year=1956},
    Book{isbn="978-0547928227", name="The Return of the King", year=1957}
]

例 3: 関係トラバーサル

入力：

@Query("MATCH (m:Movie)<-[:ACTED_IN]-(a:Person) " +
       "WHERE m.title = $title RETURN a.name as actorName")
List<String> findActorsByMovieTitle(@Param("title") String title);

List<String> actors = movieRepository.findActorsByMovieTitle("The Matrix");

出力：

["Keanu Reeves", "Laurence Fishburne", "Carrie-Anne Moss", "Hugo Weaving"]

---

完全なムービーデータベース、ソーシャルネットワークパターン、e コマース製品カタログ、カスタムクエリ、反応型操作をカバーする基本から上級の例に進みます。

包括的なコード例についてはexamplesを参照してください。

ベストプラクティス

エンティティ設計

• 最終フィールド付き不変エンティティを使用
• ビジネスキー（@Id）または生成された ID（@Id @GeneratedValue）の間で選択
• エンティティはグラフ構造に焦点を当てて、ビジネスロジックではなく
• 適切な関係方向を使用（INCOMING、OUTGOING、UNDIRECTED）

リポジトリ設計

• 命令型には Neo4jRepository、反応型には ReactiveNeo4jRepository を拡張
• シンプルなクエリにはクエリ導出を使用
• 複雑なグラフパターン用にカスタム @Query を記述
• 同じアプリケーション内で命令型と反応型を混在させない

設定

• Cypher-DSL ダイアレクトを常に明示的に設定
• 認証情報には環境固有のプロパティを使用
• ソースコードに認証情報をハードコーディングしない
• 負荷に基づいて接続プーリングを設定

テスト

• 統合テストに Neo4j Harness を使用
• withFixture() Cypher クエリでテストデータを提供
• テストスライシングに @DataNeo4jTest を使用
• 成功シナリオとエッジケース両方をテスト

アーキテクチャ

• コンストラクタインジェクションのみを使用
• ドメインエンティティを DTO から分離
• 機能ベースのパッケージ構造に従う
• ドメイン層をフレームワーク非依存に保つ

セキュリティ

• 認証情報には Spring Boot プロパティ上書きを使用
• 適切な認証と認可を設定
• サービス層で入力パラメータを検証
• Cypher インジェクションを防ぐためにパラメータ化クエリを使用

制約と警告

• 同じアプリケーション内で命令型と反応型リポジトリを混在させないでください。
• Neo4j トランザクションは書き込み操作に必要です。@Transactional が適切に設定されていることを確認してください。
• 深い関係トラバーサルはパフォーマンスの問題を引き起こす可能性があるため注意してください。
• 大きな結果セットはメモリ問題を避けるためページネーションが必要です。
• Cypher クエリは大文字と小文字を区別します。プロパティ名で一貫した大文字化を確認してください。
• 不変エンティティは生成された ID に対して適切な wither メソッドが必要です。
• Spring Data Neo4j の関係はデフォルトではレイジーロードされません。大規模グラフの場合はプロジェクションを検討してください。
• Neo4j Java ドライバーはリアクティブストリームと互換性がありません。反応型操作には反応型ドライバーを使用してください。

トラブルシューティング

問題	原因	解決方法
localhost:7687 上の「接続が拒否されました」	Neo4j サーバーが実行されていない	Neo4j を開始するか、テスト用に埋め込み Neo4j を使用
「認証に失敗しました」	認証情報が間違っている	spring.neo4j.authentication.username/password を確認
エンティティが保存されない / MATCH が何も返さない	トランザクションがコミットされない	@Transactional を追加するか、自動コミット設定を確認
保存時に ConstraintViolationException	重複した @Id 値	ID が一意か確認するか、@GeneratedValue を使用
結果に関係がない	間違った @Relationship 方向	Direction.INCOMING/OUTGOING/UNDIRECTED を確認
@Query が誤ったデータを返す	Cypher パラメータ構文	$paramName ではなく ${paramName} を使用
@DataNeo4jTest でテストが失敗	埋め込み Neo4j が開始されない	テスト前に @BeforeAll で Neo4j が開始されたか確認

参考資料

詳細なドキュメント（完全な API リファレンス、Cypher クエリパターン、設定オプション）：

• アノテーションリファレンス
• Cypher クエリ言語
• 設定プロパティ
• リポジトリメソッド
• プロジェクションと DTO
• トランザクション管理
• パフォーマンスチューニング

外部リソース

• Spring Data Neo4j 公式ドキュメント
• Neo4j デベロッパーガイド
• Spring Data Commons ドキュメント