jpa-patterns

JPA/Hibernate 模式

用於 Spring Boot 中的資料建模、Repository 與效能調校。

啟用時機

• 設計 JPA 實體與表格映射
• 定義關聯 (@OneToMany, @ManyToOne, @ManyToMany)
• 最佳化查詢 (N+1 預防、擷取策略、投影)
• 配置交易、審計或軟刪除
• 設定分頁、排序或自訂 Repository 方法
• 調校連線池 (HikariCP) 或第二級快取

實體設計

@Entity
@Table(name = "markets", indexes = {
  @Index(name = "idx_markets_slug", columnList = "slug", unique = true)
})
@EntityListeners(AuditingEntityListener.class)
public class MarketEntity {
  @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;

  @Column(nullable = false, length = 200)
  private String name;

  @Column(nullable = false, unique = true, length = 120)
  private String slug;

  @Enumerated(EnumType.STRING)
  private MarketStatus status = MarketStatus.ACTIVE;

  @CreatedDate private Instant createdAt;
  @LastModifiedDate private Instant updatedAt;
}

啟用審計：

@Configuration
@EnableJpaAuditing
class JpaConfig {}

關聯與 N+1 預防

@OneToMany(mappedBy = "market", cascade = CascadeType.ALL, orphanRemoval = true)
private List<PositionEntity> positions = new ArrayList<>();

• 預設為延遲載入；需要時在查詢中使用 JOIN FETCH
• 對集合避免使用 EAGER；對讀取路徑使用 DTO 投影

@Query("select m from MarketEntity m left join fetch m.positions where m.id = :id")
Optional<MarketEntity> findWithPositions(@Param("id") Long id);

Repository 模式

public interface MarketRepository extends JpaRepository<MarketEntity, Long> {
  Optional<MarketEntity> findBySlug(String slug);

  @Query("select m from MarketEntity m where m.status = :status")
  Page<MarketEntity> findByStatus(@Param("status") MarketStatus status, Pageable pageable);
}

• 對輕量級查詢使用投影：

public interface MarketSummary {
  Long getId();
  String getName();
  MarketStatus getStatus();
}
Page<MarketSummary> findAllBy(Pageable pageable);

交易

• 在服務方法上加上 @Transactional 註解
• 對讀取路徑使用 @Transactional(readOnly = true) 以最佳化
• 謹慎選擇傳播行為；避免長時間執行的交易

@Transactional
public Market updateStatus(Long id, MarketStatus status) {
  MarketEntity entity = repo.findById(id)
      .orElseThrow(() -> new EntityNotFoundException("Market"));
  entity.setStatus(status);
  return Market.from(entity);
}

分頁

PageRequest page = PageRequest.of(pageNumber, pageSize, Sort.by("createdAt").descending());
Page<MarketEntity> markets = repo.findByStatus(MarketStatus.ACTIVE, page);

若要類比游標式分頁，可在 JPQL 中加入 id > :lastId 條件並配合排序。

索引與效能

• 為常見的篩選條件 (status, slug, 外鍵) 加入索引
• 使用複合索引以符合查詢模式 (status, created_at)
• 避免 select *；只投影所需的欄位
• 使用 saveAll 和 hibernate.jdbc.batch_size 進行批次寫入

連線池 (HikariCP)

建議的屬性：

spring.datasource.hikari.maximum-pool-size=20
spring.datasource.hikari.minimum-idle=5
spring.datasource.hikari.connection-timeout=30000
spring.datasource.hikari.validation-timeout=5000

對於 PostgreSQL 的 LOB 處理，請加上：

spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true

快取

• 第一級快取是 EntityManager 層級；避免在不同交易之間保留實體
• 對讀取頻繁的實體，謹慎考慮第二級快取；務必驗證清除策略

遷移

• 使用 Flyway 或 Liquibase；生產環境絕不依賴 Hibernate 自動 DDL
• 保持遷移的冪等性與累加性；未經計畫不要刪除欄位

測試資料存取

• 偏好使用 @DataJpaTest 搭配 Testcontainers 來模擬生產環境
• 透過日誌驗證 SQL 效率：設定 logging.level.org.hibernate.SQL=DEBUG 以及 logging.level.org.hibernate.orm.jdbc.bind=TRACE 以檢視參數值

切記：保持實體精簡、查詢有目的、交易簡短。使用擷取策略與投影預防 N+1，並為讀寫路徑建立索引。