Spring Data JPA

概要

Spring Data JPA リポジトリ、エンティティ関係、クエリ、ページネーション、監査、トランザクションのパターンを提供します。

使用する場合

CRUD操作を行うリポジトリ、エンティティ関係、@Queryアノテーション、ページネーション、監査、またはUUID主キーを作成する場合。

手順

リポジトリインターフェースの作成

リポジトリインターフェースを実装するには:

1. 適切なリポジトリインターフェースを拡張します:

   @Repository
   public interface UserRepository extends JpaRepository<User, Long> {
       // Custom methods defined here
   }
   

2. シンプルな条件には派生クエリを使用します:

   Optional<User> findByEmail(String email);
   List<User> findByStatusOrderByCreatedDateDesc(String status);
   

3. @Queryでカスタムクエリを実装します:

   @Query("SELECT u FROM User u WHERE u.status = :status")
   List<User> findActiveUsers(@Param("status") String status);
   

エンティティの構成

1. 適切なアノテーションでエンティティを定義します:

   @Entity
   @Table(name = "users")
   public class User {
       @Id
       @GeneratedValue(strategy = GenerationType.IDENTITY)
       private Long id;
   
       @Column(nullable = false, length = 100)
       private String email;
   }
   

2. 適切なカスケードタイプを使用して関係を構成します:

   @OneToMany(mappedBy = "user", cascade = CascadeType.ALL, orphanRemoval = true)
   private List<Order> orders = new ArrayList<>();
   

   検証: 本番環境データに適用する前に、小規模なデータセットでカスケード動作をテストしてください。削除操作が予期せずカスケードしないことを確認してください。

3. データベース監査を設定します:

   @CreatedDate
   @Column(nullable = false, updatable = false)
   private LocalDateTime createdDate;
   

クエリパターンの適用

1. シンプルな条件には派生クエリを使用します
2. 複雑なクエリには@Queryを使用します
3. 単一の結果にはOptional<T>を返します
4. ページネーションにはPageableを使用します
5. 更新/削除操作には@Modifyingを適用します

トランザクションの管理

1. 読み取り専用操作に@Transactional(readOnly = true)をマークします
2. 変更操作には明示的なトランザクション境界を使用します
3. 必要に応じてロールバック条件を指定します

検証と最適化

1. エンティティ構成を検証します:

• 本番環境へのデプロイ前にトランザクション内でカスケード動作をテストしてください
• 双方向関係が正しく同期することを検証してください

2. クエリのパフォーマンスを最適化します:

• 大規模なテーブルに対するクエリでEXPLAIN ANALYZEを実行してください
• パフォーマンスの問題が検出された場合: インデックスを追加 → EXPLAINで検証 → 繰り返し
• @EntityGraphを使用してN+1クエリを防ぎます

3. ページネーションを検証します:

• インデックス付きの列がページネーションクエリをサポートしていることを確認してください
• 大規模なデータセットでテストして、カーソルの安定性を検証してください

例

基本的なCRUDリポジトリ

@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {
    // Derived query
    List<Product> findByCategory(String category);

    // Custom query
    @Query("SELECT p FROM Product p WHERE p.price > :minPrice")
    List<Product> findExpensiveProducts(@Param("minPrice") BigDecimal minPrice);
}

ページネーション実装

@Service
public class ProductService {
    private final ProductRepository repository;

    public Page<Product> getProducts(int page, int size) {
        Pageable pageable = PageRequest.of(page, size, Sort.by("name").ascending());
        return repository.findAll(pageable);
    }
}

監査機能付きエンティティ

@Entity
@EntityListeners(AuditingEntityListener.class)
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @CreatedDate
    @Column(nullable = false, updatable = false)
    private LocalDateTime createdDate;

    @LastModifiedDate
    private LocalDateTime lastModifiedDate;

    @CreatedBy
    @Column(nullable = false, updatable = false)
    private String createdBy;
}

ベストプラクティス

エンティティ設計

• コンストラクタインジェクションのみを使用してください (フィールドインジェクションは絶対に使用しないでください)
• final修飾子を使用した不変フィールドを選択してください
• DTOには Java records (16+) または@Valueを使用してください
• 常に適切な@Idおよび@GeneratedValueアノテーションを提供してください
• 明示的な@Tableおよび@Columnアノテーションを使用してください

パフォーマンス最適化

• 適切なフェッチ戦略を使用してください (LAZY vs EAGER)
• 大規模なデータセットにはページネーションを実装してください
• よくクエリされるフィールドにデータベースインデックスを使用してください
• N+1クエリ問題を避けるために@EntityGraphの使用を検討してください

リファレンスドキュメント

包括的な例、詳細なパターン、高度な構成については、以下を参照してください:

• Examples - 一般的なシナリオの完全なコード例
• Reference - 詳細なパターンと高度な構成

制約と警告

• JPA エンティティを REST API に直接公開しないでください。遅延ロードの問題を防ぐため、常に DTO を使用してください。
• @EntityGraphまたはJOIN FETCHをクエリで使用して N+1 クエリ問題を回避してください。
• 大規模なコレクションでCascadeType.REMOVEを使用する場合は注意してください。パフォーマンスの問題を引き起こす可能性があります。
• コレクションにEAGERフェッチタイプを使用しないでください。過度なデータベースクエリを引き起こす可能性があります。
• 長時間実行トランザクションは回避してください。データベースロック競合を引き起こす可能性があります。
• 読み取り操作には@Transactional(readOnly = true)を使用して、最適化を有効にしてください。
• ファーストレベルキャッシュに注意してください。エンティティは同じトランザクション内でデータベースの変更を反映しない可能性があります。
• UUID 主キーはインデックスの断片化を引き起こす可能性があります。シーケンシャル UUID または Long ID の使用を検討してください。
• 大規模なデータセットのページネーションには、フルテーブルスキャンを避けるため適切なインデックスが必要です。