Spring Data JPA 复合主键查询与最佳实践

本文深入探讨了在 spring data jpa 中处理复合主键的策略。我们将学习如何正确配置 `jparepository` 以支持 `embeddedid`，并介绍三种查询复合主键实体的方法：使用 `findbyid` 配合 `embeddedid` 对象、通过方法名派生查询，以及利用 `@query` 注解自定义 jpql。此外，文章还将强调使用现代日期时间 api 和构建健壮的 `optional` 错误处理机制等关键最佳实践，以提升代码质量和可维护性。

理解 JPA 复合主键

在关系型数据库中，有时一个表的主键由多个列共同组成，这就是复合主键。在 JPA 中，我们通常通过 @EmbeddedId 和 @Embeddable 注解来定义复合主键。@Embeddable 注解用于标记一个类作为可嵌入的组件，它包含了构成复合主键的所有字段。而 @EmbeddedId 则用于实体类中，声明该实体使用一个嵌入式对象作为其主键。

以下是一个复合主键 PlansPKId 的定义示例，它由 planId 和 planDate 组成：

@Data
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode
@Embeddable
public class PlansPKId implements Serializable {

    private long planId;

    private Date planDate; // format: yyyy-mm-dd
}

登录后复制

相应的 Plans 实体将使用 @EmbeddedId 来引用这个复合主键类：

@Data
@AllArgsConstructor
@NoArgsConstructor
@Entity
@Table(name = "plans")
public class Plans {
    @EmbeddedId
    private PlansPKId plansPKId;

    @Column
    private String planName;

    @Column
    private String weekday;

    // ... 其他字段和关联关系
}

登录后复制

Spring Data JPA 复合主键查询策略

在使用 Spring Data JPA 时，JpaRepository 的 findById() 方法只接受一个参数作为实体的主键类型。这意味着，如果您的实体使用了复合主键，您不能直接将构成复合主键的多个字段作为参数传递给 findById()。相反，您需要将整个复合主键对象作为 ID 类型传递。

1. 使用 findById() 配合 EmbeddedId 对象

这是处理复合主键最直接的方式。您需要将 JpaRepository 的第二个泛型参数（ID 类型）设置为您的复合主键类 (PlansPKId)。

首先，定义您的仓库接口：

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface PlansRepository extends JpaRepository<Plans, PlansPKId> {
}

登录后复制

然后，在您的业务逻辑中，通过创建一个 PlansPKId 实例并将其传递给 findById() 方法来查询实体：

import java.util.Date;

// ...
public Plans assignPlansToMeds(Long id, Long planId, Date planDate) {
    // ...
    Plans plans = plansRepo.findById(new PlansPKId(planId, planDate))
                           .orElseThrow(() -> new PlansNotFoundException(planId, planDate)); // 见下文错误处理部分
    // ...
    return plansRepo.save(plans);
}

登录后复制

注意事项: 每次查询都需要创建 PlansPKId 的新实例。

2. 通过方法名派生查询

Spring Data JPA 提供了强大的功能，可以根据仓库接口中的方法名自动生成查询。对于复合主键，您可以通过引用嵌入式 ID 对象的属性来构建查询方法名。

例如，如果您想根据 planId 和 planDate 查询 Plans 实体，可以定义如下方法：

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
import java.util.Date;
import java.util.Optional;

@Repository
public interface PlansRepository extends JpaRepository<Plans, PlansPKId> {
    Optional<Plans> findByPlansPKIdPlanIdAndPlansPKIdPlanDate(long planId, Date planDate);
}

登录后复制

Spring Data JPA 会自动解析 PlansPKIdPlanId 和 PlansPKIdPlanDate，并生成相应的查询。 注意事项: 这种方法可能导致方法名过长且难以阅读，尤其当复合主键包含更多字段时。

3. 使用 @Query 注解自定义 JPQL 查询

当您需要更灵活的查询或者希望方法名更简洁时，可以使用 @Query 注解来定义 JPQL (Java Persistence Query Language) 或原生 SQL 查询。

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;
import java.util.Date;
import java.util.Optional;

@Repository
public interface PlansRepository extends JpaRepository<Plans, PlansPKId> {

    @Query("select p from Plans p where p.plansPKId.planId = :planId and p.plansPKId.planDate = :planDate")
    Optional<Plans> findByCompositeId(@Param("planId") long planId, @Param("planDate") Date planDate);
}

登录后复制

在这种情况下，您可以在 @Query 注解中直接引用 Plans 实体中的 plansPKId 字段，并进一步访问其内部属性 planId 和 planDate。@Param 注解用于将方法参数映射到 JPQL 查询中的命名参数。

标签： java stream 状态码 yy