如何使用 JPA 和 Hibernate 映射组合键？

Question

在这段代码中，如何为复合键生成一个Java类（how to composite key in hibernate）：

create table Time (
     levelStation int(15) not null,
     src varchar(100) not null,
     dst varchar(100) not null,
     distance int(15) not null,
     price int(15) not null,
     confPathID int(15) not null,
     constraint ConfPath_fk foreign key(confPathID) references ConfPath(confPathID),
     primary key (levelStation, confPathID)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

Answer 1

要映射复合键，您可以使用 EmbeddedId 或 IdClass 注释。我知道这个问题并不严格涉及 JPA，但规范定义的规则也适用。所以他们在这里：

2.1.4 主键和实体身份

...

复合主键必须
对应于单个
持久字段或属性或
此类字段或属性的集合
如下所述。主键类
必须定义为代表一个
复合主键。合成的
主键通常出现在以下情况
当从遗留数据库映射
数据库密钥由几个组成
列。 EmbeddedId 和
IdClass 注解用于
表示复合主键。参见
第 9.1.14 和 9.1.15 节。

...

以下规则适用
复合主键：

• 主键类必须是公共的，并且必须有一个公共的无参数
  构造函数。
• 如果使用基于属性的访问，则主键的属性
  类必须是公共的或受保护的。
• 主键类必须可序列化。
• 主键类
  必须定义 equals 和 hashCode
  方法。 值的语义
  这些方法的相等性必须是
  与数据库相等性一致
  对于数据库类型
  键已映射。
• 复合主键必须表示并映射为
  可嵌入类（参见第 9.1.14 节，
  “EmbeddedId Annotation”）或者必须是
  表示并映射到多个
  实体的字段或属性
  类（参见第 9.1.15 节，“IdClass
  注释”）。
• 如果复合主键类映射到多个字段或
  实体类的属性，
  主键字段的名称或
  主键类中的属性
  并且实体类的那些必须
  对应并且它们的类型必须是
  一样。

使用 IdClass

复合主键的类可能如下所示（可以是静态内部类）：

public class TimePK implements Serializable {
    protected Integer levelStation;
    protected Integer confPathID;

    public TimePK() {}

    public TimePK(Integer levelStation, Integer confPathID) {
        this.levelStation = levelStation;
        this.confPathID = confPathID;
    }
    // equals, hashCode
}

实体：

@Entity
@IdClass(TimePK.class)
class Time implements Serializable {
    @Id
    private Integer levelStation;
    @Id
    private Integer confPathID;

    private String src;
    private String dst;
    private Integer distance;
    private Integer price;

    // getters, setters
}

IdClass 注释将多个字段映射到表 PK 。

使用 EmbeddedId

复合主键的类可能如下所示（可以是静态内部类）：

@Embeddable
public class TimePK implements Serializable {
    protected Integer levelStation;
    protected Integer confPathID;

    public TimePK() {}

    public TimePK(Integer levelStation, Integer confPathID) {
        this.levelStation = levelStation;
        this.confPathID = confPathID;
    }
    // equals, hashCode
}

实体：

@Entity
class Time implements Serializable {
    @EmbeddedId
    private TimePK timePK;

    private String src;
    private String dst;
    private Integer distance;
    private Integer price;

    //...
}

@EmbeddedId 注释将 PK 类映射到表 PK 。

差异：

• 从物理模型的角度来看，没有差异
• @EmbeddedId以某种方式更清楚地传达了该密钥是一个复合密钥，并且当组合的pk是一个有意义的实体时，IMO是有意义的本身或在您的代码中重用。
• @IdClass 用于指定某些字段组合是唯一的，但这些字段没有特殊含义。

它们还会影响您编写查询的方式（使查询或多或少变得冗长）：

• with IdClass

  从时间 t 中选择 t.levelStation
  

• 与 EmbeddedId

  从时间 t 中选择 t.timePK.levelStation
  

参考

• JPA 1.0 规范
  • 第 2.1.4 节“主键和实体身份”
  • 第 9.1.14 节“EmbeddedId 注释”
  • 第 9.1.15 节“IdClass 注解”

Answer 2

您需要使用 @EmbeddedId：

@Entity
class Time {
    @EmbeddedId
    TimeId id;

    String src;
    String dst;
    Integer distance;
    Integer price;
}

@Embeddable
class TimeId implements Serializable {
    Integer levelStation;
    Integer confPathID;
}

Answer 3

假设您有以下数据库表：

首先，您需要创建 @Embeddable持有复合标识符：

@Embeddable
public class EmployeeId implements Serializable {
 
    @Column(name = "company_id")
    private Long companyId;
 
    @Column(name = "employee_number")
    private Long employeeNumber;
 
    public EmployeeId() {
    }
 
    public EmployeeId(Long companyId, Long employeeId) {
        this.companyId = companyId;
        this.employeeNumber = employeeId;
    }
 
    public Long getCompanyId() {
        return companyId;
    }
 
    public Long getEmployeeNumber() {
        return employeeNumber;
    }
 
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof EmployeeId)) return false;
        EmployeeId that = (EmployeeId) o;
        return Objects.equals(getCompanyId(), that.getCompanyId()) &&
                Objects.equals(getEmployeeNumber(), that.getEmployeeNumber());
    }
 
    @Override
    public int hashCode() {
        return Objects.hash(getCompanyId(), getEmployeeNumber());
    }
}

