jpa-patterns

jpa-patterns

热门

JPA/Hibernate模式,用于Spring Boot中的实体设计、关系映射、查询优化、事务管理、审计、索引、分页和连接池。

23万Star
3.5万Fork
更新于 2026/7/14
SKILL.md
readonly只读
name
jpa-patterns
description

JPA/Hibernate模式,用于Spring Boot中的实体设计、关系映射、查询优化、事务管理、审计、索引、分页和连接池。

JPA/Hibernate模式

用于Spring Boot中的数据建模、仓库和性能调优。

何时激活

  • 设计JPA实体和表映射
  • 定义关系(@OneToMany、@ManyToOne、@ManyToMany)
  • 优化查询(N+1预防、抓取策略、投影)
  • 配置事务、审计或软删除
  • 设置分页、排序或自定义仓库方法
  • 调优连接池(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);

仓库模式

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并排序。

索引与性能

  • 为常用过滤条件(statusslug、外键)添加索引
  • 使用与查询模式匹配的复合索引(status, created_at
  • 避免select *;只投影需要的列
  • 使用saveAllhibernate.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=DEBUGlogging.level.org.hibernate.orm.jdbc.bind=TRACE以查看参数值

记住:保持实体精简,查询有目的,事务短小。通过抓取策略和投影预防N+1,并为读写路径建立索引。