chore: sync with upstream e7cb442 + update zh translations

This commit is contained in:
xuxiang
2026-02-02 18:57:56 +08:00
parent 6f87d43c19
commit d7cafbe582
66 changed files with 9395 additions and 1465 deletions

View File

@@ -1,13 +1,13 @@
---
name: jpa-patterns
description: JPA/Hibernate patterns for entity design, relationships, query optimization, transactions, auditing, indexing, pagination, and pooling in Spring Boot.
description: Spring Boot 中用于实体设计、关联关系、查询优化、事务、审计、索引、分页和连接池的 JPA/Hibernate 模式。
---
# JPA/Hibernate Patterns
# JPA/Hibernate 模式
Use for data modeling, repositories, and performance tuning in Spring Boot.
用于 Spring Boot 中的数据建模、存储层Repositories开发和性能调优。
## Entity Design
## 实体设计(Entity Design
```java
@Entity
@@ -33,29 +33,29 @@ public class MarketEntity {
}
```
Enable auditing:
启用审计Auditing
```java
@Configuration
@EnableJpaAuditing
class JpaConfig {}
```
## Relationships and N+1 Prevention
## 关联关系与 N+1 问题预防
```java
@OneToMany(mappedBy = "market", cascade = CascadeType.ALL, orphanRemoval = true)
private List<PositionEntity> positions = new ArrayList<>();
```
- Default to lazy loading; use `JOIN FETCH` in queries when needed
- Avoid `EAGER` on collections; use DTO projections for read paths
- 默认使用懒加载Lazy loading必要时在查询中使用 `JOIN FETCH`
- 避免在集合上使用立即加载(`EAGER`);对于读取路径,优先使用 DTO 投影Projections
```java
@Query("select m from MarketEntity m left join fetch m.positions where m.id = :id")
Optional<MarketEntity> findWithPositions(@Param("id") Long id);
```
## Repository Patterns
## 存储层模式(Repository Patterns
```java
public interface MarketRepository extends JpaRepository<MarketEntity, Long> {
@@ -66,7 +66,7 @@ public interface MarketRepository extends JpaRepository<MarketEntity, Long> {
}
```
- Use projections for lightweight queries:
- 使用投影Projections)进行轻量级查询:
```java
public interface MarketSummary {
Long getId();
@@ -76,11 +76,11 @@ public interface MarketSummary {
Page<MarketSummary> findAllBy(Pageable pageable);
```
## Transactions
## 事务(Transactions
- Annotate service methods with `@Transactional`
- Use `@Transactional(readOnly = true)` for read paths to optimize
- Choose propagation carefully; avoid long-running transactions
- 使用 `@Transactional` 注解 Service 方法
- 在读取路径上使用 `@Transactional(readOnly = true)` 进行优化
- 谨慎选择传播行为Propagation避免长事务
```java
@Transactional
@@ -92,25 +92,25 @@ public Market updateStatus(Long id, MarketStatus status) {
}
```
## Pagination
## 分页(Pagination
```java
PageRequest page = PageRequest.of(pageNumber, pageSize, Sort.by("createdAt").descending());
Page<MarketEntity> markets = repo.findByStatus(MarketStatus.ACTIVE, page);
```
For cursor-like pagination, include `id > :lastId` in JPQL with ordering.
对于游标式分页Cursor-like pagination),请在 JPQL 中包含 `id > :lastId` 并配合排序。
## Indexing and Performance
## 索引与性能
- Add indexes for common filters (`status`, `slug`, foreign keys)
- Use composite indexes matching query patterns (`status, created_at`)
- Avoid `select *`; project only needed columns
- Batch writes with `saveAll` and `hibernate.jdbc.batch_size`
- 为常用过滤器(`status``slug`、外键添加索引Indexing
- 使用匹配查询模式的复合索引Composite indexes,如 `status, created_at`
- 避免使用 `select *`;仅投影所需的列
- 使用 `saveAll` 并配置 `hibernate.jdbc.batch_size` 进行批量写入
## Connection Pooling (HikariCP)
## 连接池(Connection Pooling - HikariCP
Recommended properties:
推荐属性:
```
spring.datasource.hikari.maximum-pool-size=20
spring.datasource.hikari.minimum-idle=5
@@ -118,24 +118,24 @@ spring.datasource.hikari.connection-timeout=30000
spring.datasource.hikari.validation-timeout=5000
```
For PostgreSQL LOB handling, add:
对于 PostgreSQL LOB 处理,请添加:
```
spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
```
## Caching
## 缓存(Caching
- 1st-level cache is per EntityManager; avoid keeping entities across transactions
- For read-heavy entities, consider second-level cache cautiously; validate eviction strategy
- 一级缓存(1st-level cache)是基于 EntityManager 的;避免跨事务保留实体
- 对于读多写少的实体谨慎考虑二级缓存2nd-level cache验证逐出策略Eviction strategy
## Migrations
## 数据迁移(Migrations
- Use Flyway or Liquibase; never rely on Hibernate auto DDL in production
- Keep migrations idempotent and additive; avoid dropping columns without plan
- 使用 Flyway Liquibase;在生产环境中绝不要依赖 Hibernate 的自动 DDL
- 保持迁移是幂等Idempotent且具有增量性的避免在没有计划的情况下删除列
## Testing Data Access
## 测试数据访问
- Prefer `@DataJpaTest` with Testcontainers to mirror production
- Assert SQL efficiency using logs: set `logging.level.org.hibernate.SQL=DEBUG` and `logging.level.org.hibernate.orm.jdbc.bind=TRACE` for parameter values
- 优先使用 `@DataJpaTest` 配合 Testcontainers 来模拟生产环境
- 使用日志断言 SQL 效率:设置 `logging.level.org.hibernate.SQL=DEBUG` 以及 `logging.level.org.hibernate.orm.jdbc.bind=TRACE` 以查看参数值
**Remember**: Keep entities lean, queries intentional, and transactions short. Prevent N+1 with fetch strategies and projections, and index for your read/write paths.
**记住**保持实体精简、查询意图明确且事务简短。通过抓取策略Fetch strategies和投影Projections)来防止 N+1 问题,并针对读/写路径建立索引。