padrões-jpa

Padrões JPA/Hibernate

Use para modelagem de dados, repositórios e ajuste de desempenho no Spring Boot.

Quando Ativar

• Projetar entidades JPA e mapeamentos de tabelas
• Definir relacionamentos (@OneToMany, @ManyToOne, @ManyToMany)
• Otimizar consultas (prevenção N+1, estratégias de fetch, projeções)
• Configurar transações, auditoria ou exclusões lógicas
• Configurar paginação, ordenação ou métodos de repositório personalizados
• Ajustar pooling de conexão (HikariCP) ou cache de segundo nível

Design de Entidades

@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;
}

Habilitar auditoria:

@Configuration
@EnableJpaAuditing
class JpaConfig {}

Relacionamentos e Prevenção N+1

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

• Prefira carregamento preguiçoso (lazy loading); use JOIN FETCH em consultas quando necessário
• Evite EAGER em coleções; use projeções DTO para caminhos de leitura

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

Padrões de Repositório

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);
}

• Use projeções para consultas leves:

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

Transações

• Anote métodos de serviço com @Transactional
• Use @Transactional(readOnly = true) para caminhos de leitura e otimizar
• Escolha a propagação com cuidado; evite transações de longa duração

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

Paginação

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

Para paginação do tipo cursor, inclua id > :lastId no JPQL com ordenação.

Indexação e Desempenho

• Adicione índices para filtros comuns (status, slug, chaves estrangeiras)
• Use índices compostos que correspondam aos padrões de consulta (status, created_at)
• Evite select *; projete apenas as colunas necessárias
• Realize gravações em lote com saveAll e hibernate.jdbc.batch_size

Pooling de Conexão (HikariCP)

Propriedades recomendadas:

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

Para manipulação de LOB no PostgreSQL, adicione:

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

Cache

• O cache de primeiro nível é por EntityManager; evite manter entidades entre transações
• Para entidades com muitas leituras, considere o cache de segundo nível com cautela; valide a estratégia de evicção

Migrações

• Use Flyway ou Liquibase; nunca dependa do auto DDL do Hibernate em produção
• Mantenha as migrações idempotentes e aditivas; evite excluir colunas sem planejamento

Testando Acesso a Dados

• Prefira @DataJpaTest com Testcontainers para espelhar a produção
• Avalie a eficiência do SQL usando logs: defina logging.level.org.hibernate.SQL=DEBUG e logging.level.org.hibernate.orm.jdbc.bind=TRACE para valores de parâmetros

Lembre-se: Mantenha as entidades enxutas, consultas intencionais e transações curtas. Previna o N+1 com estratégias de fetch e projeções, e indexe para seus caminhos de leitura/escrita.