Spring Data JPA ストリームのクエリメソッド-＆＃＆チュートリアル-php.cn

Spring Data JPA Stream Query Methods

導入

従来、大量のデータをフェッチすると、結果セット全体をメモリにロードすることが多くなるため、メモリリソースに負担がかかる可能性があります。

=>;ストリームクエリメソッドは、Java 8 Streams を使用してデータを段階的に処理する方法を提供することで、ソリューションを提供します。これにより、常にデータの一部のみがメモリに保持されるようになり、パフォーマンスとスケーラビリティが向上します。

このブログ投稿では、Spring Data JPA でストリームクエリメソッドがどのように機能するかを詳しく掘り下げ、そのユースケースを調査し、その実装を示します。

このガイドでは次のものを使用します:

IDE: IntelliJ IDEA (Spring アプリケーションに推奨) または Eclipse
Java バージョン: 17
Spring Data JPA バージョン: 2.7.x 以降 (Spring Boot 3.x と互換性あり)

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

ログイン後にコピー

注: より詳細な例については、こちらの GitHub リポジトリにアクセスしてください

1. ストリームクエリメソッドとは何ですか?

Spring Data JPA のストリームクエリメソッドを使用すると、クエリ結果をリストや他のコレクション型ではなくストリームとして返すことができます。このアプローチにはいくつかの利点があります。

効率的なリソース管理: データは段階的に処理され、メモリのオーバーヘッドが削減されます。
遅延処理: 結果はオンデマンドでフェッチされ、処理されます。これは、ページネーションやバッチ処理などのシナリオに最適です。
関数型プログラミングとの統合: ストリームは Java の関数型プログラミング機能に適合し、フィルター、マップ、収集などの操作を可能にします。

2. ストリームクエリメソッドの使用方法?

=>;電子商取引アプリケーションを開発していて、次のことをしたいと想像してみましょう。

特定の日付以降に注文したすべての顧客を取得します。
指定された合計金額を超える注文をフィルターします。
過去 6 か月以内の合計注文額に基づいて顧客をグループ化します。
顧客名とその合計注文額の概要としてデータを返します。

エンティティ

顧客: 顧客を表します。

@Setter
@Getter
@Entity
@Entity(name = "tbl_customer")
public class Customer {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private String email;

    @OneToMany(mappedBy = "customer", cascade = CascadeType.ALL, fetch = FetchType.LAZY)
    private List<Order> orders;
}

ログイン後にコピー

注文: 顧客による注文を表します。

@Setter
@Getter
@Entity(name = "tbl_order")
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private Double amount;
    private LocalDateTime orderDate;

    @ManyToOne
    @JoinColumn(name = "customer_id")
    private Customer customer;
}

ログイン後にコピー

リポジトリ

CustomerRepository は、顧客と、特定の日付以降に行われた関連する注文を選択するために使用されます。そして、Stream を使用しました。 List の代わりにクエリの結果を処理します。

public interface CustomerRepository extends JpaRepository<Customer, Long> {
    @Query("""
                SELECT c FROM tbl_customer c JOIN FETCH c.orders o WHERE o.orderDate >= :startDate
            """)
    @QueryHints(
            @QueryHint(name = AvailableHints.HINT_FETCH_SIZE, value = "25")
    )
    Stream<Customer> findCustomerWithOrders(@Param("startDate") LocalDateTime startDate);
}

ログイン後にコピー

注:

JOIN FETCH により、注文は積極的にロードされます。
JPA に追加のヒントを提供するために使用される @QueryHints (Hibernate など) は、クエリの実行を最適化します。

=>;たとえば、クエリが 100 レコードを返した場合:

最初の 25 レコードがアプリケーションによってフェッチされ、処理されます。
それらが処理されると、次の 25 がフェッチされ、100 レコードすべてが処理されるまで同様に繰り返されます。
この動作により、メモリ使用量が最小限に抑えられ、100 件すべてのレコードが一度にメモリにロードされることがなくなります。

サービス

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

ログイン後にコピー

これは、startDate と minOrderAmount の 2 つのパラメーターを使用してデータを処理するサービスクラスです。ご覧のとおり、SQL クエリを使用してフィルタリングすることはなく、すべてのデータをストリームとしてロードし、Java コードでフィルタリングしてグループ化します。

コントローラー

@Setter
@Getter
@Entity
@Entity(name = "tbl_customer")
public class Customer {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private String email;

    @OneToMany(mappedBy = "customer", cascade = CascadeType.ALL, fetch = FetchType.LAZY)
    private List<Order> orders;
}

ログイン後にコピー

テスト

=>;テスト用のデータを作成するには、ソースコード内で次のスクリプトを実行するか、自分で追加することができます。

src/main/resources/dummy-data.sql

リクエスト:

startDate: 2024-05-01T00:00:00
最小注文量: 100

@Setter
@Getter
@Entity(name = "tbl_order")
public class Order {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private Double amount;
    private LocalDateTime orderDate;

    @ManyToOne
    @JoinColumn(name = "customer_id")
    private Customer customer;
}

ログイン後にコピー

応答:

合計金額が minOrderAmount 以上のすべての顧客を返します。

public interface CustomerRepository extends JpaRepository<Customer, Long> {
    @Query("""
                SELECT c FROM tbl_customer c JOIN FETCH c.orders o WHERE o.orderDate >= :startDate
            """)
    @QueryHints(
            @QueryHint(name = AvailableHints.HINT_FETCH_SIZE, value = "25")
    )
    Stream<Customer> findCustomerWithOrders(@Param("startDate") LocalDateTime startDate);
}

ログイン後にコピー

3. ストリームとリスト

=>; IntelliJ Profiler を使用して、メモリ使用量と実行時間を監視できます。大規模なデータセットを追加してテストする方法の詳細については、私の GitHub リポジトリを参照してください

小規模データセット: (顧客 10 人、注文 100 件)

ストリーム: 実行時間 (~5ms)、メモリ使用量 (低)
リスト: 実行時間 (~4ms)、メモリ使用量 (低)

大規模なデータセット (顧客 10,000、注文 100,000)

ストリーム: 実行時間 (~202ms)、メモリ使用量 (中程度)
リスト: 実行時間 (~176ms)、メモリ使用量 (高)

パフォーマンス指標

Metric	Stream	List
Initial Fetch Time	Slightly slower (due to lazy loading)	Faster (all at once)
Memory Consumption	Low (incremental processing)	High (entire dataset in memory)
Memory Consumption	Low (incremental processing)	High (entire dataset in memory)
Processing Overhead	Efficient for large datasets	May cause memory issues for large datasets
Batch Fetching	Supported (with fetch size)	Not applicable
Error Recovery	Graceful with early termination	Limited, as data is preloaded