Spring Data JPA 流查詢方法

介紹

傳統上，獲取大量資料可能會導致記憶體資源緊張，因為它通常涉及將整個結果集載入記憶體。

=>流查詢方法透過提供一種使用 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 中的流查詢方法允許我們以 Stream 的形式傳回查詢結果，而不是 List 或其他集合類型。這種方法有幾個好處：

• 高效率的資源管理：增量處理數據，減少記憶體開銷。

• 延遲處理：隨選取得和處理結果，非常適合分頁或批次等場景。

• 與函數式程式設計整合：串流符合 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而不是清單處理查詢結果。

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 確保訂單被急切地載入。

• @QueryHints 用於向 JPA（例如 Hibernate）提供額外提示以最佳化查詢執行。

=>例如，當我的查詢傳回 100 筆記錄時：

• 前 25 筆記錄由應用程式取得並處理。
• 處理完畢後，將取得接下來的 25 筆記錄，依此類推，直到處理完所有 100 筆記錄。
• 此行為最大限度地減少了記憶體使用量，並避免一次將所有 100 筆記錄載入到記憶體中。

服務

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

這裡是處理資料的服務類，有兩個參數startDate和minOrderAmount。如您所見，我們不使用 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

請求：

• 開始日期: 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

總結

Spring Data JPA 流查詢方法提供了一種優雅的方式來高效處理大型資料集，同時利用 Java Streams 的強大功能。透過增量處理數據，它們減少了記憶體消耗並與現代函數式程式設計範例無縫整合。

您對流查詢方法有何看法？在下面的評論中分享您的經驗和用例！

下一篇文章見。快樂編碼！

以上是Spring Data JPA 流查詢方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！