有了这个，我们可以通过使用 @EmbeddedId 注释来映射使用复合标识符的 Employee 实体：

@Entity(name = "Employee")
@Table(name = "employee")
public class Employee {
 
    @EmbeddedId
    private EmployeeId id;
 
    private String name;
 
    public EmployeeId getId() {
        return id;
    }
 
    public void setId(EmployeeId id) {
        this.id = id;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
}

Phone 与 Employee 具有 @ManyToOne 关联的实体，需要通过两个 @JoinColumn 映射从父类引用复合标识符：

@Entity(name = "Phone")
@Table(name = "phone")
public class Phone {
 
    @Id
    @Column(name = "`number`")
    private String number;
 
    @ManyToOne
    @JoinColumns({
        @JoinColumn(
            name = "company_id",
            referencedColumnName = "company_id"),
        @JoinColumn(
            name = "employee_number",
            referencedColumnName = "employee_number")
    })
    private Employee employee;
 
    public Employee getEmployee() {
        return employee;
    }
 
    public void setEmployee(Employee employee) {
        this.employee = employee;
    }
 
    public String getNumber() {
        return number;
    }
 
    public void setNumber(String number) {
        this.number = number;
    }
}

Answer 4

主键类必须定义 equals 和 hashCode 方法

1. 在实现 equals 时，您应该使用 instanceof 来允许与子类进行比较。如果 Hibernate 延迟加载一对一或多对一关系，您将拥有该类的代理而不是普通类。代理是一个子类。比较类名将会失败。
   从技术上讲：您应该遵循 Liskows 替换原则并忽略对称性。
2. 下一个陷阱是使用诸如 name.equals(that.name) 之类的东西，而不是 name.equals(that.getName()) 。如果是代理，第一个将会失败。

http://www.laliluna.de/jpa-hibernate-guide/ch06s06.html

Answer 5

看来你是从头开始做这件事。尝试使用可用的逆向工程工具，例如数据库中的 Netbeans 实体，至少可以实现基础知识的自动化（例如嵌入式 id）。如果您有很多表，这可能会变得非常令人头痛。我建议避免重新发明轮子，并使用尽可能多的可用工具将编码减少到最少和最重要的部分，即您打算做的事情。

Answer 6

让我们举一个简单的例子。假设有两个名为 test 和 customer 的表，描述如下：

create table test(
  test_id int(11) not null auto_increment,
  primary key(test_id));

create table customer(
  customer_id int(11) not null auto_increment,
  name varchar(50) not null,
  primary key(customer_id));

还有一个表用于跟踪 test 和 customer：

create table tests_purchased(
  customer_id int(11) not null,
  test_id int(11) not null,
  created_date datetime not null,
  primary key(customer_id, test_id));

我们可以看到表tests_purchased中的主键是复合键，所以我们将使用... hbm.xml 映射文件中的 标记。因此 PurchasedTest.hbm.xml 将如下所示：

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
  "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
  "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

<hibernate-mapping>
  <class name="entities.PurchasedTest" table="tests_purchased">

    <composite-id name="purchasedTestId">
      <key-property name="testId" column="TEST_ID" />
      <key-property name="customerId" column="CUSTOMER_ID" />
    </composite-id>

    <property name="purchaseDate" type="timestamp">
      <column name="created_date" />
    </property>

  </class>
</hibernate-mapping>

但它并没有在这里结束。在 Hibernate 中，我们使用 session.load (entityClass, id_type_object) 来使用主键查找并加载实体。在复合键的情况下，ID 对象应该是一个单独的 ID 类（在上面的例子中是一个 PurchasedTestId 类）它只声明如下的主键属性：

import java.io.Serializable;

public class PurchasedTestId implements Serializable {
  private Long testId;
  private Long customerId;

  // an easy initializing constructor
  public PurchasedTestId(Long testId, Long customerId) {
    this.testId = testId;
    this.customerId = customerId;
  }

  public Long getTestId() {
    return testId;
  }

  public void setTestId(Long testId) {
    this.testId = testId;
  }

  public Long getCustomerId() {
    return customerId;
  }

  public void setCustomerId(Long customerId) {
    this.customerId = customerId;
  }

