Hibernate-：@IdClass（paymentIdClass）

JPA (Java Persistence API) 中的 @IdClass(paymentIdClass) 注释用于定义Payment实体的复合键。复合键由多个字段组成，而不是单个字段。

1. @IdClass 的用途

@IdClass 指定 Payment 实体的主键由多个属性组成。 我们将多个字段定义为主键，而不是单个主键列。这是非常必要的，当实体没有单个自然的唯一标识符，而是依靠多个字段的组合来识别唯一的标识。例如，Payment 实体可能有一个复合主键，包括：

• customer: 指向 Customer 实体的外键 (整数)
• checkNumber: 表示支票号码的字符串

customer 和 checkNumber 每次付款记录的组合唯一标志。

2. @IdClass 的工作原理

@IdClass(PaymentId.class) 告诉 JPA，Payment 实体将使用 PaymentId 类作为其复合主键。

PaymentId 类必须：

• 是一个 JavaBean (无参构造函数和无参构造函数 getter/setter 方法)。
• 实现 Serializable 接口。
• 覆盖 equals() 和 hashCode() 确保实体比较正确的方法。
• 拥有与 Payment 匹配实体主键字段的字段。

3. PaymentId 类的结构

PaymentId 类应构建如下：

import java.io.Serializable;
import java.util.Objects;

public class PaymentId implements Serializable {
    private Integer customer;  // 必须与 payment.customer 的类型匹配 (customer 的 ID)
    private String checkNumber;

    // 无参结构函数 (必须序列化)
    public PaymentId() {}

    public PaymentId(Integer customer, String checkNumber) {
        this.customer = customer;
        this.checkNumber = checkNumber;
    }

    // getter 和 setter 方法
    public Integer getCustomer() { return customer; }
    public void setCustomer(Integer customer) { this.customer = customer; }

    public String getCheckNumber() { return checkNumber; }
    public void setCheckNumber(String checkNumber) { this.checkNumber = checkNumber; }

    // 覆盖 equals() 和 hashCode() 方法，用于 JPA 中间的正确比较
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        PaymentId that = (PaymentId) o;
        return Objects.equals(customer, that.customer) && Objects.equals(checkNumber, that.checkNumber);
    }

    @Override
    public int hashCode() {
        return Objects.hash(customer, checkNumber);
    }
}

4. JPA 如何使用 @IdClass

持久化 Payment 实体时，JPA 使用 PaymentId 类表示其主键。JPA 检查数据库中是否有具有相同复合主键的实体。

检索 Payment 实体时，JPA 使用 PaymentId 对复合主键进行中定义字段重建。

5. 替代方法：使用 @EmbeddedId

除了 @IdClass，定义复合主键的另一种方法是 @EmbeddedId，它直接将主键字段嵌入实体内部：

@Embeddable
public class PaymentId implements Serializable {
    @ManyToOne
    @JoinColumn(name = "customerNumber")
    private Customer customer;

    @Column(name = "checkNumber", length = 50)
    private String checkNumber;

    // 构造函数, equals(), hashCode(), getter 和 setter 方法
}

然后，Payment 实体将使用：

@EmbeddedId
private PaymentId id;

主要区别在于 @EmbeddedId 将复合主键视为嵌入式对象， @IdClass 分开字段。

6. 为什么要用？ @IdClass？

@IdClass 以下情况非常有用：

• 主键定义与实体之间的清晰分离需要维护。
• 复合主键已被定义为使用遗留数据库。

总结

@IdClass(PaymentId.class) 告诉 JPA，主键由多个字段组成 (customer 和 checkNumber) 组成。PaymentId 允许类作为标识符表示。 JPA 在实体操作(如持久化、检索和比较)中正确处理复合主键的各种情况。

以上是Hibernatete-：@IdClass（paymentIdClass）详情请关注图灵教育的其他相关文章！