  @Override
  public boolean equals(Object arg0) {
    if(arg0 == null) return false;
    if(!(arg0 instanceof PurchasedTestId)) return false;
    PurchasedTestId arg1 = (PurchasedTestId) arg0;
    return (this.testId.longValue() == arg1.getTestId().longValue()) &&
           (this.customerId.longValue() == arg1.getCustomerId().longValue());
  }

  @Override
  public int hashCode() {
    int hsCode;
    hsCode = testId.hashCode();
    hsCode = 19 * hsCode+ customerId.hashCode();
    return hsCode;
  }
}

重要的一点是我们还实现了两个函数 hashCode() 和 equals()，因为 Hibernate 依赖于它们。

Answer 7

使用 hbm.xml

    <composite-id>

        <!--<key-many-to-one name="productId" class="databaselayer.users.UserDB" column="user_name"/>-->
        <key-property name="productId" column="PRODUCT_Product_ID" type="int"/>
        <key-property name="categoryId" column="categories_id" type="int" />
    </composite-id>  

使用注释

复合键类

public  class PK implements Serializable{
    private int PRODUCT_Product_ID ;    
    private int categories_id ;

    public PK(int productId, int categoryId) {
        this.PRODUCT_Product_ID = productId;
        this.categories_id = categoryId;
    }

    public int getPRODUCT_Product_ID() {
        return PRODUCT_Product_ID;
    }

    public void setPRODUCT_Product_ID(int PRODUCT_Product_ID) {
        this.PRODUCT_Product_ID = PRODUCT_Product_ID;
    }

    public int getCategories_id() {
        return categories_id;
    }

    public void setCategories_id(int categories_id) {
        this.categories_id = categories_id;
    }

    private PK() { }

    @Override
    public boolean equals(Object o) {
        if ( this == o ) {
            return true;
        }

        if ( o == null || getClass() != o.getClass() ) {
            return false;
        }

        PK pk = (PK) o;
        return Objects.equals(PRODUCT_Product_ID, pk.PRODUCT_Product_ID ) &&
                Objects.equals(categories_id, pk.categories_id );
    }

    @Override
    public int hashCode() {
        return Objects.hash(PRODUCT_Product_ID, categories_id );
    }
}

实体类

@Entity(name = "product_category")
@IdClass( PK.class )
public  class ProductCategory implements Serializable {
    @Id    
    private int PRODUCT_Product_ID ;   

    @Id 
    private int categories_id ;

    public ProductCategory(int productId, int categoryId) {
        this.PRODUCT_Product_ID = productId ;
        this.categories_id = categoryId;
    }

    public ProductCategory() { }

    public int getPRODUCT_Product_ID() {
        return PRODUCT_Product_ID;
    }

    public void setPRODUCT_Product_ID(int PRODUCT_Product_ID) {
        this.PRODUCT_Product_ID = PRODUCT_Product_ID;
    }

    public int getCategories_id() {
        return categories_id;
    }

    public void setCategories_id(int categories_id) {
        this.categories_id = categories_id;
    }

    public void setId(PK id) {
        this.PRODUCT_Product_ID = id.getPRODUCT_Product_ID();
        this.categories_id = id.getCategories_id();
    }

    public PK getId() {
        return new PK(
            PRODUCT_Product_ID,
            categories_id
        );
    }    
}

Answer 8

另一种选择是将其映射为 ConfPath 表中复合元素的映射。

不过，此映射将受益于 (ConfPathID,levelStation) 上的索引。

public class ConfPath {
    private Map<Long,Time> timeForLevelStation = new HashMap<Long,Time>();

    public Time getTime(long levelStation) {
        return timeForLevelStation.get(levelStation);
    }

    public void putTime(long levelStation, Time newValue) {
        timeForLevelStation.put(levelStation, newValue);
    }
}

public class Time {
    String src;
    String dst;
    long distance;
    long price;

    public long getDistance() {
        return distance;
    }

    public void setDistance(long distance) {
        this.distance = distance;
    }

    public String getDst() {
        return dst;
    }

    public void setDst(String dst) {
        this.dst = dst;
    }

    public long getPrice() {
        return price;
    }

    public void setPrice(long price) {
        this.price = price;
    }

    public String getSrc() {
        return src;
    }

    public void setSrc(String src) {
        this.src = src;
    }
}

映射：

<class name="ConfPath" table="ConfPath">
    <id column="ID" name="id">
        <generator class="native"/>
    </id>
    <map cascade="all-delete-orphan" name="values" table="example"
            lazy="extra">
        <key column="ConfPathID"/>
        <map-key type="long" column="levelStation"/>
        <composite-element class="Time">
            <property name="src" column="src" type="string" length="100"/>
            <property name="dst" column="dst" type="string" length="100"/>
            <property name="distance" column="distance"/>
            <property name="price" column="price"/>
        </composite-element>
    </map>
</class>